added optional --message flag

Author: Daniele Marostica

internal/clioptions/clioptions.go

@@ -89,6 +89,8 @@ type CLIOptions struct {
 	ShowServiceAccounts bool
 
 	ResolveExtensionsDetails bool
+
+	Message string
 }
 
 // NewCLIOptions return a new CLIOptions instance

internal/cmd/project/apply.go

@@ -42,6 +42,7 @@ type applyProjectOptions struct {
 	ProjectID    string
 	RevisionName string
 	FilePath     string
+	Title        string
 }
 
 // ApplyCmd returns a cobra command for applying a project configuration
@@ -61,6 +62,7 @@ func ApplyCmd(options *clioptions.CLIOptions) *cobra.Command {
 				RevisionName: options.Revision,
 				ProjectID:    restConfig.ProjectID,
 				FilePath:     options.InputFilePath,
+				Title:        options.Message,
 			}
 
 			return handleApplyProjectConfigurationCmd(cmd.Context(), client, cmdOptions)
@@ -71,6 +73,9 @@ func ApplyCmd(options *clioptions.CLIOptions) *cobra.Command {
 	options.AddProjectFlags(flags)
 	options.AddRevisionFlags(flags)
 
+	flags.StringVarP(&options.Message, "message", "m", "", "the message to use when saving the configuration")
+
+	// file path flag is required
 	flags.StringVarP(&options.InputFilePath, "file", "f", "", "path to JSON/YAML file containing the project configuration")
 	if err := cmd.MarkFlagRequired("file"); err != nil {
 		panic(err)
@@ -126,11 +131,10 @@ func applyConfiguration(ctx context.Context, client *client.APIClient, options a
 		return fmt.Errorf("cannot parse project configuration: %w", err)
 	}
 
-	previousSnapshotID := structuredConfig.Config["commitId"].(string)
-	applyConfig := configuration.ApplyRequest{
-		Configuration: structuredConfig,
-		Title:         "[miactl] Applied project configuration",
-		PreviousSave:  previousSnapshotID,
+	applyConfig := configuration.BuildApplyRequest(structuredConfig)
+
+	if options.Title != "" {
+		applyConfig = applyConfig.WithTitle(options.Title)
 	}
 
 	body, err := resources.EncodeResourceToJSON(applyConfig)

internal/cmd/project/apply_test.go

@@ -232,6 +232,31 @@ func TestApplyProjectCmd(t *testing.T) {
 				return false
 			}),
 		},
+		"with custom title": {
+			options: applyProjectOptions{
+				ProjectID:    "test-project",
+				RevisionName: "test-revision",
+				FilePath:     "testdata/base-config.json",
+				Title:        "apply config custom title",
+			},
+			testServer: applyTestServer(t, func(w http.ResponseWriter, r *http.Request) bool {
+				if r.URL.Path == "/api/backend/projects/test-project/revisions/test-revision/configuration" && r.Method == http.MethodPost {
+					var requestBody map[string]any
+					err := json.NewDecoder(r.Body).Decode(&requestBody)
+					require.NoError(t, err)
+
+					assert.Contains(t, requestBody, "title")
+					assert.Equal(t, "apply config custom title", requestBody["title"])
+
+					w.WriteHeader(http.StatusOK)
+					w.Write([]byte(`{}`))
+
+					return true
+				}
+
+				return false
+			}),
+		},
 	}
 
 	for name, testCase := range testCases {

internal/resources/configuration/applyrequest.go

@@ -15,8 +15,32 @@
 
 package configuration
 
+const (
+	DefaultTitle = "[miactl] Applied project configuration"
+)
+
 type ApplyRequest struct {
 	Title        string `json:"title" yaml:"title"`
 	PreviousSave string `json:"previousSave,omitempty" yaml:"previousSave,omitempty"`
 	*Configuration
 }
+
+func BuildApplyRequest(config *Configuration) *ApplyRequest {
+	req := &ApplyRequest{
+		Configuration: config,
+	}
+
+	return req.
+		withPreviousSnapshotID(config.Config["commitId"].(string)).
+		WithTitle(DefaultTitle)
+}
+
+func (r *ApplyRequest) WithTitle(title string) *ApplyRequest {
+	r.Title = title
+	return r
+}
+
+func (r *ApplyRequest) withPreviousSnapshotID(previousSnapshotID string) *ApplyRequest {
+	r.PreviousSave = previousSnapshotID
+	return r
+}