feat: add storage-box-type command (#1131)

Adds the CRUD commands `hcloud storage-box-type describe` and `hcloud
storage-box-type list`.

Related to #1117

---------

Co-authored-by: lukasmetzner <[email protected]>

Author: 2 people

docs/reference/manual/hcloud.md

@@ -42,6 +42,7 @@ A command-line interface for Hetzner Cloud
 * [hcloud server](hcloud_server.md)	 - Manage Servers
 * [hcloud server-type](hcloud_server-type.md)	 - View Server Types
 * [hcloud ssh-key](hcloud_ssh-key.md)	 - Manage SSH Keys
+* [hcloud storage-box-type](hcloud_storage-box-type.md)	 - View Storage Box Types
 * [hcloud version](hcloud_version.md)	 - Print version information
 * [hcloud volume](hcloud_volume.md)	 - Manage Volumes
 * [hcloud zone](hcloud_zone.md)	 - [experimental] Manage DNS Zones and Zone RRSets (records)

docs/reference/manual/hcloud_storage-box-type.md

@@ -0,0 +1,29 @@
+## hcloud storage-box-type
+
+View Storage Box Types
+
+### Options
+
+```
+  -h, --help   help for storage-box-type
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              Config file path (default "~/.config/hcloud/cli.toml")
+      --context string             Currently active context
+      --debug                      Enable debug output
+      --debug-file string          File to write debug output to
+      --endpoint string            Hetzner Cloud API endpoint (default "https://api.hetzner.cloud/v1")
+      --hetzner-endpoint string    Hetzner API endpoint (default "https://api.hetzner.com/v1")
+      --no-experimental-warnings   If true, experimental warnings are not shown
+      --poll-interval duration     Interval at which to poll information, for example action progress (default 500ms)
+      --quiet                      If true, only print error messages
+```
+
+### SEE ALSO
+
+* [hcloud](hcloud.md)	 - Hetzner Cloud CLI
+* [hcloud storage-box-type describe](hcloud_storage-box-type_describe.md)	 - Describe a Storage Box Type
+* [hcloud storage-box-type list](hcloud_storage-box-type_list.md)	 - List Storage Box Types

docs/reference/manual/hcloud_storage-box-type_describe.md

@@ -0,0 +1,32 @@
+## hcloud storage-box-type describe
+
+Describe a Storage Box Type
+
+```
+hcloud storage-box-type describe [options] <storage-box-type>
+```
+
+### Options
+
+```
+  -h, --help                 help for describe
+  -o, --output stringArray   output options: json|yaml|format
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              Config file path (default "~/.config/hcloud/cli.toml")
+      --context string             Currently active context
+      --debug                      Enable debug output
+      --debug-file string          File to write debug output to
+      --endpoint string            Hetzner Cloud API endpoint (default "https://api.hetzner.cloud/v1")
+      --hetzner-endpoint string    Hetzner API endpoint (default "https://api.hetzner.com/v1")
+      --no-experimental-warnings   If true, experimental warnings are not shown
+      --poll-interval duration     Interval at which to poll information, for example action progress (default 500ms)
+      --quiet                      If true, only print error messages
+```
+
+### SEE ALSO
+
+* [hcloud storage-box-type](hcloud_storage-box-type.md)	 - View Storage Box Types

docs/reference/manual/hcloud_storage-box-type_list.md

@@ -0,0 +1,50 @@
+## hcloud storage-box-type list
+
+List Storage Box Types
+
+### Synopsis
+
+Displays a list of Storage Box Types.
+
+Output can be controlled with the -o flag. Use -o noheader to suppress the
+table header. Displayed columns and their order can be set with
+-o columns=deprecated,description (see available columns below).
+
+Columns:
+ - deprecated
+ - description
+ - id
+ - name
+ - size
+ - subaccounts_limit
+
+```
+hcloud storage-box-type list [options]
+```
+
+### Options
+
+```
+  -h, --help                 help for list
+  -o, --output stringArray   output options: noheader|columns=...|json|yaml
+  -l, --selector string      Selector to filter by labels
+  -s, --sort strings         Determine the sorting of the result
+```
+
+### Options inherited from parent commands
+
+```
+      --config string              Config file path (default "~/.config/hcloud/cli.toml")
+      --context string             Currently active context
+      --debug                      Enable debug output
+      --debug-file string          File to write debug output to
+      --endpoint string            Hetzner Cloud API endpoint (default "https://api.hetzner.cloud/v1")
+      --hetzner-endpoint string    Hetzner API endpoint (default "https://api.hetzner.com/v1")
+      --no-experimental-warnings   If true, experimental warnings are not shown
+      --poll-interval duration     Interval at which to poll information, for example action progress (default 500ms)
+      --quiet                      If true, only print error messages
+```
+
+### SEE ALSO
+
+* [hcloud storage-box-type](hcloud_storage-box-type.md)	 - View Storage Box Types

internal/cli/root.go

@@ -24,6 +24,7 @@ import (
 	"github.com/hetznercloud/cli/internal/cmd/server"
 	"github.com/hetznercloud/cli/internal/cmd/servertype"
 	"github.com/hetznercloud/cli/internal/cmd/sshkey"
+	"github.com/hetznercloud/cli/internal/cmd/storageboxtype"
 	"github.com/hetznercloud/cli/internal/cmd/util"
 	"github.com/hetznercloud/cli/internal/cmd/version"
 	"github.com/hetznercloud/cli/internal/cmd/volume"
@@ -61,6 +62,7 @@ func NewRootCommand(s state.State) *cobra.Command {
 		firewall.NewCommand(s),
 		placementgroup.NewCommand(s),
 		primaryip.NewCommand(s),
+		storageboxtype.NewCommand(s),
 		zone.NewCommand(s),
 	)
 

internal/cmd/storageboxtype/describe.go

@@ -0,0 +1,71 @@
+package storageboxtype
+
+import (
+	"github.com/dustin/go-humanize"
+	"github.com/spf13/cobra"
+
+	"github.com/hetznercloud/cli/internal/cmd/base"
+	"github.com/hetznercloud/cli/internal/cmd/util"
+	"github.com/hetznercloud/cli/internal/hcapi2"
+	"github.com/hetznercloud/cli/internal/state"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
+)
+
+var DescribeCmd = base.DescribeCmd[*hcloud.StorageBoxType]{
+	ResourceNameSingular: "Storage Box Type",
+	ShortDescription:     "Describe a Storage Box Type",
+	NameSuggestions:      func(c hcapi2.Client) func() []string { return c.StorageBoxType().Names },
+	Fetch: func(s state.State, _ *cobra.Command, idOrName string) (*hcloud.StorageBoxType, any, error) {
+		st, _, err := s.Client().StorageBoxType().Get(s, idOrName)
+		if err != nil {
+			return nil, nil, err
+		}
+		return st, hcloud.SchemaFromStorageBoxType(st), nil
+	},
+	PrintText: func(s state.State, cmd *cobra.Command, storageBoxType *hcloud.StorageBoxType) error {
+		cmd.Printf("ID:\t\t\t\t%d\n", storageBoxType.ID)
+		cmd.Printf("Name:\t\t\t\t%s\n", storageBoxType.Name)
+		cmd.Printf("Description:\t\t\t%s\n", storageBoxType.Description)
+		cmd.Printf("Size:\t\t\t\t%s\n", humanize.IBytes(uint64(storageBoxType.Size)))
+		cmd.Printf("Snapshot Limit:\t\t\t%d\n", storageBoxType.SnapshotLimit)
+		cmd.Printf("Automatic Snapshot Limit:\t%d\n", storageBoxType.AutomaticSnapshotLimit)
+		cmd.Printf("Subaccounts Limit:\t\t%d\n", storageBoxType.SubaccountsLimit)
+		cmd.Print(util.DescribeDeprecation(storageBoxType))
+
+		err := loadCurrencyFromAPI(s, storageBoxType)
+		if err != nil {
+			cmd.PrintErrf("failed to get currency for Storage Box Type prices: %v", err)
+		}
+
+		cmd.Printf("Pricings per Location:\n")
+		for _, price := range storageBoxType.Pricings {
+			cmd.Printf("  - Location:\t%s\n", price.Location)
+			cmd.Printf("    Hourly:\t%s\n", util.GrossPrice(price.PriceHourly))
+			cmd.Printf("    Monthly:\t%s\n", util.GrossPrice(price.PriceMonthly))
+			cmd.Printf("    Setup Fee:\t%s\n", util.GrossPrice(price.SetupFee))
+			cmd.Printf("\n")
+		}
+
+		return nil
+	},
+}
+
+func loadCurrencyFromAPI(s state.State, storageBoxType *hcloud.StorageBoxType) error {
+	pricing, _, err := s.Client().Pricing().Get(s)
+	if err != nil {
+		return err
+	}
+
+	for i := range storageBoxType.Pricings {
+		storageBoxType.Pricings[i].PriceMonthly.Currency = pricing.Currency
+		storageBoxType.Pricings[i].PriceMonthly.VATRate = pricing.VATRate
+
+		storageBoxType.Pricings[i].PriceHourly.Currency = pricing.Currency
+		storageBoxType.Pricings[i].PriceHourly.VATRate = pricing.VATRate
+
+		storageBoxType.Pricings[i].SetupFee.Currency = pricing.Currency
+		storageBoxType.Pricings[i].SetupFee.VATRate = pricing.VATRate
+	}
+
+	return nil
+}

internal/cmd/storageboxtype/describe_test.go

@@ -0,0 +1,98 @@
+package storageboxtype_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/mock/gomock"
+
+	"github.com/hetznercloud/cli/internal/cmd/storageboxtype"
+	"github.com/hetznercloud/cli/internal/testutil"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
+)
+
+func TestDescribe(t *testing.T) {
+	fx := testutil.NewFixture(t)
+	defer fx.Finish()
+
+	cmd := storageboxtype.DescribeCmd.CobraCommand(fx.State())
+	fx.ExpectEnsureToken()
+
+	fx.Client.StorageBoxTypeClient.EXPECT().
+		Get(gomock.Any(), "bx11").
+		Return(&hcloud.StorageBoxType{
+			ID:                     42,
+			Name:                   "bx11",
+			Description:            "BX11",
+			SnapshotLimit:          10,
+			AutomaticSnapshotLimit: 10,
+			SubaccountsLimit:       200,
+			Size:                   1073741824,
+			Pricings: []hcloud.StorageBoxTypeLocationPricing{
+				{
+					Location: "fsn1",
+					PriceHourly: hcloud.Price{
+						Gross: "0.0051",
+						Net:   "0.0051",
+					},
+					PriceMonthly: hcloud.Price{
+						Gross: "3.2000",
+						Net:   "3.2000",
+					},
+					SetupFee: hcloud.Price{
+						Gross: "0.0000",
+						Net:   "0.0000",
+					},
+				},
+				{
+					Location: "hel1",
+					PriceHourly: hcloud.Price{
+						Gross: "0.0051",
+						Net:   "0.0051",
+					},
+					PriceMonthly: hcloud.Price{
+						Gross: "3.2000",
+						Net:   "3.2000",
+					},
+					SetupFee: hcloud.Price{
+						Gross: "0.0000",
+						Net:   "0.0000",
+					},
+				},
+			},
+		}, nil, nil)
+
+	fx.Client.PricingClient.EXPECT().
+		Get(gomock.Any()).
+		Return(hcloud.Pricing{
+			Currency: "EUR",
+			VATRate:  "1.19",
+		}, nil, nil)
+
+	out, errOut, err := fx.Run(cmd, []string{"bx11"})
+
+	expOut := `ID:				42
+Name:				bx11
+Description:			BX11
+Size:				1.0 GiB
+Snapshot Limit:			10
+Automatic Snapshot Limit:	10
+Subaccounts Limit:		200
+Pricings per Location:
+  - Location:	fsn1
+    Hourly:	€ 0.0051
+    Monthly:	€ 3.2000
+    Setup Fee:	€ 0.0000
+
+  - Location:	hel1
+    Hourly:	€ 0.0051
+    Monthly:	€ 3.2000
+    Setup Fee:	€ 0.0000
+
+`
+
+	require.NoError(t, err)
+	assert.Empty(t, errOut)
+	assert.Equal(t, expOut, out)
+}

internal/cmd/storageboxtype/list.go

@@ -0,0 +1,44 @@
+package storageboxtype
+
+import (
+	"github.com/dustin/go-humanize"
+	"github.com/spf13/pflag"
+
+	"github.com/hetznercloud/cli/internal/cmd/base"
+	"github.com/hetznercloud/cli/internal/cmd/output"
+	"github.com/hetznercloud/cli/internal/cmd/util"
+	"github.com/hetznercloud/cli/internal/hcapi2"
+	"github.com/hetznercloud/cli/internal/state"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud"
+	"github.com/hetznercloud/hcloud-go/v2/hcloud/schema"
+)
+
+var ListCmd = base.ListCmd[*hcloud.StorageBoxType, schema.StorageBoxType]{
+	ResourceNamePlural: "Storage Box Types",
+	JSONKeyGetByName:   "storage_box_types",
+	DefaultColumns:     []string{"id", "name", "description", "size", "snapshot_limit", "automatic_snapshot_limit", "subaccounts_limit"},
+	SortOption:         nil, // Storage Box Types do not support sorting
+
+	Fetch: func(s state.State, _ *pflag.FlagSet, listOpts hcloud.ListOpts, _ []string) ([]*hcloud.StorageBoxType, error) {
+		opts := hcloud.StorageBoxTypeListOpts{ListOpts: listOpts}
+		return s.Client().StorageBoxType().AllWithOpts(s, opts)
+	},
+
+	OutputTable: func(t *output.Table, _ hcapi2.Client) {
+		t.
+			AddAllowedFields(hcloud.StorageBoxType{}).
+			AddFieldFn("size", func(obj interface{}) string {
+				storageBoxType := obj.(*hcloud.StorageBoxType)
+				return humanize.IBytes(uint64(storageBoxType.Size))
+			}).
+			AddFieldFn("deprecated", func(obj interface{}) string {
+				storageBoxType := obj.(*hcloud.StorageBoxType)
+				if !storageBoxType.IsDeprecated() {
+					return "-"
+				}
+				return util.Datetime(storageBoxType.UnavailableAfter())
+			})
+	},
+
+	Schema: hcloud.SchemaFromStorageBoxType,
+}