add a "docs" field to models, parsed from schema.yml. it contains a b…

…oolean "show" which defaults to True.
dbt-labs · Feb 7, 2020 · ae3ef19 · ae3ef19
1 parent 9df123a
commit ae3ef19
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 7 deletions.
diff --git a/core/dbt/contracts/graph/parsed.py b/core/dbt/contracts/graph/parsed.py
@@ -21,7 +21,7 @@
 from dbt.clients.system import write_file
 import dbt.flags
 from dbt.contracts.graph.unparsed import (
-    UnparsedNode, UnparsedMacro, UnparsedDocumentationFile, Quoting,
+    UnparsedNode, UnparsedMacro, UnparsedDocumentationFile, Quoting, Docs,
     UnparsedBaseNode, FreshnessThreshold, ExternalTable,
     AdditionalPropertiesAllowed, HasYamlMetadata
 )
@@ -188,6 +188,7 @@ def patch(self, patch: 'ParsedNodePatch'):
         self.columns = patch.columns
         self.docrefs = patch.docrefs
         self.meta = patch.meta
+        self.docs = patch.docs
         if dbt.flags.STRICT_MODE:
             assert isinstance(self, JsonSchemaMixin)
             self.to_dict(validate=True)
@@ -225,6 +226,7 @@ class ParsedNodeDefaults(ParsedNodeMandatory):
     description: str = field(default='')
     columns: Dict[str, ColumnInfo] = field(default_factory=dict)
     meta: Dict[str, Any] = field(default_factory=dict)
+    docs: Docs = field(default_factory=Docs)
     patch_path: Optional[str] = None
     build_path: Optional[str] = None
 
@@ -469,6 +471,7 @@ class ParsedPatch(HasYamlMetadata, Replaceable):
     description: str
     docrefs: List[Docref]
     meta: Dict[str, Any]
+    docs: Docs
 
 
 # The parsed node update is only the 'patch', not the test. The test became a

diff --git a/core/dbt/contracts/graph/unparsed.py b/core/dbt/contracts/graph/unparsed.py
@@ -58,12 +58,18 @@ class UnparsedRunHook(UnparsedNode):
     index: Optional[int] = None
 
 
+@dataclass
+class Docs(JsonSchemaMixin, Replaceable):
+    show: bool = True
+
+
 @dataclass
 class HasDocs(JsonSchemaMixin, Replaceable):
     name: str
     description: str = ''
     meta: Dict[str, Any] = field(default_factory=dict)
     data_type: Optional[str] = None
+    docs: Docs = field(default_factory=Docs)
 
 
 TestDef = Union[Dict[str, Any], str]

diff --git a/core/dbt/parser/schemas.py b/core/dbt/parser/schemas.py
@@ -628,6 +628,7 @@ def parse_patch(
             columns=refs.column_info,
             docrefs=refs.docrefs,
             meta=block.target.meta,
+            docs=block.target.docs,
         )
         self.results.add_patch(self.yaml.file, result)
 
@@ -668,5 +669,6 @@ def parse_patch(
             description=description,
             docrefs=refs.docrefs,
             meta=block.target.meta,
+            docs=block.target.docs,
         )
         self.results.add_macro_patch(self.yaml.file, result)
diff --git a/test/integration/029_docs_generate_tests/models/schema.yml b/test/integration/029_docs_generate_tests/models/schema.yml
@@ -3,6 +3,8 @@ version: 2
 models:
   - name: model
     description: "The test model"
+    docs:
+      show: false
     columns:
       - name: id
         description: The user ID number

diff --git a/test/integration/029_docs_generate_tests/test_docs_generate.py b/test/integration/029_docs_generate_tests/test_docs_generate.py
@@ -951,6 +951,7 @@ def expected_seeded_manifest(self, model_database=None):
                     },
                     'patch_path': model_schema_yml_path,
                     'docrefs': [],
+                    'docs': {'show': False},
                     'compiled': True,
                     'compiled_sql': ANY,
                     'extra_ctes_injected': True,
@@ -1033,6 +1034,7 @@ def expected_seeded_manifest(self, model_database=None):
                         },
                     },
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': '',
                     'extra_ctes_injected': True,
@@ -1076,6 +1078,7 @@ def expected_seeded_manifest(self, model_database=None):
                     'meta': {},
                     'unique_id': 'test.test.not_null_model_id',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': AnyStringWith('count(*)'),
                     'extra_ctes_injected': True,
@@ -1124,6 +1127,7 @@ def expected_seeded_manifest(self, model_database=None):
                     'meta': {},
                     'unique_id': 'test.test.test_nothing_model_',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': AnyStringWith('select 0'),
                     'extra_ctes_injected': True,
@@ -1172,6 +1176,7 @@ def expected_seeded_manifest(self, model_database=None):
                     'meta': {},
                     'unique_id': 'test.test.unique_model_id',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': AnyStringWith('count(*)'),
                     'extra_ctes_injected': True,
@@ -1331,6 +1336,7 @@ def expected_postgres_references_manifest(self, model_database=None):
                     },
                     'description': '',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'fqn': ['test', 'ephemeral_copy'],
                     'name': 'ephemeral_copy',
                     'original_file_path': self.dir('ref_models/ephemeral_copy.sql'),
@@ -1409,6 +1415,7 @@ def expected_postgres_references_manifest(self, model_database=None):
                             'documentation_package': ''
                         }
                     ],
+                    'docs': {'show': True},
                     'fqn': ['test', 'ephemeral_summary'],
                     'name': 'ephemeral_summary',
                     'original_file_path': self.dir('ref_models/ephemeral_summary.sql'),
@@ -1489,6 +1496,7 @@ def expected_postgres_references_manifest(self, model_database=None):
                             'documentation_package': ''
                         }
                     ],
+                    'docs': {'show': True},
                     'fqn': ['test', 'view_summary'],
                     'name': 'view_summary',
                     'original_file_path': self.dir('ref_models/view_summary.sql'),
@@ -1571,6 +1579,7 @@ def expected_postgres_references_manifest(self, model_database=None):
                     'depends_on': {'macros': [], 'nodes': []},
                     'description': 'The test seed',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'fqn': ['test', 'seed'],
                     'name': 'seed',
                     'original_file_path': self.dir('seed/seed.csv'),
@@ -2472,6 +2481,7 @@ def expected_redshift_incremental_view_manifest(self):
                     },
                     'patch_path': self.dir('rs_models/schema.yml'),
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': ANY,
                     'extra_ctes_injected': True,
@@ -2554,6 +2564,7 @@ def expected_redshift_incremental_view_manifest(self):
                     },
                     'description': 'The test seed',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'compiled': True,
                     'compiled_sql': ANY,
                     'extra_ctes_injected': True,
@@ -2780,6 +2791,7 @@ def expected_run_results(self, quote_schema=True, quote_model=False,
                     },
                     'description': 'The test model',
                     'docrefs': [],
+                    'docs': {'show': False},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'model'],
@@ -2868,6 +2880,7 @@ def expected_run_results(self, quote_schema=True, quote_model=False,
                     'depends_on': {'macros': [], 'nodes': []},
                     'description': 'The test seed',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'seed'],
@@ -2922,6 +2935,7 @@ def expected_run_results(self, quote_schema=True, quote_model=False,
                     'depends_on': {'macros': [], 'nodes': ['model.test.model']},
                     'description': '',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'schema_test', 'not_null_model_id'],
@@ -2980,6 +2994,7 @@ def expected_run_results(self, quote_schema=True, quote_model=False,
                     'depends_on': {'macros': [], 'nodes': ['model.test.model']},
                     'description': '',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'schema_test', 'test_nothing_model_'],
@@ -3038,6 +3053,7 @@ def expected_run_results(self, quote_schema=True, quote_model=False,
                     'depends_on': {'macros': [], 'nodes': ['model.test.model']},
                     'description': '',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'schema_test', 'unique_model_id'],
@@ -3159,6 +3175,7 @@ def expected_postgres_references_run_results(self):
                             'documentation_package': ''
                         }
                     ],
+                    'docs': {'show': True},
                     'extra_ctes': [
                         {'id': 'model.test.ephemeral_copy', 'sql': cte_sql},
                     ],
@@ -3257,6 +3274,7 @@ def expected_postgres_references_run_results(self):
                             'documentation_package': ''
                         }
                     ],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'view_summary'],
@@ -3349,6 +3367,7 @@ def expected_postgres_references_run_results(self):
                     'depends_on': {'macros': [], 'nodes': []},
                     'description': 'The test seed',
                     'docrefs': [],
+                    'docs': {'show': True},
                     'extra_ctes': [],
                     'extra_ctes_injected': True,
                     'fqn': ['test', 'seed'],

diff --git a/test/unit/test_contracts_graph_compiled.py b/test/unit/test_contracts_graph_compiled.py
@@ -45,6 +45,7 @@ def test_basic_uncompiled(self):
                 'vars': {},
             },
             'docrefs': [],
+            'docs': {'show': True},
             'columns': {},
             'meta': {},
             'compiled': False,
@@ -129,6 +130,7 @@ def test_basic_compiled(self):
                 'vars': {},
             },
             'docrefs': [],
+            'docs': {'show': True},
             'columns': {},
             'meta': {},
             'compiled': True,
@@ -185,6 +187,7 @@ def test_invalid_extra_fields(self):
             'database': 'test_db',
             'schema': 'test_schema',
             'alias': 'bar',
+            'docs': {'show': True},
             'notvalid': 'nope',
         }
         self.assert_fails_validation(bad_extra)
@@ -203,6 +206,7 @@ def test_invalid_bad_type(self):
             'database': 'test_db',
             'schema': 'test_schema',
             'alias': 'bar',
+            'docs': {'show': True},
         }
         self.assert_fails_validation(bad_type)
 
@@ -242,6 +246,7 @@ def test_basic_uncompiled(self):
                 'severity': 'error',
             },
             'docrefs': [],
+            'docs': {'show': True},
             'columns': {},
             'meta': {},
             'compiled': False,
@@ -327,6 +332,7 @@ def test_basic_compiled(self):
                 'severity': 'warn',
             },
             'docrefs': [],
+            'docs': {'show': True},
             'columns': {},
             'meta': {},
             'compiled': True,
@@ -385,6 +391,7 @@ def test_invalid_extra_fields(self):
             'database': 'test_db',
             'schema': 'test_schema',
             'alias': 'bar',
+            'docs': {'show': True},
             'extra': 'extra value',
         }
         self.assert_fails_validation(bad_extra)
@@ -403,5 +410,6 @@ def test_invalid_resource_type(self):
             'database': 'test_db',
             'schema': 'test_schema',
             'alias': 'bar',
+            'docs': {'show': True},
         }
         self.assert_fails_validation(bad_type)