fe0eca6e7a
The tool failed to properly resolve nested local dependencies to jsonnet
bundles in different directory trees. This arises because the
installation command resolves and installs nested jsonnet local
dependencies relative to the root jsonnetfile, rather than track and
evaluate the installation path relative to the nested library's
jsonnetfile.
Consider a repository with multiple local jsonnet bundles in various
directory trees, organised as follows (lockfiles elided for brevity):
/top/of/tree
|- lib/module_A
|- jsonnetfile.json
|- lib/module_B
|- jsonnetfile.json
|- src/root_module
|- jsonnetfile.json
The modules depend on each other as follows:
┌───────────────────┐ ┌───────────────────┐ ┌───────────────────┐
│ │ │ │ │ │
│ src/root_module │──>│ lib/module_A │──>│ lib/module_B │
│ │ │ │ │ │
└───────────────────┘ └───────────────────┘ └───────────────────┘
where X ──> Y indicates bundle X depends on bundle Y, expressed by
adding a dependency of type local in bundle X's jsonnetfile.json, whose
path is the relative path from bundle X to bundle Y in the directory
structure. For example, src/root_module will express a local dependency
on path ../lib/module_A to depend on library module A.
Invoking jb install in src/root_module will result in an error:
jb: error: failed to install packages: downloading: symlink destination path does not exist: %w:
stat /top/of/tree/src/module_B: no such file or directory
This occurs because jsonnet-bundler improperly attempts to resolve the
nested dependency on library module B relative to the root module path,
i.e. src/root_module. The correct behaviour is to perform such
resolution relative to the depending module's jsonnetfile.json, i.e.
relative to lib/module_A.
|
||
|---|---|---|
| cmd/jb | ||
| pkg | ||
| scripts | ||
| spec | ||
| tool/rewrite | ||
| vendor | ||
| .drone.jsonnet | ||
| .drone.yml | ||
| .gitignore | ||
| .header | ||
| CHANGELOG.md | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| VERSION | ||
jsonnet-bundler
NOTE: This project is alpha stage. Flags, configuration, behavior and design may change significantly in following releases.
The jsonnet-bundler is a package manager for Jsonnet.
Install
go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest
NOTE: please use a recent Go version to do this, ideally Go 1.13 or greater.
This will put jb in $(go env GOPATH)/bin. If you encounter the error
jb: command not found after installation then you may need to add that directory to your $PATH as shown in their docs.
Package Install
- Arch Linux AUR
- Mac OS X via Homebrew:
brew install jsonnet-bundler - Fedora (>= 32):
sudo dnf install golang-github-jsonnet-bundler
Features
- Fetches transitive dependencies
- Can vendor subtrees, as opposed to whole repositories
Current Limitations
- Always downloads entire dependent repositories, even when updating
- If two dependencies depend on the same package (diamond problem), they must require the same version
Example Usage
Initialize your project:
mkdir myproject
cd myproject
jb init
The existence of the jsonnetfile.json file means your directory is now a
jsonnet-bundler package that can define dependencies.
To depend on another package (another Github repository):
Note that your dependency need not be initialized with a jsonnetfile.json.
If it is not, it is assumed it has no transitive dependencies.
jb install https://github.com/anguslees/kustomize-libsonnet
Now write myconfig.jsonnet, which can import a file from that package.
Remember to use -J vendor when running Jsonnet to include the vendor tree.
local kustomize = import 'kustomize-libsonnet/kustomize.libsonnet';
local my_resource = {
metadata: {
name: 'my-resource',
},
};
kustomize.namePrefix('staging-')(my_resource)
To depend on a package that is in a subtree of a Github repo (this package also happens to bring in a transitive dependency):
jb install https://github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator
Note that if you are copy pasting from the Github website's address bar,
remove the tree/master from the path.
If pushed to Github, your project can now be referenced from other packages in the same way, with its dependencies fetched automatically.
All command line flags
$ jb -h
usage: jb [<flags>] <command> [<args> ...]
A jsonnet package manager
Flags:
-h, --help Show context-sensitive help (also try --help-long and
--help-man).
--version Show application version.
--jsonnetpkg-home="vendor"
The directory used to cache packages in.
-q, --quiet Suppress any output from git command.
Commands:
help [<command>...]
Show help.
init
Initialize a new empty jsonnetfile
install [<flags>] [<uris>...]
Install new dependencies. Existing ones are silently skipped
update [<uris>...]
Update all or specific dependencies.
rewrite
Automatically rewrite legacy imports to absolute ones
Design
This is an implemention of the design specified in this document: https://docs.google.com/document/d/1czRScSvvOiAJaIjwf3CogOULgQxhY9MkiBKOQI1yR14/edit#heading=h.upn4d5pcxy4c