operator: add ctx to func UpgradeImages and logger for env vars of images

hj-johannes-lee · hj-johannes-lee · commit 20caa42e7ad6 · 2023-09-18T12:04:32.000-07:00
Signed-off-by: Hyeongju Johannes Lee &lt;hyeongju.lee@intel.com&gt;
diff --git a/pkg/controllers/dlb/controller.go b/pkg/controllers/dlb/controller.go
@@ -68,7 +68,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.DlbDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/dsa/controller.go b/pkg/controllers/dsa/controller.go
@@ -71,7 +71,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.DsaDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/fpga/controller.go b/pkg/controllers/fpga/controller.go
@@ -67,7 +67,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.FpgaDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/gpu/controller.go b/pkg/controllers/gpu/controller.go
@@ -72,7 +72,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.GpuDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/iaa/controller.go b/pkg/controllers/iaa/controller.go
@@ -69,7 +69,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.IaaDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/qat/controller.go b/pkg/controllers/qat/controller.go
@@ -72,7 +72,7 @@ func (c *controller) CreateEmptyObject() client.Object {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.QatDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {
diff --git a/pkg/controllers/reconciler.go b/pkg/controllers/reconciler.go
@@ -169,7 +169,7 @@ func (r *reconciler) createObjects(ctx context.Context,
 	return result, nil
 }
 
-func UpgradeImages(image *string, initimage *string) (upgrade bool) {
+func UpgradeImages(ctx context.Context, image *string, initimage *string) (upgrade bool) {
 	for _, s := range []*string{image, initimage} {
 		if s == nil {
 			continue
@@ -181,6 +181,8 @@ func UpgradeImages(image *string, initimage *string) (upgrade bool) {
 			envVarValue := os.Getenv(strings.ReplaceAll(strings.ToUpper(filepath.Base(name)), "-", "_") + "_SHA")
 
 			if envVarValue != "" && *s != envVarValue {
+				log.FromContext(ctx).Info("env var for the image: " + name + " is already set; user input of the image is ignored")
+
 				*s = envVarValue
 				upgrade = true
 
diff --git a/pkg/controllers/reconciler_test.go b/pkg/controllers/reconciler_test.go
@@ -15,6 +15,7 @@
 package controllers
 
 import (
+	"context"
 	"testing"
 )
 
@@ -63,7 +64,7 @@ func TestUpgrade(test *testing.T) {
 	for i := range tests {
 		t := tests[i]
 
-		upgrade := UpgradeImages(&t.image, &t.initimage)
+		upgrade := UpgradeImages(context.Background(), &t.image, &t.initimage)
 
 		if !(upgrade == t.upgrade && t.image == t.expectedImage && t.initimage == t.expectedInitimage) {
 			test.Errorf("expectedUpgrade: %v, received: %v", t.upgrade, upgrade)
diff --git a/pkg/controllers/sgx/controller.go b/pkg/controllers/sgx/controller.go
@@ -64,7 +64,7 @@ type controller struct {
 
 func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {
 	dp := obj.(*devicepluginv1.SgxDevicePlugin)
-	return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)
+	return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)
 }
 
 func (c *controller) CreateEmptyObject() client.Object {

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ func (c *controller) CreateEmptyObject() client.Object {`
`68`	`68`
`69`	`69`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`70`	`70`	`dp := obj.(*devicepluginv1.DlbDevicePlugin)`
`71`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`71`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ func (c *controller) CreateEmptyObject() client.Object {`
`71`	`71`
`72`	`72`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`73`	`73`	`dp := obj.(*devicepluginv1.DsaDevicePlugin)`
`74`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`74`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func (c *controller) CreateEmptyObject() client.Object {`
`67`	`67`
`68`	`68`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`69`	`69`	`dp := obj.(*devicepluginv1.FpgaDevicePlugin)`
`70`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`70`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ func (c *controller) CreateEmptyObject() client.Object {`
`72`	`72`
`73`	`73`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`74`	`74`	`dp := obj.(*devicepluginv1.GpuDevicePlugin)`
`75`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`75`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ func (c *controller) CreateEmptyObject() client.Object {`
`69`	`69`
`70`	`70`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`71`	`71`	`dp := obj.(*devicepluginv1.IaaDevicePlugin)`
`72`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`72`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`func (c *controller) GetTotalObjectCount(ctx context.Context, clnt client.Client) (int, error) {`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ type controller struct {`
`64`	`64`
`65`	`65`	`func (c *controller) Upgrade(ctx context.Context, obj client.Object) bool {`
`66`	`66`	`dp := obj.(*devicepluginv1.SgxDevicePlugin)`
`67`		`- return controllers.UpgradeImages(&dp.Spec.Image, &dp.Spec.InitImage)`
	`67`	`+ return controllers.UpgradeImages(ctx, &dp.Spec.Image, &dp.Spec.InitImage)`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`func (c *controller) CreateEmptyObject() client.Object {`