Improved Enum type docs and Include test for extending a schema that uses Enums

Related GraphQL-js commit: graphql/graphql-js@37924d2

Author: syrusakbary

graphql/type/definition.py

@@ -495,11 +495,14 @@ class GraphQLEnumType(GraphQLType):
 
     Example:
 
-        RGBType = GraphQLEnumType('RGB', {
-            'RED': 0,
-            'GREEN': 1,
-            'BLUE': 2,
-        })
+        RGBType = GraphQLEnumType(
+            name='RGB',
+            values=OrderedDict([
+                ('RED', GraphQLEnumValue(0)),
+                ('GREEN', GraphQLEnumValue(1)),
+                ('BLUE', GraphQLEnumValue(2))
+            ])
+        )
 
     Note: If a value is not provided in a definition, the name of the enum value will be used as it's internal value.
     """

graphql/utils/tests/test_extend_schema.py

@@ -4,10 +4,10 @@
 
 from graphql import parse
 from graphql.execution import execute
-from graphql.type import (GraphQLArgument, GraphQLField, GraphQLID,
-                          GraphQLInterfaceType, GraphQLList, GraphQLNonNull,
-                          GraphQLObjectType, GraphQLSchema, GraphQLString,
-                          GraphQLUnionType)
+from graphql.type import (GraphQLArgument, GraphQLEnumType, GraphQLEnumValue,
+                          GraphQLField, GraphQLID, GraphQLInterfaceType,
+                          GraphQLList, GraphQLNonNull, GraphQLObjectType,
+                          GraphQLSchema, GraphQLString, GraphQLUnionType)
 from graphql.utils.extend_schema import extend_schema
 from graphql.utils.schema_printer import print_schema
 
@@ -55,12 +55,21 @@
     types=[FooType, BizType],
 )
 
+SomeEnumType = GraphQLEnumType(
+    name='SomeEnum',
+    values=OrderedDict([
+        ('ONE', GraphQLEnumValue(1)),
+        ('TWO', GraphQLEnumValue(2)),
+    ])
+)
+
 test_schema = GraphQLSchema(
     query=GraphQLObjectType(
         name='Query',
         fields=lambda: OrderedDict([
             ('foo', GraphQLField(FooType)),
             ('someUnion', GraphQLField(SomeUnionType)),
+            ('someEnum', GraphQLField(SomeEnumType)),
             ('someInterface', GraphQLField(
                 SomeInterfaceType,
                 args={
@@ -143,9 +152,15 @@ def test_extends_objects_by_adding_new_fields():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface
@@ -201,9 +216,74 @@ def test_extends_objects_by_adding_new_fields_with_arguments():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
+interface SomeInterface {
+  name: String
+  some: SomeInterface
+}
+
+union SomeUnion = Foo | Biz
+'''
+
+
+def test_extends_objects_by_adding_new_fields_with_existing_types():
+    ast = parse('''
+      extend type Foo {
+        newField(arg1: SomeEnum!): SomeEnum
+      }
+
+      input NewInputObj {
+        field1: Int
+        field2: [Float]
+        field3: String!
+      }
+    ''')
+    original_print = print_schema(test_schema)
+    extended_schema = extend_schema(test_schema, ast)
+    assert extended_schema != test_schema
+    assert print_schema(test_schema) == original_print
+    assert print_schema(extended_schema) == \
+        '''schema {
+  query: Query
+}
+
+type Bar implements SomeInterface {
+  name: String
+  some: SomeInterface
+  foo: Foo
+}
+
+type Biz {
+  fizz: String
+}
+
+type Foo implements SomeInterface {
+  name: String
+  some: SomeInterface
+  tree: [Foo]!
+  newField(arg1: SomeEnum!): SomeEnum
+}
+
+type Query {
+  foo: Foo
+  someUnion: SomeUnion
+  someEnum: SomeEnum
+  someInterface(id: ID!): SomeInterface
+}
+
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface
@@ -250,9 +330,15 @@ def test_extends_objects_by_adding_implemented_interfaces():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface
@@ -343,9 +429,15 @@ def test_extends_objects_by_adding_implemented_interfaces_2():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface
@@ -397,9 +489,15 @@ def test_extends_objects_by_adding_implemented_new_interfaces():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface
@@ -464,9 +562,15 @@ def test_extends_objects_multiple_times():
 type Query {
   foo: Foo
   someUnion: SomeUnion
+  someEnum: SomeEnum
   someInterface(id: ID!): SomeInterface
 }
 
+enum SomeEnum {
+  ONE
+  TWO
+}
+
 interface SomeInterface {
   name: String
   some: SomeInterface