fix: Standardise schema migration CLI errors (#1682)

## Relevant issue(s)

Resolves #1652

## Description

Standardises `schema migration` CLI errors. And errors if given unknown
lens cfg properties.

Adds integration tests for the commands.

Makefile

@@ -29,7 +29,7 @@ ifdef BUILD_TAGS
 BUILD_FLAGS+=-tags $(BUILD_TAGS)
 endif
 
-TEST_FLAGS=-race -shuffle=on -timeout 70s
+TEST_FLAGS=-race -shuffle=on -timeout 120s
 
 PLAYGROUND_DIRECTORY=playground
 LENS_TEST_DIRECTORY=tests/integration/schema/migrations
@@ -243,6 +243,7 @@ test\:lens:
 
 .PHONY: test\:cli
 test\:cli:
+	@$(MAKE) deps:lens
 	gotestsum --format testname -- ./$(CLI_TEST_DIRECTORY)/... $(TEST_FLAGS)
 
 # Using go-acc to ensure integration tests are included.

cli/errors.go

@@ -10,7 +10,11 @@
 
 package cli
 
-import "github.com/sourcenetwork/defradb/errors"
+import (
+	"strings"
+
+	"github.com/sourcenetwork/defradb/errors"
+)
 
 const (
 	errMissingArg                  string = "missing argument"
@@ -61,8 +65,12 @@ func NewErrMissingArg(name string) error {
 	return errors.New(errMissingArg, errors.NewKV("Name", name))
 }
 
-func NewErrMissingArgs(count int, provided int) error {
-	return errors.New(errMissingArgs, errors.NewKV("Required", count), errors.NewKV("Provided", provided))
+func NewErrMissingArgs(names []string) error {
+	return errors.New(errMissingArgs, errors.NewKV("Required", strings.Join(names, ", ")))
+}
+
+func NewErrTooManyArgs(max, actual int) error {
+	return errors.New(errTooManyArgs, errors.NewKV("Max", max), errors.NewKV("Actual", actual))
 }
 
 func NewFailedToReadFile(inner error) error {

cli/schema_migration_get.go

@@ -36,13 +36,11 @@ Example:
   defradb client schema migration get'
 
 Learn more about the DefraDB GraphQL Schema Language on https://docs.source.network.`,
-		Args: func(cmd *cobra.Command, args []string) error {
+		RunE: func(cmd *cobra.Command, args []string) (err error) {
 			if err := cobra.NoArgs(cmd, args); err != nil {
-				return errors.New("this command take no arguments")
+				return NewErrTooManyArgs(0, len(args))
 			}
-			return nil
-		},
-		RunE: func(cmd *cobra.Command, args []string) (err error) {
+
 			endpoint, err := httpapi.JoinPaths(cfg.API.AddressToURL(), httpapi.SchemaMigrationPath)
 			if err != nil {
 				return errors.Wrap("join paths failed", err)

cli/schema_migration_set.go

@@ -45,16 +45,14 @@ Example: add from stdin:
   cat schema_migration.lens | defradb client schema migration set bae123 bae456 -
 
 Learn more about the DefraDB GraphQL Schema Language on https://docs.source.network.`,
-		Args: func(cmd *cobra.Command, args []string) error {
+		RunE: func(cmd *cobra.Command, args []string) (err error) {
 			if err := cobra.MinimumNArgs(2)(cmd, args); err != nil {
-				return errors.New("must specify src and dst schema versions, as well as a lens cfg")
+				return NewErrMissingArgs([]string{"src", "dst", "cfg"})
 			}
 			if err := cobra.MaximumNArgs(3)(cmd, args); err != nil {
-				return errors.New("must specify src and dst schema versions, as well as a lens cfg")
+				return NewErrTooManyArgs(3, len(args))
 			}
-			return nil
-		},
-		RunE: func(cmd *cobra.Command, args []string) (err error) {
+
 			var lensCfgJson string
 			var srcSchemaVersionID string
 			var dstSchemaVersionID string
@@ -72,7 +70,7 @@ Learn more about the DefraDB GraphQL Schema Language on https://docs.source.netw
 			} else if len(args) == 2 {
 				// If the lensFile flag has not been provided then it must be provided as an arg
 				// and thus len(args) cannot be 2
-				return errors.Wrap("must provide a lens cfg", err)
+				return NewErrMissingArg("cfg")
 			} else if isFileInfoPipe(fi) && args[2] != "-" {
 				log.FeedbackInfo(
 					cmd.Context(),
@@ -98,17 +96,20 @@ Learn more about the DefraDB GraphQL Schema Language on https://docs.source.netw
 			dstSchemaVersionID = args[1]
 
 			if lensCfgJson == "" {
-				return errors.New("empty lens configuration provided")
+				return NewErrMissingArg("cfg")
 			}
 			if srcSchemaVersionID == "" {
-				return errors.New("no source schema version id provided")
+				return NewErrMissingArg("src")
 			}
 			if dstSchemaVersionID == "" {
-				return errors.New("no destination schema version id provided")
+				return NewErrMissingArg("dst")
 			}
 
+			decoder := json.NewDecoder(strings.NewReader(lensCfgJson))
+			decoder.DisallowUnknownFields()
+
 			var lensCfg model.Lens
-			err = json.Unmarshal([]byte(lensCfgJson), &lensCfg)
+			err = decoder.Decode(&lensCfg)
 			if err != nil {
 				return errors.Wrap("invalid lens configuration", err)
 			}

cli/schema_patch.go

@@ -54,7 +54,7 @@ To learn more about the DefraDB GraphQL Schema Language, refer to https://docs.s
 				if err = cmd.Usage(); err != nil {
 					return err
 				}
-				return ErrTooManyArgs
+				return NewErrTooManyArgs(1, len(args))
 			}
 
 			if patchFile != "" {

tests/integration/cli/client_schema_migration_get_test.go

@@ -0,0 +1,110 @@
+// Copyright 2023 Democratized Data Foundation
+//
+// Use of this software is governed by the Business Source License
+// included in the file licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with
+// the Business Source License, use of this software will be governed
+// by the Apache License, Version 2.0, included in the file
+// licenses/APL.txt.
+
+package clitest
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/sourcenetwork/defradb/tests/lenses"
+)
+
+func TestSchemaMigrationGet_GivenOneArg_ShouldReturnError(t *testing.T) {
+	conf := NewDefraNodeDefaultConfig(t)
+	stopDefra := runDefraNode(t, conf)
+
+	_, stderr := runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "get",
+		"notAnArg",
+	})
+	_ = stopDefra()
+
+	assertContainsSubstring(t, stderr, "too many arguments. Max: 0, Actual: 1")
+}
+
+func TestSchemaMigrationGet_GivenNoMigrations_ShouldSucceed(t *testing.T) {
+	conf := NewDefraNodeDefaultConfig(t)
+	stopDefra := runDefraNode(t, conf)
+
+	stdout, _ := runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "get",
+	})
+	_ = stopDefra()
+
+	assertContainsSubstring(t, stdout, `{"data":{"configuration":[]}}`)
+}
+
+func TestSchemaMigrationGet_GivenEmptyMigrationObj_ShouldSucceed(t *testing.T) {
+	conf := NewDefraNodeDefaultConfig(t)
+	stopDefra := runDefraNode(t, conf)
+
+	stdout, _ := runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "set",
+		"bae123", "bae456", "{}",
+	})
+	assertContainsSubstring(t, stdout, "success")
+
+	stdout, _ = runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "get",
+	})
+	_ = stopDefra()
+
+	assertContainsSubstring(t, stdout,
+		`{"data":{"configuration":[{"SourceSchemaVersionID":"bae123","DestinationSchemaVersionID":"bae456","Lenses":null}]}}`,
+	)
+}
+
+func TestSchemaMigrationGet_GivenEmptyMigration_ShouldSucceed(t *testing.T) {
+	conf := NewDefraNodeDefaultConfig(t)
+	stopDefra := runDefraNode(t, conf)
+
+	stdout, _ := runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "set",
+		"bae123", "bae456", `{"lenses": []}`,
+	})
+	assertContainsSubstring(t, stdout, "success")
+
+	stdout, _ = runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "get",
+	})
+	_ = stopDefra()
+
+	assertContainsSubstring(t, stdout,
+		`{"data":{"configuration":[{"SourceSchemaVersionID":"bae123","DestinationSchemaVersionID":"bae456","Lenses":[]}]}}`,
+	)
+}
+
+func TestSchemaMigrationGet_GivenMigration_ShouldSucceed(t *testing.T) {
+	conf := NewDefraNodeDefaultConfig(t)
+	stopDefra := runDefraNode(t, conf)
+
+	stdout, _ := runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "set",
+		"bae123", "bae456",
+		fmt.Sprintf(`{"lenses": [{"path":"%s","arguments":{"dst":"verified","value":true}}]}`, lenses.SetDefaultModulePath),
+	})
+	assertContainsSubstring(t, stdout, "success")
+
+	stdout, _ = runDefraCommand(t, conf, []string{
+		"client", "schema", "migration", "get",
+	})
+	_ = stopDefra()
+
+	assertContainsSubstring(t, stdout,
+		`{"data":{"configuration":[{"SourceSchemaVersionID":"bae123","DestinationSchemaVersionID":"bae456","Lenses":[`+
+			fmt.Sprintf(
+				`{"Path":"%s",`,
+				lenses.SetDefaultModulePath,
+			)+
+			`"Inverse":false,"Arguments":{"dst":"verified","value":true}}`+
+			`]}]}}`,
+	)
+}