merge main, fix conflicts

Author: aphralG

.github/workflows/codeql-analysis.yml

@@ -58,7 +58,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/init@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           languages: ${{ matrix.language }}
           build-mode: ${{ matrix.build-mode }}
@@ -70,6 +70,6 @@ jobs:
           # queries: security-extended,security-and-quality
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/analyze@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           category: "/language:${{matrix.language}}"

.github/workflows/f5-cla.yml

@@ -28,7 +28,7 @@ jobs:
     steps:
       - name: Run F5 Contributor License Agreement (CLA) assistant
         if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have hereby read the F5 CLA and agree to its terms') || github.event_name == 'pull_request_target'
-        uses: contributor-assistant/github-action@f41946747f85d28e9a738f4f38dbcc74b69c7e0e # v2.5.1
+        uses: contributor-assistant/github-action@b1522fa982419e79591a92e1267de463a281cdb7 # v2.6.0
         with:
           # Any pull request targeting the following branch will trigger a CLA check.
           branch: "main"

.github/workflows/scorecard.yml

@@ -57,6 +57,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/upload-sarif@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           sarif_file: results.sarif

.golangci.yml

@@ -34,6 +34,7 @@ linters:
     - asasalint
     - asciicheck
     - bidichk
+    - containedctx
     - contextcheck
     - copyloopvar
     - dupword

client/nginx.go

@@ -8,7 +8,6 @@ import (
 	"strings"
 	"sync"
 	"testing"
-	"time"
 )
 
 func TestDetermineUpdates(t *testing.T) {
@@ -581,27 +580,6 @@ func TestClientWithAPIVersion(t *testing.T) {
 	}
 }
 
-func TestClientWithTimeout(t *testing.T) {
-	t.Parallel()
-	// Test creating a new client with a supported API version on the client
-	client, err := NewNginxClient("http://api-url", WithTimeout(1*time.Second))
-	if err != nil {
-		t.Fatalf("unexpected error: %v", err)
-	}
-	if client == nil {
-		t.Fatalf("client is nil")
-	}
-
-	// Test creating a new client with an invalid duration
-	client, err = NewNginxClient("http://api-url", WithTimeout(-1*time.Second))
-	if err == nil {
-		t.Fatalf("expected error, but got nil")
-	}
-	if client != nil {
-		t.Fatalf("expected client to be nil, but got %v", client)
-	}
-}
-
 func TestClientWithHTTPClient(t *testing.T) {
 	t.Parallel()
 	// Test creating a new client passing a custom HTTP client
@@ -687,21 +665,6 @@ func TestClientWithMaxAPI(t *testing.T) {
 }
 
 func TestGetStats_NoStreamEndpoint(t *testing.T) {
-	tests := []struct {
-		ctx  context.Context
-		name string
-	}{
-		{
-			ctx:  nil,
-			name: "no context test",
-		},
-		{
-			ctx:  context.Background(),
-			name: "with context test",
-		},
-	}
-	var err error
-	var client *NginxClient
 	var writeLock sync.Mutex
 
 	t.Parallel()
@@ -712,19 +675,19 @@ func TestGetStats_NoStreamEndpoint(t *testing.T) {
 		switch {
 		case r.RequestURI == "/":
 
-			_, err = w.Write([]byte(`[4, 5, 6, 7, 8, 9]`))
+			_, err := w.Write([]byte(`[4, 5, 6, 7, 8, 9]`))
 			if err != nil {
 				t.Fatalf("unexpected error: %v", err)
 			}
 		case r.RequestURI == "/7/":
-			_, err = w.Write([]byte(`["nginx","processes","connections","slabs","http","resolvers","ssl"]`))
+			_, err := w.Write([]byte(`["nginx","processes","connections","slabs","http","resolvers","ssl"]`))
 			if err != nil {
 				t.Fatalf("unexpected error: %v", err)
 			}
 		case strings.HasPrefix(r.RequestURI, "/7/stream"):
 			t.Fatal("Stream endpoint should not be called since it does not exist.")
 		default:
-			_, err = w.Write([]byte(`{}`))
+			_, err := w.Write([]byte(`{}`))
 			if err != nil {
 				t.Fatalf("unexpected error: %v", err)
 			}
@@ -733,27 +696,17 @@ func TestGetStats_NoStreamEndpoint(t *testing.T) {
 	defer ts.Close()
 
 	// Test creating a new client with a supported API version on the server
-	client, err = NewNginxClient(ts.URL, WithAPIVersion(7), WithCheckAPI())
+	client, err := NewNginxClient(ts.URL, WithAPIVersion(7), WithCheckAPI())
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
 	if client == nil {
 		t.Fatalf("client is nil")
 	}
 
-	var stats *Stats
-	for _, test := range tests {
-		if test.ctx == nil {
-			stats, err = client.GetStats()
-			if err != nil {
-				t.Fatalf("unexpected error: %v", err)
-			}
-		} else {
-			stats, err = client.GetStatsWithContext(test.ctx)
-			if err != nil {
-				t.Fatalf("unexpected error: %v", err)
-			}
-		}
+	stats, err := client.GetStats(context.Background())
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
 	}
 
 	if !reflect.DeepEqual(stats.StreamServerZones, StreamServerZones{}) {
@@ -771,20 +724,6 @@ func TestGetStats_NoStreamEndpoint(t *testing.T) {
 }
 
 func TestGetStats_SSL(t *testing.T) {
-	tests := []struct {
-		ctx  context.Context
-		name string
-	}{
-		{
-			ctx:  nil,
-			name: "no context test",
-		},
-		{
-			ctx:  context.Background(),
-			name: "with context test",
-		},
-	}
-
 	t.Parallel()
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		switch {
@@ -841,41 +780,30 @@ func TestGetStats_SSL(t *testing.T) {
 		t.Fatalf("client is nil")
 	}
 
-	var stats *Stats
-
-	for _, test := range tests {
-		if test.ctx == nil {
-			stats, err = client.GetStats()
-			if err != nil {
-				t.Fatalf("unexpected error: %v", err)
-			}
-		} else {
-			stats, err = client.GetStatsWithContext(test.ctx)
-			if err != nil {
-				t.Fatalf("unexpected error: %v", err)
-			}
-		}
+	stats, err := client.GetStats(context.Background())
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
 
-		testStats := SSL{
-			Handshakes:       79572,
-			HandshakesFailed: 21025,
-			SessionReuses:    15762,
-			NoCommonProtocol: 4,
-			NoCommonCipher:   2,
-			HandshakeTimeout: 0,
-			PeerRejectedCert: 0,
-			VerifyFailures: VerifyFailures{
-				NoCert:           0,
-				ExpiredCert:      2,
-				RevokedCert:      1,
-				HostnameMismatch: 2,
-				Other:            1,
-			},
-		}
+	testStats := SSL{
+		Handshakes:       79572,
+		HandshakesFailed: 21025,
+		SessionReuses:    15762,
+		NoCommonProtocol: 4,
+		NoCommonCipher:   2,
+		HandshakeTimeout: 0,
+		PeerRejectedCert: 0,
+		VerifyFailures: VerifyFailures{
+			NoCert:           0,
+			ExpiredCert:      2,
+			RevokedCert:      1,
+			HostnameMismatch: 2,
+			Other:            1,
+		},
+	}
 
-		if !reflect.DeepEqual(stats.SSL, testStats) {
-			t.Fatalf("SSL stats: expected %v, actual %v", testStats, stats.SSL)
-		}
+	if !reflect.DeepEqual(stats.SSL, testStats) {
+		t.Fatalf("SSL stats: expected %v, actual %v", testStats, stats.SSL)
 	}
 }
 
@@ -902,7 +830,7 @@ func TestGetMaxAPIVersionServer(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
-	maxVer, err := c.GetMaxAPIVersion()
+	maxVer, err := c.GetMaxAPIVersion(context.Background())
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}
@@ -934,7 +862,7 @@ func TestGetMaxAPIVersionClient(t *testing.T) {
 		t.Fatalf("unexpected error: %v", err)
 	}
 
-	maxVer, err := c.GetMaxAPIVersion()
+	maxVer, err := c.GetMaxAPIVersion(context.Background())
 	if err != nil {
 		t.Fatalf("unexpected error: %v", err)
 	}

client/nginx_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"context"
 	"testing"
 
 	"github.com/nginxinc/nginx-plus-go-client/client"
@@ -16,8 +17,8 @@ func TestStatsNoStream(t *testing.T) {
 	if err != nil {
 		t.Fatalf("Error connecting to nginx: %v", err)
 	}
-
-	stats, err := c.GetStats()
+	ctx := context.Background()
+	stats, err := c.GetStats(ctx)
 	if err != nil {
 		t.Errorf("Error getting stats: %v", err)
 	}