move template AccessLog to separate structure

Author: tataruty

internal/controller/nginx/config/base_http_config.go

@@ -10,9 +10,15 @@ import (
 
 var baseHTTPTemplate = gotemplate.Must(gotemplate.New("baseHttp").Parse(baseHTTPTemplateText))
 
+type AccessLog struct {
+	Format     string // User's format string
+	Path       string // Where to write logs (/dev/stdout)
+	FormatName string // Internal format name (ngf_user_defined_log_format)
+	Disabled   bool   // User's disabled flag
+}
 type httpConfig struct {
 	DNSResolver             *dataplane.DNSResolverConfig
-	AccessLog               *dataplane.AccessLog
+	AccessLog               *AccessLog
 	DefaultAccessLogPath    string
 	DefaultLogFormatName    string
 	Includes                []shared.Include
@@ -30,9 +36,7 @@ func executeBaseHTTPConfig(conf dataplane.Configuration) []executeResult {
 		NginxReadinessProbePort: conf.BaseHTTPConfig.NginxReadinessProbePort,
 		IPFamily:                getIPFamily(conf.BaseHTTPConfig),
 		DNSResolver:             conf.BaseHTTPConfig.DNSResolver,
-		AccessLog:               conf.Logging.AccessLog,
-		DefaultAccessLogPath:    dataplane.DefaultAccessLogPath,
-		DefaultLogFormatName:    dataplane.DefaultLogFormatName,
+		AccessLog:               buildAccessLog(conf.Logging.AccessLog),
 	}
 
 	results := make([]executeResult, 0, len(includes)+1)
@@ -44,3 +48,22 @@ func executeBaseHTTPConfig(conf dataplane.Configuration) []executeResult {
 
 	return results
 }
+
+func buildAccessLog(accessLogConfig *dataplane.AccessLog) *AccessLog {
+	if accessLogConfig != nil {
+		accessLog := &AccessLog{
+			Path:       dataplane.DefaultAccessLogPath,
+			FormatName: dataplane.DefaultLogFormatName,
+		}
+		if accessLogConfig.Format != "" {
+			accessLog.Format = accessLogConfig.Format
+		}
+
+		if accessLogConfig.Disabled {
+			accessLog.Disabled = accessLogConfig.Disabled
+		}
+
+		return accessLog
+	}
+	return nil
+}

internal/controller/nginx/config/base_http_config_template.go

@@ -52,14 +52,14 @@ server {
 {{- /* Access log directives for AccessLog. If path is "off" we disable logging. */ -}}
 {{- /* We use a fixed name for user-defined log format to avoid complexity of passing the name around. */ -}}
 {{- if .AccessLog }}
-  {{- if .AccessLog.Disabled }}
+{{- if .AccessLog.Disabled }}
 access_log off;
-  {{- else }}
-  {{- if .AccessLog.Format }}
-log_format {{ .DefaultLogFormatName }} '{{ .AccessLog.Format }}';
-access_log {{ .DefaultAccessLogPath }} {{ .DefaultLogFormatName }};
-  {{- end }}
-  {{- end }}
+{{- else }}
+{{- if .AccessLog.Format }}
+log_format {{ .AccessLog.FormatName }} '{{ .AccessLog.Format }}';
+access_log {{ .AccessLog.Path }} {{ .AccessLog.FormatName }};
+{{- end }}
+{{- end }}
 {{- end }}
 
 {{ range $i := .Includes -}}

internal/controller/nginx/config/base_http_config_test.go

@@ -23,7 +23,7 @@ func TestLoggingSettingsTemplate(t *testing.T) {
 		unexpectedOutputs []string
 	}{
 		{
-			name:      "Log format and access log with custom path and custom format name",
+			name:      "Log format and access log with custom format",
 			accessLog: &dataplane.AccessLog{Format: logFormat},
 			expectedOutputs: []string{
 				fmt.Sprintf("log_format %s '%s'", dataplane.DefaultLogFormatName, logFormat),

internal/controller/provisioner/objects.go

@@ -406,18 +406,11 @@ func (p *NginxProvisioner) buildNginxConfigMaps(
 		workerConnections = *nProxyCfg.WorkerConnections
 	}
 
-	// Add LogFormats and AccessLogs to mainFields
-	accessLog := addAccessLogsToNginxConfig(logging)
-
 	mainFields := map[string]interface{}{
 		"ErrorLevel":        logLevel,
 		"WorkerConnections": workerConnections,
 	}
 
-	if accessLog != nil {
-		mainFields["AccessLog"] = accessLog
-	}
-
 	// Create events ConfigMap data using template
 	eventsFields := map[string]interface{}{
 		"WorkerConnections": workerConnections,
@@ -1443,19 +1436,3 @@ func DetermineNginxImageName(
 
 	return fmt.Sprintf("%s:%s", image, tag), pullPolicy
 }
-
-func addAccessLogsToNginxConfig(logging *ngfAPIv1alpha2.NginxLogging) *ngfAPIv1alpha2.NginxAccessLog {
-	accessLog := &ngfAPIv1alpha2.NginxAccessLog{}
-	if logging == nil {
-		return accessLog
-	}
-
-	if logging.AccessLog != nil {
-		accessLog = &ngfAPIv1alpha2.NginxAccessLog{
-			Disabled: logging.AccessLog.Disabled,
-			Format:   logging.AccessLog.Format,
-		}
-	}
-
-	return accessLog
-}