Merge pull request #13 from rbob86/additional_lookml_rules

Added two more rules + tests

Author: jdemartino78

config.example.yaml

@@ -2,10 +2,14 @@
   severity: warning
 - rule: view_with_many_fields_requires_fields_hidden_by_default
   severity: ignore
+- rule: view_with_dimensions_and_measures_has_one_primary_key_defined
+  severity: ignore
 - rule: dimension_group_of_type_time_requires_datatype
   severity: error
 - rule: dimension_group_of_type_time_requires_timeframe
   severity: warning
+- rule: explore_joins_require_relationship
+  severity: ignore
 - rule: explore_requires_description
   severity: ignore
 - rule: field_sql_html_requires_user_attribute_when_search_terms_found

linter/rule_factory.py

@@ -5,9 +5,11 @@
 # TODO: AUTO-IMPORT RULES
 from linter.rules.field_requires_description import FieldRequiresDescription
 from linter.rules.view_with_many_fields_requires_fields_hidden_by_default import ViewWithManyFieldsRequiresFieldsHiddenByDefault
+from linter.rules.view_with_dimensions_and_measures_has_one_primary_key import ViewWithDimensionsAndMeasuresHasOnePrimaryKey
 from linter.rules.dimension_group_of_type_time_requires_datatype import DimensionGroupOfTypeTimeRequiresDatatype
 from linter.rules.dimension_group_of_type_time_requires_timeframe import DimensionGroupOfTypeTimeRequiresTimeframe
 from linter.rules.explore_requires_description import ExploreRequiresDescription
+from linter.rules.explore_joins_require_relationship import ExploreJoinsRequireRelationship
 from linter.rules.field_sql_html_requires_user_attribute_when_search_terms_found import FieldSqlHtmlRequiresUserAttributeWhenSearchTermsFound
 
 

linter/rules/explore_joins_require_relationship.py

@@ -0,0 +1,13 @@
+from linter.rule import Rule
+
+
+class ExploreJoinsRequireRelationship(Rule):
+    def applies_to():
+        return ('explore',)
+
+    def run(self, explore):
+        joins = explore.get('joins', [])
+        for join in joins:
+            if not 'relationship' in join:
+                return False
+        return True

linter/rules/view_with_dimensions_and_measures_has_one_primary_key.py

@@ -0,0 +1,19 @@
+from linter.rule import Rule
+
+
+class ViewWithDimensionsAndMeasuresHasOnePrimaryKey(Rule):
+    def applies_to():
+        return ('view',)
+
+    def run(self, view):
+        dimensions, measures = [
+            view.get(key, []) for key in ['dimensions', 'measures']]
+        has_primary_key = True
+        if len(measures) > 0 and len(dimensions) > 0:
+            has_primary_key = False
+            for dimension in dimensions:
+                if 'primary_key' in dimension:
+                    if has_primary_key:
+                        return False
+                    has_primary_key = True
+        return has_primary_key

test/rules/test_explore_joins_require_relationship.py

@@ -0,0 +1,29 @@
+from linter.rule import Severity
+from linter.rules.explore_joins_require_relationship import ExploreJoinsRequireRelationship
+
+
+def test_run_method_successfully_validates_explore_with_joins_and_relationships() -> None:
+    rule = ExploreJoinsRequireRelationship(Severity.ERROR.value)
+
+    explore = {'sql_always_where': "${products.category} in\n  (select ${products.category} from ${products.SQL_TABLE_NAME} products\n  where ${products.brand} = 'Allegra K'\n  group by 1)", 'joins': [{'type': 'left_outer', 'sql_on': '${order_items.user_id} = ${users.id}', 'relationship': 'many_to_one', 'name': 'users'}, {'fields': [
+        'inventory_items.id'], 'type': 'left_outer', 'sql_on': '${order_items.inventory_item_id} = ${inventory_items.id}', 'relationship': 'many_to_one', 'name': 'inventory_items'}, {'type': 'left_outer', 'sql_on': '${inventory_items.product_id} = ${products.id}', 'relationship': 'many_to_one', 'name': 'products'}], 'name': 'order_items'}
+    rule_result = rule.run(explore)
+    assert rule_result == True
+
+
+def test_run_method_successfully_validates_explore_without_joins() -> None:
+    rule = ExploreJoinsRequireRelationship(Severity.ERROR.value)
+
+    explore = {
+        'sql_always_where': "${products.category} in\n  (select ${products.category} from ${products.SQL_TABLE_NAME} products\n  where ${products.brand} = 'Allegra K'\n  group by 1)", 'name': 'order_items'}
+    rule_result = rule.run(explore)
+    assert rule_result == True
+
+
+def test_run_method_fails_to_validate_explore_with_joins_and_without_relationship() -> None:
+    rule = ExploreJoinsRequireRelationship(Severity.ERROR.value)
+
+    explore = {'sql_always_where': "${products.category} in\n  (select ${products.category} from ${products.SQL_TABLE_NAME} products\n  where ${products.brand} = 'Allegra K'\n  group by 1)", 'joins': [{'type': 'left_outer', 'sql_on': '${order_items.user_id} = ${users.id}', 'name': 'users'}, {'fields': [
+        'inventory_items.id'], 'type': 'left_outer', 'sql_on': '${order_items.inventory_item_id} = ${inventory_items.id}', 'relationship': 'many_to_one', 'name': 'inventory_items'}, {'type': 'left_outer', 'sql_on': '${inventory_items.product_id} = ${products.id}', 'relationship': 'many_to_one', 'name': 'products'}], 'name': 'order_items'}
+    rule_result = rule.run(explore)
+    assert rule_result == False

test/rules/test_view_with_dimensions_and_measures_has_one_primary_key_defined.py

@@ -0,0 +1,43 @@
+from linter.rule import Severity
+from linter.rules.view_with_dimensions_and_measures_has_one_primary_key import ViewWithDimensionsAndMeasuresHasOnePrimaryKey
+
+
+def test_run_method_successfully_validates_view_file_with_dimensions_and_measures_has_one_primary_key() -> None:
+    rule = ViewWithDimensionsAndMeasuresHasOnePrimaryKey(
+        Severity.ERROR.value)
+
+    view = {'sql_table_name': 'public.products', 'dimensions': [{'primary_key': 'yes', 'type': 'number', 'sql': 'CASE WHEN {{ _user_attributes[""permissions_financial_row_level""] }} = 1 THEN\n            ${TABLE}.id\n        ELSE\n            -1\n        END',
+                                                                 'html': '{% if _user_attributes[""permissions_financial_row_level""] == 1 %}\n        {{ rendered_value }}\n        {% else %}\n        [Insufficient Permissions]\n        {% endif %}', 'name': 'id'}], 'name': 'products'}
+    rule_result = rule.run(view)
+    assert rule_result == True
+
+
+def test_run_method_successfully_validates_view_file_with_dimensions_and_no_measures_does_not_require_primary_key() -> None:
+    rule = ViewWithDimensionsAndMeasuresHasOnePrimaryKey(
+        Severity.ERROR.value)
+
+    view = {'sql_table_name': 'public.products',
+            'dimensions': range(0, 50), 'name': 'total_cost'}
+    rule_result = rule.run(view)
+    assert rule_result == True
+
+
+def test_run_method_successfully_validates_view_file_with_no_dimensions_and_measures_does_not_require_primary_key() -> None:
+    rule = ViewWithDimensionsAndMeasuresHasOnePrimaryKey(
+        Severity.ERROR.value)
+
+    view = {'sql_table_name': 'public.products',
+            'measure': range(0, 50), 'name': 'total_cost'}
+    rule_result = rule.run(view)
+    assert rule_result == True
+
+
+def test_run_method_fails_when_view_with_dimensions_and_measures_does_not_have_a_primary_key() -> None:
+    rule = ViewWithDimensionsAndMeasuresHasOnePrimaryKey(
+        Severity.ERROR.value)
+
+    view = {'sql_table_name': 'public.products',
+            'dimensions': [str(dim) for dim in range(0, 50)], 'name': 'this_view',
+            'measures': [str(measure) for measure in range(0, 50)]}
+    rule_result = rule.run(view)
+    assert rule_result == False