Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve error handling for Prism Client #354

Merged
merged 6 commits into from
Jan 9, 2024
Merged

fix: improve error handling for Prism Client #354

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de5b09e
fix: use wrapper errors to clearly denote issues in client building
faiq Jan 3, 2024
babe2c6
fix: adds a function to properly sanitize the address
faiq Jan 3, 2024
0396a84
fix: adds tests for ip address case given
faiq Jan 4, 2024
f335e7a
fix: uses a defined type for port error
faiq Jan 4, 2024
cf34f59
fix: clean up variable naming
faiq Jan 4, 2024
40872bd
fix: remove validation here to be moved into prism-client
faiq Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions pkg/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ const (
capxNamespaceKey = "POD_NAMESPACE"
)

var ErrPrismAddressNotSet = fmt.Errorf("cannot get credentials if Prism Address is not set")
var ErrPrismPortNotSet = fmt.Errorf("cannot get credentials if Prism Port is not set")

type NutanixClientHelper struct {
secretInformer coreinformers.SecretInformer
configMapInformer coreinformers.ConfigMapInformer
Expand All @@ -64,14 +67,15 @@ func (n *NutanixClientHelper) GetClientFromEnvironment(ctx context.Context, nuta
prismCentralInfo := nutanixCluster.Spec.PrismCentral
if prismCentralInfo != nil {
if prismCentralInfo.Address == "" {
return nil, fmt.Errorf("cannot get credentials if Prism Address is not set")
return nil, ErrPrismAddressNotSet
}
if prismCentralInfo.Port == 0 {
return nil, fmt.Errorf("cannot get credentials if Prism Port is not set")
return nil, ErrPrismPortNotSet
}
credentialRef := prismCentralInfo.CredentialRef
if credentialRef == nil {
return nil, fmt.Errorf("credentialRef must be set on prismCentral attribute for cluster %s in namespace %s", nutanixCluster.Name, nutanixCluster.Namespace)
credentialRef, err := GetCredentialRefForCluster(nutanixCluster)
faiq marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
//nolint:wrapcheck // error is alredy wrapped
faiq marked this conversation as resolved.
Show resolved Hide resolved
return nil, err
}
// If namespace is empty, use the cluster namespace
if credentialRef.Namespace == "" {
Expand All @@ -94,7 +98,7 @@ func (n *NutanixClientHelper) GetClientFromEnvironment(ctx context.Context, nuta
// Add env provider for CAPX manager
npe, err := n.getManagerNutanixPrismEndpoint()
if err != nil {
return nil, err
return nil, fmt.Errorf("failed to create prism endpoint: %w", err)
}
// If namespaces is not set, set it to the namespace of the CAPX manager
if npe.CredentialRef.Namespace == "" {
Expand All @@ -115,15 +119,14 @@ func (n *NutanixClientHelper) GetClientFromEnvironment(ctx context.Context, nuta
*npe,
n.secretInformer,
n.configMapInformer))

// init env with providers
env := environment.NewEnvironment(
providers...,
)
// fetch endpoint details
me, err := env.GetManagementEndpoint(envTypes.Topology{})
if err != nil {
return nil, err
return nil, fmt.Errorf("failed to get management endpoint object: %w", err)
}
creds := prismgoclient.Credentials{
URL: me.Address.Host,
Expand Down Expand Up @@ -155,26 +158,25 @@ func (n *NutanixClientHelper) GetClient(cred prismgoclient.Credentials, addition
}
cli, err := nutanixClientV3.NewV3Client(cred, clientOpts...)
if err != nil {
return nil, err
return nil, fmt.Errorf("failed to create new nutanix client: %w", err)
}

// Check if the client is working
_, err = cli.V3.GetCurrentLoggedInUser(context.Background())
if err != nil {
return nil, err
return nil, fmt.Errorf("failed to get current logged in user with client: %w", err)
}

return cli, nil
}

func (n *NutanixClientHelper) getManagerNutanixPrismEndpoint() (*credentialTypes.NutanixPrismEndpoint, error) {
npe := &credentialTypes.NutanixPrismEndpoint{}
config, err := n.readEndpointConfig()
if err != nil {
return npe, err
return nil, fmt.Errorf("failed to read config: %w", err)
}
if err = json.Unmarshal(config, npe); err != nil {
return npe, err
return nil, fmt.Errorf("failed to unmarshal config: %w", err)
}
if npe.CredentialRef == nil {
return nil, fmt.Errorf("credentialRef must be set on CAPX manager")
Expand All @@ -196,16 +198,16 @@ func GetCredentialRefForCluster(nutanixCluster *infrav1.NutanixCluster) (*creden
if nutanixCluster == nil {
return nil, fmt.Errorf("cannot get credential reference if nutanix cluster object is nil")
}
prismCentralinfo := nutanixCluster.Spec.PrismCentral
if prismCentralinfo == nil {
prismCentralInfo := nutanixCluster.Spec.PrismCentral
if prismCentralInfo == nil {
return nil, nil
}
if prismCentralinfo.CredentialRef == nil {
if prismCentralInfo.CredentialRef == nil {
return nil, fmt.Errorf("credentialRef must be set on prismCentral attribute for cluster %s in namespace %s", nutanixCluster.Name, nutanixCluster.Namespace)
}
if prismCentralinfo.CredentialRef.Kind != credentialTypes.SecretKind {
if prismCentralInfo.CredentialRef.Kind != credentialTypes.SecretKind {
return nil, nil
}

return prismCentralinfo.CredentialRef, nil
return prismCentralInfo.CredentialRef, nil
}
Loading