github.com/mstephano/gqlgen-schemagen@v0.0.0-20230113041936-dd2cd4ea46aa/plugin/federation/federation_test.go (about)

     1  package federation
     2  
     3  import (
     4  	"testing"
     5  
     6  	"github.com/mstephano/gqlgen-schemagen/codegen"
     7  	"github.com/mstephano/gqlgen-schemagen/codegen/config"
     8  	"github.com/stretchr/testify/require"
     9  )
    10  
    11  func TestWithEntities(t *testing.T) {
    12  	f, cfg := load(t, "testdata/allthethings/gqlgen.yml")
    13  
    14  	require.Equal(t, []string{"ExternalExtension", "Hello", "MoreNesting", "NestedKey", "VeryNestedKey", "World"}, cfg.Schema.Types["_Entity"].Types)
    15  
    16  	require.Len(t, cfg.Schema.Types["Entity"].Fields, 6)
    17  
    18  	require.Equal(t, "findExternalExtensionByUpc", cfg.Schema.Types["Entity"].Fields[0].Name)
    19  	require.Equal(t, "findHelloByName", cfg.Schema.Types["Entity"].Fields[1].Name)
    20  	// missing on purpose: all @external fields:
    21  	// require.Equal(t, "findMoreNestingByID", cfg.Schema.Types["Entity"].Fields[2].Name)
    22  	require.Equal(t, "findNestedKeyByIDAndHelloName", cfg.Schema.Types["Entity"].Fields[2].Name)
    23  	require.Equal(t, "findVeryNestedKeyByIDAndHelloNameAndWorldFooAndWorldBarAndMoreWorldFoo", cfg.Schema.Types["Entity"].Fields[3].Name)
    24  	require.Equal(t, "findWorldByFoo", cfg.Schema.Types["Entity"].Fields[4].Name)
    25  	require.Equal(t, "findWorldByBar", cfg.Schema.Types["Entity"].Fields[5].Name)
    26  
    27  	require.NoError(t, f.MutateConfig(cfg))
    28  
    29  	require.Len(t, f.Entities, 6)
    30  
    31  	require.Equal(t, "ExternalExtension", f.Entities[0].Name)
    32  	require.Len(t, f.Entities[0].Resolvers, 1)
    33  	require.Len(t, f.Entities[0].Resolvers[0].KeyFields, 1)
    34  	require.Equal(t, "upc", f.Entities[0].Resolvers[0].KeyFields[0].Definition.Name)
    35  	require.Equal(t, "String", f.Entities[0].Resolvers[0].KeyFields[0].Definition.Type.Name())
    36  
    37  	require.Equal(t, "Hello", f.Entities[1].Name)
    38  	require.Len(t, f.Entities[1].Resolvers, 1)
    39  	require.Len(t, f.Entities[1].Resolvers[0].KeyFields, 1)
    40  	require.Equal(t, "name", f.Entities[1].Resolvers[0].KeyFields[0].Definition.Name)
    41  	require.Equal(t, "String", f.Entities[1].Resolvers[0].KeyFields[0].Definition.Type.Name())
    42  
    43  	require.Equal(t, "MoreNesting", f.Entities[2].Name)
    44  	require.Len(t, f.Entities[2].Resolvers, 0)
    45  
    46  	require.Equal(t, "NestedKey", f.Entities[3].Name)
    47  	require.Len(t, f.Entities[3].Resolvers, 1)
    48  	require.Len(t, f.Entities[3].Resolvers[0].KeyFields, 2)
    49  	require.Equal(t, "id", f.Entities[3].Resolvers[0].KeyFields[0].Definition.Name)
    50  	require.Equal(t, "String", f.Entities[3].Resolvers[0].KeyFields[0].Definition.Type.Name())
    51  	require.Equal(t, "helloName", f.Entities[3].Resolvers[0].KeyFields[1].Definition.Name)
    52  	require.Equal(t, "String", f.Entities[3].Resolvers[0].KeyFields[1].Definition.Type.Name())
    53  
    54  	require.Equal(t, "VeryNestedKey", f.Entities[4].Name)
    55  	require.Len(t, f.Entities[4].Resolvers, 1)
    56  	require.Len(t, f.Entities[4].Resolvers[0].KeyFields, 5)
    57  	require.Equal(t, "id", f.Entities[4].Resolvers[0].KeyFields[0].Definition.Name)
    58  	require.Equal(t, "String", f.Entities[4].Resolvers[0].KeyFields[0].Definition.Type.Name())
    59  	require.Equal(t, "helloName", f.Entities[4].Resolvers[0].KeyFields[1].Definition.Name)
    60  	require.Equal(t, "String", f.Entities[4].Resolvers[0].KeyFields[1].Definition.Type.Name())
    61  	require.Equal(t, "worldFoo", f.Entities[4].Resolvers[0].KeyFields[2].Definition.Name)
    62  	require.Equal(t, "String", f.Entities[4].Resolvers[0].KeyFields[2].Definition.Type.Name())
    63  	require.Equal(t, "worldBar", f.Entities[4].Resolvers[0].KeyFields[3].Definition.Name)
    64  	require.Equal(t, "Int", f.Entities[4].Resolvers[0].KeyFields[3].Definition.Type.Name())
    65  	require.Equal(t, "moreWorldFoo", f.Entities[4].Resolvers[0].KeyFields[4].Definition.Name)
    66  	require.Equal(t, "String", f.Entities[4].Resolvers[0].KeyFields[4].Definition.Type.Name())
    67  
    68  	require.Len(t, f.Entities[4].Requires, 2)
    69  	require.Equal(t, f.Entities[4].Requires[0].Name, "id")
    70  	require.Equal(t, f.Entities[4].Requires[1].Name, "helloSecondary")
    71  
    72  	require.Equal(t, "World", f.Entities[5].Name)
    73  	require.Len(t, f.Entities[5].Resolvers, 2)
    74  	require.Len(t, f.Entities[5].Resolvers[0].KeyFields, 1)
    75  	require.Equal(t, "foo", f.Entities[5].Resolvers[0].KeyFields[0].Definition.Name)
    76  	require.Equal(t, "String", f.Entities[5].Resolvers[0].KeyFields[0].Definition.Type.Name())
    77  	require.Len(t, f.Entities[5].Resolvers[1].KeyFields, 1)
    78  	require.Equal(t, "bar", f.Entities[5].Resolvers[1].KeyFields[0].Definition.Name)
    79  	require.Equal(t, "Int", f.Entities[5].Resolvers[1].KeyFields[0].Definition.Type.Name())
    80  }
    81  
    82  func TestNoEntities(t *testing.T) {
    83  	f, cfg := load(t, "testdata/entities/nokey.yml")
    84  
    85  	err := f.MutateConfig(cfg)
    86  	require.NoError(t, err)
    87  	require.Len(t, f.Entities, 0)
    88  }
    89  
    90  func TestInterfaceKeyDirective(t *testing.T) {
    91  	f, cfg := load(t, "testdata/interfaces/key.yml")
    92  
    93  	err := f.MutateConfig(cfg)
    94  	require.NoError(t, err)
    95  	require.Len(t, f.Entities, 0)
    96  }
    97  
    98  func TestInterfaceExtendsDirective(t *testing.T) {
    99  	require.Panics(t, func() {
   100  		load(t, "testdata/interfaces/extends.yml")
   101  	})
   102  }
   103  
   104  func TestCodeGeneration(t *testing.T) {
   105  	f, cfg := load(t, "testdata/allthethings/gqlgen.yml")
   106  
   107  	require.Len(t, cfg.Schema.Types["_Entity"].Types, 6)
   108  	require.Len(t, f.Entities, 6)
   109  
   110  	require.NoError(t, f.MutateConfig(cfg))
   111  
   112  	data, err := codegen.BuildData(cfg)
   113  	if err != nil {
   114  		panic(err)
   115  	}
   116  	require.NoError(t, f.GenerateCode(data))
   117  }
   118  
   119  func TestCodeGenerationFederation2(t *testing.T) {
   120  	f, cfg := load(t, "testdata/federation2/federation2.yml")
   121  	err := f.MutateConfig(cfg)
   122  
   123  	require.NoError(t, err)
   124  	require.Equal(t, "ExternalExtension", f.Entities[0].Name)
   125  	require.Len(t, f.Entities[0].Resolvers, 1)
   126  	require.Equal(t, "Hello", f.Entities[1].Name)
   127  	require.Empty(t, f.Entities[1].Resolvers)
   128  	require.Equal(t, "World", f.Entities[2].Name)
   129  	require.Empty(t, f.Entities[2].Resolvers)
   130  
   131  	data, err := codegen.BuildData(cfg)
   132  	if err != nil {
   133  		panic(err)
   134  	}
   135  	require.NoError(t, f.GenerateCode(data))
   136  }
   137  
   138  func TestInjectSourceLate(t *testing.T) {
   139  	_, cfg := load(t, "testdata/allthethings/gqlgen.yml")
   140  	entityGraphqlGenerated := false
   141  	for _, source := range cfg.Sources {
   142  		if source.Name != "federation/entity.graphql" {
   143  			continue
   144  		}
   145  		entityGraphqlGenerated = true
   146  		require.Contains(t, source.Input, "union _Entity")
   147  		require.Contains(t, source.Input, "type _Service {")
   148  		require.Contains(t, source.Input, "extend type Query {")
   149  		require.Contains(t, source.Input, "_entities(representations: [_Any!]!): [_Entity]!")
   150  		require.Contains(t, source.Input, "_service: _Service!")
   151  	}
   152  	require.True(t, entityGraphqlGenerated)
   153  
   154  	_, cfg = load(t, "testdata/entities/nokey.yml")
   155  	entityGraphqlGenerated = false
   156  	for _, source := range cfg.Sources {
   157  		if source.Name != "federation/entity.graphql" {
   158  			continue
   159  		}
   160  		entityGraphqlGenerated = true
   161  		require.NotContains(t, source.Input, "union _Entity")
   162  		require.Contains(t, source.Input, "type _Service {")
   163  		require.Contains(t, source.Input, "extend type Query {")
   164  		require.NotContains(t, source.Input, "_entities(representations: [_Any!]!): [_Entity]!")
   165  		require.Contains(t, source.Input, "_service: _Service!")
   166  	}
   167  	require.True(t, entityGraphqlGenerated)
   168  
   169  	_, cfg = load(t, "testdata/schema/customquerytype.yml")
   170  	for _, source := range cfg.Sources {
   171  		if source.Name != "federation/entity.graphql" {
   172  			continue
   173  		}
   174  		require.Contains(t, source.Input, "extend type CustomQuery {")
   175  	}
   176  }
   177  
   178  func load(t *testing.T, name string) (*federation, *config.Config) {
   179  	t.Helper()
   180  
   181  	cfg, err := config.LoadConfig(name)
   182  	require.NoError(t, err)
   183  
   184  	if cfg.Federation.Version == 0 {
   185  		cfg.Federation.Version = 1
   186  	}
   187  
   188  	f := &federation{Version: cfg.Federation.Version}
   189  	cfg.Sources = append(cfg.Sources, f.InjectSourceEarly())
   190  	require.NoError(t, cfg.LoadSchema())
   191  
   192  	if src := f.InjectSourceLate(cfg.Schema); src != nil {
   193  		cfg.Sources = append(cfg.Sources, src)
   194  	}
   195  	require.NoError(t, cfg.LoadSchema())
   196  
   197  	require.NoError(t, cfg.Init())
   198  	return f, cfg
   199  }