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.

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

feat: adds a validation hook #498

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions api/variables/variables.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright 2023 D2iQ, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package variables

import (
"encoding/json"
"fmt"

runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
)

func UnmarshalRuntimeVariable[T any](runtimeVariable *runtimehooksv1.Variable, obj *T) error {
err := json.Unmarshal(runtimeVariable.Value.Raw, obj)
if err != nil {
return fmt.Errorf("error unmarshalling variable: %w", err)
}

return nil
}

//nolint:gocritic // no need for named results
func GetRuntimhookVariableByName(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
func GetRuntimhookVariableByName(
func GetRuntimehookVariableByName(

name string,
variables []runtimehooksv1.Variable,
) (*runtimehooksv1.Variable, int) {
faiq marked this conversation as resolved.
Show resolved Hide resolved
for i, runtimevar := range variables {
if runtimevar.Name == name {
return &runtimevar, i
}
}
return nil, -1
}
3 changes: 3 additions & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import (
dockermutation "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/docker/mutation"
dockerworkerconfig "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/docker/workerconfig"
"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/generic/lifecycle"
"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/generic/validation"
nutanixclusterconfig "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/nutanix/clusterconfig"
nutanixmutation "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/nutanix/mutation"
nutanixworkerconfig "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/pkg/handlers/nutanix/workerconfig"
Expand Down Expand Up @@ -84,6 +85,7 @@ func main() {

genericLifecycleHandlers := lifecycle.New(globalOptions)

validationHandlers := validation.New()
// Initialize and parse command line flags.
logs.AddFlags(pflag.CommandLine, logs.SkipLoggingConfigurationFlags())
logsv1.AddFlags(logOptions, pflag.CommandLine)
Expand Down Expand Up @@ -142,6 +144,7 @@ func main() {
}

var allHandlers []handlers.Named
allHandlers = append(allHandlers, validationHandlers.AllHandlers(mgr)...)
allHandlers = append(allHandlers, genericLifecycleHandlers.AllHandlers(mgr)...)
allHandlers = append(allHandlers, awsMetaHandlers...)
allHandlers = append(allHandlers, dockerMetaHandlers...)
Expand Down
24 changes: 24 additions & 0 deletions pkg/handlers/generic/validation/handlers.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Copyright 2023 D2iQ, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package validation

import (
"sigs.k8s.io/controller-runtime/pkg/manager"

"github.com/d2iq-labs/cluster-api-runtime-extensions-nutanix/common/pkg/capi/clustertopology/handlers"
"github.com/d2iq-labs/cluster-api-runtime-extensions-nutanix/pkg/handlers/generic/validation/helm"
)

type Handlers struct{}

func New() *Handlers {
return &Handlers{}
}

func (h *Handlers) AllHandlers(mgr manager.Manager) []handlers.Named {
validationHandler := helm.New(mgr.GetClient())
return []handlers.Named{
validationHandler,
}
}
87 changes: 87 additions & 0 deletions pkg/handlers/generic/validation/helm/handler.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
// Copyright 2023 D2iQ, Inc. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

package helm

import (
"context"
"crypto/tls"
"fmt"
"net/http"

runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
ctrl "sigs.k8s.io/controller-runtime"
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"

"github.com/d2iq-labs/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
"github.com/d2iq-labs/cluster-api-runtime-extensions-nutanix/api/variables"
"github.com/d2iq-labs/cluster-api-runtime-extensions-nutanix/pkg/handlers/generic/clusterconfig"
)

type HelmRegistryValidator struct {
client ctrlclient.Client
variableName string
}

func New(
c ctrlclient.Client,
) *HelmRegistryValidator {
return &HelmRegistryValidator{
client: c,
variableName: clusterconfig.MetaVariableName,
}
}

func (h *HelmRegistryValidator) Name() string {
return "HelmRegistryValidator"
}

func (h *HelmRegistryValidator) ValidateTopology(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we please add a unit test for this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im not sure about this particular function, but we can split it out to be more testable

ctx context.Context,
req *runtimehooksv1.ValidateTopologyRequest,
res *runtimehooksv1.ValidateTopologyResponse,
) {
log := ctrl.LoggerFrom(ctx)
clusterVar, ind := variables.GetRuntimhookVariableByName(h.variableName, req.Variables)
if ind == -1 {
log.V(5).Info(fmt.Sprintf("did not find variable %s in %v", h.variableName, req.Variables))
return
}
var cluster v1alpha1.ClusterConfig
if err := variables.UnmarshalRuntimeVariable[v1alpha1.ClusterConfig](clusterVar, &cluster); err != nil {
failString := fmt.Sprintf("failed to unmarshal variable %v to clusterConfig", clusterVar)
log.Error(err, failString)
res.SetStatus(runtimehooksv1.ResponseStatusFailure)
res.SetMessage(failString)
return
}
helmChartRepo := cluster.Spec.Addons.HelmChartRepository
cl := &http.Client{
Transport: &http.Transport{
//nolint:gosec // this is done because customers can occasionally have self signed
// or no certificates to OCI registries
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
},
}
resp, err := cl.Get(fmt.Sprintf("%s/v2", *helmChartRepo))
if err != nil {
failString := fmt.Sprintf("failed to ping provided helm registry %s", *helmChartRepo)
log.Error(err, failString)
res.SetStatus(runtimehooksv1.ResponseStatusFailure)
res.SetMessage(failString)
return
}
defer resp.Body.Close()
if resp.StatusCode == http.StatusOK || resp.StatusCode == http.StatusUnauthorized {
res.SetStatus(runtimehooksv1.ResponseStatusSuccess)
return
}
failString := fmt.Sprintf(
"failed to get 401 or 200 response from hitting registry: %s got status: %d",
*helmChartRepo,
resp.StatusCode,
)
log.Error(err, failString)
res.SetStatus(runtimehooksv1.ResponseStatusFailure)
res.SetMessage(failString)
}
Loading