STAC-23211: Accept specific stackpack version during provisioning

Author: aacevedoosorio

cmd/stackpack/stackpack_install.go

@@ -16,6 +16,7 @@ import (
 type InstallArgs struct {
 	Name             string
 	UnlockedStrategy string
+	Version          string
 	Params           map[string]string
 	Wait             bool
 	Timeout          time.Duration
@@ -33,7 +34,10 @@ func StackpackInstallCommand(cli *di.Deps) *cobra.Command {
 sts stackpack install --name example -p "full_name=First Last" -p URL=https://stackstate.com
 
 # install and wait for completion
-sts stackpack install --name kubernetes -p cluster_name=production --wait`,
+sts stackpack install --name kubernetes -p cluster_name=production --wait
+
+# install a specific (older) version, e.g. to downgrade
+sts stackpack install --name example --stackpack-version 1.2.3 -p "full_name=First Last"`,
 		RunE: cli.CmdRunEWithApi(RunStackpackInstallCommand(args)),
 	}
 	common.AddRequiredNameFlagVar(cmd, &args.Name, "Name of the StackPack")
@@ -44,6 +48,7 @@ sts stackpack install --name kubernetes -p cluster_name=production --wait`,
 		"Strategy use to upgrade StackPack instance"+
 			fmt.Sprintf(" (must be { %s })", strings.Join(UnlockedStrategyChoices, " | ")),
 	)
+	cmd.Flags().StringVar(&args.Version, StackpackVersionFlag, "", "Install a specific version of the StackPack (for downgrade). The StackPack must not already be installed at a different version.")
 	cmd.Flags().StringToStringVarP(&args.Params, ParameterFlag, "p", args.Params, "List of parameters of the form \"key=value\"")
 	cmd.Flags().BoolVar(&args.Wait, "wait", false, "Wait for installation to complete")
 	cmd.Flags().DurationVar(&args.Timeout, "timeout", DefaultTimeout, "Timeout for waiting")
@@ -57,7 +62,11 @@ func RunStackpackInstallCommand(args *InstallArgs) di.CmdWithApiFn {
 		api *stackstate_api.APIClient,
 		serverInfo *stackstate_api.ServerInfo,
 	) common.CLIError {
-		instance, resp, err := api.StackpackApi.ProvisionDetails(cli.Context, args.Name).RequestBody(args.Params).Unlocked(args.UnlockedStrategy).Execute()
+		apiRequest := api.StackpackApi.ProvisionDetails(cli.Context, args.Name).RequestBody(args.Params).Unlocked(args.UnlockedStrategy)
+		if args.Version != "" {
+			apiRequest = apiRequest.Version(args.Version)
+		}
+		instance, resp, err := apiRequest.Execute()
 		if err != nil {
 			return common.NewResponseError(err, resp)
 		}

cmd/stackpack/stackpack_install_test.go

@@ -112,6 +112,34 @@ func TestStackpackInstallNoParameters(t *testing.T) {
 	)
 }
 
+func TestStackpackInstallWithVersion(t *testing.T) {
+	cli, cmd := setupStackPackInstallCmd(t)
+
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "install", "--name", "zabbix",
+		"--stackpack-version", "3.2.0",
+	)
+
+	strategyFlag := FailStrategy
+	versionFlag := "3.2.0"
+	assert.Equal(t,
+		stackstate_api.ProvisionDetailsCall{
+			PstackPackName: "zabbix",
+			Punlocked:      &strategyFlag,
+			Pversion:       &versionFlag,
+			PrequestBody:   &map[string]string{},
+		},
+		(*cli.MockClient.ApiMocks.StackpackApi.ProvisionDetailsCalls)[0],
+	)
+}
+
+func TestStackpackInstallWithoutVersion(t *testing.T) {
+	cli, cmd := setupStackPackInstallCmd(t)
+
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "install", "--name", "zabbix")
+
+	assert.Nil(t, (*cli.MockClient.ApiMocks.StackpackApi.ProvisionDetailsCalls)[0].Pversion)
+}
+
 func TestStackpackInstallPrintsToJson(t *testing.T) {
 	cli, cmd := setupStackPackInstallCmd(t)
 

generated/stackstate_api/api/openapi.yaml

@@ -413,6 +413,14 @@ paths:
         required: true
         schema:
           type: string
+      - description: "Optional version string (e.g. '1.2.3'). If not provided, the\
+          \ latest version is used. When provisioning, the StackPack cannot already\
+          \ be installed at a different version."
+        in: query
+        name: version
+        required: false
+        schema:
+          type: string
       requestBody:
         content:
           application/json:
@@ -14857,7 +14865,7 @@ components:
       properties:
         _type:
           enum:
-          - ErrorPresentationComponentLink
+          - ErrorComponentPresentationLink
           type: string
         linkId:
           description: Identity key for this link.
@@ -20781,7 +20789,6 @@ components:
             $ref: '#/components/schemas/PresentationHighlightMetricsSection'
           type: array
       required:
-      - fields
       - title
       type: object
     PresentationHighlightField:

generated/stackstate_api/api_stackpack.go

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Title** | **string** |  | 
-**Fields** | [**[]PresentationHighlightField**](PresentationHighlightField.md) |  | 
+**Fields** | Pointer to [**[]PresentationHighlightField**](PresentationHighlightField.md) |  | [optional] 
 **Provisioning** | Pointer to [**PresentationHighlightProvisioning**](PresentationHighlightProvisioning.md) |  | [optional] 
 **RelatedResources** | Pointer to [**[]PresentationRelatedResource**](PresentationRelatedResource.md) |  | [optional] 
 **Links** | Pointer to [**[]PresentationLink**](PresentationLink.md) |  | [optional] 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 
 ### NewPresentationHighlight
 
-`func NewPresentationHighlight(title string, fields []PresentationHighlightField, ) *PresentationHighlight`
+`func NewPresentationHighlight(title string, ) *PresentationHighlight`
 
 NewPresentationHighlight instantiates a new PresentationHighlight object
 This constructor will assign default values to properties that have it defined,
@@ -70,6 +70,11 @@ and a boolean to check if the value has been set.
 
 SetFields sets Fields field to given value.
 
+### HasFields
+
+`func (o *PresentationHighlight) HasFields() bool`
+
+HasFields returns a boolean if a field has been set.
 
 ### GetProvisioning
 

generated/stackstate_api/docs/PresentationHighlight.md

@@ -92,7 +92,7 @@ Name | Type | Description  | Notes
 
 ## ProvisionDetails
 
-> ProvisionResponse ProvisionDetails(ctx, stackPackName).Unlocked(unlocked).RequestBody(requestBody).Execute()
+> ProvisionResponse ProvisionDetails(ctx, stackPackName).Unlocked(unlocked).Version(version).RequestBody(requestBody).Execute()
 
 Provision API
 
@@ -113,11 +113,12 @@ import (
 func main() {
     stackPackName := "stackPackName_example" // string | 
     unlocked := "unlocked_example" // string | 
+    version := "version_example" // string | Optional version string (e.g. '1.2.3'). If not provided, the latest version is used. When provisioning, the StackPack cannot already be installed at a different version. (optional)
     requestBody := map[string]string{"key": "Inner_example"} // map[string]string |  (optional)
 
     configuration := openapiclient.NewConfiguration()
     apiClient := openapiclient.NewAPIClient(configuration)
-    resp, r, err := apiClient.StackpackApi.ProvisionDetails(context.Background(), stackPackName).Unlocked(unlocked).RequestBody(requestBody).Execute()
+    resp, r, err := apiClient.StackpackApi.ProvisionDetails(context.Background(), stackPackName).Unlocked(unlocked).Version(version).RequestBody(requestBody).Execute()
     if err != nil {
         fmt.Fprintf(os.Stderr, "Error when calling `StackpackApi.ProvisionDetails``: %v\n", err)
         fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
@@ -144,6 +145,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 
  **unlocked** | **string** |  | 
+ **version** | **string** | Optional version string (e.g. '1.2.3'). If not provided, the latest version is used. When provisioning, the StackPack cannot already be installed at a different version. | 
  **requestBody** | **map[string]string** |  | 
 
 ### Return type

generated/stackstate_api/docs/StackpackApi.md

@@ -1 +1 @@
-9c9f7edc3fc4bf1b8f62092b80f6ed50fcd8be2e
+3889f3a46f6a2405349b35221fb60aad09eafe14