✨ Support custom CII_Best_Practices_URL via environment variable. (#4882)

kash2104 · web-flow · commit 66c42b6118a2 · 2025-12-17T10:26:01.000-07:00
* Support custom CII_Best_Practices custom URL via environment variables.

Signed-off-by: kash2104 &lt;kparikh1104@gmail.com&gt;

* Add tests for CII_Best_Practices custom URL.

Signed-off-by: kash2104 &lt;kparikh1104@gmail.com&gt;

---------

Signed-off-by: kash2104 &lt;kparikh1104@gmail.com&gt;
diff --git a/checks/cii_best_practices_test.go b/checks/cii_best_practices_test.go
@@ -17,6 +17,9 @@ package checks
 import (
 	"context"
 	"errors"
+	"fmt"
+	"net/http"
+	"net/http/httptest"
 	"testing"
 
 	"go.uber.org/mock/gomock"
@@ -126,3 +129,61 @@ func TestCIIBestPractices(t *testing.T) {
 		})
 	}
 }
+
+func TestCIIBestPractices_CustomURL_AllBadges(t *testing.T) {
+	tests := []struct {
+		name      string
+		badgeJSON string
+		expected  clients.BadgeLevel
+	}{
+		{
+			"NotFoundBadge",
+			`[]`,
+			clients.NotFound,
+		},
+		{
+			"InProgressBadge", `[{"badge_level":"in_progress"}]`,
+			clients.InProgress,
+		},
+		{
+			"PassingBadge", `[{"badge_level":"passing"}]`,
+			clients.Passing,
+		},
+		{
+			"SilverBadge", `[{"badge_level":"silver"}]`,
+			clients.Silver,
+		},
+		{
+			"GoldBadge", `[{"badge_level":"gold"}]`,
+			clients.Gold,
+		},
+		{
+			"UnknownBadge", `[{"badge_level":"foo"}]`,
+			clients.Unknown,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				if r.URL.Path != "/projects.json" {
+					t.Errorf("Expected request path '/projects.json', got: %s", r.URL.Path)
+				}
+				fmt.Fprint(w, tt.badgeJSON)
+			}))
+			defer server.Close()
+
+			t.Setenv("CII_BEST_PRACTICES_URL", server.URL)
+
+			client := clients.DefaultCIIBestPracticesClient()
+			badge, err := client.GetBadgeLevel(t.Context(), "github.com/owner/repo")
+			if err != nil && tt.expected != clients.Unknown {
+				t.Fatalf("GetBadgeLevel() returned unexpected error: %v", err)
+			}
+
+			if badge != tt.expected {
+				t.Errorf("GetBadgeLevel() = %v, want %v", badge, tt.expected)
+			}
+		})
+	}
+}
diff --git a/clients/cii_client.go b/clients/cii_client.go
@@ -16,6 +16,7 @@ package clients
 
 import (
 	"context"
+	"os"
 )
 
 const (
@@ -31,6 +32,10 @@ const (
 	Silver
 	// Gold level for CII Best Practices badge.
 	Gold
+	// CII Best Practices default URL.
+	defaultCIIBestPracticesURL = "https://www.bestpractices.dev"
+	// CII Best Practices URL environment variable.
+	envVarCIIBestPracticesURL = "CII_BEST_PRACTICES_URL"
 )
 
 // BadgeLevel corresponds to CII-Best-Practices badge levels.
@@ -64,7 +69,13 @@ type CIIBestPracticesClient interface {
 
 // DefaultCIIBestPracticesClient returns http-based implementation of the interface.
 func DefaultCIIBestPracticesClient() CIIBestPracticesClient {
-	return &httpClientCIIBestPractices{}
+	baseURL := os.Getenv(envVarCIIBestPracticesURL)
+	if baseURL == "" {
+		baseURL = defaultCIIBestPracticesURL
+	}
+	return &httpClientCIIBestPractices{
+		baseURL: baseURL,
+	}
 }
 
 // BlobCIIBestPracticesClient returns a blob-based implementation of the interface.
diff --git a/clients/cii_http_client.go b/clients/cii_http_client.go
@@ -28,7 +28,9 @@ var errTooManyRequests = errors.New("failed after exponential backoff")
 
 // httpClientCIIBestPractices implements the CIIBestPracticesClient interface.
 // A HTTP client with exponential backoff is used to communicate with the CII Best Practices servers.
-type httpClientCIIBestPractices struct{}
+type httpClientCIIBestPractices struct {
+	baseURL string
+}
 
 type expBackoffTransport struct {
 	numRetries uint8
@@ -49,7 +51,7 @@ func (transport *expBackoffTransport) RoundTrip(req *http.Request) (*http.Respon
 // GetBadgeLevel implements CIIBestPracticesClient.GetBadgeLevel.
 func (client *httpClientCIIBestPractices) GetBadgeLevel(ctx context.Context, uri string) (BadgeLevel, error) {
 	repoURI := fmt.Sprintf("https://%s", uri)
-	url := fmt.Sprintf("https://www.bestpractices.dev/projects.json?url=%s", repoURI)
+	url := fmt.Sprintf("%s/projects.json?url=%s", client.baseURL, repoURI)
 	req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
 	if err != nil {
 		return Unknown, fmt.Errorf("error during http.NewRequestWithContext: %w", err)
