Move config version to dataplane.Configuration type

Author: ciarams87

internal/mode/static/handler.go

@@ -100,14 +100,14 @@ func (h *eventHandlerImpl) HandleEventBatch(ctx context.Context, batch events.Ev
 	h.cfg.statusUpdater.Update(ctx, buildStatuses(graph, nginxReloadRes))
 }
 
-func (h *eventHandlerImpl) updateNginx(ctx context.Context, conf dataplane.Configuration) error {
-	files, configVersion := h.cfg.generator.Generate(conf)
+func (h *eventHandlerImpl) updateNginx(ctx context.Context, conf *dataplane.Configuration) error {
+	files := h.cfg.generator.Generate(conf)
 
 	if err := h.cfg.nginxFileMgr.ReplaceFiles(files); err != nil {
 		return fmt.Errorf("failed to replace NGINX configuration files: %w", err)
 	}
 
-	if err := h.cfg.nginxRuntimeMgr.Reload(ctx, configVersion); err != nil {
+	if err := h.cfg.nginxRuntimeMgr.Reload(ctx, conf.Version); err != nil {
 		return fmt.Errorf("failed to reload NGINX: %w", err)
 	}
 

internal/mode/static/handler_test.go

@@ -45,7 +45,7 @@ var _ = Describe("eventHandler", func() {
 		Expect(fakeProcessor.ProcessCallCount()).Should(Equal(1))
 
 		Expect(fakeGenerator.GenerateCallCount()).Should(Equal(1))
-		Expect(fakeGenerator.GenerateArgsForCall(0)).Should(Equal(expectedConf))
+		Expect(fakeGenerator.GenerateArgsForCall(0)).Should(Equal(&expectedConf))
 
 		Expect(fakeNginxFileMgr.ReplaceFilesCallCount()).Should(Equal(1))
 		files := fakeNginxFileMgr.ReplaceFilesArgsForCall(0)
@@ -100,7 +100,7 @@ var _ = Describe("eventHandler", func() {
 		BeforeEach(func() {
 			fakeProcessor.ProcessReturns(true /* changed */, &graph.Graph{})
 
-			fakeGenerator.GenerateReturns(fakeCfgFiles, 1)
+			fakeGenerator.GenerateReturns(fakeCfgFiles)
 		})
 
 		When("a batch has one event", func() {

internal/mode/static/nginx/config/configfakes/fake_generator.go

@@ -32,7 +32,7 @@ var ConfigFolders = []string{httpFolder, secretsFolder}
 // This interface is used for testing purposes only.
 type Generator interface {
 	// Generate generates NGINX configuration files from internal representation.
-	Generate(configuration dataplane.Configuration) ([]file.File, int)
+	Generate(configuration *dataplane.Configuration) []file.File
 }
 
 // GeneratorImpl is an implementation of Generator.
@@ -61,19 +61,20 @@ type executeFunc func(configuration dataplane.Configuration) []byte
 // It is the responsibility of the caller to validate the configuration before calling this function.
 // In case of invalid configuration, NGINX will fail to reload or could be configured with malicious configuration.
 // To validate, use the validators from the validation package.
-func (g *GeneratorImpl) Generate(conf dataplane.Configuration) ([]file.File, int) {
+func (g *GeneratorImpl) Generate(conf *dataplane.Configuration) []file.File {
 	g.configVersion++
+	conf.Version = g.configVersion
 	files := make([]file.File, 0, len(conf.SSLKeyPairs)+1 /* http config */)
 
 	for id, pair := range conf.SSLKeyPairs {
 		files = append(files, generatePEM(id, pair.Cert, pair.Key))
 	}
 
-	files = append(files, generateHTTPConfig(conf))
+	files = append(files, generateHTTPConfig(*conf))
 
 	files = append(files, generateConfigVersion(g.configVersion))
 
-	return files, g.configVersion
+	return files
 }
 
 func generatePEM(id dataplane.SSLKeyPairID, cert []byte, key []byte) file.File {

internal/mode/static/nginx/config/generator.go

@@ -64,7 +64,7 @@ func TestGenerate(t *testing.T) {
 
 	generator := config.NewGeneratorImpl()
 
-	files, version := generator.Generate(conf)
+	files := generator.Generate(&conf)
 
 	g.Expect(files).To(HaveLen(3))
 
@@ -87,5 +87,5 @@ func TestGenerate(t *testing.T) {
 	g.Expect(files[2].Type).To(Equal(file.TypeRegular))
 	g.Expect(files[2].Path).To(Equal("/etc/nginx/conf.d/config-version.conf"))
 	configVersion := string(files[2].Content)
-	g.Expect(configVersion).To(ContainSubstring(fmt.Sprintf("return 200 %d", version)))
+	g.Expect(configVersion).To(ContainSubstring(fmt.Sprintf("return 200 %d", conf.Version)))
 }

internal/mode/static/nginx/config/generator_test.go

@@ -79,9 +79,9 @@ func TestExecuteServers(t *testing.T) {
 func TestExecuteForDefaultServers(t *testing.T) {
 	testcases := []struct {
 		msg       string
-		conf      dataplane.Configuration
 		httpPorts []int
 		sslPorts  []int
+		conf      dataplane.Configuration
 	}{
 		{
 			conf: dataplane.Configuration{},

internal/mode/static/nginx/config/servers_test.go

@@ -16,13 +16,13 @@ import (
 const wildcardHostname = "~^"
 
 // BuildConfiguration builds the Configuration from the Graph.
-func BuildConfiguration(ctx context.Context, g *graph.Graph, resolver resolver.ServiceResolver) Configuration {
+func BuildConfiguration(ctx context.Context, g *graph.Graph, resolver resolver.ServiceResolver) *Configuration {
 	if g.GatewayClass == nil || !g.GatewayClass.Valid {
-		return Configuration{}
+		return &Configuration{}
 	}
 
 	if g.Gateway == nil {
-		return Configuration{}
+		return &Configuration{}
 	}
 
 	upstreams := buildUpstreams(ctx, g.Gateway.Listeners, resolver)
@@ -38,7 +38,7 @@ func BuildConfiguration(ctx context.Context, g *graph.Graph, resolver resolver.S
 		SSLKeyPairs:   keyPairs,
 	}
 
-	return config
+	return &config
 }
 
 // buildSSLKeyPairs builds the SSLKeyPairs from the Secrets. It will only include Secrets that are referenced by

internal/mode/static/state/dataplane/configuration.go

@@ -31,6 +31,8 @@ type Configuration struct {
 	Upstreams []Upstream
 	// BackendGroups holds all unique BackendGroups.
 	BackendGroups []BackendGroup
+	// Version represents the version of the generated configuration.
+	Version int
 }
 
 // SSLKeyPairID is a unique identifier for a SSLKeyPair.