Summary
When working with poetry, you can configure poetry with some specifics using the command line interface e.g.:
poetry config virtualenvs.create true
The recommendation here is to always hard-encode those configurations in a local file. This can be done adding a --local flag in the poetry config command:
poetry config --local virtualenvs.create true
The above command will create the a poetry.toml file at the root of your project, with the following information:
[virtualenvs]
create = true
This ensures that your configuration is always hard-encoded and replicable.
List the current poetry configuration
This can be done via a simple command:
poetry config --list
Use-case: system-git-client true
I rarely have to define poetry configurations, however it helps me to fix the following problem I encounter from time to time:
(1) I have a CI/CD pipeline running on Gitlab;
(2) This pipeline has 3 different stages: quality-checks, build and deploy;
(3) Each of these stages might require python dependencies. These dependencies are managed by poetry. You need the Gitlab CI/CD runner to install them within the virtual environment where the stages are gonna execute their scripts. This means, you need each job to run poetry install. E.g.:
variables:
GIT_SUBMODULE_STRATEGY: recursive
stages:
- test
- build
- deploy
quality-checks:
image: "<your-custom-docker-path>/ci-cd-python-test-harness:latest"
stage: test
script:
- <setup-gitlab-ssh-access>
- <add-safe-git-directories>
- poetry install
- make checks
...
Note: here, the last line make checks triggers a Makefile action, running black, mypy, pylint and pytest on the codebase. You can have a look on what this make command looks like in the snippet immediately below:
black:
poetry run black .
mypy:
poetry run mypy <your-src-folder>
pylint:
poetry run pylint <your-src-folder>
test:
PYTHONWARNINGS=ignore poetry run pytest -vvvs <your-test-folder>
checks: black mypy pylint test
Thus, I have my CI/CD running poetry install before the CI/CD runner to be able to test my code in its virtual environment.
(4) Part of the poetry install will install all the dependencies my project contains, including git submodules. This is exactly where our issue lies!
$ poetry install
Creating virtualenv <your-repository>_-py3.10 in /home/gitlab-runner/.cache/pypoetry/virtualenvs
Installing dependencies from lock file
No git repository was found at ../../<your-submodule-repository>.git
Cleaning up project directory and file based variables
00:01
ERROR: Job failed: exit code 1
In order for your project to be able to use git submodules and the CI/CD to run successfully, you need to run the following command:
poetry config --local experimental.system-git-client true
This creates a poetry.toml file with the following lines:
[experimental]
system-git-client = true
This trick should fix the No git repository was found error occurring in your CI/CD pipeline.