feat: add get item type definition list command

Author: Paola Nicosia

internal/cmd/item-type-definition.go

@@ -0,0 +1,44 @@
+// 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 cmd
+
+import (
+	"github.com/mia-platform/miactl/internal/clioptions"
+	itd "github.com/mia-platform/miactl/internal/cmd/item-type-definition"
+	"github.com/spf13/cobra"
+)
+
+func ItemTypeDefinitionCmd(options *clioptions.CLIOptions) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "catalog",
+		Short: "View and manage Catalog items. This command is available from Mia-Platform Console v14.1.0.",
+	}
+
+	// add cmd flags
+	flags := cmd.PersistentFlags()
+	options.AddConnectionFlags(flags)
+	options.AddCompanyFlags(flags)
+	options.AddContextFlags(flags)
+
+	// add sub commands
+	cmd.AddCommand(itd.ListCmd(options))
+	// TODO
+	// cmd.AddCommand(itd.GetCmd(options))
+	// cmd.AddCommand(itd.DeleteCmd(options))
+	// cmd.AddCommand(itd.ApplyCmd(options))
+
+	return cmd
+}

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

@@ -0,0 +1,171 @@
+// 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"
+	"fmt"
+	"strconv"
+
+	"github.com/mia-platform/miactl/internal/client"
+	"github.com/mia-platform/miactl/internal/clioptions"
+	"github.com/mia-platform/miactl/internal/printer"
+	itd "github.com/mia-platform/miactl/internal/resources/item-type-definition"
+	"github.com/mia-platform/miactl/internal/util"
+	"github.com/spf13/cobra"
+)
+
+type GetItdsOptions struct {
+	CompanyID string
+	Public    bool
+}
+
+const (
+	listItdEndpoint = "/api/marketplace/item-type-definitions/"
+	listCmdLong     = `List Item Type Definitions
+
+    This command lists the Item Type Definitions of a company. It works with Mia-Platform Console v14.1.0 or later.
+
+    you can also specify the following flags:
+    - --public - if this flag is set, the command fetches not only the items from the requested company, but also the public Catalog items from other companies.
+    `
+	listCmdUse = "list --company-id company-id"
+)
+
+func ListCmd(options *clioptions.CLIOptions) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   listCmdUse,
+		Short: "List item type definitions",
+		Long:  listCmdLong,
+		RunE:  runListCmd(options),
+	}
+
+	options.AddPublicFlag(cmd.Flags())
+
+	return cmd
+}
+
+func runListCmd(options *clioptions.CLIOptions) func(cmd *cobra.Command, args []string) error {
+	return func(cmd *cobra.Command, _ []string) error {
+		restConfig, err := options.ToRESTConfig()
+		cobra.CheckErr(err)
+		apiClient, err := client.APIClientForConfig(restConfig)
+		cobra.CheckErr(err)
+
+		canUseNewAPI, versionError := util.VersionCheck(cmd.Context(), apiClient, 14, 1)
+		if !canUseNewAPI || versionError != nil {
+			return itd.ErrUnsupportedCompanyVersion
+		}
+
+		marketplaceItemsOptions := GetItdsOptions{
+			CompanyID: restConfig.CompanyID,
+			Public:    options.MarketplaceFetchPublicItems,
+		}
+
+		err = PrintItds(cmd.Context(), apiClient, marketplaceItemsOptions, options.Printer(), listItdEndpoint)
+		cobra.CheckErr(err)
+
+		return nil
+	}
+}
+
+func PrintItds(context context.Context, client *client.APIClient, options GetItdsOptions, p printer.IPrinter, endpoint string) error {
+	itds, err := fetchItds(context, client, options, endpoint)
+	if err != nil {
+		return err
+	}
+
+	p.Keys("Name", "Display Name", "Visibility", "Publisher", "Versioning Supported")
+	for _, itd := range itds {
+		publisher := itd.Metadata.Publisher.Name
+		if publisher == "" {
+			publisher = "-"
+		}
+
+		p.Record(
+			itd.Metadata.Name,
+			itd.Metadata.DisplayName,
+			itd.Metadata.Visibility.Scope,
+			publisher,
+			strconv.FormatBool(itd.Spec.IsVersioningSupported),
+		)
+	}
+	p.Print()
+	return nil
+}
+
+func fetchItds(ctx context.Context, client *client.APIClient, options GetItdsOptions, endpoint string) ([]*itd.ItemTypeDefinition, error) {
+	err := validateOptions(options)
+	if err != nil {
+		return nil, err
+	}
+
+	request := buildRequest(client, options, endpoint)
+	resp, err := executeRequest(ctx, request)
+	if err != nil {
+		return nil, err
+	}
+
+	marketplaceItems, err := parseResponse(resp)
+	if err != nil {
+		return nil, err
+	}
+
+	return marketplaceItems, nil
+}
+
+func validateOptions(options GetItdsOptions) error {
+	requestedSpecificCompany := len(options.CompanyID) > 0
+
+	if !requestedSpecificCompany {
+		return itd.ErrMissingCompanyID
+	}
+
+	return nil
+}
+
+func buildRequest(client *client.APIClient, options GetItdsOptions, endpoint string) *client.Request {
+	request := client.Get().APIPath(endpoint)
+	switch {
+	case options.Public:
+		request.SetParam("visibility", "console"+","+options.CompanyID)
+	case !options.Public:
+		request.SetParam("visibility", options.CompanyID)
+	}
+
+	return request
+}
+
+func executeRequest(ctx context.Context, request *client.Request) (*client.Response, error) {
+	resp, err := request.Do(ctx)
+	if err != nil {
+		return nil, fmt.Errorf("error executing request: %w", err)
+	}
+	if err := resp.Error(); err != nil {
+		return nil, err
+	}
+
+	return resp, nil
+}
+
+func parseResponse(resp *client.Response) ([]*itd.ItemTypeDefinition, error) {
+	marketplaceItems := make([]*itd.ItemTypeDefinition, 0)
+	if err := resp.ParseResponse(&marketplaceItems); err != nil {
+		return nil, fmt.Errorf("error parsing response body: %w", err)
+	}
+
+	return marketplaceItems, nil
+}