Skip to content

Commit

Permalink
chore: move context.TODO to context.Background() (3) (zarf-dev#2747)
Browse files Browse the repository at this point in the history
Signed-off-by: schristoff-du <167717759+schristoff-du@users.noreply.github.com>
Co-authored-by: schristoff-du <167717759+schristoff-du@users.noreply.github.com>
Signed-off-by: Tim Seagren <timseagren@defenseunicorns.com>
  • Loading branch information
2 people authored and chaospuppy committed Aug 5, 2024
1 parent 5ca9e87 commit fd90b88
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 16 deletions.
2 changes: 1 addition & 1 deletion src/extensions/bigbang/bigbang.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ func Run(ctx context.Context, YOLO bool, tmpPaths *layout.ComponentPaths, c type

// Template the chart so we can see what GitRepositories are being referenced in the
// manifests created with the provided Helm.
template, _, err := helmCfg.TemplateChart()
template, _, err := helmCfg.TemplateChart(ctx)
if err != nil {
return c, fmt.Errorf("unable to template Big Bang Chart: %w", err)
}
Expand Down
13 changes: 7 additions & 6 deletions src/internal/packager/helm/chart.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
package helm

import (
"context"
"errors"
"fmt"
"time"
Expand All @@ -30,7 +31,7 @@ import (
)

// InstallOrUpgradeChart performs a helm install of the given chart.
func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error) {
func (h *Helm) InstallOrUpgradeChart(ctx context.Context) (types.ConnectStrings, string, error) {
fromMessage := h.chart.URL
if fromMessage == "" {
fromMessage = "Zarf-generated helm chart"
Expand All @@ -52,7 +53,7 @@ func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error) {
return nil, "", fmt.Errorf("unable to initialize the K8s client: %w", err)
}

postRender, err := h.newRenderer()
postRender, err := h.newRenderer(ctx)
if err != nil {
return nil, "", fmt.Errorf("unable to create helm renderer: %w", err)
}
Expand Down Expand Up @@ -126,7 +127,7 @@ func (h *Helm) InstallOrUpgradeChart() (types.ConnectStrings, string, error) {
}

// TemplateChart generates a helm template from a given chart.
func (h *Helm) TemplateChart() (manifest string, chartValues chartutil.Values, err error) {
func (h *Helm) TemplateChart(ctx context.Context) (manifest string, chartValues chartutil.Values, err error) {
message.Debugf("helm.TemplateChart()")
spinner := message.NewProgressSpinner("Templating helm chart %s", h.chart.Name)
defer spinner.Stop()
Expand Down Expand Up @@ -170,7 +171,7 @@ func (h *Helm) TemplateChart() (manifest string, chartValues chartutil.Values, e
return "", nil, fmt.Errorf("unable to load chart data: %w", err)
}

client.PostRenderer, err = h.newRenderer()
client.PostRenderer, err = h.newRenderer(ctx)
if err != nil {
return "", nil, fmt.Errorf("unable to create helm renderer: %w", err)
}
Expand Down Expand Up @@ -204,7 +205,7 @@ func (h *Helm) RemoveChart(namespace string, name string, spinner *message.Spinn

// UpdateReleaseValues updates values for a given chart release
// (note: this only works on single-deep charts, charts with dependencies (like loki-stack) will not work)
func (h *Helm) UpdateReleaseValues(updatedValues map[string]interface{}) error {
func (h *Helm) UpdateReleaseValues(ctx context.Context, updatedValues map[string]interface{}) error {
spinner := message.NewProgressSpinner("Updating values for helm release %s", h.chart.ReleaseName)
defer spinner.Stop()

Expand All @@ -213,7 +214,7 @@ func (h *Helm) UpdateReleaseValues(updatedValues map[string]interface{}) error {
return fmt.Errorf("unable to initialize the K8s client: %w", err)
}

postRender, err := h.newRenderer()
postRender, err := h.newRenderer(ctx)
if err != nil {
return fmt.Errorf("unable to create helm renderer: %w", err)
}
Expand Down
4 changes: 2 additions & 2 deletions src/internal/packager/helm/post-render.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ type renderer struct {
namespaces map[string]*corev1.Namespace
}

func (h *Helm) newRenderer() (*renderer, error) {
func (h *Helm) newRenderer(ctx context.Context) (*renderer, error) {
message.Debugf("helm.NewRenderer()")

rend := &renderer{
Expand All @@ -49,7 +49,7 @@ func (h *Helm) newRenderer() (*renderer, error) {
return rend, nil
}

namespace, err := h.cluster.Clientset.CoreV1().Namespaces().Get(context.TODO(), h.chart.Namespace, metav1.GetOptions{})
namespace, err := h.cluster.Clientset.CoreV1().Namespaces().Get(ctx, h.chart.Namespace, metav1.GetOptions{})
if err != nil && !kerrors.IsNotFound(err) {
return nil, fmt.Errorf("unable to check for existing namespace %q in cluster: %w", h.chart.Namespace, err)
}
Expand Down
4 changes: 2 additions & 2 deletions src/internal/packager/helm/zarf.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func (h *Helm) UpdateZarfRegistryValues(ctx context.Context) error {
Namespace: "zarf",
ReleaseName: "zarf-docker-registry",
}
err = h.UpdateReleaseValues(registryValues)
err = h.UpdateReleaseValues(ctx, registryValues)
if err != nil {
return fmt.Errorf("error updating the release values: %w", err)
}
Expand Down Expand Up @@ -119,7 +119,7 @@ func (h *Helm) UpdateZarfAgentValues(ctx context.Context) error {
}
h.variableConfig.SetApplicationTemplates(applicationTemplates)

err = h.UpdateReleaseValues(map[string]interface{}{})
err = h.UpdateReleaseValues(ctx, map[string]interface{}{})
if err != nil {
return fmt.Errorf("error updating the release values: %w", err)
}
Expand Down
8 changes: 4 additions & 4 deletions src/pkg/packager/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ func (p *Packager) deployComponent(ctx context.Context, component types.ZarfComp
}

if hasCharts || hasManifests {
if charts, err = p.installChartAndManifests(componentPath, component); err != nil {
if charts, err = p.installChartAndManifests(ctx, componentPath, component); err != nil {
return charts, err
}
}
Expand Down Expand Up @@ -610,7 +610,7 @@ func (p *Packager) generateValuesOverrides(chart types.ZarfChart, componentName
}

// Install all Helm charts and raw k8s manifests into the k8s cluster.
func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPaths, component types.ZarfComponent) (installedCharts []types.InstalledChart, err error) {
func (p *Packager) installChartAndManifests(ctx context.Context, componentPaths *layout.ComponentPaths, component types.ZarfComponent) (installedCharts []types.InstalledChart, err error) {
for _, chart := range component.Charts {
// Do not wait for the chart to be ready if data injections are present.
if len(component.DataInjections) > 0 {
Expand Down Expand Up @@ -646,7 +646,7 @@ func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPath
p.cfg.PkgOpts.Retries),
)

addedConnectStrings, installedChartName, err := helmCfg.InstallOrUpgradeChart()
addedConnectStrings, installedChartName, err := helmCfg.InstallOrUpgradeChart(ctx)
if err != nil {
return installedCharts, err
}
Expand Down Expand Up @@ -699,7 +699,7 @@ func (p *Packager) installChartAndManifests(componentPaths *layout.ComponentPath
}

// Install the chart.
addedConnectStrings, installedChartName, err := helmCfg.InstallOrUpgradeChart()
addedConnectStrings, installedChartName, err := helmCfg.InstallOrUpgradeChart(ctx)
if err != nil {
return installedCharts, err
}
Expand Down
2 changes: 1 addition & 1 deletion src/pkg/packager/prepare.go
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ func (p *Packager) findImages(ctx context.Context) (imgMap map[string][]string,
}

// Generate helm templates for this chart
chartTemplate, chartValues, err := helmCfg.TemplateChart()
chartTemplate, chartValues, err := helmCfg.TemplateChart(ctx)
if err != nil {
message.WarnErrf(err, "Problem rendering the helm template for %s: %s", chart.Name, err.Error())
erroredCharts = append(erroredCharts, chart.Name)
Expand Down

0 comments on commit fd90b88

Please sign in to comment.