Add prerequisite client and util funcs for capibmadm cli (#1074)

* Add prereq client and util funcs for capibmadm cli

* Add context cancel support

Author: dharaneeshvrd

cmd/capibmadm/clients/iam/iam.go

@@ -0,0 +1,31 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 iam contains, client to create iam authenticator.
+package iam
+
+import (
+	"github.com/IBM/go-sdk-core/v5/core"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
+)
+
+// GetIAMAuth creates core Authenticator from API key provided.
+func GetIAMAuth() *core.IamAuthenticator {
+	return &core.IamAuthenticator{
+		ApiKey: options.GlobalOptions.IBMCloudAPIKey,
+	}
+}

cmd/capibmadm/clients/platformservices/client.go

@@ -0,0 +1,41 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 platformservices contains client functions for platform services.
+package platformservices
+
+import (
+	"github.com/IBM/platform-services-go-sdk/iamidentityv1"
+	"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
+)
+
+// NewResourceManagerV2Client creates new resource manager client.
+func NewResourceManagerV2Client() (*resourcemanagerv2.ResourceManagerV2, error) {
+	return resourcemanagerv2.NewResourceManagerV2(&resourcemanagerv2.ResourceManagerV2Options{
+		Authenticator: iam.GetIAMAuth(),
+		URL:           resourcemanagerv2.DefaultServiceURL,
+	})
+}
+
+// NewIAMIdentityClient creates iam identity client.
+func NewIAMIdentityClient() (*iamidentityv1.IamIdentityV1, error) {
+	return iamidentityv1.NewIamIdentityV1(&iamidentityv1.IamIdentityV1Options{
+		Authenticator: iam.GetIAMAuth(),
+		URL:           iamidentityv1.DefaultServiceURL,
+	})
+}

cmd/capibmadm/clients/powervs/client.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 powervs contains powervs client functions.
+package powervs
+
+import (
+	"fmt"
+
+	"github.com/IBM-Cloud/power-go-client/ibmpisession"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
+)
+
+// NewPISession creates new powervs client.
+// To-Do: Need to handle custom endpoint URL if user wants to use staging env.
+func NewPISession(accountID string, region string, zone string, debug bool) (*ibmpisession.IBMPISession, error) {
+	return ibmpisession.NewIBMPISession(&ibmpisession.IBMPIOptions{Authenticator: iam.GetIAMAuth(),
+		Debug:       debug,
+		URL:         fmt.Sprintf("https://%s.power-iaas.cloud.ibm.com", region),
+		UserAccount: accountID,
+		Zone:        zone})
+}

cmd/capibmadm/clients/vpc/client.go

@@ -0,0 +1,36 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 vpc contains vpc client functions.
+package vpc
+
+import (
+	"github.com/IBM/vpc-go-sdk/vpcv1"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
+)
+
+// NewV1Client creates new vpcv1 client.
+// To-Do: Need to handle custom endpoint URL if user wants to use staging env.
+func NewV1Client(region string) (*vpcv1.VpcV1, error) {
+	svcEndpoint := "https://" + region + ".iaas.cloud.ibm.com/v1"
+
+	return vpcv1.NewVpcV1(&vpcv1.VpcV1Options{
+		ServiceName:   "vpcs",
+		Authenticator: iam.GetIAMAuth(),
+		URL:           svcEndpoint,
+	})
+}

cmd/capibmadm/cmd/root.go

@@ -17,9 +17,12 @@ limitations under the License.
 package cmd
 
 import (
+	"context"
 	"flag"
 	"fmt"
 	"os"
+	"os/signal"
+	"syscall"
 
 	"github.com/spf13/cobra"
 
@@ -56,8 +59,20 @@ func rootCommand() *cobra.Command {
 
 // Execute executes the root command.
 func Execute() {
-	if err := rootCommand().Execute(); err != nil {
-		fmt.Fprintln(os.Stderr, err)
+	cmd := rootCommand()
+
+	ctx, cancel := context.WithCancel(context.Background())
+
+	sigs := make(chan os.Signal, 1)
+	signal.Notify(sigs, syscall.SIGINT)
+	go func() {
+		<-sigs
+		fmt.Fprintln(os.Stderr, "\nAborted...")
+		cancel()
+	}()
+
+	if err := cmd.ExecuteContext(ctx); err != nil {
+		fmt.Fprintf(os.Stderr, "%v\n", err)
 		os.Exit(1)
 	}
 }

cmd/capibmadm/utils/printer.go

@@ -0,0 +1,98 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 utils
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/cli-runtime/pkg/printers"
+)
+
+// PrinterType is a type declaration for a printer type.
+type PrinterType string
+
+var (
+	// PrinterTypeTable is a table printer type.
+	PrinterTypeTable = PrinterType("table")
+	// PrinterTypeJSON is a json printer type.
+	PrinterTypeJSON = PrinterType("json")
+)
+
+var (
+	// ErrUnknowPrinterType is an error if a printer type isn't known.
+	ErrUnknowPrinterType = errors.New("unknown printer type")
+	// ErrTableRequired is an error if the object being printed
+	// isn't a metav1.Table.
+	ErrTableRequired = errors.New("metav1.Table is required")
+)
+
+// Printer is an interface for a printer.
+type Printer interface {
+	// Print is a method to print an object
+	Print(in interface{}) error
+}
+
+// NewPrinter creates a new printer.
+func NewPrinter(printerType string, writer io.Writer) (Printer, error) {
+	switch printerType {
+	case string(PrinterTypeTable):
+		return &tablePrinter{writer: writer}, nil
+	case string(PrinterTypeJSON):
+		return &jsonPrinter{writer: writer}, nil
+	default:
+		return nil, ErrUnknowPrinterType
+	}
+}
+
+type tablePrinter struct {
+	writer io.Writer
+}
+
+func (p *tablePrinter) Print(in interface{}) error {
+	table, ok := in.(*metav1.Table)
+	if !ok {
+		return ErrTableRequired
+	}
+
+	options := printers.PrintOptions{}
+	tablePrinter := printers.NewTablePrinter(options)
+	scheme := runtime.NewScheme()
+	printer, err := printers.NewTypeSetter(scheme).WrapToPrinter(tablePrinter, nil)
+	if err != nil {
+		return err
+	}
+
+	return printer.PrintObj(table, p.writer)
+}
+
+type jsonPrinter struct {
+	writer io.Writer
+}
+
+func (p *jsonPrinter) Print(in interface{}) error {
+	data, err := json.MarshalIndent(in, "", "  ")
+	if err != nil {
+		return fmt.Errorf("marshalling object as json: %w", err)
+	}
+	_, err = p.writer.Write(data)
+	return err
+}

cmd/capibmadm/utils/utils.go

@@ -0,0 +1,113 @@
+/*
+Copyright 2023 The Kubernetes Authors.
+
+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 utils contains utility and printer functions for cli.
+package utils
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/go-openapi/strfmt"
+
+	"github.com/IBM/go-sdk-core/v5/core"
+	"github.com/IBM/platform-services-go-sdk/iamidentityv1"
+	"github.com/IBM/platform-services-go-sdk/resourcemanagerv2"
+
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/platformservices"
+	"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
+)
+
+// GetAccountID returns IBM cloud account ID of API key used.
+func GetAccountID(ctx context.Context, auth *core.IamAuthenticator) (string, error) {
+	iamv1, err := platformservices.NewIAMIdentityClient()
+	if err != nil {
+		return "", err
+	}
+
+	apiKeyDetailsOpt := iamidentityv1.GetAPIKeysDetailsOptions{IamAPIKey: &options.GlobalOptions.IBMCloudAPIKey}
+	apiKey, _, err := iamv1.GetAPIKeysDetailsWithContext(ctx, &apiKeyDetailsOpt)
+	if err != nil {
+		return "", err
+	}
+	if apiKey == nil {
+		return "", fmt.Errorf("could not retrieve account id")
+	}
+
+	return *apiKey.AccountID, nil
+}
+
+// GetResourceGroupID returns ID of given resource group name.
+func GetResourceGroupID(ctx context.Context, resourceGroup string, accountID string) (string, error) {
+	rmv2, err := platformservices.NewResourceManagerV2Client()
+
+	if err != nil {
+		return "", err
+	}
+
+	if rmv2 == nil {
+		return "", fmt.Errorf("unable to get resource controller")
+	}
+
+	rmv2ListResourceGroupOpt := resourcemanagerv2.ListResourceGroupsOptions{Name: &resourceGroup, AccountID: &accountID}
+	resourceGroupListResult, _, err := rmv2.ListResourceGroupsWithContext(ctx, &rmv2ListResourceGroupOpt)
+	if err != nil {
+		return "", err
+	}
+
+	if resourceGroupListResult != nil && len(resourceGroupListResult.Resources) > 0 {
+		rg := resourceGroupListResult.Resources[0]
+		resourceGroupID := *rg.ID
+		return resourceGroupID, nil
+	}
+
+	err = fmt.Errorf("could not retrieve resource group id for %s", resourceGroup)
+	return "", err
+}
+
+// DereferencePointer dereferences pointer.
+func DereferencePointer(value interface{}) interface{} {
+	switch v := value.(type) {
+	case *string:
+		if v != nil {
+			return *v
+		}
+		return ""
+	case *int, *int8, *int16, *int32, *int64:
+		i := value.(*int64)
+		if i != nil {
+			return *i
+		}
+		return 0
+	case *strfmt.DateTime:
+		if v != nil {
+			return *v
+		}
+		return strfmt.DateTime{}
+	case *bool:
+		if v != nil {
+			return *v
+		}
+		return false
+	case *float32, *float64:
+		f := value.(*float64)
+		if f != nil {
+			return *f
+		}
+		return 0
+	}
+	return nil
+}