Internal: Set image projects via configs

dev-docs/new-distro.md

@@ -100,7 +100,7 @@ The instructions are very similar to the instructions for `ops_agent_test`.
         or
         [test/third_party_apps/presubmit/bullseye_aarch64.gcl](https://github.com/GoogleCloudPlatform/ops-agent/blob/master/kokoro/config/test/third_party_apps/bullseye_aarch64.gcl),
         set `platforms` to `['$DISTRO_FAMILY']` (instead of
-        `['debian-11']`). You should also add this section right after the
+        `['debian-cloud:debian-11']`). You should also add this section right after the
         `platforms =` line:
 
         ```gcl

integration_test/README.md

@@ -50,7 +50,7 @@ Alternatively, you can export `PROJECT` and `TRANSFERS_BUCKET` in your
 environment and simply call the target.  
 You can also specify the `ZONES` and `PLATFORMS` variables if you would like
 to run the tests on something other than the defaults (`us-central1-b` for
-ZONES and `debian-11` for `PLATFORMS`).
+ZONES and `debian-cloud:debian-11` for `PLATFORMS`).
 
 The above command will run the tests against the stable Ops Agent. To test
 against a pre-built but unreleased agent, you can use add the

integration_test/gce/gce_testing.go

@@ -36,7 +36,7 @@ AGENT_PACKAGES_IN_GCS, for details see README.md.
 
 	PROJECT=dev_project \
 	ZONES=us-central1-b \
-	PLATFORMS=debian-10,centos-8,rhel-8-2-sap-ha,sles-15,ubuntu-2004-lts,windows-2016,windows-2019 \
+	PLATFORMS=debian-cloud:debian-10,rocky-linux-cloud:rocky-linux-8,rhel-sap-cloud:rhel-8-2-sap-ha,suse-cloud:sles-15,ubuntu-os-cloud:ubuntu-2004-lts,windows-cloud:windows-2016,windows-cloud:windows-2019 \
 	go test -v ops_agent_test.go \
 	  -test.parallel=1000 \
 	  -tags=integration_test \
@@ -295,6 +295,8 @@ type VM struct {
 	Project     string
 	Network     string
 	Platform    string
+	// The VMOptions.ImageSpec used to create the VM.
+	ImageSpec   string
 	Zone        string
 	MachineType string
 	ID          int64
@@ -1060,8 +1062,23 @@ func getVMPlatform(image string, platform string) (string, error) {
 	return "", errors.New("at least one of image or platform must be specified")
 }
 
+// In cases where ImageSpec is not being used yet, construct it from known fields.
+func constructImageSpec(options *VMOptions) {
+	if options.ImageSpec != "" || options.ImageProject == "" {
+		return
+	}
+	if options.Platform != "" {
+		options.ImageSpec = fmt.Sprintf("%s:%s", options.ImageProject, options.Platform)
+	} else if options.Image != "" {
+		options.ImageSpec = fmt.Sprintf("%s=%s", options.ImageProject, options.Image)
+	}
+}
+
+// parseImageSpec looks for the ImageSpec field in VMOptions and sets
+// ImageProject/Image/Platform accordingly.
 func parseImageSpec(options *VMOptions) (error) {
 	if options.ImageSpec == "" {
+		constructImageSpec(options)
 		return nil
 	}
 
@@ -1088,9 +1105,6 @@ func parseImageSpec(options *VMOptions) (error) {
 			options.Image = s[1]
 	}
 
-	// We do this in case subsequent calls try to expand ImageSpec again.
-	options.ImageSpec = ""
-
 	return nil
 }
 
@@ -1109,11 +1123,12 @@ func attemptCreateInstance(ctx context.Context, logger *log.Logger, options VMOp
 		return nil, err
 	}
 	vm := &VM{
-		Project:  options.Project,
-		Platform: platform,
-		Name:     options.Name,
-		Network:  os.Getenv("NETWORK_NAME"),
-		Zone:     options.Zone,
+		Project:   options.Project,
+		Platform:  platform,
+		ImageSpec: options.ImageSpec,
+		Name:      options.Name,
+		Network:   os.Getenv("NETWORK_NAME"),
+		Zone:      options.Zone,
 	}
 	if vm.Name == "" {
 		// The VM name needs to adhere to these restrictions:
@@ -1317,11 +1332,6 @@ func CreateInstance(origCtx context.Context, logger *log.Logger, options VMOptio
 	ctx, cancel := context.WithTimeout(origCtx, 3*vmInitTimeout)
 	defer cancel()
 
-	err := parseImageSpec(&options)
-	if err != nil {
-		return nil, err
-	}
-
 	shouldRetry := func(err error) bool {
 		// VM creation can hit quota, especially when re-running presubmits,
 		// or when multple people are running tests.
@@ -1865,6 +1875,10 @@ func SetupLogger(t *testing.T) *logging.DirectoryLogger {
 type VMOptions struct {
 	// Optional. Can be used to pass image/image family & image project in one
 	// string. If set, Platform/Image/ImageProject should not be set.
+	//
+	// Example Image Specs:
+	// Image Family / Project: `<project>:<family>`
+	// Specific Image / Project: `<project>=<image>``
 	ImageSpec string
 	// Required. Normally passed as --image-family to
 	// "gcloud compute images create".

integration_test/metadata/integration_metadata.go

@@ -19,7 +19,6 @@ import (
 	"fmt"
 	"reflect"
 	"regexp"
-	"strings"
 
 	"cloud.google.com/go/monitoring/apiv3/v2/monitoringpb"
 	"github.com/go-playground/validator/v10"
@@ -133,9 +132,7 @@ func UnmarshalAndValidate(data []byte, i interface{}) error {
 
 func SliceContains(slice []string, toFind string) bool {
 	for _, entry := range slice {
-		// vm.Platform (ex. `sles-15`) does not align with ImageSpec (ex. `suse-cloud:sles-15`)
-		// TODO, remove lingering references to "Platform" and use "Image Spec" instead.
-		if strings.HasSuffix(entry, toFind) {
+		if entry == toFind {
 			return true
 		}
 	}

integration_test/soak_test/README.md

@@ -6,7 +6,7 @@ parameters as desired) and run:
 
 ```
 PROJECT=my_project \
-  DISTRO=debian-11 \
+  DISTRO=debian-cloud:debian-11 \
   ZONES=us-central1-b \
   TTL=100m \
   LOG_SIZE_IN_BYTES=1000 \

integration_test/soak_test/cmd/launcher/main.go

@@ -29,7 +29,7 @@ LOG_SIZE_IN_BYTES: How many bytes each log entry should be.
 
 TTL: How long to keep the VM alive, expressed as "24h30m" or similar.
 
-DISTRO: The GCE image family name to run, e.g. "debian-11".
+DISTRO: The Image Spec to run the tests on, e.g. "debian-cloud:debian-11".
 
 VM_NAME: (Optional) The name of the VM to spawn. If not supplied,
 a random name will be generated by gce_testing.go.

integration_test/third_party_apps_test.go

@@ -21,7 +21,7 @@ For instructions, see the top of gce_testing.go.
 This test needs the following environment variables to be defined, in addition
 to the ones mentioned at the top of gce_testing.go:
 
-PLATFORMS: a comma-separated list of distros to test, e.g. "centos-7,centos-8".
+PLATFORMS: a comma-separated list of image specs to test, e.g. "suse-cloud:sles-12,ubuntu-os-cloud:ubuntu-2310-amd64".
 
 The following variables are optional:
 
@@ -408,11 +408,11 @@ func verifyLog(actualLog *cloudlogging.Entry, expectedLog *metadata.ExpectedLog)
 }
 
 // stripUnavailableFields removes the fields that are listed as unavailable_on
-// the current platform.
-func stripUnavailableFields(fields []*metadata.LogFields, platform string) []*metadata.LogFields {
+// the current image spec.
+func stripUnavailableFields(fields []*metadata.LogFields, imageSpec string) []*metadata.LogFields {
 	var result []*metadata.LogFields
 	for _, field := range fields {
-		if !metadata.SliceContains(field.UnavailableOn, platform) {
+		if !metadata.SliceContains(field.UnavailableOn, imageSpec) {
 			result = append(result, field)
 		}
 	}
@@ -431,14 +431,14 @@ func runLoggingTestCases(ctx context.Context, logger *log.Logger, vm *gce.VM, lo
 		// underlying struct.
 		entry := *entry
 		go func() {
-			// Strip out the fields that are not available on this platform.
+			// Strip out the fields that are not available on this image spec.
 			// We do this here so that:
 			// 1. the field is never mentioned in the query we send, and
 			// 2. verifyLogField treats it as any other unexpected field, which
 			//    means it will fail the test ("expected no value for field").
 			//    This could result in annoying test failures if the app suddenly
 			//    begins reporting a log field on a certain platform.
-			entry.Fields = stripUnavailableFields(entry.Fields, vm.Platform)
+			entry.Fields = stripUnavailableFields(entry.Fields, vm.ImageSpec)
 
 			// Construct query using remaining fields with a nonempty regex.
 			query := constructQuery(entry.LogName, entry.Fields)
@@ -499,7 +499,7 @@ func runMetricsTestCases(ctx context.Context, logger *log.Logger, vm *gce.VM, me
 			logger.Printf("Skipping optional or representative metric %s", metric.Type)
 			continue
 		}
-		if metadata.SliceContains(metric.UnavailableOn, vm.Platform) {
+		if metadata.SliceContains(metric.UnavailableOn, vm.ImageSpec) {
 			logger.Printf("Skipping metric %s due to unavailable_on", metric.Type)
 			continue
 		}

tasks.mak

@@ -93,7 +93,7 @@ endif
 # If you would like to use a custom build you can provide a REPO_SUFFIX or
 # AGENT_PACKAGES_IN_GCS. These targets function fine without either specified.
 ZONES ?= us-central1-b
-PLATFORMS ?= debian-11
+PLATFORMS ?= debian-cloud:debian-11
 
 integration_tests:
 	ZONES="${ZONES}" \