msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

feat: Track paths in Load*

Browse Source 
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
pull/9403/head
Josh Soref 5 years ago
parent 585e6572bd
commit fee5be7384
11 changed files with 50 additions and 35 deletions
Show Stats Download Patch File Download Diff File

2
cmd/helm/testdata/output/lint-chart-with-bad-subcharts-with-subcharts.txt vendored
Unescape View File

@ -2,7 +2,7 @@
[INFO] Chart.yaml: icon is recommended
[WARNING] templates/: directory not found
[ERROR] : unable to load chart
error unpacking bad-subchart in chart-with-bad-subcharts: validation: chart.metadata.name is required
error unpacking bad-subchart in chart-with-bad-subcharts (from ./testdata/testcharts/chart-with-bad-subcharts/): validation: chart.metadata.name is required
==> Linting testdata/testcharts/chart-with-bad-subcharts/charts/bad-subchart
[ERROR] Chart.yaml: name is required

2
cmd/helm/testdata/output/lint-chart-with-bad-subcharts.txt vendored
Unescape View File

@ -2,6 +2,6 @@
[INFO] Chart.yaml: icon is recommended
[WARNING] templates/: directory not found
[ERROR] : unable to load chart
error unpacking bad-subchart in chart-with-bad-subcharts: validation: chart.metadata.name is required
error unpacking bad-subchart in chart-with-bad-subcharts (from ./testdata/testcharts/chart-with-bad-subcharts/): validation: chart.metadata.name is required
Error: 1 chart(s) linted, 1 chart(s) failed

2
cmd/helm/testdata/output/upgrade-with-bad-dependencies.txt vendored
Unescape View File

@ -1 +1 @@
Error: cannot load Chart.yaml: error converting YAML to JSON: yaml: line 6: did not find expected '-' indicator
Error: cannot load Chart.yaml (from ./testdata/testcharts/chart-bad-requirements/): error converting YAML to JSON: yaml: line 6: did not find expected '-' indicator

3
internal/experimental/registry/cache.go
Unescape View File

@ -142,7 +142,8 @@ func (cache *Cache) FetchReference(ref *Reference) (*CacheRefSummary, error) {
if err != nil {
return &r, err
}
ch, err := loader.LoadArchive(bytes.NewBuffer(contentBytes))
ch, err := loader.LoadArchive(bytes.NewBuffer(contentBytes),
fmt.Sprintf("[Chart(Name: %s, Repo: %s, Tag: %s)]", r.Name, r.Repo, r.Tag))
if err != nil {
return &r, err
}

18
internal/test/test.go
Unescape View File

@ -20,7 +20,9 @@ import (
"bytes"
"flag"
"io/ioutil"
"os"
"path/filepath"
"strings"
"github.com/pkg/errors"
)
@ -53,7 +55,7 @@ func AssertGoldenBytes(t TestingT, actual []byte, filename string) {
func AssertGoldenString(t TestingT, actual, filename string) {
t.Helper()
if err := compare([]byte(actual), path(filename)); err != nil {
if err := compare(relativize([]byte(actual)), path(filename)); err != nil {
t.Fatalf("%v", err)
}
}
@ -77,7 +79,7 @@ func path(filename string) string {
}
func compare(actual []byte, filename string) error {
actual = normalize(actual)
actual = relativize(normalize(actual))
if err := update(filename, actual); err != nil {
return err
}
@ -103,3 +105,15 @@ func update(filename string, in []byte) error {
func normalize(in []byte) []byte {
return bytes.Replace(in, []byte("\r\n"), []byte("\n"), -1)
}
func relativize(relative []byte) []byte {
relativeString := string(relative)
if !strings.Contains(relativeString, "(from ") {
return relative
}
base, err := os.Getwd()
if err != nil {
return relative
}
return []byte(strings.ReplaceAll(relativeString, base, "."))
}

10
pkg/chart/loader/archive.go
Unescape View File

@ -62,7 +62,7 @@ func LoadFile(name string) (*chart.Chart, error) {
return nil, err
}
c, err := LoadArchive(raw)
c, err := LoadArchive(raw, name)
if err != nil {
if err == gzip.ErrHeader {
return nil, fmt.Errorf("file '%s' does not appear to be a valid chart file (details: %s)", name, err)
@ -101,7 +101,7 @@ func ensureArchive(name string, raw *os.File) error {
// LoadArchiveFiles reads in files out of an archive into memory. This function
// performs important path security checks and should always be used before
// expanding a tarball
func LoadArchiveFiles(in io.Reader) ([]*BufferedFile, error) {
func LoadArchiveFiles(in io.Reader, Path string) ([]*BufferedFile, error) {
unzipped, err := gzip.NewReader(in)
if err != nil {
return nil, err
@ -187,11 +187,11 @@ func LoadArchiveFiles(in io.Reader) ([]*BufferedFile, error) {
}
// LoadArchive loads from a reader containing a compressed tar archive.
func LoadArchive(in io.Reader) (*chart.Chart, error) {
files, err := LoadArchiveFiles(in)
func LoadArchive(in io.Reader, Path string) (*chart.Chart, error) {
files, err := LoadArchiveFiles(in, Path)
if err != nil {
return nil, err
}
return LoadFiles(files)
return LoadFiles(files, Path)
}

2
pkg/chart/loader/archive_test.go
Unescape View File

@ -83,7 +83,7 @@ func TestLoadArchiveFiles(t *testing.T) {
_ = tw.Close()
_ = gzw.Close()
files, err := LoadArchiveFiles(buf)
files, err := LoadArchiveFiles(buf, tc.name)
tc.check(t, files, err)
})
}

2
pkg/chart/loader/directory.go
Unescape View File

@ -116,5 +116,5 @@ func LoadDir(dir string) (*chart.Chart, error) {
return c, err
}
return LoadFiles(files)
return LoadFiles(files, topdir)
}

24
pkg/chart/loader/load.go
Unescape View File

@ -69,7 +69,7 @@ type BufferedFile struct {
}
// LoadFiles loads from in-memory files.
func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
func LoadFiles(files []*BufferedFile, Path string) (*chart.Chart, error) {
c := new(chart.Chart)
subcharts := make(map[string][]*BufferedFile)
@ -82,7 +82,7 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
c.Metadata = new(chart.Metadata)
}
if err := yaml.Unmarshal(f.Data, c.Metadata); err != nil {
return c, errors.Wrap(err, "cannot load Chart.yaml")
return c, errors.Wrapf(err, "cannot load Chart.yaml (from %s)", Path)
}
// NOTE(bacongobbler): while the chart specification says that APIVersion must be set,
// Helm 2 accepted charts that did not provide an APIVersion in their chart metadata.
@ -100,12 +100,12 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
case f.Name == "Chart.lock":
c.Lock = new(chart.Lock)
if err := yaml.Unmarshal(f.Data, &c.Lock); err != nil {
return c, errors.Wrap(err, "cannot load Chart.lock")
return c, errors.Wrapf(err, "cannot load Chart.lock (from %s)", Path)
}
case f.Name == "values.yaml":
c.Values = make(map[string]interface{})
if err := yaml.Unmarshal(f.Data, &c.Values); err != nil {
return c, errors.Wrap(err, "cannot load values.yaml")
return c, errors.Wrapf(err, "cannot load values.yaml (from %s)", Path)
}
case f.Name == "values.schema.json":
c.Schema = f.Data
@ -117,10 +117,10 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
c.Metadata = new(chart.Metadata)
}
if c.Metadata.APIVersion != chart.APIVersionV1 {
log.Printf("Warning: Dependencies are handled in Chart.yaml since apiVersion \"v2\". We recommend migrating dependencies to Chart.yaml.")
log.Printf("Warning: Dependencies are handled in Chart.yaml (from %s) since apiVersion \"v2\". We recommend migrating dependencies to Chart.yaml.", Path)
}
if err := yaml.Unmarshal(f.Data, c.Metadata); err != nil {
return c, errors.Wrap(err, "cannot load requirements.yaml")
return c, errors.Wrapf(err, "cannot load requirements.yaml (from %s)", Path)
}
if c.Metadata.APIVersion == chart.APIVersionV1 {
c.Files = append(c.Files, &chart.File{Name: f.Name, Data: f.Data})
@ -129,7 +129,7 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
case f.Name == "requirements.lock":
c.Lock = new(chart.Lock)
if err := yaml.Unmarshal(f.Data, &c.Lock); err != nil {
return c, errors.Wrap(err, "cannot load requirements.lock")
return c, errors.Wrapf(err, "cannot load requirements.lock (from %s)", Path)
}
if c.Metadata == nil {
c.Metadata = new(chart.Metadata)
@ -155,7 +155,7 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
}
if c.Metadata == nil {
return c, errors.New("Chart.yaml file is missing")
return c, errors.Errorf("Chart.yaml file is missing (from %s)", Path)
}
if err := c.Validate(); err != nil {
@ -171,10 +171,10 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
case filepath.Ext(n) == ".tgz":
file := files[0]
if file.Name != n {
return c, errors.Errorf("error unpacking tar in %s: expected %s, got %s", c.Name(), n, file.Name)
return c, errors.Errorf("error unpacking tar in %s (from %s): expected %s, got %s", c.Name(), Path, n, file.Name)
}
// Untar the chart and add to c.Dependencies
sc, err = LoadArchive(bytes.NewBuffer(file.Data))
sc, err = LoadArchive(bytes.NewBuffer(file.Data), Path)
default:
// We have to trim the prefix off of every file, and ignore any file
// that is in charts/, but isn't actually a chart.
@ -187,11 +187,11 @@ func LoadFiles(files []*BufferedFile) (*chart.Chart, error) {
f.Name = parts[1]
buff = append(buff, f)
}
sc, err = LoadFiles(buff)
sc, err = LoadFiles(buff, Path)
}
if err != nil {
return c, errors.Wrapf(err, "error unpacking %s in %s", n, c.Name())
return c, errors.Wrapf(err, "error unpacking %s in %s (from %s)", n, c.Name(), Path)
}
c.AddDependency(sc)
}

14
pkg/chart/loader/load_test.go
Unescape View File

@ -223,7 +223,7 @@ func TestLoadFiles_BadCases(t *testing.T) {
},
expectError: "validation: chart.metadata.apiVersion is required"},
} {
_, err := LoadFiles(tt.bufferedFiles)
_, err := LoadFiles(tt.bufferedFiles, tt.name)
if err == nil {
t.Fatal("expected error when load illegal files")
}
@ -274,7 +274,7 @@ icon: https://example.com/64x64.png
},
}
c, err := LoadFiles(goodFiles)
c, err := LoadFiles(goodFiles, t.Name())
if err != nil {
t.Errorf("Expected good files to be loaded, got %v", err)
}
@ -299,10 +299,10 @@ icon: https://example.com/64x64.png
t.Errorf("Expected number of templates == 2, got %d", len(c.Templates))
}
if _, err = LoadFiles([]*BufferedFile{}); err == nil {
if _, err = LoadFiles([]*BufferedFile{}, t.Name()); err == nil {
t.Fatal("Expected err to be non-nil")
}
if err.Error() != "Chart.yaml file is missing" {
if err.Error() != "Chart.yaml file is missing (from TestLoadFiles)" {
t.Errorf("Expected chart metadata missing error, got '%s'", err.Error())
}
}
@ -363,7 +363,7 @@ icon: https://example.com/64x64.png
log.SetOutput(stderr)
}()
_, err = LoadFiles(goodFiles)
_, err = LoadFiles(goodFiles, t.Name())
if err != nil {
t.Errorf("Expected good files to be loaded, got %v", err)
}
@ -480,7 +480,7 @@ func TestLoadInvalidArchive(t *testing.T) {
illegalChart = filepath.Join(tmpdir, "abs-path2.tgz")
writeTar(illegalChart, "files/whatever.yaml", []byte("hello: world"))
_, err = Load(illegalChart)
if err.Error() != "Chart.yaml file is missing" {
if !strings.Contains(err.Error(), "Chart.yaml file is missing") {
t.Errorf("Unexpected error message: %s", err)
}
@ -488,7 +488,7 @@ func TestLoadInvalidArchive(t *testing.T) {
illegalChart = filepath.Join(tmpdir, "abs-winpath.tgz")
writeTar(illegalChart, "c:\\Chart.yaml", []byte("hello: world"))
_, err = Load(illegalChart)
if err.Error() != "validation: chart.metadata.name is required" {
if !strings.Contains(err.Error(), "validation: chart.metadata.name is required") {
t.Error(err)
}
}

6
pkg/chartutil/expand.go
Unescape View File

@ -32,7 +32,7 @@ import (
// Expand uncompresses and extracts a chart into the specified directory.
func Expand(dir string, r io.Reader) error {
files, err := loader.LoadArchiveFiles(r)
files, err := loader.LoadArchiveFiles(r, dir)
if err != nil {
return err
}
@ -43,13 +43,13 @@ func Expand(dir string, r io.Reader) error {
if file.Name == "Chart.yaml" {
ch := &chart.Metadata{}
if err := yaml.Unmarshal(file.Data, ch); err != nil {
return errors.Wrap(err, "cannot load Chart.yaml")
return errors.Wrapf(err, "cannot load Chart.yaml (from %s)", dir)
}
chartName = ch.Name
}
}
if chartName == "" {
return errors.New("chart name not specified")
return errors.Errorf("chart name not specified (in %s)", dir)
}
// Find the base directory

Write Preview
Loading…
Cancel
Save