Merge branch 'release-1.13' into automated-cherry-pick-of-#1593-upstream-release-1.13

Author: pwschuurman

cmd/gce-pd-csi-driver/main.go

@@ -17,11 +17,8 @@ package main
 
 import (
 	"context"
-	"errors"
 	"flag"
-	"fmt"
 	"math/rand"
-	"net/url"
 	"os"
 	"runtime"
 	"strings"
@@ -41,6 +38,7 @@ import (
 var (
 	cloudConfigFilePath  = flag.String("cloud-config", "", "Path to GCE cloud provider config")
 	endpoint             = flag.String("endpoint", "unix:/tmp/csi.sock", "CSI endpoint")
+	computeEndpoint      = flag.String("compute-endpoint", "", "If set, used as the endpoint for the GCE API.")
 	runControllerService = flag.Bool("run-controller-service", true, "If set to false then the CSI driver does not activate its controller service (default: true)")
 	runNodeService       = flag.Bool("run-node-service", true, "If set to false then the CSI driver does not activate its node service (default: true)")
 	httpEndpoint         = flag.String("http-endpoint", "", "The TCP network address where the prometheus metrics endpoint will listen (example: `:8080`). The default is empty string, which means metrics endpoint is disabled.")
@@ -75,10 +73,6 @@ var (
 	multiZoneVolumeHandleDiskTypesFlag = flag.String("multi-zone-volume-handle-disk-types", "", "Comma separated list of allowed disk types that can use the multi-zone volumeHandle. Used only if --multi-zone-volume-handle-enable")
 	multiZoneVolumeHandleEnableFlag    = flag.Bool("multi-zone-volume-handle-enable", false, "If set to true, the multi-zone volumeHandle feature will be enabled")
 
-	computeEnvironment        gce.Environment = gce.EnvironmentProduction
-	computeEndpoint           *url.URL
-	allowedComputeEnvironment = []gce.Environment{gce.EnvironmentStaging, gce.EnvironmentProduction}
-
 	version string
 )
 
@@ -92,16 +86,13 @@ func init() {
 	// Use V(4) for general debug information logging
 	// Use V(5) for GCE Cloud Provider Call informational logging
 	// Use V(6) for extra repeated/polling information
-	enumFlag(&computeEnvironment, "compute-environment", allowedComputeEnvironment, "Operating compute environment")
-	urlFlag(&computeEndpoint, "compute-endpoint", "Compute endpoint")
 	klog.InitFlags(flag.CommandLine)
 	flag.Set("logtostderr", "true")
 }
 
 func main() {
 	flag.Parse()
 	rand.Seed(time.Now().UnixNano())
-	klog.Infof("Operating compute environment set to: %s and computeEndpoint is set to: %v", computeEnvironment, computeEndpoint)
 	handle()
 	os.Exit(0)
 }
@@ -173,7 +164,7 @@ func handle() {
 	// Initialize requirements for the controller service
 	var controllerServer *driver.GCEControllerServer
 	if *runControllerService {
-		cloudProvider, err := gce.CreateCloudProvider(ctx, version, *cloudConfigFilePath, computeEndpoint, computeEnvironment)
+		cloudProvider, err := gce.CreateCloudProvider(ctx, version, *cloudConfigFilePath, *computeEndpoint)
 		if err != nil {
 			klog.Fatalf("Failed to get cloud provider: %v", err.Error())
 		}
@@ -222,29 +213,3 @@ func handle() {
 
 	gceDriver.Run(*endpoint, *grpcLogCharCap, *enableOtelTracing)
 }
-
-func enumFlag(target *gce.Environment, name string, allowedComputeEnvironment []gce.Environment, usage string) {
-	flag.Func(name, usage, func(flagValue string) error {
-		for _, allowedValue := range allowedComputeEnvironment {
-			if gce.Environment(flagValue) == allowedValue {
-				*target = gce.Environment(flagValue)
-				return nil
-			}
-		}
-		errMsg := fmt.Sprintf(`must be one of %v`, allowedComputeEnvironment)
-		return errors.New(errMsg)
-	})
-
-}
-
-func urlFlag(target **url.URL, name string, usage string) {
-	flag.Func(name, usage, func(flagValue string) error {
-		computeURL, err := url.ParseRequestURI(flagValue)
-		if err == nil {
-			*target = computeURL
-			return nil
-		}
-		klog.Infof("Error parsing endpoint compute endpoint %v", err)
-		return err
-	})
-}

pkg/gce-cloud-provider/compute/gce.go

@@ -19,7 +19,6 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
-	"net/url"
 	"os"
 	"runtime"
 	"time"
@@ -38,9 +37,6 @@ import (
 	"k8s.io/klog/v2"
 )
 
-type Environment string
-type Version string
-
 const (
 	TokenURL                        = "https://accounts.google.com/o/oauth2/token"
 	diskSourceURITemplateSingleZone = "projects/%s/zones/%s/disks/%s"       // {gce.projectID}/zones/{disk.Zone}/disks/{disk.Name}"
@@ -50,12 +46,7 @@ const (
 
 	regionURITemplate = "projects/%s/regions/%s"
 
-	replicaZoneURITemplateSingleZone             = "projects/%s/zones/%s" // {gce.projectID}/zones/{disk.Zone}
-	versionV1                        Version     = "v1"
-	versionBeta                      Version     = "beta"
-	versionAlpha                     Version     = "alpha"
-	EnvironmentStaging               Environment = "staging"
-	EnvironmentProduction            Environment = "production"
+	replicaZoneURITemplateSingleZone = "projects/%s/zones/%s" // {gce.projectID}/zones/{disk.Zone}
 )
 
 type CloudProvider struct {
@@ -81,7 +72,7 @@ type ConfigGlobal struct {
 	Zone      string `gcfg:"zone"`
 }
 
-func CreateCloudProvider(ctx context.Context, vendorVersion string, configPath string, computeEndpoint *url.URL, computeEnvironment Environment) (*CloudProvider, error) {
+func CreateCloudProvider(ctx context.Context, vendorVersion string, configPath string, computeEndpoint string) (*CloudProvider, error) {
 	configFile, err := readConfig(configPath)
 	if err != nil {
 		return nil, err
@@ -96,23 +87,20 @@ func CreateCloudProvider(ctx context.Context, vendorVersion string, configPath s
 		return nil, err
 	}
 
-	svc, err := createCloudService(ctx, vendorVersion, tokenSource, computeEndpoint, computeEnvironment)
+	svc, err := createCloudService(ctx, vendorVersion, tokenSource, computeEndpoint)
 	if err != nil {
 		return nil, err
 	}
-	klog.Infof("Compute endpoint for V1 version: %s", svc.BasePath)
 
-	betasvc, err := createBetaCloudService(ctx, vendorVersion, tokenSource, computeEndpoint, computeEnvironment)
+	betasvc, err := createBetaCloudService(ctx, vendorVersion, tokenSource, computeEndpoint)
 	if err != nil {
 		return nil, err
 	}
-	klog.Infof("Compute endpoint for Beta version: %s", betasvc.BasePath)
 
-	alphasvc, err := createAlphaCloudService(ctx, vendorVersion, tokenSource, computeEndpoint, computeEnvironment)
+	alphasvc, err := createAlphaCloudService(ctx, vendorVersion, tokenSource, computeEndpoint)
 	if err != nil {
 		return nil, err
 	}
-	klog.Infof("Compute endpoint for Alpha version: %s", alphasvc.BasePath)
 
 	project, zone, err := getProjectAndZone(configFile)
 	if err != nil {
@@ -176,23 +164,16 @@ func readConfig(configPath string) (*ConfigFile, error) {
 	return cfg, nil
 }
 
-func createAlphaCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint *url.URL, computeEnvironment Environment) (*computealpha.Service, error) {
-	computeOpts, err := getComputeVersion(ctx, tokenSource, computeEndpoint, computeEnvironment, versionAlpha)
-	if err != nil {
-		klog.Errorf("Failed to get compute endpoint: %s", err)
-	}
-	service, err := computealpha.NewService(ctx, computeOpts...)
+func createBetaCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint string) (*computebeta.Service, error) {
+	client, err := newOauthClient(ctx, tokenSource)
 	if err != nil {
 		return nil, err
 	}
-	service.UserAgent = fmt.Sprintf("GCE CSI Driver/%s (%s %s)", vendorVersion, runtime.GOOS, runtime.GOARCH)
-	return service, nil
-}
 
-func createBetaCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint *url.URL, computeEnvironment Environment) (*computebeta.Service, error) {
-	computeOpts, err := getComputeVersion(ctx, tokenSource, computeEndpoint, computeEnvironment, versionBeta)
-	if err != nil {
-		klog.Errorf("Failed to get compute endpoint: %s", err)
+	computeOpts := []option.ClientOption{option.WithHTTPClient(client)}
+	if computeEndpoint != "" {
+		betaEndpoint := fmt.Sprintf("%s/compute/beta/", computeEndpoint)
+		computeOpts = append(computeOpts, option.WithEndpoint(betaEndpoint))
 	}
 	service, err := computebeta.NewService(ctx, computeOpts...)
 	if err != nil {
@@ -202,41 +183,47 @@ func createBetaCloudService(ctx context.Context, vendorVersion string, tokenSour
 	return service, nil
 }
 
-func createCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint *url.URL, computeEnvironment Environment) (*compute.Service, error) {
-	computeOpts, err := getComputeVersion(ctx, tokenSource, computeEndpoint, computeEnvironment, versionV1)
+func createAlphaCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint string) (*computealpha.Service, error) {
+	client, err := newOauthClient(ctx, tokenSource)
 	if err != nil {
-		klog.Errorf("Failed to get compute endpoint: %s", err)
+		return nil, err
 	}
-	service, err := compute.NewService(ctx, computeOpts...)
+
+	computeOpts := []option.ClientOption{option.WithHTTPClient(client)}
+	if computeEndpoint != "" {
+		alphaEndpoint := fmt.Sprintf("%s/compute/alpha/", computeEndpoint)
+		computeOpts = append(computeOpts, option.WithEndpoint(alphaEndpoint))
+	}
+	service, err := computealpha.NewService(ctx, computeOpts...)
 	if err != nil {
 		return nil, err
 	}
 	service.UserAgent = fmt.Sprintf("GCE CSI Driver/%s (%s %s)", vendorVersion, runtime.GOOS, runtime.GOARCH)
 	return service, nil
 }
 
-func getComputeVersion(ctx context.Context, tokenSource oauth2.TokenSource, computeEndpoint *url.URL, computeEnvironment Environment, computeVersion Version) ([]option.ClientOption, error) {
+func createCloudService(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint string) (*compute.Service, error) {
+	svc, err := createCloudServiceWithDefaultServiceAccount(ctx, vendorVersion, tokenSource, computeEndpoint)
+	return svc, err
+}
+
+func createCloudServiceWithDefaultServiceAccount(ctx context.Context, vendorVersion string, tokenSource oauth2.TokenSource, computeEndpoint string) (*compute.Service, error) {
 	client, err := newOauthClient(ctx, tokenSource)
 	if err != nil {
 		return nil, err
 	}
-	computeOpts := []option.ClientOption{option.WithHTTPClient(client)}
 
-	if computeEndpoint != nil {
-		computeEnvironmentSuffix := constructComputeEndpointPath(computeEnvironment, computeVersion)
-		computeEndpoint.Path = computeEnvironmentSuffix
-		endpoint := computeEndpoint.String()
-		computeOpts = append(computeOpts, option.WithEndpoint(endpoint))
+	computeOpts := []option.ClientOption{option.WithHTTPClient(client)}
+	if computeEndpoint != "" {
+		v1Endpoint := fmt.Sprintf("%s/compute/v1/", computeEndpoint)
+		computeOpts = append(computeOpts, option.WithEndpoint(v1Endpoint))
 	}
-	return computeOpts, nil
-}
-
-func constructComputeEndpointPath(env Environment, version Version) string {
-	prefix := ""
-	if env == EnvironmentStaging {
-		prefix = fmt.Sprintf("%s_", env)
+	service, err := compute.NewService(ctx, computeOpts...)
+	if err != nil {
+		return nil, err
 	}
-	return fmt.Sprintf("compute/%s%s/", prefix, version)
+	service.UserAgent = fmt.Sprintf("GCE CSI Driver/%s (%s %s)", vendorVersion, runtime.GOOS, runtime.GOARCH)
+	return service, nil
 }
 
 func newOauthClient(ctx context.Context, tokenSource oauth2.TokenSource) (*http.Client, error) {

pkg/gce-cloud-provider/compute/gce_test.go

@@ -18,30 +18,14 @@ limitations under the License.
 package gcecloudprovider
 
 import (
-	"context"
 	"errors"
 	"fmt"
 	"net/http"
-	"net/url"
 	"testing"
-	"time"
 
-	"golang.org/x/oauth2"
-
-	"google.golang.org/api/compute/v1"
 	"google.golang.org/api/googleapi"
 )
 
-type mockTokenSource struct{}
-
-func (*mockTokenSource) Token() (*oauth2.Token, error) {
-	return &oauth2.Token{
-		AccessToken:  "access",
-		TokenType:    "Bearer",
-		RefreshToken: "refresh",
-		Expiry:       time.Now().Add(1 * time.Hour),
-	}, nil
-}
 func TestIsGCEError(t *testing.T) {
 	testCases := []struct {
 		name          string
@@ -100,61 +84,3 @@ func TestIsGCEError(t *testing.T) {
 		}
 	}
 }
-
-func TestGetComputeVersion(t *testing.T) {
-	testCases := []struct {
-		name               string
-		computeEndpoint    *url.URL
-		computeEnvironment Environment
-		computeVersion     Version
-		expectedEndpoint   string
-		expectError        bool
-	}{
-
-		{
-			name:               "check for production environment",
-			computeEndpoint:    convertStringToURL("https://compute.googleapis.com"),
-			computeEnvironment: EnvironmentProduction,
-			computeVersion:     versionBeta,
-			expectedEndpoint:   "https://compute.googleapis.com/compute/beta/",
-			expectError:        false,
-		},
-		{
-			name:               "check for staging environment",
-			computeEndpoint:    convertStringToURL("https://compute.googleapis.com"),
-			computeEnvironment: EnvironmentStaging,
-			computeVersion:     versionV1,
-			expectedEndpoint:   "https://compute.googleapis.com/compute/staging_v1/",
-			expectError:        false,
-		},
-		{
-			name:               "check for random string as endpoint",
-			computeEndpoint:    convertStringToURL(""),
-			computeEnvironment: "prod",
-			computeVersion:     "v1",
-			expectedEndpoint:   "compute/v1/",
-			expectError:        true,
-		},
-	}
-	for _, tc := range testCases {
-		ctx := context.Background()
-		computeOpts, err := getComputeVersion(ctx, &mockTokenSource{}, tc.computeEndpoint, tc.computeEnvironment, tc.computeVersion)
-		service, _ := compute.NewService(ctx, computeOpts...)
-		gotEndpoint := service.BasePath
-		if err != nil && !tc.expectError {
-			t.Fatalf("Got error %v", err)
-		}
-		if gotEndpoint != tc.expectedEndpoint && !tc.expectError {
-			t.Fatalf("expected endpoint %s, got endpoint %s", tc.expectedEndpoint, gotEndpoint)
-		}
-	}
-
-}
-
-func convertStringToURL(urlString string) *url.URL {
-	parsedURL, err := url.ParseRequestURI(urlString)
-	if err != nil {
-		return nil
-	}
-	return parsedURL
-}

pkg/gce-pd-csi-driver/controller.go

@@ -178,7 +178,7 @@ const (
 )
 
 var (
-	validResourceApiVersions = map[string]bool{"v1": true, "alpha": true, "beta": true, "staging_v1": true, "staging_beta": true, "staging_alpha": true}
+	validResourceApiVersions = map[string]bool{"v1": true, "alpha": true, "beta": true}
 )
 
 func isDiskReady(disk *gce.CloudDisk) (bool, error) {

test/e2e/tests/single_zone_e2e_test.go

@@ -1280,7 +1280,7 @@ var _ = Describe("GCE PD CSI Driver", func() {
 		}()
 	})
 
-	It("Should pass if valid compute endpoint is passed in", func() {
+	It("Should pass/fail if valid/invalid compute endpoint is passed in", func() {
 		// gets instance set up w/o compute-endpoint set from test setup
 		_, err := getRandomTestContext().Client.ListVolumes()
 		Expect(err).To(BeNil(), "no error expected when passed valid compute url")
@@ -1295,6 +1295,15 @@ var _ = Describe("GCE PD CSI Driver", func() {
 
 		klog.Infof("Creating new driver and client for node %s\n", i.GetName())
 
+		// Create new driver and client w/ invalid endpoint
+		tcInvalid, err := testutils.GCEClientAndDriverSetup(i, "invalid-string")
+		if err != nil {
+			klog.Fatalf("Failed to set up Test Context for instance %v: %w", i.GetName(), err)
+		}
+
+		_, err = tcInvalid.Client.ListVolumes()
+		Expect(err.Error()).To(ContainSubstring("no such host"), "expected error when passed invalid compute url")
+
 		// Create new driver and client w/ valid, passed-in endpoint
 		tcValid, err := testutils.GCEClientAndDriverSetup(i, "https://compute.googleapis.com")
 		if err != nil {

test/e2e/utils/utils.go

@@ -65,6 +65,7 @@ func GCEClientAndDriverSetup(instance *remote.InstanceInfo, computeEndpoint stri
 	// useful to see what's happening when debugging tests.
 	driverRunCmd := fmt.Sprintf("sh -c '/usr/bin/nohup %s/gce-pd-csi-driver -v=6 --endpoint=%s --multi-zone-volume-handle-enable --multi-zone-volume-handle-disk-types=pd-standard %s 2> %s/prog.out < /dev/null > /dev/null &'",
 		workspace, endpoint, strings.Join(extra_flags, " "), workspace)
+
 	config := &remote.ClientConfig{
 		PkgPath:      pkgPath,
 		BinPath:      binPath,