technofab/jsonnet-bundler
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/jsonnet-bundler.git synced 2025-12-11 23:50:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(spec): version field (#85)

Browse source 
Adds a `version` field to the `jsonnetfile.json`, so that `jb` can automatically recognize too old / too new schema versions, instead of panicking.
This commit is contained in:
Matthias Loibl 2020-02-28 17:41:49 +01:00 • committed by GitHub
parent efe0c9e864
commit bcd89fd33d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 454 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

66
pkg/jsonnetfile/jsonnetfile.go
View file

@ -21,8 +21,9 @@ import (
"github.com/pkg/errors"
"github.com/jsonnet-bundler/jsonnet-bundler/spec"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/deps"
v0 "github.com/jsonnet-bundler/jsonnet-bundler/spec/v0"
v1 "github.com/jsonnet-bundler/jsonnet-bundler/spec/v1"
depsv1 "github.com/jsonnet-bundler/jsonnet-bundler/spec/v1/deps"
)
const (
@ -30,13 +31,15 @@ const (
LockFile = "jsonnetfile.lock.json"
)
var ErrNoFile = errors.New("no jsonnetfile")
var (
ErrUpdateJB = errors.New("jsonnetfile version unknown, update jb")
)
// Load reads a jsonnetfile.(lock).json from disk
func Load(filepath string) (spec.JsonnetFile, error) {
func Load(filepath string) (v1.JsonnetFile, error) {
bytes, err := ioutil.ReadFile(filepath)
if err != nil {
return spec.New(), err
return v1.New(), err
}
return Unmarshal(bytes)
@ -44,19 +47,56 @@ func Load(filepath string) (spec.JsonnetFile, error) {
// Unmarshal creates a spec.JsonnetFile from bytes. Empty bytes
// will create an empty spec.
func Unmarshal(bytes []byte) (spec.JsonnetFile, error) {
m := spec.New()
func Unmarshal(bytes []byte) (v1.JsonnetFile, error) {
m := v1.New()
if len(bytes) == 0 {
return m, nil
}
if err := json.Unmarshal(bytes, &m); err != nil {
return m, errors.Wrap(err, "failed to unmarshal file")
}
if m.Dependencies == nil {
m.Dependencies = make(map[string]deps.Dependency)
versions := struct {
Version uint `json:"version"`
}{}
err := json.Unmarshal(bytes, &versions)
if err != nil {
return m, err
}
return m, nil
if versions.Version > v1.Version {
return m, ErrUpdateJB
}
if versions.Version == v1.Version {
if err := json.Unmarshal(bytes, &m); err != nil {
return m, errors.Wrap(err, "failed to unmarshal v1 file")
}
return m, nil
} else {
var mv0 v0.JsonnetFile
if err := json.Unmarshal(bytes, &mv0); err != nil {
return m, errors.Wrap(err, "failed to unmarshal jsonnetfile")
}
for name, dep := range mv0.Dependencies {
var d depsv1.Dependency
if dep.Source.GitSource != nil {
d = *depsv1.Parse("", dep.Source.GitSource.Remote)
d.Source.GitSource.Subdir = dep.Source.GitSource.Subdir
}
if dep.Source.LocalSource != nil {
d = *depsv1.Parse(dep.Source.LocalSource.Directory, dep.Source.GitSource.Remote)
}
d.Sum = dep.Sum
d.Version = dep.Version
m.Dependencies[name] = d
}
return m, nil
}
}
// Exists returns whether the file at the given path exists

194
pkg/jsonnetfile/jsonnetfile_test.go
View file

@ -23,47 +23,167 @@ import (
"github.com/stretchr/testify/assert"
"github.com/jsonnet-bundler/jsonnet-bundler/pkg/jsonnetfile"
"github.com/jsonnet-bundler/jsonnet-bundler/spec"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/deps"
v1 "github.com/jsonnet-bundler/jsonnet-bundler/spec/v1"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/v1/deps"
)
const notExist = "/this/does/not/exist"
func TestLoad(t *testing.T) {
jsonnetfileContent := `
{
"legacyImports": false,
"dependencies": [
{
"source": {
"git": {
"remote": "https://github.com/foobar/foobar",
"subdir": ""
}
},
"version": "master"
const v0JSON = `{
"dependencies": [
{
"name": "grafana-builder",
"source": {
"git": {
"remote": "https://github.com/grafana/jsonnet-libs",
"subdir": "grafana-builder"
}
]
}
`
},
"version": "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
"sum": "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE="
},
{
"name": "prometheus-mixin",
"source": {
"git": {
"remote": "https://github.com/prometheus/prometheus",
"subdir": "documentation/prometheus-mixin"
}
},
"version": "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
"sum": "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY="
}
]
}`
jsonnetFileExpected := spec.JsonnetFile{
LegacyImports: false,
Dependencies: map[string]deps.Dependency{
"github.com/foobar/foobar": {
Source: deps.Source{
GitSource: &deps.Git{
Scheme: deps.GitSchemeHTTPS,
Host: "github.com",
User: "foobar",
Repo: "foobar",
Subdir: "",
},
var v0Jsonnetfile = v1.JsonnetFile{
Dependencies: map[string]deps.Dependency{
"grafana-builder": {
Source: deps.Source{
GitSource: &deps.Git{
Scheme: deps.GitSchemeHTTPS,
Host: "github.com",
User: "grafana",
Repo: "jsonnet-libs",
Subdir: "grafana-builder",
},
Version: "master",
}},
},
Version: "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
Sum: "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE=",
},
"prometheus-mixin": {
Source: deps.Source{
GitSource: &deps.Git{
Scheme: deps.GitSchemeHTTPS,
Host: "github.com",
User: "prometheus",
Repo: "prometheus",
Subdir: "documentation/prometheus-mixin",
},
},
Version: "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
Sum: "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY=",
},
},
LegacyImports: true,
}
const v1JSON = `{
"version": 1,
"dependencies": [
{
"source": {
"git": {
"remote": "https://github.com/grafana/jsonnet-libs",
"subdir": "grafana-builder"
}
},
"version": "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
"sum": "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE="
},
{
"name": "prometheus",
"source": {
"git": {
"remote": "https://github.com/prometheus/prometheus",
"subdir": "documentation/prometheus-mixin"
}
},
"version": "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
"sum": "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY="
}
],
"legacyImports": false
}`
var v1Jsonnetfile = v1.JsonnetFile{
Dependencies: map[string]deps.Dependency{
"github.com/grafana/jsonnet-libs/grafana-builder": {
Source: deps.Source{
GitSource: &deps.Git{
Scheme: deps.GitSchemeHTTPS,
Host: "github.com",
User: "grafana",
Repo: "jsonnet-libs",
Subdir: "/grafana-builder",
},
},
Version: "54865853ebc1f901964e25a2e7a0e4d2cb6b9648",
Sum: "ELsYwK+kGdzX1mee2Yy+/b2mdO4Y503BOCDkFzwmGbE=",
},
"github.com/prometheus/prometheus/documentation/prometheus-mixin": {
LegacyNameCompat: "prometheus",
Source: deps.Source{
GitSource: &deps.Git{
Scheme: deps.GitSchemeHTTPS,
Host: "github.com",
User: "prometheus",
Repo: "prometheus",
Subdir: "/documentation/prometheus-mixin",
},
},
Version: "7c039a6b3b4b2a9d7c613ac8bd3fc16e8ca79684",
Sum: "bVGOsq3hLOw2irNPAS91a5dZJqQlBUNWy3pVwM4+kIY=",
},
},
LegacyImports: false,
}
func TestVersions(t *testing.T) {
tests := []struct {
Name string
JSON string
Jsonnetfile v1.JsonnetFile
Error error
}{
{
Name: "v0",
JSON: v0JSON,
Jsonnetfile: v0Jsonnetfile,
},
{
Name: "v1",
JSON: v1JSON,
Jsonnetfile: v1Jsonnetfile,
},
{
Name: "v100",
JSON: `{"version": 100}`,
Jsonnetfile: v1.New(),
Error: jsonnetfile.ErrUpdateJB,
},
}
for _, tc := range tests {
t.Run(tc.Name, func(t *testing.T) {
jf, err := jsonnetfile.Unmarshal([]byte(tc.JSON))
assert.Equal(t, tc.Error, err)
assert.Equal(t, tc.Jsonnetfile, jf)
})
}
}
func TestLoadV1(t *testing.T) {
tempDir, err := ioutil.TempDir("", "jb-load-jsonnetfile")
if err != nil {
t.Fatal(err)
@ -71,12 +191,12 @@ func TestLoad(t *testing.T) {
defer os.RemoveAll(tempDir)
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(jsonnetfileContent), os.ModePerm)
err = ioutil.WriteFile(tempFile, []byte(v1JSON), os.ModePerm)
assert.Nil(t, err)
jf, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, jsonnetFileExpected, jf)
assert.Equal(t, v1Jsonnetfile, jf)
}
func TestLoadEmpty(t *testing.T) {
@ -88,18 +208,18 @@ func TestLoadEmpty(t *testing.T) {
// write empty json file
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(`{}`), os.ModePerm)
err = ioutil.WriteFile(tempFile, []byte(`{"version":1}`), os.ModePerm)
assert.Nil(t, err)
// expect it to be loaded properly
got, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, spec.New(), got)
assert.Equal(t, v1.New(), got)
}
func TestLoadNotExist(t *testing.T) {
jf, err := jsonnetfile.Load(notExist)
assert.Equal(t, spec.New(), jf)
assert.Equal(t, v1.New(), jf)
assert.Error(t, err)
}