feat(body): added additional attribute '--body' to dsv secret create & dsv home c…

commands/home.go

@@ -67,12 +67,14 @@ Usage:
    • %[2]s %[1]s %[4]s %[5]s
    • %[2]s %[1]s --path %[4]s --data %[5]s
    • %[2]s %[1]s --path %[4]s --data %[6]s
-`, cst.Create, cst.NounHome, cst.ProductName, cst.ExamplePath, cst.ExampleDataJSON, cst.ExampleDataPath),
+   • %[2]s %[1]s --path %[4]s --body %[7]s
+`, cst.Create, cst.NounHome, cst.ProductName, cst.ExamplePath, cst.ExampleDataJSON, cst.ExampleDataPath, cst.ExampleBodyDataJSON),
 		FlagsPredictor: []*predictor.Params{
 			{Name: cst.Data, Shorthand: "d", Usage: fmt.Sprintf("%s to be stored in a %s. Prefix with '@' to denote filepath (required)", strings.Title(cst.Data), cst.NounSecret), Predictor: predictor.NewPrefixFilePredictor("*")},
 			{Name: cst.Path, Shorthand: "r", Usage: fmt.Sprintf("Target %s to a %s (required)", cst.Path, cst.NounSecret), Predictor: predictor.NewSecretPathPredictorDefault()},
 			{Name: cst.DataDescription, Usage: fmt.Sprintf("Description of a %s", cst.NounSecret)},
 			{Name: cst.DataAttributes, Usage: fmt.Sprintf("Attributes of a %s", cst.NounSecret)},
+			{Name: cst.Body, Usage: fmt.Sprintf("%s, attributes and/or description of a %s. (See 'usage' above). Data will take precedence over body.", strings.Title(cst.Data), cst.NounSecret)},
 		},
 		MinNumberArgs: 2,
 		RunFunc:       handleHomeCreate,

commands/secret.go

@@ -242,12 +242,14 @@
    • secret %[1]s %[4]s --data %[5]s
    • secret %[1]s --path %[4]s --data %[5]s
    • secret %[1]s --path %[4]s --data %[6]s
-`, cst.Create, cst.NounSecret, cst.ProductName, cst.ExamplePath, cst.ExampleDataJSON, cst.ExampleDataPath),
+   • secret %[1]s --path %[4]s --body %[7]s
+`, cst.Create, cst.NounSecret, cst.ProductName, cst.ExamplePath, cst.ExampleDataJSON, cst.ExampleDataPath, cst.ExampleBodyDataJSON),
 		FlagsPredictor: []*predictor.Params{
 			{Name: cst.Data, Shorthand: "d", Usage: fmt.Sprintf("%s to be stored in a %s. Prefix with '@' to denote filepath (required)", strings.Title(cst.Data), cst.NounSecret), Predictor: predictor.NewPrefixFilePredictor("*")},
 			{Name: cst.Path, Shorthand: "r", Usage: fmt.Sprintf("Target %s to a %s (required)", cst.Path, cst.NounSecret), Predictor: predictor.NewSecretPathPredictorDefault()},
 			{Name: cst.DataDescription, Usage: fmt.Sprintf("Description of a %s", cst.NounSecret)},
 			{Name: cst.DataAttributes, Usage: fmt.Sprintf("Attributes of a %s", cst.NounSecret)},
+			{Name: cst.Body, Usage: fmt.Sprintf("%s, attributes and/or description of a %s. (See 'usage' above). Data will take precedence over body.", strings.Title(cst.Data), cst.NounSecret)},
 		},
 		RunFunc: func(vcli vaultcli.CLI, args []string) int {
 			return handleSecretUpsertCmd(vcli, cst.NounSecret, cst.Create, args)
@@ -485,6 +487,7 @@
 	data := viper.GetString(cst.Data)
 	desc := viper.GetString(cst.DataDescription)
 	attributes := viper.GetStringMap(cst.DataAttributes)
+	body := viper.GetString(cst.Body)
 
 	if path == "" {
 		path = id
@@ -510,20 +513,34 @@
 		return utils.GetExecStatus(err)
 	}
 
-	if data == "" && desc == "" && len(attributes) == 0 {
-		vcli.Out().FailF("Please provide a properly formed value for at least --%s, or --%s, or --%s.",
-			cst.Data, cst.DataDescription, cst.DataAttributes)
+	if data == "" && desc == "" && len(attributes) == 0 && body == "" {
+		vcli.Out().FailF("Please provide a properly formed value for at least --%s, or --%s, or --%s, or --%s.",
+			cst.Data, cst.DataDescription, cst.DataAttributes, cst.Body)
 		return 1
 	}
 
 	dataMap := make(map[string]interface{})
-	if data != "" {
+	bodyMap := make(map[string]interface{})
+	/*Only process --body attribute if all 3 of the other attributes are empty*/
+	if body != "" && data == "" && desc == "" && len(attributes) == 0 {
+		parseErr := json.Unmarshal([]byte(body), &bodyMap)
+		if parseErr != nil {
+			vcli.Out().FailF("Failed to parse passed in secret body: %v", parseErr)
+			return 1
+		}
+		dataMap, _ = bodyMap["data"].(map[string]interface{})
+		desc, _ = bodyMap["desc"].(string)
+		attributes, _ = bodyMap["attributes"].(map[string]any)
+	}
+
+	if data != "" && len(dataMap) == 0 {
 		parseErr := json.Unmarshal([]byte(data), &dataMap)
 		if parseErr != nil {
 			vcli.Out().FailF("Failed to parse passed in secret data: %v", parseErr)
 			return 1
 		}
 	}
+
 	postData := secretUpsertBody{
 		Data:        dataMap,
 		Description: desc,

commands/secret_test.go

@@ -609,6 +609,22 @@ func TestHandleSecretUpsertCmd(t *testing.T) {
 			method:      "create",
 			expectedErr: nil,
 		},
+		{
+			name:        "Happy path --body POST",
+			fDesc:       "new description",
+			args:        []string{"mySecret", "--body", "{\"data\":{\"key\":\"value\"}}"},
+			out:         []byte(`test`),
+			method:      "create",
+			expectedErr: nil,
+		},
+		{
+			name:        "Happy path --data & --body POST",
+			fDesc:       "new description",
+			args:        []string{"mySecret", "--data", "{\"key\":\"value\"}", "--body", "{\"data\":{\"key1\":\"value1\"}}"},
+			out:         []byte(`test`),
+			method:      "create",
+			expectedErr: nil,
+		},
 		{
 			name:        "Happy path PUT (ID)",
 			fDesc:       "new description",
@@ -634,6 +650,22 @@ func TestHandleSecretUpsertCmd(t *testing.T) {
 			method:      "update",
 			expectedErr: nil,
 		},
+		{
+			name:        "Incorrect attributes in --body POST",
+			fDesc:       "new description",
+			args:        []string{"mySecret", "--body", "{\"datas\":{\"Key\":\"Values\"},\"attribute\":{\"Key2\":\"Value2\"},\"descs\":\"Secret description\"}"},
+			out:         []byte(`test`),
+			method:      "create",
+			expectedErr: errors.NewS("message: need at least one: either data, description, or attributes"),
+		},
+		{
+			name:        "No data in --data option && Incorrect attributes in --body POST",
+			fDesc:       "new description",
+			args:        []string{"mySecret", "--data", "{}", "--body", "{\"datas\":{\"key\":\"value\"}}"},
+			out:         []byte(`test`),
+			method:      "create",
+			expectedErr: errors.NewS("message: need at least one: either data, description, or attributes"),
+		},
 		{
 			name:        "no path",
 			args:        []string{"--description", "new description"},

constants/commands.go

@@ -88,6 +88,7 @@ const (
 	Value                   = "value"
 	Profile                 = "profile"
 	Path                    = "path"
+	Body                    = "body"
 	ID                      = "id"
 	Data                    = "data"
 	Username                = "auth.username"

constants/doc.go

@@ -11,6 +11,7 @@ const (
 	ExampleRoleName         = "gcp-svc-1"
 	ExampleDataJSON         = `'{"Key":"Value","Key2":"Value2"}'`
 	ExampleDataPath         = "@/tmp/data.json"
+	ExampleBodyDataJSON     = `'{"data":{"Key":"Value"},"attributes":{"Key2":"Value2"},"desc":"Secret description"}'`
 	ExampleConfigPath       = "@/tmp/config.yml"
 	ExampleUser             = "kadmin"
 	ExampleSIEM             = "LogsInc"

format/writers.go

@@ -32,7 +32,7 @@
 }
 
 func (w fileWriter) Write(p []byte) (n int, err error) {
-	err = os.WriteFile(w.filePath, p, 0664)
+	err = os.WriteFile(w.filePath, p, 0o664)
 	if err == nil {
 		n = len(p)
 	}

tests/e2e/cmd_init_test.go

@@ -18,9 +18,7 @@ func TestInitWithNoConfig(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	defer func() { deleteFile(t, config) }()
 
@@ -76,9 +74,7 @@ func TestInitWithExistingConfig(t *testing.T) {
 		profileName = "automation"
 		cacheAge    = "5"
 	)
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	createFile(t, config)
 	defer func() { deleteFile(t, config) }()
@@ -155,9 +151,7 @@ func TestInitOverwriteExistingConfig(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	createFile(t, config)
 	defer func() { deleteFile(t, config) }()
@@ -218,9 +212,7 @@ func TestInitAuthFails(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	createFile(t, config)
 	defer func() { deleteFile(t, config) }()
@@ -271,9 +263,7 @@ func TestInitAWSInvalid(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	createFile(t, config)
 	defer func() { deleteFile(t, config) }()
@@ -323,9 +313,7 @@ func TestInitClientCredsInvalid(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	createFile(t, config)
 	defer func() { deleteFile(t, config) }()
@@ -376,9 +364,7 @@ func TestInitProfileExists(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	defer func() { deleteFile(t, config) }()
 
@@ -427,9 +413,7 @@ func TestInitWrongStoreType(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	cmd := []string{
 		"init", fmt.Sprintf("--dev=%s", e.domain), fmt.Sprintf("--config=%s", config),
@@ -456,9 +440,7 @@ func TestInitWithNoStore(t *testing.T) {
 	}
 	e := newEnv()
 
-	var (
-		config = filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
-	)
+	config := filepath.Join(e.tmpDirPath, "e2e-configuration.yml")
 
 	defer func() { deleteFile(t, config) }()
 

utils/env.go

@@ -12,8 +12,10 @@
 }
 type envProvider struct{}
 
-var GetEnvProviderFunc func() EnvProvider
-var e EnvProvider
+var (
+	GetEnvProviderFunc func() EnvProvider
+	e                  EnvProvider
+)
 
 func NewEnvProvider() EnvProvider {
 	return &envProvider{}

utils/time.go

@@ -12,7 +12,7 @@ func ParseHours(s string) (int, error) {
 		return 0, nil
 	}
 
-	var invalidFormatErr = errors.New("invalid time format - submit an integer followed by one of the following: h, H, d, D, w, W")
+	invalidFormatErr := errors.New("invalid time format - submit an integer followed by one of the following: h, H, d, D, w, W")
 	units := []string{"h", "H", "d", "D", "w", "W"}
 	n, unit := s[:len(s)-1], string(s[len(s)-1])