🔧 Avoid shipping it as new rule, as mutations have a nested input best practice

Author: nambrosini

schemadiff/validation_rules/__init__.py

@@ -62,8 +62,6 @@ def is_valid(self) -> bool:
         else:
             return type_has_description
 
-        return True
-
     @property
     def message(self):
         return f"{self.change.message} without a description for {self.change.path} (rule: `{self.name}`)."
@@ -146,26 +144,3 @@ def message(self):
         return f"Description for enum value `{self.change.name}` was removed (rule: `{self.name}`)"
 
 
-class MutationWithTooManyArguments(ValidationRule):
-    """Restrict adding fields with too many top level arguments"""
-
-    name = "field-has-too-many-arguments"
-    limit = 10
-
-    def is_valid(self) -> bool:
-        if not isinstance(self.change, (ObjectTypeFieldAdded, FieldArgumentAdded)):
-            return True
-
-        if len(self.args) > self.limit:
-            return False
-        else:
-            return True
-
-    @property
-    def args(self):
-        return self.change.field.args or {}
-
-    @property
-    def message(self):
-        return f"Field `{self.change.parent.name}.{self.change.field_name}` has too many arguments " \
-               f"({len(self.args)}>{self.limit}). Rule: {self.name}"

tests/test_validation_rules.py

@@ -2,6 +2,8 @@
 from graphql import build_schema as schema
 
 from schemadiff.changes import Change, Criticality
+from schemadiff.changes.field import FieldArgumentAdded
+from schemadiff.changes.object import ObjectTypeFieldAdded
 from schemadiff.validation import evaluate_rules, ValidationResult, ValidationError
 from schemadiff.validation_rules import (
     ValidationRule,
@@ -234,6 +236,30 @@ def test_schema_added_field_no_desc():
 def test_cant_create_mutation_with_more_than_10_arguments():
     schema_restrictions = ['field-has-too-many-arguments']
 
+    class FieldHasTooManyArguments(ValidationRule):
+        """Restrict adding fields with too many top level arguments"""
+
+        name = "field-has-too-many-arguments"
+        limit = 10
+
+        def is_valid(self) -> bool:
+            if not isinstance(self.change, (ObjectTypeFieldAdded, FieldArgumentAdded)):
+                return True
+
+            if len(self.args) > self.limit:
+                return False
+            else:
+                return True
+
+        @property
+        def args(self):
+            return self.change.field.args or {}
+
+        @property
+        def message(self):
+            return f"Field `{self.change.parent.name}.{self.change.field_name}` has too many arguments " \
+                   f"({len(self.args)}>{self.limit}). Rule: {self.name}"
+
     old_schema = schema("""
     schema {
         mutation: Mutation
@@ -274,6 +300,30 @@ def test_cant_create_mutation_with_more_than_10_arguments():
 def test_cant_add_arguments_to_mutation_if_exceeds_10_args():
     schema_restrictions = ['field-has-too-many-arguments']
 
+    class FieldHasTooManyArguments(ValidationRule):
+        """Restrict adding fields with too many top level arguments"""
+
+        name = "field-has-too-many-arguments"
+        limit = 10
+
+        def is_valid(self) -> bool:
+            if not isinstance(self.change, (ObjectTypeFieldAdded, FieldArgumentAdded)):
+                return True
+
+            if len(self.args) > self.limit:
+                return False
+            else:
+                return True
+
+        @property
+        def args(self):
+            return self.change.field.args or {}
+
+        @property
+        def message(self):
+            return f"Field `{self.change.parent.name}.{self.change.field_name}` has too many arguments " \
+                   f"({len(self.args)}>{self.limit}). Rule: {self.name}"
+
     old_schema = schema("""
     schema {
         mutation: Mutation