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

fix: validate values file yaml early #125

Merged
merged 1 commit into from
Sep 19, 2024
Merged
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
18 changes: 7 additions & 11 deletions internal/cmd/local/local/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const (

type InstallOpts struct {
HelmChartVersion string
ValuesFile string
HelmValues map[string]any
Secrets []string
Migrate bool
Hosts []string
Expand Down Expand Up @@ -241,9 +241,9 @@ func (c *Command) Install(ctx context.Context, opts InstallOpts) error {
pterm.Success.Println(fmt.Sprintf("Secret from '%s' created or updated", secretFile))
}

valuesYAML, err := mergeValuesWithValuesYAML(airbyteValues, opts.ValuesFile)
valuesYAML, err := mergeValuesWithValuesYAML(airbyteValues, opts.HelmValues)
if err != nil {
return fmt.Errorf("unable to merge values with values file '%s': %w", opts.ValuesFile, err)
return err
}

if err := c.handleChart(ctx, chartRequest{
Expand Down Expand Up @@ -744,19 +744,15 @@ func determineHelmChartAction(helm helm.Client, chart *chart.Chart, releaseName
// defined in this code at a higher priority than the values defined in the values.yaml file.
// This function returns a string representation of the value.yaml file after all
// values provided were potentially overridden by the valuesYML file.
func mergeValuesWithValuesYAML(values []string, valuesYAML string) (string, error) {
func mergeValuesWithValuesYAML(values []string, userValues map[string]any) (string, error) {
a := maps.FromSlice(values)
b, err := maps.FromYAMLFile(valuesYAML)
if err != nil {
return "", fmt.Errorf("unable to read values from yaml file '%s': %w", valuesYAML, err)
}
maps.Merge(a, b)

maps.Merge(a, userValues)

res, err := maps.ToYAML(a)
if err != nil {
return "", fmt.Errorf("unable to merge values from yaml file '%s': %w", valuesYAML, err)
return "", fmt.Errorf("unable to merge values: %w", err)
}

return res, nil

}
37 changes: 6 additions & 31 deletions internal/cmd/local/local/install_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import (
"errors"
"fmt"
"net/http"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -201,7 +200,7 @@ func TestCommand_Install(t *testing.T) {
}
}

func TestCommand_Install_ValuesFile(t *testing.T) {
func TestCommand_Install_HelmValues(t *testing.T) {
expChartRepoCnt := 0
expChartRepo := []struct {
name string
Expand Down Expand Up @@ -365,36 +364,12 @@ func TestCommand_Install_ValuesFile(t *testing.T) {
t.Fatal(err)
}

if err := c.Install(context.Background(), InstallOpts{ValuesFile: "testdata/values.yml"}); err != nil {
t.Fatal(err)
helmValues := map[string]any{
"global": map[string]any{
"edition": "test",
},
}
}

func TestCommand_Install_InvalidValuesFile(t *testing.T) {
c, err := New(
k8s.TestProvider,
WithPortHTTP(portTest),
WithHelmClient(&mockHelmClient{}),
WithK8sClient(&k8stest.MockClient{}),
WithTelemetryClient(&mockTelemetryClient{}),
WithHTTPClient(&mockHTTP{}),
WithBrowserLauncher(func(url string) error {
return nil
}),
)

if err != nil {
if err := c.Install(context.Background(), InstallOpts{HelmValues: helmValues}); err != nil {
t.Fatal(err)
}

valuesFile := "testdata/dne.yml"

err = c.Install(context.Background(), InstallOpts{ValuesFile: valuesFile})
if err == nil {
t.Fatal("expecting an error, received none")
}
if !strings.Contains(err.Error(), fmt.Sprintf("unable to read values from yaml file '%s'", valuesFile)) {
t.Error("unexpected error:", err)
}

}
2 changes: 0 additions & 2 deletions internal/cmd/local/local/testdata/values.yml

This file was deleted.

8 changes: 7 additions & 1 deletion internal/cmd/local/local_install.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/airbytehq/abctl/internal/cmd/local/k8s"
"github.com/airbytehq/abctl/internal/cmd/local/local"
"github.com/airbytehq/abctl/internal/maps"
"github.com/airbytehq/abctl/internal/telemetry"
"github.com/pterm/pterm"
)
Expand Down Expand Up @@ -39,6 +40,11 @@ func (i *InstallCmd) Run(ctx context.Context, provider k8s.Provider, telClient t
return fmt.Errorf("unable to determine docker installation status: %w", err)
}

helmValues, err := maps.FromYAMLFile(i.Values)
if err != nil {
return err
}

return telClient.Wrap(ctx, telemetry.Install, func() error {
spinner.UpdateText(fmt.Sprintf("Checking for existing Kubernetes cluster '%s'", provider.ClusterName))

Expand Down Expand Up @@ -102,7 +108,7 @@ func (i *InstallCmd) Run(ctx context.Context, provider k8s.Provider, telClient t

opts := local.InstallOpts{
HelmChartVersion: i.ChartVersion,
ValuesFile: i.Values,
HelmValues: helmValues,
Secrets: i.Secret,
Migrate: i.Migrate,
Docker: dockerClient,
Expand Down
40 changes: 40 additions & 0 deletions internal/cmd/local/local_test.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
package local

import (
"context"
"os"
"path/filepath"
"strings"
"testing"

"github.com/airbytehq/abctl/internal/cmd/local/k8s"
"github.com/airbytehq/abctl/internal/cmd/local/paths"
"github.com/airbytehq/abctl/internal/telemetry"
"github.com/google/go-cmp/cmp"
)

Expand Down Expand Up @@ -89,3 +93,39 @@ func TestCheckAirbyteDir(t *testing.T) {
}
})
}

func TestValues_FileDoesntExist(t *testing.T) {
cmd := InstallCmd{Values: "thisfiledoesnotexist"}
err := cmd.Run(context.Background(), k8s.TestProvider, telemetry.NoopClient{})
if err == nil {
t.Fatal("expected error")
}
expect := "failed to read file thisfiledoesnotexist: open thisfiledoesnotexist: no such file or directory"
if err.Error() != expect {
t.Errorf("expected %q but got %q", expect, err)
}
}

func TestValues_BadYaml(t *testing.T) {
tmpdir := t.TempDir()
p := filepath.Join(tmpdir, "values.yaml")
content := `
foo:
- bar: baz
- foo
`

if err := os.WriteFile(p, []byte(content), 0644); err != nil {
t.Fatal(err)
}

cmd := InstallCmd{Values: p}
err := cmd.Run(context.Background(), k8s.TestProvider, telemetry.NoopClient{})
if err == nil {
t.Fatal("expected error")
}

if !strings.HasPrefix(err.Error(), "failed to unmarshal file") {
t.Errorf("unexpected error: %v", err)
}
}