jsonnet-bundler/cmd/jb/install.go
Tom 7b8a7836a4
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.
2020-01-24 08:02:34 +01:00

116 lines
3.3 KiB
Go

// Copyright 2018 jsonnet-bundler 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 (
"encoding/json"
"io/ioutil"
"os"
"path/filepath"
"reflect"
"github.com/pkg/errors"
kingpin "gopkg.in/alecthomas/kingpin.v2"
"github.com/jsonnet-bundler/jsonnet-bundler/pkg"
"github.com/jsonnet-bundler/jsonnet-bundler/pkg/jsonnetfile"
"github.com/jsonnet-bundler/jsonnet-bundler/spec"
"github.com/jsonnet-bundler/jsonnet-bundler/spec/deps"
)
func installCommand(dir, jsonnetHome string, uris []string) int {
if dir == "" {
dir = "."
}
jbfilebytes, err := ioutil.ReadFile(filepath.Join(dir, jsonnetfile.File))
kingpin.FatalIfError(err, "failed to load jsonnetfile")
jsonnetFile, err := jsonnetfile.Unmarshal(jbfilebytes)
kingpin.FatalIfError(err, "")
jblockfilebytes, err := ioutil.ReadFile(filepath.Join(dir, jsonnetfile.LockFile))
if !os.IsNotExist(err) {
kingpin.FatalIfError(err, "failed to load lockfile")
}
lockFile, err := jsonnetfile.Unmarshal(jblockfilebytes)
kingpin.FatalIfError(err, "")
kingpin.FatalIfError(
os.MkdirAll(filepath.Join(dir, jsonnetHome, ".tmp"), os.ModePerm),
"creating vendor folder")
for _, u := range uris {
d := deps.Parse(dir, u)
if d == nil {
kingpin.Fatalf("Unable to parse package URI `%s`", u)
}
if !depEqual(jsonnetFile.Dependencies[d.Name()], *d) {
// the dep passed on the cli is different from the jsonnetFile
jsonnetFile.Dependencies[d.Name()] = *d
// we want to install the passed version (ignore the lock)
delete(lockFile.Dependencies, d.Name())
}
}
locked, err := pkg.Ensure(jsonnetFile, jsonnetHome, lockFile.Dependencies)
kingpin.FatalIfError(err, "failed to install packages")
pkg.CleanLegacyName(jsonnetFile.Dependencies)
kingpin.FatalIfError(
writeChangedJsonnetFile(jbfilebytes, &jsonnetFile, filepath.Join(dir, jsonnetfile.File)),
"updating jsonnetfile.json")
kingpin.FatalIfError(
writeChangedJsonnetFile(jblockfilebytes, &spec.JsonnetFile{Dependencies: locked}, filepath.Join(dir, jsonnetfile.LockFile)),
"updating jsonnetfile.lock.json")
return 0
}
func depEqual(d1, d2 deps.Dependency) bool {
name := d1.Name() == d2.Name()
version := d1.Version == d2.Version
source := reflect.DeepEqual(d1.Source, d2.Source)
return name && version && source
}
func writeJSONFile(name string, d interface{}) error {
b, err := json.MarshalIndent(d, "", " ")
if err != nil {
return errors.Wrap(err, "encoding json")
}
b = append(b, []byte("\n")...)
return ioutil.WriteFile(name, b, 0644)
}
func writeChangedJsonnetFile(originalBytes []byte, modified *spec.JsonnetFile, path string) error {
origJsonnetFile, err := jsonnetfile.Unmarshal(originalBytes)
if err != nil {
return err
}
if reflect.DeepEqual(origJsonnetFile, *modified) {
return nil
}
return writeJSONFile(path, *modified)
}