helm/cmd/helm/repo_update_test.go

/*
Copyright The Helm Authors.
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 main

import (
	"bytes"
	"fmt"
	"io"
	"os"
	"path/filepath"
	"strings"
	"testing"

	"helm.sh/helm/v3/internal/test/ensure"
	"helm.sh/helm/v3/pkg/getter"
	"helm.sh/helm/v3/pkg/repo"
	"helm.sh/helm/v3/pkg/repo/repotest"
)

func TestUpdateCmd(t *testing.T) {
	var out bytes.Buffer
	// Instead of using the HTTP updater, we provide our own for this test.
	// The TestUpdateCharts test verifies the HTTP behavior independently.
	updater := func(repos []*repo.ChartRepository, out io.Writer, failOnRepoUpdateFail bool) error {
		for _, re := range repos {
			fmt.Fprintln(out, re.Config.Name)
		}
		return nil
	}
	o := &repoUpdateOptions{
		update:   updater,
		repoFile: "testdata/repositories.yaml",
	}
	if err := o.run(&out); err != nil {
		t.Fatal(err)
	}

	if got := out.String(); !strings.Contains(got, "charts") ||
		!strings.Contains(got, "firstexample") ||
		!strings.Contains(got, "secondexample") {
		t.Errorf("Expected 'charts', 'firstexample' and 'secondexample' but got %q", got)
	}
}

func TestUpdateCmdMultiple(t *testing.T) {
	var out bytes.Buffer
	// Instead of using the HTTP updater, we provide our own for this test.
	// The TestUpdateCharts test verifies the HTTP behavior independently.
	updater := func(repos []*repo.ChartRepository, out io.Writer, failOnRepoUpdateFail bool) error {
		for _, re := range repos {
			fmt.Fprintln(out, re.Config.Name)
		}
		return nil
	}
	o := &repoUpdateOptions{
		update:   updater,
		repoFile: "testdata/repositories.yaml",
		names:    []string{"firstexample", "charts"},
	}
	if err := o.run(&out); err != nil {
		t.Fatal(err)
	}

	if got := out.String(); !strings.Contains(got, "charts") ||
		!strings.Contains(got, "firstexample") ||
		strings.Contains(got, "secondexample") {
		t.Errorf("Expected 'charts' and 'firstexample' but not 'secondexample' but got %q", got)
	}
}

func TestUpdateCmdInvalid(t *testing.T) {
	var out bytes.Buffer
	// Instead of using the HTTP updater, we provide our own for this test.
	// The TestUpdateCharts test verifies the HTTP behavior independently.
	updater := func(repos []*repo.ChartRepository, out io.Writer, failOnRepoUpdateFail bool) error {
		for _, re := range repos {
			fmt.Fprintln(out, re.Config.Name)
		}
		return nil
	}
	o := &repoUpdateOptions{
		update:   updater,
		repoFile: "testdata/repositories.yaml",
		names:    []string{"firstexample", "invalid"},
	}
	if err := o.run(&out); err == nil {
		t.Fatal("expected error but did not get one")
	}
}

func TestUpdateCustomCacheCmd(t *testing.T) {
	rootDir := t.TempDir()
	cachePath := filepath.Join(rootDir, "updcustomcache")
	os.Mkdir(cachePath, os.ModePerm)

	ts, err := repotest.NewTempServerWithCleanup(t, "testdata/testserver/*.*")
	if err != nil {
		t.Fatal(err)
	}
	defer ts.Stop()

	o := &repoUpdateOptions{
		update:    updateCharts,
		repoFile:  filepath.Join(ts.Root(), "repositories.yaml"),
		repoCache: cachePath,
	}
	b := io.Discard
	if err := o.run(b); err != nil {
		t.Fatal(err)
	}
	if _, err := os.Stat(filepath.Join(cachePath, "test-index.yaml")); err != nil {
		t.Fatalf("error finding created index file in custom cache: %v", err)
	}
}

func TestUpdateCharts(t *testing.T) {
	defer resetEnv()()
	ensure.HelmHome(t)

	ts, err := repotest.NewTempServerWithCleanup(t, "testdata/testserver/*.*")
	if err != nil {
		t.Fatal(err)
	}
	defer ts.Stop()

	r, err := repo.NewChartRepository(&repo.Entry{
		Name: "charts",
		URL:  ts.URL(),
	}, getter.All(settings))
	if err != nil {
		t.Error(err)
	}

	b := bytes.NewBuffer(nil)
	updateCharts([]*repo.ChartRepository{r}, b, false)

	got := b.String()
	if strings.Contains(got, "Unable to get an update") {
		t.Errorf("Failed to get a repo: %q", got)
	}
	if !strings.Contains(got, "Update Complete.") {
		t.Error("Update was not successful")
	}
}

func TestRepoUpdateFileCompletion(t *testing.T) {
	checkFileCompletion(t, "repo update", false)
	checkFileCompletion(t, "repo update repo1", false)
}

func TestUpdateChartsFail(t *testing.T) {
	defer resetEnv()()
	ensure.HelmHome(t)

	ts, err := repotest.NewTempServerWithCleanup(t, "testdata/testserver/*.*")
	if err != nil {
		t.Fatal(err)
	}
	defer ts.Stop()

	var invalidURL = ts.URL() + "55"
	r, err := repo.NewChartRepository(&repo.Entry{
		Name: "charts",
		URL:  invalidURL,
	}, getter.All(settings))
	if err != nil {
		t.Error(err)
	}

	b := bytes.NewBuffer(nil)
	if err := updateCharts([]*repo.ChartRepository{r}, b, false); err != nil {
		t.Error("Repo update should not return error if update of repository fails")
	}

	got := b.String()
	if !strings.Contains(got, "Unable to get an update") {
		t.Errorf("Repo should have failed update but instead got: %q", got)
	}
	if !strings.Contains(got, "Update Complete.") {
		t.Error("Update was not successful")
	}
}

func TestUpdateChartsFailWithError(t *testing.T) {
	defer resetEnv()()
	ensure.HelmHome(t)

	ts, err := repotest.NewTempServerWithCleanup(t, "testdata/testserver/*.*")
	if err != nil {
		t.Fatal(err)
	}
	defer ts.Stop()

	var invalidURL = ts.URL() + "55"
	r, err := repo.NewChartRepository(&repo.Entry{
		Name: "charts",
		URL:  invalidURL,
	}, getter.All(settings))
	if err != nil {
		t.Error(err)
	}

	b := bytes.NewBuffer(nil)
	err = updateCharts([]*repo.ChartRepository{r}, b, true)
	if err == nil {
		t.Error("Repo update should return error because update of repository fails and 'fail-on-repo-update-fail' flag set")
		return
	}
	var expectedErr = "Failed to update the following repositories"
	var receivedErr = err.Error()
	if !strings.Contains(receivedErr, expectedErr) {
		t.Errorf("Expected error (%s) but got (%s) instead", expectedErr, receivedErr)
	}
	if !strings.Contains(receivedErr, invalidURL) {
		t.Errorf("Expected invalid URL (%s) in error message but got (%s) instead", invalidURL, receivedErr)
	}

	got := b.String()
	if !strings.Contains(got, "Unable to get an update") {
		t.Errorf("Repo should have failed update but instead got: %q", got)
	}
	if strings.Contains(got, "Update Complete.") {
		t.Error("Update was not successful and should return error message because 'fail-on-repo-update-fail' flag set")
	}
}