updates based on reviews

nginxinc · Jul 10, 2024 · afdc237 · afdc237
1 parent 2a4a408
commit afdc237
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 20 deletions.
diff --git a/apis/v1alpha1/nginxproxy_types.go b/apis/v1alpha1/nginxproxy_types.go
@@ -44,7 +44,7 @@ const (
 
 // NginxProxySpec defines the desired state of the NginxProxy.
 type NginxProxySpec struct {
-	// IPFamily specifies the IP family to be used by the server.
+	// IPFamily specifies the IP family to be used by the NGINX.
 	// Default is "dual", meaning the server will use both IPv4 and IPv6.
 	//
 	// +optional

diff --git a/config/crd/bases/gateway.nginx.org_nginxproxies.yaml b/config/crd/bases/gateway.nginx.org_nginxproxies.yaml
@@ -54,7 +54,7 @@ spec:
                 type: boolean
               ipFamily:
                 description: |-
-                  IPFamily specifies the IP family to be used by the server.
+                  IPFamily specifies the IP family to be used by the NGINX.
                   Default is "dual", meaning the server will use both IPv4 and IPv6.
                 enum:
                 - dual

diff --git a/deploy/crds.yaml b/deploy/crds.yaml
@@ -699,7 +699,7 @@ spec:
                 type: boolean
               ipFamily:
                 description: |-
-                  IPFamily specifies the IP family to be used by the server.
+                  IPFamily specifies the IP family to be used by the NGINX.
                   Default is "dual", meaning the server will use both IPv4 and IPv6.
                 enum:
                 - dual

diff --git a/internal/mode/static/nginx/config/http/config.go b/internal/mode/static/nginx/config/http/config.go
@@ -12,7 +12,7 @@ type Server struct {
 	GRPC          bool
 }
 
-// IPFamily holds the IP family configuration for all servers.
+// IPFamily holds the IP family configuration to be used by NGINX.
 type IPFamily struct {
 	IPv4 bool
 	IPv6 bool
@@ -112,3 +112,9 @@ type ProxySSLVerify struct {
 	TrustedCertificate string
 	Name               string
 }
+
+// ServerConfig holds configuration for an HTTP server and IP family to be used by NGINX.
+type ServerConfig struct {
+	Servers  []Server
+	IPFamily IPFamily
+}
diff --git a/internal/mode/static/nginx/config/servers.go b/internal/mode/static/nginx/config/servers.go
@@ -57,16 +57,11 @@ var grpcBaseHeaders = []http.Header{
 	},
 }
 
-type serverConfig struct {
-	Servers  []http.Server
-	IPFamily http.IPFamily
-}
-
 func executeServers(conf dataplane.Configuration) []executeResult {
 	ipFamily := getIPFamily(conf.BaseHTTPConfig)
 	servers, httpMatchPairs := createServers(conf.HTTPServers, conf.SSLServers)
 
-	serverConfig := serverConfig{
+	serverConfig := http.ServerConfig{
 		Servers:  servers,
 		IPFamily: ipFamily,
 	}

diff --git a/internal/mode/static/nginx/config/servers_template.go b/internal/mode/static/nginx/config/servers_template.go
@@ -29,25 +29,25 @@ server {
     {{- else }}
 server {
         {{- if $s.SSL }}
-        {{- if $.IPFamily.IPv4 }}
+          {{- if $.IPFamily.IPv4 }}
     listen {{ $s.Port }} ssl;
-        {{- end }}
-        {{- if $.IPFamily.IPv6 }}
+          {{- end }}
+          {{- if $.IPFamily.IPv6 }}
     listen [::]:{{ $s.Port }} ssl;
-        {{- end }}
+          {{- end }}
     ssl_certificate {{ $s.SSL.Certificate }};
     ssl_certificate_key {{ $s.SSL.CertificateKey }};
 
     if ($ssl_server_name != $host) {
         return 421;
     }
         {{- else }}
-        {{- if $.IPFamily.IPv4 }}
+          {{- if $.IPFamily.IPv4 }}
     listen {{ $s.Port }};
-        {{- end }}
-        {{- if $.IPFamily.IPv6 }}
+          {{- end }}
+          {{- if $.IPFamily.IPv6 }}
     listen [::]:{{ $s.Port }};
-        {{- end }}
+          {{- end }}
         {{- end }}
 
     server_name {{ $s.ServerName }};

diff --git a/internal/mode/static/nginx/config/servers_test.go b/internal/mode/static/nginx/config/servers_test.go
@@ -2581,3 +2581,36 @@ func TestAdditionFilename(t *testing.T) {
 	name := createAdditionFileName(dataplane.Addition{Identifier: "my-addition"})
 	g.Expect(name).To(Equal(includesFolder + "/" + "my-addition.conf"))
 }
+
+func TestGetIPFamily(t *testing.T) {
+	test := []struct {
+		msg            string
+		baseHTTPConfig dataplane.BaseHTTPConfig
+		expected       http.IPFamily
+	}{
+		{
+			msg:            "ipv4",
+			baseHTTPConfig: dataplane.BaseHTTPConfig{IPFamily: dataplane.IPv4},
+			expected:       http.IPFamily{IPv4: true, IPv6: false},
+		},
+		{
+			msg:            "ipv6",
+			baseHTTPConfig: dataplane.BaseHTTPConfig{IPFamily: dataplane.IPv6},
+			expected:       http.IPFamily{IPv4: false, IPv6: true},
+		},
+		{
+			msg:            "dual",
+			baseHTTPConfig: dataplane.BaseHTTPConfig{IPFamily: dataplane.Dual},
+			expected:       http.IPFamily{IPv4: true, IPv6: true},
+		},
+	}
+
+	for _, tc := range test {
+		t.Run(tc.msg, func(t *testing.T) {
+			g := NewWithT(t)
+
+			result := getIPFamily(tc.baseHTTPConfig)
+			g.Expect(result).To(Equal(tc.expected))
+		})
+	}
+}
diff --git a/site/content/reference/api.md b/site/content/reference/api.md
@@ -308,7 +308,7 @@ IPFamilyType
 </td>
 <td>
 <em>(Optional)</em>
-<p>IPFamily specifies the IP family to be used by the server.
+<p>IPFamily specifies the IP family to be used by the NGINX.
 Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
 </td>
 </tr>
@@ -930,7 +930,7 @@ IPFamilyType
 </td>
 <td>
 <em>(Optional)</em>
-<p>IPFamily specifies the IP family to be used by the server.
+<p>IPFamily specifies the IP family to be used by the NGINX.
 Default is &ldquo;dual&rdquo;, meaning the server will use both IPv4 and IPv6.</p>
 </td>
 </tr>