feat: absolute imports (#63)

* feat: go-like import style

jb now creates a directory structure inside of vendor/ that is similar to how go
does (github.com/grafana/jsonnet-libs). This is reflected in the final import
paths, which means they will be go-like

* refactor(spec/deps): named regexs

* feat: make goImportStyle configurable

Defaults to off, can be enabled in `jsonnetfile.json`

* fix: integration test

* doc: license headers

* fix(deps): remove GO_IMPORT_STYLE

not an option anymore, will always do so and symlink

* feat: symlink to legacy location

* feat: allow to disable legacy links

* fix(test): legacyImports in integration tests

* fix(spec): test

* fix: respect legacyName aliases

It was possible to alias packages by changing `name` previously.

While names are now absolute (and computed), legacy links should still respect
old aliases to avoid breaking code.

* fix(test): integration

* fix(init): keep legacyImports enabled for now

* feat: rewrite imports

adds a command to automatically rewrite imports from legacy to absolute style

* fix(tool): rewrite confused by prefixing packages

When a package was a prefix of another one, it broke.
Fixed that by using a proper regular expression. Added a test to make sure it
works as expected

* Update cmd/jb/init.go

* fix: exclude local packages from legacy linking

They actually still use the old style, which is fine. LegacyLinking
messed them up, but from now on it just ignores symlinks that match a localPackage.
This commit is contained in:
Tom 2020-01-24 08:02:34 +01:00 committed by GitHub
parent 184841238b
commit 7b8a7836a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 1129 additions and 361 deletions

View file

@ -22,6 +22,7 @@ import (
"github.com/pkg/errors"
"github.com/jsonnet-bundler/jsonnet-bundler/spec"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/deps"
)
const (
@ -52,7 +53,7 @@ func Unmarshal(bytes []byte) (spec.JsonnetFile, error) {
return m, errors.Wrap(err, "failed to unmarshal file")
}
if m.Dependencies == nil {
m.Dependencies = make(map[string]spec.Dependency)
m.Dependencies = make(map[string]deps.Dependency)
}
return m, nil

View file

@ -24,17 +24,17 @@ import (
"github.com/jsonnet-bundler/jsonnet-bundler/pkg/jsonnetfile"
"github.com/jsonnet-bundler/jsonnet-bundler/spec"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/deps"
)
const notExist = "/this/does/not/exist"
func TestLoad(t *testing.T) {
empty := spec.New()
jsonnetfileContent := `{
jsonnetfileContent := `
{
"legacyImports": false,
"dependencies": [
{
"name": "foobar",
"source": {
"git": {
"remote": "https://github.com/foobar/foobar",
@ -46,62 +46,61 @@ func TestLoad(t *testing.T) {
]
}
`
jsonnetFileExpected := spec.JsonnetFile{
Dependencies: map[string]spec.Dependency{
"foobar": {
Name: "foobar",
Source: spec.Source{
GitSource: &spec.GitSource{
Remote: "https://github.com/foobar/foobar",
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: "",
},
},
Version: "master",
DepSource: "",
Version: "master",
}},
}
{
jf, err := jsonnetfile.Load(notExist)
assert.Equal(t, empty, jf)
assert.Error(t, err)
tempDir, err := ioutil.TempDir("", "jb-load-jsonnetfile")
if err != nil {
t.Fatal(err)
}
{
tempDir, err := ioutil.TempDir("", "jb-load-jsonnetfile")
if err != nil {
t.Fatal(err)
}
defer func() {
err := os.RemoveAll(tempDir)
assert.Nil(t, err)
}()
defer os.RemoveAll(tempDir)
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(`{}`), os.ModePerm)
assert.Nil(t, err)
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(jsonnetfileContent), os.ModePerm)
assert.Nil(t, err)
jf, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, empty, jf)
jf, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, jsonnetFileExpected, jf)
}
func TestLoadEmpty(t *testing.T) {
tempDir, err := ioutil.TempDir("", "jb-load-empty")
if err != nil {
t.Fatal(err)
}
{
tempDir, err := ioutil.TempDir("", "jb-load-jsonnetfile")
if err != nil {
t.Fatal(err)
}
defer func() {
err := os.RemoveAll(tempDir)
assert.Nil(t, err)
}()
defer os.RemoveAll(tempDir)
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(jsonnetfileContent), os.ModePerm)
assert.Nil(t, err)
// write empty json file
tempFile := filepath.Join(tempDir, jsonnetfile.File)
err = ioutil.WriteFile(tempFile, []byte(`{}`), os.ModePerm)
assert.Nil(t, err)
jf, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, jsonnetFileExpected, jf)
}
// expect it to be loaded properly
got, err := jsonnetfile.Load(tempFile)
assert.Nil(t, err)
assert.Equal(t, spec.New(), got)
}
func TestLoadNotExist(t *testing.T) {
jf, err := jsonnetfile.Load(notExist)
assert.Equal(t, spec.New(), jf)
assert.Error(t, err)
}
func TestFileExists(t *testing.T) {