armada-operator/pkg/runner/runner.go

/*
Copyright 2023.

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 runner

import (
	"context"
	"errors"
	"sync"
	"time"

	"github.com/go-logr/logr"
	"helm.sh/helm/v3/pkg/action"
	"helm.sh/helm/v3/pkg/chart"
	"helm.sh/helm/v3/pkg/chartutil"
	"helm.sh/helm/v3/pkg/kube"
	"helm.sh/helm/v3/pkg/release"
	"helm.sh/helm/v3/pkg/storage/driver"
	"k8s.io/cli-runtime/pkg/genericclioptions"

	armadav1 "opendev.org/airship/armada-operator/api/v1"
)

// Runner represents a Helm action runner capable of performing Helm
// operations for a ArmadaChart.
type Runner struct {
	mu        sync.Mutex
	config    *action.Configuration
	logBuffer *LogBuffer
}

type ActionError struct {
	Err          error
	CapturedLogs string
}

func (e ActionError) Error() string {
	return e.Err.Error()
}

func (e ActionError) Unwrap() error {
	return e.Err
}

// NewRunner constructs a new Runner configured to run Helm actions with the
// given genericclioptions.RESTClientGetter, and the release and storage
// namespace configured to the provided values.
func NewRunner(getter genericclioptions.RESTClientGetter, storageNamespace string, logger logr.Logger) (*Runner, error) {
	runner := &Runner{
		logBuffer: NewLogBuffer(NewDebugLog(logger.V(2)), defaultBufferSize),
	}

	// Default to the trace level logger for the Helm action configuration,
	// to ensure storage logs are captured.
	cfg := new(action.Configuration)
	if err := cfg.Init(getter, storageNamespace, "secret", NewDebugLog(logger)); err != nil {
		return nil, err
	}

	// Override the logger used by the Helm actions and Kube client with the log buffer,
	// which provides useful information in the event of an error.
	cfg.Log = runner.logBuffer.Log
	if kc, ok := cfg.KubeClient.(*kube.Client); ok {
		kc.Log = runner.logBuffer.Log
	}
	runner.config = cfg

	return runner, nil
}

// Install runs a Helm install action for the given ArmadaChart.
func (r *Runner) Install(ctx context.Context, ac armadav1.ArmadaChart, chart *chart.Chart, values chartutil.Values) (*release.Release, error) {
	r.mu.Lock()
	defer r.mu.Unlock()
	defer r.logBuffer.Reset()

	install := action.NewInstall(r.config)
	install.ReleaseName = ac.Name
	install.Namespace = ac.Namespace

	if ac.Spec.Wait.Native != nil && ac.Spec.Wait.Native.Enabled && ac.Spec.Wait.Timeout > 0 {
		install.Wait = true
		install.Timeout = time.Duration(int64(time.Second) * int64(ac.Spec.Wait.Timeout))
	}
	install.DisableOpenAPIValidation = true
	install.CreateNamespace = true

	rel, err := install.RunWithContext(ctx, chart, values.AsMap())
	return rel, wrapActionErr(r.logBuffer, err)
}

// Upgrade runs an Helm upgrade action for the given ArmadaChart.
func (r *Runner) Upgrade(ctx context.Context, ac armadav1.ArmadaChart, chart *chart.Chart, values chartutil.Values) (*release.Release, error) {
	r.mu.Lock()
	defer r.mu.Unlock()
	defer r.logBuffer.Reset()

	upgrade := action.NewUpgrade(r.config)
	upgrade.Namespace = ac.Spec.Namespace
	if ac.Spec.Wait.Native != nil && ac.Spec.Wait.Native.Enabled && ac.Spec.Wait.Timeout > 0 {
		upgrade.Wait = true
		upgrade.Timeout = time.Duration(int64(time.Second) * int64(ac.Spec.Wait.Timeout))
	}
	upgrade.DisableOpenAPIValidation = true

	rel, err := upgrade.RunWithContext(ctx, ac.Name, chart, values.AsMap())
	return rel, wrapActionErr(r.logBuffer, err)
}

// Test runs an Helm test action for the given ArmadaChart.
func (r *Runner) Test(ac armadav1.ArmadaChart) (*release.Release, error) {
	r.mu.Lock()
	defer r.mu.Unlock()
	defer r.logBuffer.Reset()

	r.logBuffer.Log("performing test")
	test := action.NewReleaseTesting(r.config)
	test.Namespace = ac.Spec.Namespace
	test.Timeout = time.Duration(int64(time.Second) * int64(ac.Spec.Wait.Timeout))

	rel, err := test.Run(ac.Name)
	return rel, wrapActionErr(r.logBuffer, err)
}

// Uninstall runs an Helm uninstall action
func (r *Runner) Uninstall(ac armadav1.ArmadaChart) error {
	r.mu.Lock()
	defer r.mu.Unlock()
	defer r.logBuffer.Reset()

	uninstall := action.NewUninstall(r.config)

	_, err := uninstall.Run(ac.Name)
	return wrapActionErr(r.logBuffer, err)
}

// ObserveLastRelease observes the last revision, if there is one,
// for the actual Helm release associated with the given ArmadaChart.
func (r *Runner) ObserveLastRelease(ac armadav1.ArmadaChart) (*release.Release, error) {
	rel, err := r.config.Releases.Last(ac.Name)
	if err != nil && errors.Is(err, driver.ErrReleaseNotFound) {
		err = nil
	}
	return rel, err
}

// UpdateReleaseStatus sets the new status for release
func (r *Runner) UpdateReleaseStatus(rel *release.Release) error {
	return r.config.Releases.Update(rel)
}

func wrapActionErr(log *LogBuffer, err error) error {
	if err == nil {
		return err
	}
	err = &ActionError{
		Err:          err,
		CapturedLogs: log.String(),
	}
	return err
}