feat: get and delete cmds

Author: Paola Nicosia

internal/clioptions/clioptions.go

@@ -79,6 +79,8 @@ type CLIOptions struct {
 	MarketplaceItemObjectID     string
 	MarketplaceFetchPublicItems bool
 
+	ItemTypeDefinitionName string
+
 	FromCronJob string
 
 	FollowLogs bool
@@ -262,6 +264,12 @@ func (o *CLIOptions) AddMarketplaceVersionFlag(flags *pflag.FlagSet) (flagName s
 	return
 }
 
+func (o *CLIOptions) AddItemTypeDefinitionNameFlag(flags *pflag.FlagSet) (flagName string) {
+	flagName = "name"
+	flags.StringVarP(&o.ItemTypeDefinitionName, flagName, "i", "", "The name of the Item Type Definition")
+	return
+}
+
 func (o *CLIOptions) AddCreateJobFlags(flags *pflag.FlagSet) {
 	flags.StringVar(&o.FromCronJob, "from", "", "name of the cronjob to create a Job from")
 }

internal/cmd/catalog/get.go

@@ -36,7 +36,7 @@ const (
 
 	This command works with Mia-Platform Console v14.0.0 or later.
 
-	You need to specify the companyId, itemId and version, via the respective flags. The company-id flag can be omitted if it is already set in the context.
+	You need to specify the itemId, via the respective flag. The company-id flag can be omitted if it is already set in the context.
 	`
 	cmdGetUse = "get { --item-id item-id --version version }"
 )

internal/cmd/item-type-definition.go

@@ -35,9 +35,8 @@ func ItemTypeDefinitionCmd(options *clioptions.CLIOptions) *cobra.Command {
 
 	// add sub commands
 	cmd.AddCommand(itd.ListCmd(options))
-	// TODO
-	// cmd.AddCommand(itd.GetCmd(options))
-	// cmd.AddCommand(itd.DeleteCmd(options))
+	cmd.AddCommand(itd.GetCmd(options))
+	cmd.AddCommand(itd.DeleteCmd(options))
 	// cmd.AddCommand(itd.ApplyCmd(options))
 
 	return cmd

internal/cmd/item-type-definition/delete.go

@@ -0,0 +1,113 @@
+// Copyright Mia srl
+// SPDX-License-Identifier: Apache-2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package itd
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+
+	"github.com/mia-platform/miactl/internal/client"
+	"github.com/mia-platform/miactl/internal/clioptions"
+	"github.com/mia-platform/miactl/internal/resources/catalog"
+	"github.com/mia-platform/miactl/internal/resources/marketplace"
+	"github.com/mia-platform/miactl/internal/util"
+	"github.com/spf13/cobra"
+)
+
+var (
+	ErrServerDeleteItem     = errors.New("server error while deleting item type definition")
+	ErrUnexpectedDeleteItem = errors.New("unexpected response while deleting item")
+)
+
+const (
+	deleteItdEndpoint = "/api/tenants/%s/marketplace/item-type-definitions/%s/"
+
+	cmdDeleteLongDescription = `Delete an Item Type Definition. It works with Mia-Platform Console v14.1.0 or later.
+
+	You need to specify the companyId and the item type definition name via the respective flags (recommended). The company-id flag can be omitted if it is already set in the context.
+	`
+	cmdUse = "delete { --name name --version version }"
+)
+
+func DeleteCmd(options *clioptions.CLIOptions) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:        cmdUse,
+		Short:      "Delete a Catalog item",
+		Long:       cmdDeleteLongDescription,
+		SuggestFor: []string{"rm"},
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			restConfig, err := options.ToRESTConfig()
+			cobra.CheckErr(err)
+			client, err := client.APIClientForConfig(restConfig)
+			cobra.CheckErr(err)
+
+			canUseNewAPI, versionError := util.VersionCheck(cmd.Context(), client, 14, 0)
+			if !canUseNewAPI || versionError != nil {
+				return catalog.ErrUnsupportedCompanyVersion
+			}
+
+			companyID := restConfig.CompanyID
+			if len(companyID) == 0 {
+				return marketplace.ErrMissingCompanyID
+			}
+
+			if options.MarketplaceItemVersion != "" && options.MarketplaceItemID != "" {
+				err = deleteITD(
+					cmd.Context(),
+					client,
+					companyID,
+					options.ItemTypeDefinitionName,
+				)
+				cobra.CheckErr(err)
+				return nil
+			}
+
+			return errors.New("invalid input parameters")
+		},
+	}
+
+	ITDFlagName := options.AddItemTypeDefinitionNameFlag(cmd.Flags())
+
+	cmd.MarkFlagRequired(ITDFlagName)
+
+	return cmd
+}
+
+func deleteITD(ctx context.Context, client *client.APIClient, companyID, name string) error {
+	resp, err := client.
+		Delete().
+		APIPath(fmt.Sprintf(deleteItdEndpoint, companyID, name)).
+		Do(ctx)
+
+	if err != nil {
+		return fmt.Errorf("error executing request: %w", err)
+	}
+
+	switch resp.StatusCode() {
+	case http.StatusNoContent:
+		fmt.Println("item deleted successfully")
+		return nil
+	case http.StatusNotFound:
+		return marketplace.ErrItemNotFound
+	default:
+		if resp.StatusCode() >= http.StatusInternalServerError {
+			return ErrServerDeleteItem
+		}
+		return fmt.Errorf("%w: %d", ErrUnexpectedDeleteItem, resp.StatusCode())
+	}
+}

internal/cmd/item-type-definition/delete_test.go

@@ -0,0 +1,165 @@
+// Copyright Mia srl
+// SPDX-License-Identifier: Apache-2.0
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package itd
+
+import (
+	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/mia-platform/miactl/internal/client"
+	"github.com/mia-platform/miactl/internal/clioptions"
+	itd "github.com/mia-platform/miactl/internal/resources/item-type-definition"
+	"github.com/mia-platform/miactl/internal/resources/marketplace"
+	"github.com/stretchr/testify/require"
+)
+
+const (
+	mockDeleteCompanyID = "company-id"
+)
+
+func TestDeleteResourceCmd(t *testing.T) {
+	t.Run("test command creation", func(t *testing.T) {
+		opts := clioptions.NewCLIOptions()
+		cmd := DeleteCmd(opts)
+		require.NotNil(t, cmd)
+	})
+
+	t.Run("should not run command when Console version is lower than 14.0.0", func(t *testing.T) {
+		server := httptest.NewServer(unexecutedCmdMockServer(t))
+		defer server.Close()
+
+		opts := clioptions.NewCLIOptions()
+		opts.CompanyID = mockDeleteCompanyID
+		opts.Endpoint = server.URL
+
+		cmd := DeleteCmd(opts)
+		cmd.SetArgs([]string{"delete", "--item-id", "some-item-id", "--version", "1.0.0"})
+
+		err := cmd.Execute()
+		require.ErrorIs(t, err, itd.ErrUnsupportedCompanyVersion)
+	})
+}
+
+func deleteByItemIDAndVersionMockServer(t *testing.T,
+	statusCode int,
+	mockName string,
+	callsCount *int,
+) *httptest.Server {
+	t.Helper()
+	return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		require.Equal(t,
+			fmt.Sprintf(deleteItdEndpoint, mockDeleteCompanyID, mockName),
+			r.RequestURI,
+		)
+		require.Equal(t, http.MethodDelete, r.Method)
+		w.WriteHeader(statusCode)
+		if statusCode != http.StatusNoContent {
+			w.Write([]byte(`
+			{
+				"message": "some error message"
+			}
+			`))
+		}
+		*callsCount++
+	}))
+}
+
+func TestDeleteItemByItemIDAndVersion(t *testing.T) {
+	mockClientConfig := &client.Config{
+		Transport: http.DefaultTransport,
+	}
+	testCases := []struct {
+		testName string
+
+		statusCode int
+
+		name string
+
+		expectedErr   error
+		expectedCalls int
+	}{
+		{
+			testName:   "should not return error if deletion is successful",
+			statusCode: http.StatusNoContent,
+			name:       "plugin",
+
+			expectedErr:   nil,
+			expectedCalls: 1,
+		},
+		{
+			testName: "should return not found error in case the item is not found",
+			name:     "plugin",
+
+			statusCode: http.StatusNotFound,
+
+			expectedErr:   marketplace.ErrItemNotFound,
+			expectedCalls: 1,
+		},
+		{
+			testName: "should return generic error in case the server responds 500",
+			name:     "plugin",
+
+			statusCode: http.StatusInternalServerError,
+
+			expectedErr:   ErrServerDeleteItem,
+			expectedCalls: 1,
+		},
+		{
+			testName: "should return unexpected response error in case of bad request response",
+			name:     "plugin",
+
+			statusCode: http.StatusBadRequest,
+
+			expectedErr:   ErrUnexpectedDeleteItem,
+			expectedCalls: 1,
+		},
+	}
+
+	for _, tt := range testCases {
+		t.Run(tt.testName, func(t *testing.T) {
+			callsCount := new(int)
+			*callsCount = 0
+			testServer := deleteByItemIDAndVersionMockServer(
+				t,
+				tt.statusCode,
+				tt.name,
+				callsCount,
+			)
+			defer testServer.Close()
+
+			mockClientConfig.Host = testServer.URL
+			client, err := client.APIClientForConfig(mockClientConfig)
+			require.NoError(t, err)
+
+			err = deleteITD(
+				t.Context(),
+				client,
+				mockDeleteCompanyID,
+				tt.name,
+			)
+
+			require.Equal(t, tt.expectedCalls, *callsCount, "did not match number of calls")
+
+			if tt.expectedErr != nil {
+				require.ErrorIs(t, err, tt.expectedErr)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}