add docs attributte to each file and for each variable

osl-incubator · Dec 22, 2023 · ae5bd2c · ae5bd2c
1 parent 330dab2
commit ae5bd2c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/src/envers/core.py b/src/envers/core.py
@@ -197,9 +197,11 @@ def draft(
             env_vars = dotenv_values(env_path)
             file_spec = {
                 "type": "dotenv",
+                "docs": "",
                 "vars": {
                     var: {
                         "type": "string",
+                        "docs": "",
                         "default": value,
                     }
                     for var, value in env_vars.items()

diff --git a/tests/test_core.py b/tests/test_core.py
@@ -15,15 +15,17 @@
 def spec_v1():
     """Return dummy data for spec v1."""
     return {
-        "status": "draft",
         "docs": "",
+        "status": "draft",
         "profiles": ["base"],
         "spec": {
             "files": {
                 ".env": {
+                    "docs": "",
                     "type": "dotenv",
                     "vars": {
                         "var": {
+                            "docs": "",
                             "type": "string",
                             "default": "hello",
                         }
@@ -63,8 +65,8 @@ def test_draft(self):
             "version": "0.1",
             "releases": {
                 spec_version: {
-                    "status": "draft",
                     "docs": "",
+                    "status": "draft",
                     "profiles": ["base"],
                     "spec": {"files": {}},
                 }
@@ -161,9 +163,11 @@ def test_draft_from_multi_env(self, spec_v1):
 
         spec_files = expected_data["releases"][v1]["spec"]["files"]
         spec_files[env_path_1] = {
+            "docs": "",
             "type": "dotenv",
             "vars": {
                 "var1": {
+                    "docs": "",
                     "type": "string",
                     "default": "hello1",
                 }
@@ -181,9 +185,11 @@ def test_draft_from_multi_env(self, spec_v1):
 
         spec_files = expected_data["releases"][v1]["spec"]["files"]
         spec_files[env_path_2] = {
+            "docs": "",
             "type": "dotenv",
             "vars": {
                 "var2": {
+                    "docs": "",
                     "type": "string",
                     "default": "hello2",
                 }