Leverage central context in assets

Refactoring in preparation for context wiring in OpenStack.

Author: pierreprinetti

pkg/asset/cluster/cluster.go

@@ -80,7 +80,7 @@ func (c *Cluster) Dependencies() []asset.Asset {
 	}
 }
 
-// Generate launches the cluster and generates the terraform state file on disk.
+// GenerateWithContext launches the cluster and generates the terraform state file on disk.
 func (c *Cluster) GenerateWithContext(ctx context.Context, parents asset.Parents) (err error) {
 	if InstallDir == "" {
 		logrus.Fatalf("InstallDir has not been set for the %q asset", c.Name())
@@ -115,11 +115,11 @@ func (c *Cluster) GenerateWithContext(ctx context.Context, parents asset.Parents
 	logrus.Infof("Creating infrastructure resources...")
 	switch platform {
 	case typesaws.Name:
-		if err := aws.PreTerraform(context.TODO(), clusterID.InfraID, installConfig); err != nil {
+		if err := aws.PreTerraform(ctx, clusterID.InfraID, installConfig); err != nil {
 			return err
 		}
 	case typesazure.Name, typesazure.StackTerraformName:
-		if err := azure.PreTerraform(context.TODO(), clusterID.InfraID, installConfig); err != nil {
+		if err := azure.PreTerraform(ctx, clusterID.InfraID, installConfig); err != nil {
 			return err
 		}
 	case typesopenstack.Name:
@@ -130,7 +130,7 @@ func (c *Cluster) GenerateWithContext(ctx context.Context, parents asset.Parents
 				break
 			}
 		}
-		if err := openstack.PreTerraform(context.TODO(), tfvarsFile, installConfig, clusterID, rhcosImage); err != nil {
+		if err := openstack.PreTerraform(ctx, tfvarsFile, installConfig, clusterID, rhcosImage); err != nil {
 			return err
 		}
 	}

pkg/asset/installconfig/installconfig.go

@@ -60,8 +60,8 @@ func (a *InstallConfig) Dependencies() []asset.Asset {
 	}
 }
 
-// Generate generates the install-config.yaml file.
-func (a *InstallConfig) Generate(parents asset.Parents) error {
+// GenerateWithContext generates the install-config.yaml file.
+func (a *InstallConfig) GenerateWithContext(ctx context.Context, parents asset.Parents) error {
 	sshPublicKey := &sshPublicKey{}
 	baseDomain := &baseDomain{}
 	clusterName := &clusterName{}
@@ -103,14 +103,15 @@ func (a *InstallConfig) Generate(parents asset.Parents) error {
 
 	defaults.SetInstallConfigDefaults(a.Config)
 
-	return a.finish("")
+	return a.finish(ctx, "")
 }
 
 // Load returns the installconfig from disk.
 func (a *InstallConfig) Load(f asset.FileFetcher) (found bool, err error) {
+	ctx := context.TODO()
 	found, err = a.LoadFromFile(f)
 	if found && err == nil {
-		if err := a.finish(installConfigFilename); err != nil {
+		if err := a.finish(ctx, installConfigFilename); err != nil {
 			return false, errors.Wrap(err, asset.InstallConfigError)
 		}
 	}
@@ -138,7 +139,7 @@ func (a *InstallConfig) finishAWS() error {
 	return nil
 }
 
-func (a *InstallConfig) finish(filename string) error {
+func (a *InstallConfig) finish(ctx context.Context, filename string) error {
 	if a.Config.AWS != nil {
 		a.AWS = aws.NewMetadata(a.Config.Platform.AWS.Region, a.Config.Platform.AWS.Subnets, a.Config.AWS.ServiceEndpoints)
 		if err := a.finishAWS(); err != nil {
@@ -169,7 +170,7 @@ func (a *InstallConfig) finish(filename string) error {
 		return errors.Wrapf(err, "invalid %q file", filename)
 	}
 
-	if err := a.platformValidation(); err != nil {
+	if err := a.platformValidation(ctx); err != nil {
 		return err
 	}
 
@@ -179,7 +180,7 @@ func (a *InstallConfig) finish(filename string) error {
 // platformValidation runs validations that require connecting to the
 // underlying platform. In some cases, platforms also duplicate validations
 // that have already been checked by validation.ValidateInstallConfig().
-func (a *InstallConfig) platformValidation() error {
+func (a *InstallConfig) platformValidation(ctx context.Context) error {
 	if a.Config.Platform.Azure != nil {
 		if a.Config.Platform.Azure.IsARO() {
 			// ARO performs platform validation in the Resource Provider before
@@ -193,7 +194,7 @@ func (a *InstallConfig) platformValidation() error {
 		return icazure.Validate(client, a.Config)
 	}
 	if a.Config.Platform.GCP != nil {
-		client, err := icgcp.NewClient(context.TODO())
+		client, err := icgcp.NewClient(ctx)
 		if err != nil {
 			return err
 		}
@@ -212,7 +213,7 @@ func (a *InstallConfig) platformValidation() error {
 		return icibmcloud.Validate(client, a.Config)
 	}
 	if a.Config.Platform.AWS != nil {
-		return aws.Validate(context.TODO(), a.AWS, a.Config)
+		return aws.Validate(ctx, a.AWS, a.Config)
 	}
 	if a.Config.Platform.VSphere != nil {
 		return icvsphere.Validate(a.Config)
@@ -231,3 +232,9 @@ func (a *InstallConfig) platformValidation() error {
 	}
 	return field.ErrorList{}.ToAggregate()
 }
+
+// Generate is implemented so this asset maintains compatibility with the Asset
+// interface. It should never be called.
+func (*InstallConfig) Generate(_ asset.Parents) (err error) {
+	panic("InstallConfig.Generate was called instead of InstallConfig.GenerateWithContext")
+}

pkg/asset/installconfig/installconfig_test.go

@@ -1,6 +1,7 @@
 package installconfig
 
 import (
+	"context"
 	"errors"
 	"os"
 	"testing"
@@ -35,7 +36,7 @@ func TestInstallConfigGenerate_FillsInDefaults(t *testing.T) {
 		pullSecret,
 		platform,
 	)
-	if err := installConfig.Generate(parents); err != nil {
+	if err := installConfig.GenerateWithContext(context.Background(), parents); err != nil {
 		t.Errorf("unexpected error generating install config: %v", err)
 	}
 	expected := &types.InstallConfig{

pkg/asset/installconfig/platform.go

@@ -1,6 +1,7 @@
 package installconfig
 
 import (
+	"context"
 	"fmt"
 	"sort"
 
@@ -48,8 +49,8 @@ func (a *platform) Dependencies() []asset.Asset {
 	return []asset.Asset{}
 }
 
-// Generate queries for input from the user.
-func (a *platform) Generate(asset.Parents) error {
+// GenerateWithContext queries for input from the user.
+func (a *platform) GenerateWithContext(ctx context.Context, _ asset.Parents) error {
 	platform, err := a.queryUserForPlatform()
 	if err != nil {
 		return err
@@ -148,3 +149,9 @@ func (a *platform) queryUserForPlatform() (platform string, err error) {
 func (a *platform) CurrentName() string {
 	return a.Platform.Name()
 }
+
+// Generate is implemented so this asset maintains compatibility with the Asset
+// interface. It should never be called.
+func (*platform) Generate(_ asset.Parents) (err error) {
+	panic("platform.Generate was called instead of platform.GenerateWithContext")
+}

pkg/asset/machines/clusterapi.go

@@ -68,10 +68,10 @@ func (c *ClusterAPI) Dependencies() []asset.Asset {
 	}
 }
 
-// Generate generates Cluster API machine manifests.
+// GenerateWithContext generates Cluster API machine manifests.
 //
 //nolint:gocyclo
-func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
+func (c *ClusterAPI) GenerateWithContext(ctx context.Context, dependencies asset.Parents) error {
 	installConfig := &installconfig.InstallConfig{}
 	clusterID := &installconfig.ClusterID{}
 	rhcosImage := new(rhcos.Image)
@@ -87,7 +87,6 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 	var err error
 	ic := installConfig.Config
 	pool := *ic.ControlPlane
-	ctx := context.TODO()
 
 	switch ic.Platform.Name() {
 	case awstypes.Name:
@@ -234,7 +233,7 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 			mpool.Zones = []string{""}
 		}
 		if len(mpool.Zones) == 0 {
-			azs, err := client.GetAvailabilityZones(context.TODO(), ic.Platform.Azure.Region, mpool.InstanceType)
+			azs, err := client.GetAvailabilityZones(ctx, ic.Platform.Azure.Region, mpool.InstanceType)
 			if err != nil {
 				return fmt.Errorf("failed to fetch availability zones: %w", err)
 			}
@@ -245,10 +244,10 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 				mpool.Zones = []string{""}
 			}
 		}
-		// client.GetControlPlaneSubnet(context.TODO(), ic.Platform.Azure.ResourceGroupName, ic.Platform.Azure.VirtualNetwork, )
+		// client.GetControlPlaneSubnet(ctx, ic.Platform.Azure.ResourceGroupName, ic.Platform.Azure.VirtualNetwork, )
 
 		if mpool.OSImage.Publisher != "" {
-			img, ierr := client.GetMarketplaceImage(context.TODO(), ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
+			img, ierr := client.GetMarketplaceImage(ctx, ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
 			if ierr != nil {
 				return fmt.Errorf("failed to fetch marketplace image: %w", ierr)
 			}
@@ -262,7 +261,7 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 		pool.Platform.Azure = &mpool
 		subnet := ic.Azure.ControlPlaneSubnet
 
-		capabilities, err := client.GetVMCapabilities(context.TODO(), mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
+		capabilities, err := client.GetVMCapabilities(ctx, mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
 		if err != nil {
 			return err
 		}
@@ -337,7 +336,7 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 			// that the installer's install-config has been provided with bogus values.
 
 			// Timeout context for Lookup
-			ctx, cancel := context.WithTimeout(context.TODO(), 30*time.Second)
+			ctx, cancel := context.WithTimeout(ctx, 30*time.Second)
 			defer cancel()
 
 			_, err := resolver.LookupHost(ctx, v.Server)
@@ -349,7 +348,7 @@ func (c *ClusterAPI) Generate(dependencies asset.Parents) error {
 			// Timeout context for Networks
 			// vCenter APIs can be unreliable in performance, extended this context
 			// timeout to 60 seconds.
-			ctx, cancel = context.WithTimeout(context.TODO(), 60*time.Second)
+			ctx, cancel = context.WithTimeout(ctx, 60*time.Second)
 			defer cancel()
 
 			err = installConfig.VSphere.Networks(ctx, v, platform.FailureDomains)
@@ -521,3 +520,9 @@ func (c *ClusterAPI) Load(f asset.FileFetcher) (bool, error) {
 	asset.SortManifestFiles(c.FileList)
 	return len(c.FileList) > 0, nil
 }
+
+// Generate is implemented so this asset maintains compatibility with the Asset
+// interface. It should never be called.
+func (*ClusterAPI) Generate(_ asset.Parents) (err error) {
+	panic("ClusterAPI.Generate was called instead of ClusterAPI.GenerateWithContext")
+}

pkg/asset/machines/master.go

@@ -154,9 +154,10 @@ func (m *Master) Dependencies() []asset.Asset {
 	}
 }
 
-// Generate generates the Master asset.
-func (m *Master) Generate(dependencies asset.Parents) error {
-	ctx := context.TODO()
+// GenerateWithContext generates the Master asset.
+//
+//nolint:gocyclo
+func (m *Master) GenerateWithContext(ctx context.Context, dependencies asset.Parents) error {
 	clusterID := &installconfig.ClusterID{}
 	installConfig := &installconfig.InstallConfig{}
 	rhcosImage := new(rhcos.Image)
@@ -357,7 +358,7 @@ func (m *Master) Generate(dependencies asset.Parents) error {
 
 		client := icazure.NewClient(session)
 		if len(mpool.Zones) == 0 {
-			azs, err := client.GetAvailabilityZones(context.TODO(), ic.Platform.Azure.Region, mpool.InstanceType)
+			azs, err := client.GetAvailabilityZones(ctx, ic.Platform.Azure.Region, mpool.InstanceType)
 			if err != nil {
 				return errors.Wrap(err, "failed to fetch availability zones")
 			}
@@ -370,7 +371,7 @@ func (m *Master) Generate(dependencies asset.Parents) error {
 		}
 
 		if mpool.OSImage.Publisher != "" {
-			img, ierr := client.GetMarketplaceImage(context.TODO(), ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
+			img, ierr := client.GetMarketplaceImage(ctx, ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
 			if ierr != nil {
 				return fmt.Errorf("failed to fetch marketplace image: %w", ierr)
 			}
@@ -383,7 +384,7 @@ func (m *Master) Generate(dependencies asset.Parents) error {
 		}
 		pool.Platform.Azure = &mpool
 
-		capabilities, err := client.GetVMCapabilities(context.TODO(), mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
+		capabilities, err := client.GetVMCapabilities(ctx, mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
 		if err != nil {
 			return err
 		}
@@ -877,3 +878,9 @@ func createAssetFiles(objects []interface{}, fileName string) ([]*asset.File, er
 
 	return assetFiles, nil
 }
+
+// Generate is implemented so this asset maintains compatibility with the Asset
+// interface. It should never be called.
+func (*Master) Generate(_ asset.Parents) (err error) {
+	panic("Master.Generate was called instead of Master.GenerateWithContext")
+}

pkg/asset/machines/master_test.go

@@ -1,6 +1,7 @@
 package machines
 
 import (
+	"context"
 	"fmt"
 	"testing"
 
@@ -173,7 +174,7 @@ spec:
 				},
 			)
 			master := &Master{}
-			if err := master.Generate(parents); err != nil {
+			if err := master.GenerateWithContext(context.Background(), parents); err != nil {
 				t.Fatalf("failed to generate master machines: %v", err)
 			}
 			expectedLen := len(tc.expectedMachineConfig)
@@ -232,7 +233,7 @@ func TestControlPlaneIsNotModified(t *testing.T) {
 		},
 	)
 	master := &Master{}
-	if err := master.Generate(parents); err != nil {
+	if err := master.GenerateWithContext(context.Background(), parents); err != nil {
 		t.Fatalf("failed to generate master machines: %v", err)
 	}
 
@@ -301,7 +302,7 @@ func TestBaremetalGeneratedAssetFiles(t *testing.T) {
 		},
 	)
 	master := &Master{}
-	assert.NoError(t, master.Generate(parents))
+	assert.NoError(t, master.GenerateWithContext(context.Background(), parents))
 
 	assert.Len(t, master.HostFiles, 2)
 	verifyHost(t, master.HostFiles[0], "openshift/99_openshift-cluster-api_hosts-0.yaml", "master-0")

pkg/asset/machines/worker.go

@@ -267,9 +267,10 @@ func (w *Worker) Dependencies() []asset.Asset {
 	}
 }
 
-// Generate generates the Worker asset.
-func (w *Worker) Generate(dependencies asset.Parents) error {
-	ctx := context.TODO()
+// GenerateWithContext generates the Worker asset.
+//
+//nolint:gocyclo
+func (w *Worker) GenerateWithContext(ctx context.Context, dependencies asset.Parents) error {
 	clusterID := &installconfig.ClusterID{}
 	installConfig := &installconfig.InstallConfig{}
 	rhcosImage := new(rhcos.Image)
@@ -461,7 +462,7 @@ func (w *Worker) Generate(dependencies asset.Parents) error {
 
 			client := icazure.NewClient(session)
 			if len(mpool.Zones) == 0 {
-				azs, err := client.GetAvailabilityZones(context.TODO(), ic.Platform.Azure.Region, mpool.InstanceType)
+				azs, err := client.GetAvailabilityZones(ctx, ic.Platform.Azure.Region, mpool.InstanceType)
 				if err != nil {
 					return errors.Wrap(err, "failed to fetch availability zones")
 				}
@@ -474,7 +475,7 @@ func (w *Worker) Generate(dependencies asset.Parents) error {
 			}
 
 			if mpool.OSImage.Publisher != "" {
-				img, ierr := client.GetMarketplaceImage(context.TODO(), ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
+				img, ierr := client.GetMarketplaceImage(ctx, ic.Platform.Azure.Region, mpool.OSImage.Publisher, mpool.OSImage.Offer, mpool.OSImage.SKU, mpool.OSImage.Version)
 				if ierr != nil {
 					return fmt.Errorf("failed to fetch marketplace image: %w", ierr)
 				}
@@ -487,7 +488,7 @@ func (w *Worker) Generate(dependencies asset.Parents) error {
 			}
 			pool.Platform.Azure = &mpool
 
-			capabilities, err := client.GetVMCapabilities(context.TODO(), mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
+			capabilities, err := client.GetVMCapabilities(ctx, mpool.InstanceType, installConfig.Config.Platform.Azure.Region)
 			if err != nil {
 				return err
 			}
@@ -855,3 +856,9 @@ func (w *Worker) MachineSets() ([]machinev1beta1.MachineSet, error) {
 
 	return machineSets, nil
 }
+
+// Generate is implemented so this asset maintains compatibility with the Asset
+// interface. It should never be called.
+func (*Worker) Generate(_ asset.Parents) (err error) {
+	panic("Worker.Generate was called instead of Worker.GenerateWithContext")
+}