Merge pull request #14 from rbob86/additional_lookml_rules

Added one rule, update example config file

Author: eric-lyons

config.example.yaml

@@ -1,17 +1,19 @@
 - rule: field_requires_description
   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: warning
+- rule: view_with_dimensions_and_measures_has_one_primary_key
   severity: error
+- rule: dimension_group_of_type_time_requires_datatype
+  severity: warning
 - rule: dimension_group_of_type_time_requires_timeframe
   severity: warning
 - rule: explore_joins_require_relationship
-  severity: ignore
+  severity: warning
 - rule: explore_requires_description
-  severity: ignore
+  severity: warning
+- rule: explore_joins_contain_many_to_many_relationship
+  severity: warning
 - rule: field_sql_html_requires_user_attribute_when_search_terms_found
   severity: error
   param_sets:

linter/rule_factory.py

@@ -11,6 +11,7 @@
 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
+from linter.rules.explore_joins_contain_many_to_many_relationship import ExploreJoinsContainManyToManyRelationship
 
 
 class RuleFactory:

linter/rules/explore_joins_contain_many_to_many_relationship.py

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

test/rules/test_explore_joins_contain_many_to_many_relationship.py

@@ -0,0 +1,29 @@
+from linter.rule import Severity
+from linter.rules.explore_joins_contain_many_to_many_relationship import ExploreJoinsContainManyToManyRelationship
+
+
+def test_run_method_successfully_validates_explore_with_joins_and_no_many_to_many_relationships() -> None:
+    rule = ExploreJoinsContainManyToManyRelationship(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 = ExploreJoinsContainManyToManyRelationship(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_warns_when_explore_has_joins_and_with_many_to_many_relationship() -> None:
+    rule = ExploreJoinsContainManyToManyRelationship(Severity.WARNING.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_many', '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