test(): added tests for enum capitalization

Author: kasvith

tests/code-first/app.module.ts

@@ -1,12 +1,14 @@
 import { Module } from '@nestjs/common';
 import { GraphQLModule } from '../../lib';
+import { CatsModule } from './cats/cats.module';
 import { DirectionsModule } from './directions/directions.module';
 import { RecipesModule } from './recipes/recipes.module';
 
 @Module({
   imports: [
     RecipesModule,
     DirectionsModule,
+    CatsModule,
     GraphQLModule.forRoot({
       debug: false,
       installSubscriptionHandlers: true,

tests/code-first/cats/cats.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { CatsResolver } from './cats.resolver';
+
+@Module({
+  providers: [CatsResolver],
+})
+export class CatsModule {}

tests/code-first/cats/cats.resolver.ts

@@ -0,0 +1,13 @@
+import { Args, Query, Resolver } from '../../../lib';
+import { CatType } from '../enums/cat-type.enum';
+
+@Resolver()
+export class CatsResolver {
+  @Query((returns) => CatType)
+  catType(
+    @Args({ name: 'catType', type: () => CatType })
+    catType: CatType,
+  ): CatType {
+    return catType;
+  }
+}

tests/code-first/enums/cat-type.enum.ts

@@ -0,0 +1,12 @@
+import { registerEnumType } from '../../../lib/type-factories/register-enum-type.factory';
+export enum CatType {
+  PersianCat = 'persian-cat',
+  MaineCoon = 'maine-coon',
+  Ragdoll = 'ragdoll',
+}
+
+registerEnumType(CatType, {
+  name: 'CatType',
+  description: 'Distinguish cats',
+  mapToUppercase: true,
+});

tests/e2e/code-first-schema.spec.ts

@@ -6,12 +6,12 @@ import {
   IntrospectionField,
   IntrospectionSchema,
   printSchema,
-  TypeKind
+  TypeKind,
 } from 'graphql';
 import { GRAPHQL_SDL_FILE_HEADER } from '../../lib/graphql.constants';
 import {
   GraphQLSchemaBuilderModule,
-  GraphQLSchemaFactory
+  GraphQLSchemaFactory,
 } from '../../lib/schema-builder';
 import { DirectionsResolver } from '../code-first/directions/directions.resolver';
 import { AbstractResolver } from '../code-first/other/abstract.resolver';
@@ -25,9 +25,10 @@ import {
   getQuery,
   getQueryByName,
   getSubscription,
-  getSubscriptionByName
+  getSubscriptionByName,
 } from '../utils/introspection-schema.utils';
 import { printedSchemaSnapshot } from '../utils/printed-schema.snapshot';
+import { CatsResolver } from '../code-first/cats/cats.resolver';
 
 describe('Code-first - schema factory', () => {
   let schemaFactory: GraphQLSchemaFactory;
@@ -49,6 +50,7 @@ describe('Code-first - schema factory', () => {
         [
           RecipesResolver,
           DirectionsResolver,
+          CatsResolver,
           AbstractResolver,
           IRecipesResolver,
         ],
@@ -66,17 +68,18 @@ describe('Code-first - schema factory', () => {
         printedSchemaSnapshot,
       );
     });
-    it('should define 5 queries', async () => {
+    it('should define 6 queries', async () => {
       const type = getQuery(introspectionSchema);
 
-      expect(type.fields.length).toEqual(5);
+      expect(type.fields.length).toEqual(6);
       expect(type.fields.map((item) => item.name)).toEqual(
         expect.arrayContaining([
           'recipes',
           'search',
           'categories',
           'move',
           'recipe',
+          'catType',
         ]),
       );
     });
@@ -152,6 +155,40 @@ describe('Code-first - schema factory', () => {
       );
     });
 
+    it('should define "CatType" enum to use CAPITALIZED_UNDERSCORE', () => {
+      const type = introspectionSchema.types.find(
+        ({ name }) => name === 'CatType',
+      );
+
+      expect(type).toEqual(
+        expect.objectContaining({
+          kind: TypeKind.ENUM,
+          name: 'CatType',
+          description: 'Distinguish cats',
+          enumValues: [
+            {
+              deprecationReason: null,
+              description: null,
+              isDeprecated: false,
+              name: 'PERSIAN_CAT',
+            },
+            {
+              deprecationReason: null,
+              description: null,
+              isDeprecated: false,
+              name: 'MAINE_COON',
+            },
+            {
+              deprecationReason: null,
+              description: null,
+              isDeprecated: false,
+              name: 'RAGDOLL',
+            },
+          ],
+        }),
+      );
+    });
+
     it('should define "SearchResultUnion" union', () => {
       const type = introspectionSchema.types.find(
         ({ name }) => name === 'SearchResultUnion',

tests/graphql/sort-auto-schema.module.ts

@@ -2,11 +2,13 @@ import { Module } from '@nestjs/common';
 import { GraphQLModule } from '../../lib';
 import { RecipesModule } from '../code-first/recipes/recipes.module';
 import { DirectionsModule } from '../code-first/directions/directions.module';
+import { CatsModule } from '../code-first/cats/cats.module';
 
 @Module({
   imports: [
     RecipesModule,
     DirectionsModule,
+    CatsModule,
     GraphQLModule.forRoot({
       autoSchemaFile: 'schema.graphql',
       sortSchema: true,

tests/graphql/transform-auto-schema-file.module.ts

@@ -3,11 +3,13 @@ import { GraphQLModule } from '../../lib';
 import { RecipesModule } from '../code-first/recipes/recipes.module';
 import { DirectionsModule } from '../code-first/directions/directions.module';
 import { GraphQLSchema, lexicographicSortSchema } from 'graphql';
+import { CatsModule } from '../code-first/cats/cats.module';
 
 @Module({
   imports: [
     RecipesModule,
     DirectionsModule,
+    CatsModule,
     GraphQLModule.forRoot({
       autoSchemaFile: 'schema.graphql',
       transformSchema: (schema: GraphQLSchema) =>

tests/utils/printed-schema.snapshot.ts

@@ -67,6 +67,7 @@ type Query {
     take: Int = 25
   ): [Recipe!]!
   move(direction: Direction!): Direction!
+  catType(catType: CatType!): CatType!
 }
 
 """Search result description"""
@@ -82,6 +83,13 @@ enum Direction {
   Sideways @deprecated(reason: "Replaced with Left or Right")
 }
 
+"""Distinguish cats"""
+enum CatType {
+  PERSIAN_CAT
+  MAINE_COON
+  RAGDOLL
+}
+
 type Mutation {
   addRecipe(newRecipeData: NewRecipeInput!): Recipe!
   removeRecipe(id: String!): Boolean!
@@ -105,6 +113,13 @@ export const sortedPrintedSchemaSnapshot = `# ----------------------------------
 # THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)
 # ------------------------------------------------------
 
+"""Distinguish cats"""
+enum CatType {
+  MAINE_COON
+  PERSIAN_CAT
+  RAGDOLL
+}
+
 type Category {
   description: String!
   name: String!
@@ -154,6 +169,7 @@ input NewRecipeInput {
 }
 
 type Query {
+  catType(catType: CatType!): CatType!
   categories: [Category!]!
   move(direction: Direction!): Direction!