Merge pull request #1899 from chenz4027/OCM-6840-test

OCM-6840 | fix: Add json output test for external auth
openshift · Apr 5, 2024 · ebcb463 · ebcb463
2 parents 5935b9c + a958983
commit ebcb463
Show file tree

Hide file tree

Showing 6 changed files with 113 additions and 13 deletions.
diff --git a/cmd/describe/externalauthprovider/cmd.go b/cmd/describe/externalauthprovider/cmd.go
@@ -103,7 +103,7 @@ func runWithRuntime(r *rosa.Runtime, cmd *cobra.Command, argv []string) error {
 			r.Reporter.Errorf("%v", err)
 			os.Exit(1)
 		}
-		os.Exit(0)
+		return nil
 	}
 
 	externalAuthConfigList := describeExternalAuthProviders(r, cluster, clusterKey, externalAuthConfig)

diff --git a/cmd/describe/externalauthprovider/cmd_test.go b/cmd/describe/externalauthprovider/cmd_test.go
@@ -22,6 +22,28 @@ Issuer audiences:
 Issuer Url:                            https://test.com
 Claim mappings group:                  groups
 Claim mappings username:               username
+`
+
+	jsonOutput = `{
+  "kind": "ExternalAuth",
+  "id": "microsoft-entra-id",
+  "claim": {
+    "mappings": {
+      "groups": {
+        "claim": "groups"
+      },
+      "username": {
+        "claim": "username"
+      }
+    }
+  },
+  "issuer": {
+    "url": "https://test.com",
+    "audiences": [
+      "abc"
+    ]
+  }
+}
 `
 )
 
@@ -39,8 +61,7 @@ var _ = Describe("External authentication provider", func() {
 		})
 		hypershiftClusterReady := test.FormatClusterList([]*cmv1.Cluster{mockClusterReady})
 
-		externalAuths := make([]*cmv1.ExternalAuth, 0)
-		externalAuths = append(externalAuths, test.BuildExternalAuth())
+		externalAuth := test.BuildExternalAuth()
 
 		BeforeEach(func() {
 			testRuntime.InitRuntime()
@@ -68,13 +89,39 @@ var _ = Describe("External authentication provider", func() {
 			Expect(stderr).To(BeEmpty())
 		})
 
+		It("Pass an external auth provider name through parameter with -o json but it is not found", func() {
+			Cmd.Flags().Set("output", "json")
+			args.name = externalAuthName
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusNotFound, ""))
+			stdout, stderr, err := test.RunWithOutputCaptureAndArgv(runWithRuntime, testRuntime.RosaRuntime,
+				Cmd, &[]string{})
+			Expect(err).ToNot(BeNil())
+			Expect(err.Error()).To(ContainSubstring(
+				fmt.Sprintf("external authentication provider '%s' not found", externalAuthName)))
+			Expect(stdout).To(BeEmpty())
+			Expect(stderr).To(BeEmpty())
+		})
+
 		It("Pass an external auth provider name through parameter and it is found.", func() {
 			args.name = externalAuthName
 			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
-			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, test.FormatExternalAuthList(externalAuths)))
-			output := describeExternalAuthProviders(testRuntime.RosaRuntime,
-				mockClusterReady, test.MockClusterID, test.BuildExternalAuth())
-			Expect(output).To(Equal(describeStringOutput))
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, test.FormatResource(externalAuth)))
+			stdout, stderr, err := test.RunWithOutputCaptureAndArgv(runWithRuntime, testRuntime.RosaRuntime, Cmd, &[]string{})
+			Expect(err).To(BeNil())
+			Expect(stderr).To(BeEmpty())
+			Expect(stdout).To(Equal(describeStringOutput))
+		})
+
+		It("Pass an external auth provider name through parameter with -o json and it is found.", func() {
+			Cmd.Flags().Set("output", "json")
+			args.name = externalAuthName
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, test.FormatResource(externalAuth)))
+			stdout, stderr, err := test.RunWithOutputCaptureAndArgv(runWithRuntime, testRuntime.RosaRuntime, Cmd, &[]string{})
+			Expect(err).To(BeNil())
+			Expect(stderr).To(BeEmpty())
+			Expect(stdout).To(Equal(jsonOutput))
 		})
 	})
 })
diff --git a/cmd/list/externalauthprovider/cmd.go b/cmd/list/externalauthprovider/cmd.go
@@ -76,10 +76,9 @@ func runWithRuntime(r *rosa.Runtime, cmd *cobra.Command) error {
 	if output.HasFlag() {
 		err = output.Print(externalAuthProviders)
 		if err != nil {
-			r.Reporter.Errorf("%s", err)
-			os.Exit(1)
+			return fmt.Errorf("%s", err)
 		}
-		os.Exit(0)
+		return nil
 	}
 
 	if len(externalAuthProviders) == 0 {

diff --git a/cmd/list/externalauthprovider/cmd_test.go b/cmd/list/externalauthprovider/cmd_test.go
@@ -11,6 +11,36 @@ import (
 	"github.com/openshift/rosa/pkg/test"
 )
 
+const (
+	listOutput = `NAME                ISSUER URL
+microsoft-entra-id  https://test.com
+`
+
+	jsonOutput = `[
+  {
+    "kind": "ExternalAuth",
+    "id": "microsoft-entra-id",
+    "claim": {
+      "mappings": {
+        "groups": {
+          "claim": "groups"
+        },
+        "username": {
+          "claim": "username"
+        }
+      }
+    },
+    "issuer": {
+      "url": "https://test.com",
+      "audiences": [
+        "abc"
+      ]
+    }
+  }
+]
+`
+)
+
 var _ = Describe("list external-auth-provider", func() {
 
 	var testRuntime test.TestingRuntime
@@ -49,10 +79,30 @@ var _ = Describe("list external-auth-provider", func() {
 		It("Succeeds", func() {
 			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
 			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, test.FormatExternalAuthList(externalAuths)))
-			_, _, err := test.RunWithOutputCapture(runWithRuntime, testRuntime.RosaRuntime, Cmd)
+			stdout, stderr, err := test.RunWithOutputCapture(runWithRuntime, testRuntime.RosaRuntime, Cmd)
 			Expect(err).To(BeNil())
+			Expect(stderr).To(BeEmpty())
+			Expect(stdout).To(Equal(listOutput))
 		})
 
-	})
+		It("Returns empty array with -o json if not found", func() {
+			Cmd.Flags().Set("output", "json")
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusNotFound, ""))
+			stdout, stderr, err := test.RunWithOutputCapture(runWithRuntime, testRuntime.RosaRuntime, Cmd)
+			Expect(err).To(BeNil())
+			Expect(stderr).To(BeEmpty())
+			Expect(stdout).To(Equal("[]\n"))
+		})
 
+		It("Returns array with json context with -o json if found", func() {
+			Cmd.Flags().Set("output", "json")
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, hypershiftClusterReady))
+			testRuntime.ApiServer.AppendHandlers(RespondWithJSON(http.StatusOK, test.FormatExternalAuthList(externalAuths)))
+			stdout, stderr, err := test.RunWithOutputCapture(runWithRuntime, testRuntime.RosaRuntime, Cmd)
+			Expect(err).To(BeNil())
+			Expect(stderr).To(BeEmpty())
+			Expect(stdout).To(Equal(jsonOutput))
+		})
+	})
 })
diff --git a/cmd/revoke/breakglasscredential/cmd.go b/cmd/revoke/breakglasscredential/cmd.go
@@ -73,7 +73,7 @@ func runWithRuntime(r *rosa.Runtime, cmd *cobra.Command, argv []string) error {
 			return fmt.Errorf("failed to revoke break glass credentials on cluster '%s': %s",
 				clusterKey, err)
 		}
-		r.Reporter.Infof("Successfully revoked all break glass credentials from cluster '%s'",
+		r.Reporter.Infof("Successfully requested revocation for all break glass credentials from cluster '%s'",
 			clusterKey)
 	}
 	return nil

diff --git a/pkg/test/helpers.go b/pkg/test/helpers.go
@@ -276,6 +276,10 @@ func FormatResource(resource interface{}) string {
 		if res, ok := resource.(*v1.ControlPlaneUpgradePolicy); ok {
 			err = v1.MarshalControlPlaneUpgradePolicy(res, &outputJson)
 		}
+	case "*v1.ExternalAuth":
+		if res, ok := resource.(*v1.ExternalAuth); ok {
+			err = v1.MarshalExternalAuth(res, &outputJson)
+		}
 	default:
 		{
 			return "NOTIMPLEMENTED"