github.com/operandinc/gqlgen@v0.16.1/plugin/federation/federation_test.go (about)

     1  package federation
     2  
     3  import (
     4  	"testing"
     5  
     6  	"github.com/operandinc/gqlgen/codegen"
     7  	"github.com/operandinc/gqlgen/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 TestInjectSourceLate(t *testing.T) {
   120  	_, cfg := load(t, "testdata/allthethings/gqlgen.yml")
   121  	entityGraphqlGenerated := false
   122  	for _, source := range cfg.Sources {
   123  		if source.Name != "federation/entity.graphql" {
   124  			continue
   125  		}
   126  		entityGraphqlGenerated = true
   127  		require.Contains(t, source.Input, "union _Entity")
   128  		require.Contains(t, source.Input, "type _Service {")
   129  		require.Contains(t, source.Input, "extend type Query {")
   130  		require.Contains(t, source.Input, "_entities(representations: [_Any!]!): [_Entity]!")
   131  		require.Contains(t, source.Input, "_service: _Service!")
   132  	}
   133  	require.True(t, entityGraphqlGenerated)
   134  
   135  	_, cfg = load(t, "testdata/entities/nokey.yml")
   136  	entityGraphqlGenerated = false
   137  	for _, source := range cfg.Sources {
   138  		if source.Name != "federation/entity.graphql" {
   139  			continue
   140  		}
   141  		entityGraphqlGenerated = true
   142  		require.NotContains(t, source.Input, "union _Entity")
   143  		require.Contains(t, source.Input, "type _Service {")
   144  		require.Contains(t, source.Input, "extend type Query {")
   145  		require.NotContains(t, source.Input, "_entities(representations: [_Any!]!): [_Entity]!")
   146  		require.Contains(t, source.Input, "_service: _Service!")
   147  	}
   148  	require.True(t, entityGraphqlGenerated)
   149  
   150  	_, cfg = load(t, "testdata/schema/customquerytype.yml")
   151  	for _, source := range cfg.Sources {
   152  		if source.Name != "federation/entity.graphql" {
   153  			continue
   154  		}
   155  		require.Contains(t, source.Input, "extend type CustomQuery {")
   156  	}
   157  }
   158  
   159  func load(t *testing.T, name string) (*federation, *config.Config) {
   160  	t.Helper()
   161  
   162  	cfg, err := config.LoadConfig(name)
   163  	require.NoError(t, err)
   164  
   165  	f := &federation{}
   166  	cfg.Sources = append(cfg.Sources, f.InjectSourceEarly())
   167  	require.NoError(t, cfg.LoadSchema())
   168  
   169  	if src := f.InjectSourceLate(cfg.Schema); src != nil {
   170  		cfg.Sources = append(cfg.Sources, src)
   171  	}
   172  	require.NoError(t, cfg.LoadSchema())
   173  
   174  	require.NoError(t, cfg.Init())
   175  	return f, cfg
   176  }