MG-2253 - Create Users CLI tests (absmach#2319)

Signed-off-by: JeffMboya <[email protected]>
felixgateru · Jul 9, 2024 · 04c3594 · 04c3594
1 parent b49a2cd
commit 04c3594
Show file tree

Hide file tree

Showing 18 changed files with 1,818 additions and 354 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -92,6 +92,11 @@ jobs:
               - "auth/**"
               - "pkg/sdk/**"
 
+            cli:
+              - "cli/**"
+              - "cmd/cli/**"
+              - "pkg/sdk/**"
+
             coap:
               - "coap/**"
               - "cmd/coap/**"
@@ -296,6 +301,11 @@ jobs:
         run: |
           go test --race -v -count=1 -coverprofile=coverage/certs.out ./certs/...
 
+      - name: Run cli tests
+        if: steps.changes.outputs.cli == 'true' || steps.changes.outputs.workflow == 'true'
+        run: |
+          go test --race -v -count=1 -coverprofile=coverage/cli.out ./cli/...
+
       - name: Run CoAP tests
         if: steps.changes.outputs.coap == 'true' || steps.changes.outputs.workflow == 'true'
         run: |

diff --git a/cli/bootstrap.go b/cli/bootstrap.go
@@ -17,23 +17,23 @@ var cmdBootstrap = []cobra.Command{
 		Long:  `Create new Thing Bootstrap Config to the user identified by the provided key`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 
 			var cfg mgxsdk.BootstrapConfig
 			if err := json.Unmarshal([]byte(args[0]), &cfg); err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
 			id, err := sdk.AddBootstrap(cfg, args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
-			logCreated(id)
+			logCreatedCmd(*cmd, id)
 		},
 	},
 	{
@@ -44,7 +44,7 @@ var cmdBootstrap = []cobra.Command{
 				<thing_id> - view config of <thing_id>`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 			pageMetadata := mgxsdk.PageMetadata{
@@ -56,20 +56,20 @@ var cmdBootstrap = []cobra.Command{
 			if args[0] == "all" {
 				l, err := sdk.Bootstraps(pageMetadata, args[1])
 				if err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
-				logJSON(l)
+				logJSONCmd(*cmd, l)
 				return
 			}
 
 			c, err := sdk.ViewBootstrap(args[0], args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
-			logJSON(c)
+			logJSONCmd(*cmd, c)
 		},
 	},
 	{
@@ -82,49 +82,49 @@ var cmdBootstrap = []cobra.Command{
 				certs  <id> <client_cert> <client_key> <ca> - Update bootstrap config certificates.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) < 3 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 			if args[0] == "config" {
 				var cfg mgxsdk.BootstrapConfig
 				if err := json.Unmarshal([]byte(args[0]), &cfg); err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 
 				if err := sdk.UpdateBootstrap(cfg, args[1]); err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 
-				logOK()
+				logOKCmd(*cmd)
 				return
 			}
 			if args[0] == "connection" {
 				var ids []string
 				if err := json.Unmarshal([]byte(args[1]), &ids); err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 				if err := sdk.UpdateBootstrapConnection(args[0], ids, args[2]); err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 
-				logOK()
+				logOKCmd(*cmd)
 				return
 			}
 			if args[0] == "certs" {
 				cfg, err := sdk.UpdateBootstrapCerts(args[0], args[1], args[2], args[3], args[4])
 				if err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 
-				logJSON(cfg)
+				logJSONCmd(*cmd, cfg)
 				return
 			}
-			logUsage(cmd.Use)
+			logUsageCmd(*cmd, cmd.Use)
 		},
 	},
 	{
@@ -133,16 +133,16 @@ var cmdBootstrap = []cobra.Command{
 		Long:  `Removes Config with specified key that belongs to the user identified by the given key`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 
 			if err := sdk.RemoveBootstrap(args[0], args[1]); err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
-			logOK()
+			logOKCmd(*cmd)
 		},
 	},
 	{
@@ -152,26 +152,26 @@ var cmdBootstrap = []cobra.Command{
 				secure - Retrieves a configuration with given external ID and encrypted external key.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) < 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 			if args[0] == "secure" {
 				c, err := sdk.BootstrapSecure(args[1], args[2], args[3])
 				if err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
 
-				logJSON(c)
+				logJSONCmd(*cmd, c)
 				return
 			}
 			c, err := sdk.Bootstrap(args[0], args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
-			logJSON(c)
+			logJSONCmd(*cmd, c)
 		},
 	},
 	{
@@ -180,22 +180,22 @@ var cmdBootstrap = []cobra.Command{
 		Long:  `Whitelist updates thing state config with given id from the authenticated user`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 
 			var cfg mgxsdk.BootstrapConfig
 			if err := json.Unmarshal([]byte(args[0]), &cfg); err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
 			if err := sdk.Whitelist(cfg.ThingID, cfg.State, args[1]); err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
 
-			logOK()
+			logOKCmd(*cmd)
 		},
 	},
 }

diff --git a/cli/certs.go b/cli/certs.go
@@ -14,24 +14,24 @@ var cmdCerts = []cobra.Command{
 		Long:  `Gets a certificate for a given cert ID.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) < 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 			if args[0] == "thing" {
 				cert, err := sdk.ViewCertByThing(args[1], args[2])
 				if err != nil {
-					logError(err)
+					logErrorCmd(*cmd, err)
 					return
 				}
-				logJSON(cert)
+				logJSONCmd(*cmd, cert)
 				return
 			}
 			cert, err := sdk.ViewCert(args[0], args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
-			logJSON(cert)
+			logJSONCmd(*cmd, cert)
 		},
 	},
 	{
@@ -40,15 +40,15 @@ var cmdCerts = []cobra.Command{
 		Long:  `Revokes a certificate for a given thing ID.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 			rtime, err := sdk.RevokeCert(args[0], args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
-			logRevokedTime(rtime)
+			logRevokedTimeCmd(*cmd, rtime)
 		},
 	},
 }
@@ -63,18 +63,18 @@ func NewCertsCmd() *cobra.Command {
 		Long:  `Issues new certificate for a thing`,
 		Run: func(cmd *cobra.Command, args []string) {
 			if len(args) != 2 {
-				logUsage(cmd.Use)
+				logUsageCmd(*cmd, cmd.Use)
 				return
 			}
 
 			thingID := args[0]
 
 			c, err := sdk.IssueCert(thingID, ttl, args[1])
 			if err != nil {
-				logError(err)
+				logErrorCmd(*cmd, err)
 				return
 			}
-			logJSON(c)
+			logJSONCmd(*cmd, c)
 		},
 	}