adding logic to exit early and display the help if the user gives a l…

…egacy project id

Signed-off-by: Adam D. Cornett <adc@redhat.com>

certification/runtime/config.go

@@ -2,7 +2,6 @@ package runtime
 
 import (
 	"os"
-	"strings"
 
 	"github.com/redhat-openshift-ecosystem/openshift-preflight/certification/policy"
 
@@ -63,13 +62,7 @@ func (c *Config) storeContainerPolicyConfiguration(vcfg viper.Viper) {
 	c.PyxisAPIToken = vcfg.GetString("pyxis_api_token")
 	c.Submit = vcfg.GetBool("submit")
 	c.PyxisHost = pyxisHostLookup(vcfg.GetString("pyxis_env"), vcfg.GetString("pyxis_host"))
-
-	// Strip the ospid- prefix from the project ID if provided.
-	certificationProjectID := vcfg.GetString("certification_project_id")
-	if strings.HasPrefix(certificationProjectID, "ospid-") {
-		certificationProjectID = strings.Split(certificationProjectID, "-")[1]
-	}
-	c.CertificationProjectID = certificationProjectID
+	c.CertificationProjectID = vcfg.GetString("certification_project_id")
 }
 
 // storeOperatorPolicyConfiguration reads operator-policy-specific config

certification/runtime/config_test.go

@@ -60,16 +60,6 @@ var _ = Describe("Viper to Runtime Config", func() {
 		})
 	})
 
-	Context("With proper values, but with an opsid- prefix on the certification project ID", func() {
-		It("should properly trim the ospid- prefix and succeed", func() {
-			baseViperCfg.Set("certification_project_id", "ospid-111111111111")
-			expectedRuntimeCfg.CertificationProjectID = "111111111111"
-			cfg, err := NewConfigFrom(*baseViperCfg)
-			Expect(err).ToNot(HaveOccurred())
-			Expect(*cfg).To(BeEquivalentTo(*expectedRuntimeCfg))
-		})
-	})
-
 	It("should only have 20 struct keys for tests to be valid", func() {
 		// If this test fails, it means a developer has added or removed
 		// keys from runtime.Config, and so these tests may no longer be

cmd/check_container.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"strings"
 
@@ -28,6 +29,7 @@ func checkContainerCmd() *cobra.Command {
 		Args:  checkContainerPositionalArgs,
 		// this fmt.Sprintf is in place to keep spacing consistent with cobras two spaces that's used in: Usage, Flags, etc
 		Example: fmt.Sprintf("  %s", "preflight check container quay.io/repo-name/container-name:version"),
+		PreRunE: validateCertificationProjectId,
 		RunE:    checkContainerRunE,
 	}
 
@@ -208,3 +210,22 @@ func checkContainerPositionalArgs(cmd *cobra.Command, args []string) error {
 
 	return nil
 }
+
+// validateCertificationProjectId validates that the certification project id is in the proper format
+// and throws an error if the value provided is in a legacy format that is not usable to query pyxis
+func validateCertificationProjectId(cmd *cobra.Command, args []string) error {
+	certificationProjectID := viper.GetString("certification_project_id")
+	// splitting the certification project id into parts. if there are more than 2 elements in the array,
+	// we know they inputted a legacy project id, which can not be used to query pyxis
+	parts := strings.Split(certificationProjectID, "-")
+
+	if len(parts) > 2 {
+		return errors.New(fmt.Sprintf("certification project id: %s is improperly formatted see help command for instructions on obtaining proper value", certificationProjectID))
+	}
+
+	if parts[0] == "ospid" {
+		viper.Set("certification_project_id", parts[1])
+	}
+
+	return nil
+}

cmd/check_container_test.go

@@ -529,4 +529,45 @@ certification_project_id: mycertid`
 			})
 		})
 	})
+
+	Context("When validating the certification-project-id flag", func() {
+		Context("and the flag is set properly", func() {
+			BeforeEach(func() {
+				viper.Set("certification_project_id", "123456789")
+			})
+			It("should not change the flag value", func() {
+				err := validateCertificationProjectId(checkContainerCmd(), []string{"foo"})
+				Expect(err).ToNot(HaveOccurred())
+				Expect(viper.GetString("certification_project_id")).To(Equal("123456789"))
+			})
+		})
+		Context("and a valid ospid format is provided", func() {
+			BeforeEach(func() {
+				viper.Set("certification_project_id", "ospid-123456789")
+			})
+			It("should strip ospid- from the flag value", func() {
+				err := validateCertificationProjectId(checkContainerCmd(), []string{"foo"})
+				Expect(err).ToNot(HaveOccurred())
+				Expect(viper.GetString("certification_project_id")).To(Equal("123456789"))
+			})
+		})
+		Context("and a legacy format with ospid is provided", func() {
+			BeforeEach(func() {
+				viper.Set("certification_project_id", "ospid-62423-f26c346-6cc1dc7fae92")
+			})
+			It("should throw an error", func() {
+				err := validateCertificationProjectId(checkContainerCmd(), []string{"foo"})
+				Expect(err).To(HaveOccurred())
+			})
+		})
+		Context("and a legacy format without ospid is provided", func() {
+			BeforeEach(func() {
+				viper.Set("certification_project_id", "62423-f26c346-6cc1dc7fae92")
+			})
+			It("should throw an error", func() {
+				err := validateCertificationProjectId(checkContainerCmd(), []string{"foo"})
+				Expect(err).To(HaveOccurred())
+			})
+		})
+	})
 })