Leverage CLI is the tool used to manage and interact with any Leverage project.
It transparently handles the most complex and error prone tasks that arise from working with a state-of-the-art infrastructure definition like our Leverage Reference Architecture. Leverage CLI uses a dockerized approach to encapsulate the tools needed to perform such tasks and to free the user from having to deal with the configuration and management of said tools. Provides the means to interact with your Leverage project and allows you to define custom tasks to run.
Reviewing and implementing the Binbash Leverage Landing Zone for AWS would be a very good place to start!
For installation instructions and all documentation regarding Leverage CLI, please refer to this page.
Note for migration from previous versions
If you come from Leverage CLI version <1.8.0 and want to install Leverage CLI version >= 1.8.0 keep into account the following.
build.env file format has changed. As an example, this is the old format:
# Project settings
New version example:
# Project settings
So, if you have created a project with version <1.8.0 and want to use it with version >=1.8.0 you should:
- remove TERRAFORM_IMAGE_NAME line
- update TERRAFORM_IMAGE_TAG from this form '9.9.9' to this one '9.9.9-9.9.9'.
For the second item you can check the version here.
Setting up development environment
First, you should create a virtual environment and install all the required dependencies by running:
pipenv install --dev.
NOTE: If you don't have
pipenv in your system, you can check the following documentation: https://pipenv.pypa.io/en/latest/#install-pipenv-today
Now, go to the directory that you will be using for running the local version of the CLI (it needs to be directory outside the CLI's source code) and install the CLI as an editable package inside this new virtual environment:
pipenv install -e /path/to/cli-source-code.
After that shell into the virtual environment via
pipenv shell to start using the CLI in dev mode. This way, the
leverage command on your virtual environment will be executed from the project folder, using it as the source.
Now all the changes to the project will be immediately reflected on the command.
In order to run black automatically on every commit, you should install
And then the hooks:
To run unit tests, pytest is the tool of choice, and the required dependencies are available in the corresponding
Integration tests are implemented using bats. Bear in mind that bats tests are meant to be run in a throwaway environment since they perform filesystem manipulations and installation and removal of packages, and the cleanup may not be completely thorough. As such, is highly recommended to run these tests using de docker image.
pip3 install -r dev-requirements.txt
python3 -m pytest
bats -r tests/bats
Using docker image
A Docker image suitable for running all tests can be crafted by running
make build-image. After crafting the image all tests can be executed.
To run all tests, run
make tests. Alternatively
make test-unit or
make test-int for unit or integration tests respectively.
- On every PR, a Github Action workflow is triggered to create/update a release draft.
- The version number is determined by the labels of those PRs (major, minor, fix).
- The release draft has to be manually published. This allows for any number of PR (features, fixes) to make the cut.
- Once a release is published, another workflow is triggered to create and push the package to PyPi.
Release Candidate Process
- There is an Action called "Test Build Package and Push".
- This Action can be called manually on any branch specifying the version to release to test.
- The version is a Release Candidate following the Semver: e.g. if the next release is 1.2.3, the test version should be 1.2.3-rc.1
- The package will be published to PyPi.
- Leverage CLI was initially based on Pynt: https://github.com/rags/pynt