mirror of
https://github.com/enpaul/tox-poetry-installer.git
synced 2025-06-05 07:33:26 +00:00
Compare commits
83 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 536fd6536b | |||
bbb075a1de
|
|||
|
198287a633
|
|||
|
4b38b00f81
|
|||
|
863f88d63c
|
|||
|
d816678975
|
|||
|
552f2080f5
|
|||
|
ddbf442a30
|
|||
|
13cfb8616c
|
|||
|
df343396a4
|
|||
|
f66e59ab85
|
|||
|
f37463d172
|
|||
|
6837a64121
|
|||
|
506aae0ccd
|
|||
|
5c4d861230
|
|||
|
f3ae242cf7
|
|||
|
57787c6206
|
|||
|
661072a69f
|
|||
|
0a46b2d876
|
|||
|
c06cdfe8c2
|
|||
| e875008bff | |||
|
ef3cf00e6b
|
|||
|
230d3cffd9
|
|||
|
873e1a719c
|
|||
| f6dab542d0 | |||
|
7f004fd7e2
|
|||
| 76cc63e685 | |||
|
9efcea762e | ||
|
|
fe95ff5ca1 | ||
|
|
6991f29b4d | ||
|
|
2b8936267e | ||
|
|
3f99f3476c | ||
|
|
46a7619c4f | ||
|
|
c81215bc3b | ||
|
|
0693ce4706 | ||
|
|
a489fe2c53 | ||
|
|
a94933e7ef | ||
|
c55ba474c7
|
|||
| 2b75f74996 | |||
|
449381ca09
|
|||
|
bb44db0f9d
|
|||
|
afaf025485
|
|||
|
c984abbc2f
|
|||
|
cee49ff6c0
|
|||
|
11a478bd4e
|
|||
|
5e26a4e0de
|
|||
| c6c35636cd | |||
|
bc75c57126 | ||
|
|
7e5bc30b93 | ||
|
|
593f260278 | ||
|
779dd8c56f
|
|||
|
3399bbecc2
|
|||
|
dd61f8c40f
|
|||
| 447475ebe0 | |||
|
d711a17596
|
|||
|
4f69c8b3b2
|
|||
| bd102605b6 | |||
|
469cb251cf
|
|||
| 41ac5423f9 | |||
|
3388553ee0
|
|||
|
52f34cb317
|
|||
|
4c609770f1
|
|||
| d5650f0562 | |||
|
4261d45218
|
|||
|
d0842456cb
|
|||
|
b631a962b2
|
|||
|
453b575159
|
|||
| 50e1aaddcd | |||
|
|
d0efbd06b3 | ||
|
c435f1af69
|
|||
|
817ae28a23
|
|||
| 12c4ec62f2 | |||
|
73ddd43284 | ||
|
a181da95b3 | ||
|
|
e8ce2f391b | ||
|
|
c8fd6e4fc0 | ||
|
|
22012d4452 | ||
|
|
17d0272089 | ||
|
|
b54bf44dc5 | ||
| 17885b50f7 | |||
|
72c719c26c
|
|||
|
5f30656683
|
|||
| b3a5e869ac |
3
.github/scripts/setup-env.sh
vendored
3
.github/scripts/setup-env.sh
vendored
@ -8,7 +8,7 @@
|
||||
set -e;
|
||||
|
||||
CI_CACHE=$HOME/.cache;
|
||||
POETRY_VERSION=1.1.12;
|
||||
POETRY_VERSION=1.3.2;
|
||||
|
||||
mkdir --parents "$CI_CACHE";
|
||||
|
||||
@ -26,7 +26,6 @@ poetry --version --no-ansi;
|
||||
poetry run pip --version;
|
||||
|
||||
poetry install \
|
||||
--extras poetry \
|
||||
--quiet \
|
||||
--remove-untracked \
|
||||
--no-ansi;
|
||||
|
||||
39
.github/workflows/ci.yaml
vendored
39
.github/workflows/ci.yaml
vendored
@ -7,29 +7,33 @@ on:
|
||||
branches: ["devel"]
|
||||
jobs:
|
||||
Test:
|
||||
name: Python ${{ matrix.python.version }}
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python:
|
||||
- version: "3.6"
|
||||
toxenv: py36
|
||||
- version: "3.7"
|
||||
toxenv: py37
|
||||
- version: "3.8"
|
||||
toxenv: py38
|
||||
- version: "3.9"
|
||||
toxenv: py39
|
||||
- version: "3.10"
|
||||
toxenv: py310
|
||||
- version: "3.11"
|
||||
toxenv: py311
|
||||
- version: "3.12"
|
||||
toxenv: py312
|
||||
fail-fast: true
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Install Python ${{ matrix.python.version }}
|
||||
uses: actions/setup-python@v1
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python.version }}
|
||||
|
||||
- name: Configure Job Cache
|
||||
uses: actions/cache@v2
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pip
|
||||
@ -39,38 +43,49 @@ jobs:
|
||||
# will be invalidated, and thus all packages will be redownloaded, if the
|
||||
# lockfile is updated
|
||||
key: ${{ runner.os }}-${{ matrix.python.toxenv }}-${{ hashFiles('**/poetry.lock') }}
|
||||
|
||||
- name: Configure Path
|
||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||
|
||||
- name: Configure Environment
|
||||
run: .github/scripts/setup-env.sh
|
||||
|
||||
- name: Run Toxenv ${{ matrix.python.toxenv }}
|
||||
run: poetry run tox -e ${{ matrix.python.toxenv }}
|
||||
|
||||
Check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
- name: Install Python 3.8
|
||||
uses: actions/setup-python@v1
|
||||
|
||||
- name: Install Python 3.10
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: 3.8
|
||||
python-version: "3.10"
|
||||
|
||||
- name: Configure Job Cache
|
||||
uses: actions/cache@v2
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pip
|
||||
~/.cache/pypoetry/cache
|
||||
~/.poetry
|
||||
# Hardcoded 'py38' slug here lets this cache piggyback on the 'py38' cache
|
||||
# Hardcoded 'py310' slug here lets this cache piggyback on the 'py310' cache
|
||||
# that is generated for the tests above
|
||||
key: ${{ runner.os }}-py38-${{ hashFiles('**/poetry.lock') }}
|
||||
key: ${{ runner.os }}-py310-${{ hashFiles('**/poetry.lock') }}
|
||||
|
||||
- name: Configure Path
|
||||
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
|
||||
|
||||
- name: Configure Environment
|
||||
run: .github/scripts/setup-env.sh
|
||||
|
||||
- name: Run Static Analysis Checks
|
||||
run: poetry run tox -e static
|
||||
|
||||
- name: Run Static Analysis Checks (Tests)
|
||||
run: poetry run tox -e static-tests
|
||||
|
||||
- name: Run Security Checks
|
||||
run: poetry run tox -e security
|
||||
|
||||
@ -47,12 +47,13 @@ repos:
|
||||
|
||||
- id: reorder-python-imports
|
||||
name: reorder-python-imports
|
||||
entry: reorder-python-imports
|
||||
entry: isort
|
||||
language: system
|
||||
args:
|
||||
- "--unclassifiable-application-module=tox_poetry_installer"
|
||||
require_serial: true
|
||||
types:
|
||||
- python
|
||||
args:
|
||||
- "--filter-files"
|
||||
|
||||
- id: black
|
||||
name: black
|
||||
|
||||
@ -11,7 +11,6 @@
|
||||
# --disable=W"
|
||||
disable=logging-fstring-interpolation
|
||||
,logging-format-interpolation
|
||||
,bad-continuation
|
||||
,line-too-long
|
||||
,ungrouped-imports
|
||||
,typecheck
|
||||
|
||||
120
CHANGELOG.md
120
CHANGELOG.md
@ -2,14 +2,87 @@
|
||||
|
||||
See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).
|
||||
|
||||
## Version 1.0.0 Beta 1
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/1.0.0b1),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/1.0.0b1)
|
||||
|
||||
- Update Poetry compatibility to include >=1.5
|
||||
- Update Tox compatibility to use Tox 4
|
||||
- Remove support for Tox 3
|
||||
- Remove deprecated `--require-poetry` command line option
|
||||
- Remove deprecated `install_dev_deps` confguration option
|
||||
- Remove deprecated `--parallelize-locked-install` command line option
|
||||
|
||||
## Version 0.10.3
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.3),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.3/)
|
||||
|
||||
- Update Poetry requirement to exclude usage with incompatible 1.5 release
|
||||
|
||||
## Version 0.10.2
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.2),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.2/)
|
||||
|
||||
- Update documentation with best practices and Poetry 1.2+ command syntax
|
||||
- Fix failed install of sdist package not raising an exception in multi-threaded mode.
|
||||
Contributed by [chriskuehl](https://github.com/chriskuehl) (#86)
|
||||
|
||||
## Version 0.10.1
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.1),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.1/)
|
||||
|
||||
- Add PyPI classifier for Python-3.11 compatibility
|
||||
- Add CI support for Python-3.11
|
||||
- Add support for Poetry-1.3.x (#83)
|
||||
|
||||
## Version 0.10.0
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.10.0),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.10.0/)
|
||||
|
||||
- Add `poetry_dep_groups` option to support installing groups of Poetry dependencies.
|
||||
Contributed by [Oshmoun](https://github.com/oshmoun) (#76)
|
||||
- Deprecate `install_dev_deps` option
|
||||
|
||||
## Version 0.9.0
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.9.0),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.9.0/)
|
||||
|
||||
- Add support for Poetry-1.2.x. Contributed by [Justin Wood](https://github.com/Callek)
|
||||
(#73)
|
||||
- Update Black formatting to stable release version
|
||||
- Remove support for Python-3.6
|
||||
- Remove support for Poetry-1.1.x
|
||||
- Fix installing dependencies multiple times when transient dependencies are duplicated in
|
||||
the dependency tree
|
||||
|
||||
## Version 0.8.5
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.5),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.5/)
|
||||
|
||||
- Fix Poetry version specification supporting the incompatible Poetry-1.2.0 release
|
||||
|
||||
## Version 0.8.4
|
||||
|
||||
View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.4),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.4/)
|
||||
|
||||
- Fix issue where incompatible package versions were selected for installation when multiple
|
||||
package versions were in the lockfile
|
||||
- Fix issue where incompatible package versions were selected for installation when
|
||||
multiple package versions were in the lockfile
|
||||
|
||||
## Version 0.8.3
|
||||
|
||||
@ -26,9 +99,9 @@ View this release on:
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.2/)
|
||||
|
||||
- Improve debug-level logging for package installation, and time how long installing each
|
||||
package takes. Contributed by [Rebecca
|
||||
Turner](https://github.com/9999years).
|
||||
- Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies ([#65](https://github.com/enpaul/tox-poetry-installer/issues/65))
|
||||
package takes. Contributed by [Rebecca Turner](https://github.com/9999years) (#63).
|
||||
- Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies
|
||||
([#65](https://github.com/enpaul/tox-poetry-installer/issues/65))
|
||||
|
||||
## Version 0.8.1
|
||||
|
||||
@ -78,7 +151,8 @@ View this release on:
|
||||
process
|
||||
- Add integration with Poetry's compatibility
|
||||
[`Marker`](https://github.com/python-poetry/poetry-core/blob/master/poetry/core/version/markers.py)
|
||||
object system for determining package compatibility with the current platform ([#43](https://github.com/enpaul/tox-poetry-installer/issues/43))
|
||||
object system for determining package compatibility with the current platform
|
||||
([#43](https://github.com/enpaul/tox-poetry-installer/issues/43))
|
||||
- Add missing PyPI classifier for Python 3
|
||||
|
||||
## Version 0.6.3
|
||||
@ -103,8 +177,8 @@ View this release on:
|
||||
[CVE-2020-29651](https://nvd.nist.gov/vuln/detail/CVE-2020-29651)
|
||||
- Fix dependency identification failing when the package under test is a transient
|
||||
dependency of a locked dependency specified for installation
|
||||
- Fix `AttributeError` being raised while creating the Tox self-provisioned environment when
|
||||
using either the
|
||||
- Fix `AttributeError` being raised while creating the Tox self-provisioned environment
|
||||
when using either the
|
||||
[`minversion`](https://tox.readthedocs.io/en/latest/config.html#conf-minversion) or
|
||||
[`requires`](https://tox.readthedocs.io/en/latest/config.html#conf-requires) Tox config
|
||||
options
|
||||
@ -119,8 +193,8 @@ View this release on:
|
||||
installation problems
|
||||
- Fix regression around handling of Poetry's unsafe packages when the unsafe package is a
|
||||
transient dependency ([#33](https://github.com/enpaul/tox-poetry-installer/issues/33))
|
||||
- Fix handling of Poetry's unsafe packages when the unsafe package is a primary (environment
|
||||
or package) dependency
|
||||
- Fix handling of Poetry's unsafe packages when the unsafe package is a primary
|
||||
(environment or package) dependency
|
||||
|
||||
## Version 0.6.0
|
||||
|
||||
@ -144,7 +218,8 @@ View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.5.2),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.5.2/)
|
||||
|
||||
- Fix always attempting to install dependencies with incompatible python version constraints
|
||||
- Fix always attempting to install dependencies with incompatible python version
|
||||
constraints
|
||||
- Fix always attempting to install dependencies with incompatible python platforms
|
||||
|
||||
## Version 0.5.1
|
||||
@ -166,8 +241,8 @@ View this release on:
|
||||
|
||||
- Add option `locked_deps` to better support both locked and unlocked dependencies in a
|
||||
single environment
|
||||
- Add blocking functionality when using `require_locked_deps = true` to prevent other hooks
|
||||
from running after this one
|
||||
- Add blocking functionality when using `require_locked_deps = true` to prevent other
|
||||
hooks from running after this one
|
||||
- Update documentation to include new configuration options and errors
|
||||
- Update documentation to improve future maintainability
|
||||
- Update module structure to move from single-file module to multi-file directory module
|
||||
@ -191,7 +266,8 @@ View this release on:
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.3.1/)
|
||||
|
||||
- Fix error when installing an environment with no extras specified in the configuration
|
||||
- Fix problem where only the dependencies of the sequentially last extra would be installed
|
||||
- Fix problem where only the dependencies of the sequentially last extra would be
|
||||
installed
|
||||
- Fix regression causing no project dependencies to be installed
|
||||
|
||||
## Version 0.3.0
|
||||
@ -213,7 +289,8 @@ View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.4),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.4/)
|
||||
|
||||
- Fix support for Poetry-1.1 ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- Fix support for Poetry-1.1
|
||||
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- Include tests in sdist ([#8](https://github.com/enpaul/tox-poetry-installer/issues/8))
|
||||
|
||||
## Version 0.2.3
|
||||
@ -222,8 +299,10 @@ View this release on:
|
||||
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.3),
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.3/)
|
||||
|
||||
- Fix usage of the plugin in non-Poetry based projects ([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||
- Fix treating dependency names as case sensitive when they shouldn't be ([#7](https://github.com/enpaul/tox-poetry-installer/issues/7))
|
||||
- Fix usage of the plugin in non-Poetry based projects
|
||||
([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||
- Fix treating dependency names as case sensitive when they shouldn't be
|
||||
([#7](https://github.com/enpaul/tox-poetry-installer/issues/7))
|
||||
|
||||
## Version 0.2.2
|
||||
|
||||
@ -232,7 +311,8 @@ View this release on:
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.2/)
|
||||
|
||||
- Fix breaking when running Tox in projects that do not use Poetry for their
|
||||
environment/dependency management ([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||
environment/dependency management
|
||||
([#1](https://github.com/enpaul/tox-poetry-installer/issues/1))
|
||||
|
||||
## Version 0.2.1
|
||||
|
||||
@ -283,8 +363,8 @@ View this release on:
|
||||
[PyPI](https://pypi.org/project/tox-poetry-installer/0.1.2/)
|
||||
|
||||
- Test trivial functionality on Python-3.6 and Python-3.7
|
||||
- Fix disagreement between `pyproject.toml` and module metadata on what the current version
|
||||
is
|
||||
- Fix disagreement between `pyproject.toml` and module metadata on what the current
|
||||
version is
|
||||
- Fix constant named for PEP-440 that should have been named for PEP-508
|
||||
|
||||
## Version 0.1.1
|
||||
|
||||
@ -27,9 +27,10 @@ Examples of unacceptable behavior include:
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or email address, without their
|
||||
explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
- Publishing others' private information, such as a physical or email address, without
|
||||
their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional
|
||||
setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
@ -52,8 +53,8 @@ offline event.
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
|
||||
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All
|
||||
complaints will be reviewed and investigated promptly and fairly.
|
||||
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All complaints
|
||||
will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the reporter of
|
||||
any incident.
|
||||
@ -105,8 +106,8 @@ toward or disparagement of classes of individuals.
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
||||
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
Community Impact Guidelines were inspired by
|
||||
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
|
||||
4
Makefile
4
Makefile
@ -30,10 +30,10 @@ source: ## Build Python source distribution package
|
||||
poetry build --format sdist
|
||||
|
||||
test: ## Run the project testsuite(s)
|
||||
poetry run tox --recreate
|
||||
poetry run tox --recreate --parallel
|
||||
|
||||
dev: ## Create the local dev environment
|
||||
poetry install -E poetry
|
||||
poetry install --extras poetry --sync
|
||||
poetry run pre-commit install
|
||||
|
||||
publish: test wheel source ## Build and upload to pypi (requires $PYPI_API_KEY be set)
|
||||
|
||||
171
README.md
171
README.md
@ -25,7 +25,6 @@ environment dependencies from the [Poetry](https://python-poetry.org/) lockfile.
|
||||
- [Other Notes](#other-notes)
|
||||
- [Unsupported Tox config options](#unsupported-tox-config-options)
|
||||
- [Updating locked dependencies in a testenv](#updating-locked-dependencies-in-a-testenv)
|
||||
- [Installing unsafe dependencies](#installing-unsafe-dependencies)
|
||||
- [Using with an unmanaged Poetry installation](#using-with-an-unmanaged-poetry-installation)
|
||||
- [Developing the Plugin](#developer-documentation)
|
||||
- [Road Map](#road-map)
|
||||
@ -34,16 +33,17 @@ See the
|
||||
[Changelog](https://github.com/enpaul/tox-poetry-installer/blob/devel/CHANGELOG.md) for
|
||||
release history.
|
||||
|
||||
*See also: [official Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html), [Poetry-Dev-Dependencies Tox plugin](https://github.com/sinoroc/tox-poetry-dev-dependencies), [Poetry Tox plugin](https://github.com/tkukushkin/tox-poetry)*
|
||||
*See also: [official Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html) and
|
||||
[the official Poetry documentation on using Tox](https://python-poetry.org/docs/faq/#is-tox-supported)*
|
||||
|
||||
## Feature Overview
|
||||
|
||||
- Manage package versions in exactly one place and with exactly one tool: Poetry.
|
||||
- Ensure CI/CD and other automation tools are using the same package versions that you are
|
||||
in your local development environment.
|
||||
- Add only the packages you need to a Tox test environment, instead of everything in your
|
||||
lockfile.
|
||||
- Directly integrate with Poetry, re-using your existing package indexes and credentials
|
||||
- Add only the packages or custom groups you need to a Tox test environment, instead of
|
||||
everything in your lockfile.
|
||||
- Directly integrate with Poetry, re-using your existing package indexes and credentials,
|
||||
with no additional configuration.
|
||||
- Wherever possible, built-in Tox config options are always respected and their behavior
|
||||
kept consistent.
|
||||
@ -53,17 +53,19 @@ release history.
|
||||
|
||||
## User Documentation
|
||||
|
||||
*This section is for users looking to integrate the plugin with their project or CI system. For information on contributing to the plugin please see the [Developer Docs](#developer-documentation)*
|
||||
*This section is for users looking to integrate the plugin with their project or CI
|
||||
system. For information on contributing to the plugin please see the
|
||||
[Developer Docs](#developer-documentation)*
|
||||
|
||||
### Installing
|
||||
|
||||
The recommended way to install the plugin is to add it to a project using Poetry:
|
||||
|
||||
```bash
|
||||
poetry add tox-poetry-installer[poetry] --dev
|
||||
poetry add -G dev tox-poetry-installer[poetry]
|
||||
```
|
||||
|
||||
> **Note:** Always install the plugin with the `[poetry]` extra, unless you are
|
||||
> ℹ️ **Note:** Always install the plugin with the `[poetry]` extra, unless you are
|
||||
> [managing the Poetry installation yourself](#externally-managed-poetry-installation).
|
||||
|
||||
Alternatively, it can be installed directly to a virtual environment using Pip, though
|
||||
@ -80,16 +82,16 @@ adding the below to `tox.ini`, though this is also not recommended:
|
||||
|
||||
```ini
|
||||
requires =
|
||||
tox-poetry-installer[poetry] == 0.8.0
|
||||
tox-poetry-installer[poetry] == 0.10.2
|
||||
```
|
||||
|
||||
After installing, check that Tox recognizes the plugin by running
|
||||
`poetry run tox --version`. The command should give output similar to below:
|
||||
|
||||
```
|
||||
3.20.0 imported from .venv/lib64/python3.8/site-packages/tox/__init__.py
|
||||
3.20.0 imported from .venv/lib64/python3.10/site-packages/tox/__init__.py
|
||||
registered plugins:
|
||||
tox-poetry-installer-0.8.0 at .venv/lib64/python3.8/site-packages/tox_poetry_installer/__init__.py
|
||||
tox-poetry-installer-0.10.2 at .venv/lib64/python3.10/site-packages/tox_poetry_installer/__init__.py
|
||||
```
|
||||
|
||||
### Quick Start
|
||||
@ -146,23 +148,24 @@ locked_deps =
|
||||
commands = ...
|
||||
```
|
||||
|
||||
> **Note:** Settings configured on the main `testenv` environment are inherited by child
|
||||
> test environments (for example, `testenv:foo`). To override this, specify the setting in
|
||||
> the child environment with a different value.
|
||||
> ℹ️ **Note:** Settings configured on the main `testenv` environment are inherited by
|
||||
> child test environments (for example, `testenv:foo`). To override this, specify the
|
||||
> setting in the child environment with a different value.
|
||||
|
||||
Alternatively, we can skip specifying all of our dependencies for a test environment in
|
||||
the Tox config and just install all of our Poetry dev-dependencies automatically:
|
||||
the Tox config and install Poetry dependency groups directly:
|
||||
|
||||
```ini
|
||||
[testenv]
|
||||
description = Some very cool tests
|
||||
require_locked_deps = true
|
||||
install_dev_deps = true
|
||||
poetry_dep_groups =
|
||||
dev
|
||||
commands = ...
|
||||
```
|
||||
|
||||
> **Note:** Setting `install_dev_deps = true` on an environment that also installs the
|
||||
> project package is functionally equivalent to running `poetry install`.
|
||||
> ℹ️ **Note:** The `install_dev_deps` configuration option is deprecated. See
|
||||
> [Configuration Options](#configuration-options) for more information.
|
||||
|
||||
Finally, we can also install an unlocked dependency (a dependency which doesn't take its
|
||||
version from the Poetry lockfile) into the test environment alongside the locked ones. We
|
||||
@ -190,17 +193,17 @@ All options listed below are Tox environment options and can be applied to one o
|
||||
environment sections of the `tox.ini` file. They cannot be applied to the global Tox
|
||||
configuration section.
|
||||
|
||||
> **Note:** Settings configured on the main `testenv` environment are inherited by child
|
||||
> test environments (for example, `testenv:foo`). To override this, specify the setting in
|
||||
> the child environment with a different value.
|
||||
> ℹ️ **Note:** Settings configured on the main `testenv` environment are inherited by
|
||||
> child test environments (for example, `testenv:foo`). To override this, specify the
|
||||
> setting in the child environment with a different value.
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
| :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `locked_deps` | List | `[]` | Names of packages to install to the test environment from the Poetry lockfile. Transient dependencies (packages required by these dependencies) are automatically included. |
|
||||
| `require_locked_deps` | Boolean | False | Whether the plugin should block attempts to install unlocked dependencies to the test environment. If enabled, then the [`tox_testenv_install_deps`](https://tox.readthedocs.io/en/latest/plugins.html#tox.hookspecs.tox_testenv_install_deps) plugin hook will be intercepted and an error will be raised if the test environment has the `deps` option configured. |
|
||||
| `install_dev_deps` | Boolean | False | Whether all of the Poetry dev-dependencies should be installed to the test environment. |
|
||||
| `install_project_deps` | Boolean | True | Whether all of the Poetry primary dependencies for the project package should be installed to the test environment. |
|
||||
| `require_poetry` | Boolean | False | Whether Tox should be forced to fail if the plugin cannot import Poetry locally. If `False` then the plugin will be skipped for the test environment if Poetry cannot be imported. If `True` then the plugin will force the environment to error and the Tox run to fail. |
|
||||
| `poetry_dep_groups` | List | `[]` | Names of Poetry dependency groups specified in `pyproject.toml` to install to the test environment. |
|
||||
|
||||
### Runtime Options
|
||||
|
||||
@ -211,13 +214,6 @@ of the plugin.
|
||||
| :--------------------------- | :-----: | :-----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `--parallel-install-threads` | Integer | `10` | Number of worker threads to use to install dependencies in parallel. Installing in parallel with more threads can greatly speed up the install process, but can cause race conditions during install. Pass this option with the value `0` to entirely disable parallel installation. |
|
||||
|
||||
> **Note:** The `--require-poetry` runtime option is deprecated and will be removed in
|
||||
> version 1.0.0. Please set `require_poetry = true` in `tox.ini` for environments that
|
||||
> should fail if Poetry is not available.
|
||||
|
||||
> **Note:** The `--parallelize-locked-install` option is deprecated and will be removed in
|
||||
> version 1.0.0. Please use the `--parallel-install-threads` option.
|
||||
|
||||
### Errors
|
||||
|
||||
There are several errors that the plugin can encounter for a test environment when Tox is
|
||||
@ -230,12 +226,11 @@ error will be set to one of the "Status" values below to indicate what the error
|
||||
| `LockedDepVersionConflictError` | Indicates that an item in the `locked_deps` config option includes a [PEP-508 version specifier](https://www.python.org/dev/peps/pep-0508/#grammar) (ex: `pytest >=6.0, <6.1`). |
|
||||
| `LockedDepNotFoundError` | Indicates that an item specified in the `locked_deps` config option does not match the name of a package in the Poetry lockfile. |
|
||||
| `LockedDepsRequiredError` | Indicates that a test environment with the `require_locked_deps` config option set to `true` also specified unlocked dependencies using the [`deps`](https://tox.readthedocs.io/en/latest/config.html#conf-deps) config option. |
|
||||
| `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and the `--require-poetry` flag was provided. |
|
||||
| `RequiresUnsafeDepError` | Indicates that the package-under-test depends on a package that Poetry has classified as unsafe and cannot be installed. |
|
||||
| `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and `require_poetry = true` was specified. |
|
||||
|
||||
> **Note:** One or more of these errors can be caused by the `pyproject.toml` being out of
|
||||
> sync with the Poetry lockfile. If this is the case, than a warning will be logged when Tox
|
||||
> is run.
|
||||
> ℹ️ **Note:** One or more of these errors can be caused by the `pyproject.toml` being out
|
||||
> of sync with the Poetry lockfile. If this is the case, than a warning will be logged
|
||||
> when Tox is run.
|
||||
|
||||
### Other Notes
|
||||
|
||||
@ -246,8 +241,8 @@ these options are made obsolete by the Poetry lockfile: either they aren't neede
|
||||
equivalent functionality is instead taken directly from the package details Poetry stores
|
||||
in its lockfile.
|
||||
|
||||
> **Note:** The unsupported Tox config options will still apply to unlocked dependencies
|
||||
> being installed with the default Tox installation backend.
|
||||
> ℹ️ **Note:** The unsupported Tox config options will still apply to unlocked
|
||||
> dependencies being installed with the default Tox installation backend.
|
||||
|
||||
- [`install_command`](https://tox.readthedocs.io/en/latest/config.html#conf-install_command)
|
||||
- [`pip_pre`](https://tox.readthedocs.io/en/latest/config.html#conf-pip_pre)
|
||||
@ -268,41 +263,24 @@ built-in
|
||||
[`--recreate`](https://tox.readthedocs.io/en/latest/example/basic.html#forcing-re-creation-of-virtual-environments)
|
||||
option) for the new version to be found and installed.
|
||||
|
||||
> **Note:** To force Tox to always recreate a test environment the
|
||||
> [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config option
|
||||
> can be set.
|
||||
|
||||
#### Installing unsafe dependencies
|
||||
|
||||
There are several packages that cannot be installed from the lockfile because they are
|
||||
excluded by Poetry itself. As a result these packages cannot be installed by this plugin
|
||||
either as test environment dependencies passed directly to `locked_deps` or as a transient
|
||||
dependency. When one of these packages is encountered by the plugin a warning will be
|
||||
logged to the console and
|
||||
**the unsafe package will not be installed to the test environment**.
|
||||
|
||||
This list can be found in the Poetry source code
|
||||
[here](https://github.com/python-poetry/poetry/blob/master/poetry/puzzle/provider.py). As
|
||||
of [Poetry 1.1.6](https://github.com/python-poetry/poetry/releases/tag/1.1.6) there are
|
||||
four packages classified as "unsafe" by Poetry and excluded from the lockfile:
|
||||
|
||||
- `setuptools`
|
||||
- `distribute`
|
||||
- `pip`
|
||||
- `wheel`
|
||||
> ℹ️ **Note:** To force Tox to always recreate a test environment the
|
||||
> [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config
|
||||
> option can be set.
|
||||
|
||||
#### Using with an unmanaged Poetry installation
|
||||
|
||||
In CI/CD systems, automation environments, or other Python environments where the loaded
|
||||
site packages are not managed by Poetry, it can be useful to manage the local installation
|
||||
of Poetry externally. This also helps to avoid problems that can be caused by the
|
||||
`--no-root`, `--no-dev`, or `--remove-untracked` arguments to the `poetry install` command
|
||||
which, in some situations, can cause Poetry to uninstall itself if Poetry is specified as
|
||||
a dependency of one of the packages it is managing (like this plugin). To support these
|
||||
use cases, this plugin specifies the `poetry` package as an optional dependency that can
|
||||
be installed using a setuptools extra also named `poetry`.
|
||||
`--no-root`, `--without dev`, or `--sync` arguments to the `poetry install` command which,
|
||||
in some situations, can cause Poetry to uninstall itself if Poetry is specified as a
|
||||
dependency of one of the packages it is managing (like this plugin). To support these use
|
||||
cases, this plugin specifies the `poetry` package as an optional dependency that can be
|
||||
installed using a setuptools extra also named `poetry`.
|
||||
|
||||
**Critical Warning: This plugin requires Poetry to function. If the plugin is installed without the `poetry` setuptools extra then Poetry must be installed independently for the plugin to function properly.**
|
||||
> ⚠️ **Warning:** This plugin requires Poetry to function. If the plugin is installed
|
||||
> without the `poetry` setuptools extra then Poetry must be installed independently for
|
||||
> the plugin to function properly.
|
||||
|
||||
To skip installing the `poetry` package as a dependency of `tox-poetry-installer`, do not
|
||||
specify the `poetry` extra when adding the plugin:
|
||||
@ -310,11 +288,11 @@ specify the `poetry` extra when adding the plugin:
|
||||
```bash
|
||||
# Adding the package without the "[poetry]" extra specifier so that
|
||||
# Poetry is not added as a transient dev-dependency:
|
||||
poetry add tox-poetry-installer --dev
|
||||
poetry add -G dev tox-poetry-installer
|
||||
|
||||
# Adding the package with the "[poetry]" extra specifier, so the Poetry
|
||||
# package will be added to the environment and tracked in the lockfile:
|
||||
poetry add tox-poetry-installer[poetry] --dev
|
||||
poetry add -G dev tox-poetry-installer[poetry]
|
||||
```
|
||||
|
||||
Once the plugin is installed- either with or without the Poetry extra- you can validate
|
||||
@ -330,14 +308,15 @@ python -c '\
|
||||
'
|
||||
```
|
||||
|
||||
> **Note:** To force Tox to fail if Poetry is not installed, add the `require_poetry = true`
|
||||
> option to the tox `[testenv]` configuration. See the
|
||||
> ℹ️ **Note:** To force Tox to fail if Poetry is not installed, add the
|
||||
> `require_poetry = true` option to the tox `[testenv]` configuration. See the
|
||||
> [Config Options](#configuration-options) for more information.
|
||||
|
||||
## Developer Documentation
|
||||
|
||||
All project contributors and participants are expected to adhere to the
|
||||
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md) ([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
|
||||
[Contributor Covenant Code of Conduct, v2](CODE_OF_CONDUCT.md)
|
||||
([external link](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)).
|
||||
|
||||
The `devel` branch has the latest (and potentially unstable) changes. The stable releases
|
||||
are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases),
|
||||
@ -352,8 +331,8 @@ are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases)
|
||||
[fork the repository](https://docs.github.com/en/enterprise/2.20/user/github/getting-started-with-github/fork-a-repo)
|
||||
and [open a pull request](https://github.com/enpaul/tox-poetry-installer/compare).
|
||||
|
||||
Developing this project requires [Python 3.7+](https://www.python.org/downloads/) and
|
||||
[Poetry 1.0](https://python-poetry.org/docs/#installation) or later. GNU Make can
|
||||
Developing this project requires [Python 3.10+](https://www.python.org/downloads/) and
|
||||
[Poetry 1.4](https://python-poetry.org/docs/#installation) or later. GNU Make can
|
||||
optionally be used to quickly setup a local development environment, but this is not
|
||||
required.
|
||||
|
||||
@ -368,26 +347,20 @@ git clone git@github.com:enpaul/tox-poetry-installer.git
|
||||
|
||||
cd tox-poetry-installer/
|
||||
|
||||
# Create and configure the local development environment...
|
||||
# ...with make:
|
||||
# Create and configure the local development environment
|
||||
make dev
|
||||
# ...manually:
|
||||
poetry install -E poetry --remove-untracked
|
||||
poetry run pre-commit install
|
||||
|
||||
# Run tests and CI locally...
|
||||
# ...with make:
|
||||
# Run tests and CI locally
|
||||
make test
|
||||
# ...manually:
|
||||
poetry run tox --recreate
|
||||
|
||||
# See additional make targets
|
||||
make help
|
||||
```
|
||||
|
||||
> **Note:** The pre-commit hooks require dependencies in the Poetry environment to run. To
|
||||
> make a commit with the pre-commit hooks, you will need to run `poetry run git commit` or,
|
||||
> alternatively, [launch an environment shell](https://python-poetry.org/docs/cli/#shell).
|
||||
> ℹ️ **Note:** The pre-commit hooks require dependencies in the Poetry environment to run.
|
||||
> To make a commit with the pre-commit hooks, you will need to run `poetry run git commit`
|
||||
> or, alternatively,
|
||||
> [launch an environment shell](https://python-poetry.org/docs/cli/#shell).
|
||||
|
||||
## Road Map
|
||||
|
||||
@ -396,35 +369,39 @@ production environments on a provisional basis only.
|
||||
|
||||
- Beta classification was assigned with
|
||||
[v0.6.0](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.6.0)
|
||||
- Stable classification will be assigned when the test suite covers an acceptable number of
|
||||
use cases
|
||||
- Stable classification will be assigned when the test suite covers an acceptable number
|
||||
of use cases
|
||||
|
||||
### Path to Beta
|
||||
|
||||
- [x] Verify that primary package dependencies (from the `.package` env) are installed
|
||||
correctly using the Poetry backend.
|
||||
- [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras) Tox
|
||||
configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4))
|
||||
- [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras)
|
||||
Tox configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4))
|
||||
- [x] Add per-environment Tox configuration option to fall back to default installation
|
||||
backend.
|
||||
- [ ] ~Add warnings when an unsupported Tox configuration option is detected while using the
|
||||
Poetry backend.~ ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5))
|
||||
- [x] Add trivial tests to ensure the project metadata is consistent between the pyproject.toml
|
||||
and the module constants.
|
||||
- [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and improve
|
||||
robustness of the Tox and Poetry module imports to avoid potentially breaking API changes
|
||||
in upstream packages. ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- [ ] ~Add warnings when an unsupported Tox configuration option is detected while using
|
||||
the Poetry backend.~ ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5))
|
||||
- [x] Add trivial tests to ensure the project metadata is consistent between the
|
||||
pyproject.toml and the module constants.
|
||||
- [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and
|
||||
improve robustness of the Tox and Poetry module imports to avoid potentially breaking
|
||||
API changes in upstream packages.
|
||||
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- [ ] ~Find and implement a way to mitigate the
|
||||
[UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in
|
||||
Poetry.~ ([#6](https://github.com/enpaul/tox-poetry-installer/issues/6))
|
||||
- [x] Fix logging to make proper use of Tox's logging reporter infrastructure ([#3](https://github.com/enpaul/tox-poetry-installer/issues/3))
|
||||
- [x] Add configuration option for installing all dev-dependencies to a testenv ([#14](https://github.com/enpaul/tox-poetry-installer/issues/14))
|
||||
- [x] Fix logging to make proper use of Tox's logging reporter infrastructure
|
||||
([#3](https://github.com/enpaul/tox-poetry-installer/issues/3))
|
||||
- [x] Add configuration option for installing all dev-dependencies to a testenv
|
||||
([#14](https://github.com/enpaul/tox-poetry-installer/issues/14))
|
||||
|
||||
### Path to Stable
|
||||
|
||||
Everything in Beta plus...
|
||||
|
||||
- [ ] Fully replace dependency on `poetry` with dependency on `poetry-core` ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- [ ] Fully replace dependency on `poetry` with dependency on `poetry-core`
|
||||
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
|
||||
- [x] Add comprehensive unit tests
|
||||
- [ ] ~Add tests for each feature version of Tox between 3.8 and 3.20~
|
||||
- [x] Add tests for Python-3.6, 3.7, 3.8, and 3.9
|
||||
|
||||
3121
poetry.lock
generated
3121
poetry.lock
generated
File diff suppressed because it is too large
Load Diff
@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "tox-poetry-installer"
|
||||
version = "0.8.4"
|
||||
version = "1.0.0b1"
|
||||
license = "MIT"
|
||||
authors = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
||||
description = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
||||
@ -23,45 +23,47 @@ classifiers = [
|
||||
"Natural Language :: English",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.6",
|
||||
"Programming Language :: Python :: 3.7",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
]
|
||||
|
||||
[tool.poetry.plugins.tox]
|
||||
poetry_installer = "tox_poetry_installer"
|
||||
|
||||
[tool.poetry.extras]
|
||||
poetry = ["poetry"]
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.6.1"
|
||||
poetry = {version = "^1.0.0", optional = true}
|
||||
poetry-core = "^1.0.0"
|
||||
tox = "^3.8.0"
|
||||
python = "^3.8"
|
||||
cleo = ">=1.0,<3.0"
|
||||
poetry = "^1.5.0"
|
||||
poetry-core = "^1.1.0"
|
||||
tox = "^4.1"
|
||||
|
||||
[tool.poetry.dev-dependencies]
|
||||
bandit = "^1.6.2"
|
||||
black = {version = "^21.12b0", allow-prereleases = true, python = "^3.7"}
|
||||
blacken-docs = "^1.8.0"
|
||||
ipython = { version = "^7.18.1", python = "^3.7" }
|
||||
mdformat = "^0.6"
|
||||
mdformat-gfm = "^0.2"
|
||||
mypy = "^0.930"
|
||||
pre-commit = "^2.7.1"
|
||||
pre-commit-hooks = "^3.3.0"
|
||||
pylint = "^2.4.4"
|
||||
pytest = "^6.0.2"
|
||||
pytest-cov = "^2.10.1"
|
||||
reorder-python-imports = "^2.3.5"
|
||||
safety = "^1.9.0"
|
||||
toml = "^0.10.1"
|
||||
tox = "^3.20.0"
|
||||
types-toml = "^0.10.1"
|
||||
[tool.poetry.group.dev.dependencies]
|
||||
bandit = {version = "^1.7.7", python = "^3.10"}
|
||||
black = {version = "^24.3.0", python = "^3.10"}
|
||||
blacken-docs = {version = "^1.18.0", python = "^3.10"}
|
||||
ipython = {version = "^8.10.1", python = "^3.10"}
|
||||
isort = {version = "^5.13.2", python = "^3.10"}
|
||||
mdformat = {version = "^0.7", python = "^3.10"}
|
||||
mdformat-gfm = {version = "^0.3", python = "^3.10"}
|
||||
mypy = {version = "^1.11.1", python = "^3.10"}
|
||||
pre-commit = {version = "^3.8.0", python = "^3.10"}
|
||||
pre-commit-hooks = {version = "^4.6.0", python = "^3.10"}
|
||||
pylint = {version = "^3.2.6", python = "^3.10"}
|
||||
pytest = {version = "^8.3.2", python = "^3.10"}
|
||||
pytest-cov = {version = "^5.0.0", python = "^3.10"}
|
||||
toml = {version = "^0.10.1", python = "^3.10"}
|
||||
tox = "^4.1"
|
||||
types-toml = {version = "^0.10.1", python = "^3.10"}
|
||||
|
||||
[tool.isort]
|
||||
profile = "black"
|
||||
force_single_line = "true"
|
||||
lines_after_imports = 2
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core>=1.0.0"]
|
||||
requires = ["poetry-core>=1.1.0"]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
|
||||
@ -1,15 +1,16 @@
|
||||
# pylint: disable=missing-module-docstring, missing-function-docstring, unused-argument, too-few-public-methods
|
||||
# pylint: disable=missing-module-docstring,missing-function-docstring,unused-argument,too-few-public-methods,protected-access
|
||||
import time
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
import poetry.factory
|
||||
import poetry.installation.pip_installer
|
||||
import poetry.installation.executor
|
||||
import poetry.installation.operations.operation
|
||||
import poetry.utils.env
|
||||
import pytest
|
||||
import tox
|
||||
from poetry.core.packages import Package as PoetryPackage
|
||||
import tox.tox_env.python.virtual_env.runner
|
||||
|
||||
from tox_poetry_installer import utilities
|
||||
import tox_poetry_installer.hooks._tox_on_install_helpers
|
||||
|
||||
|
||||
TEST_PROJECT_PATH = Path(__file__).parent.resolve() / "test-project"
|
||||
@ -20,11 +21,8 @@ FAKE_VENV_PATH = Path("nowhere")
|
||||
class MockVirtualEnv:
|
||||
"""Mock class for the :class:`poetry.utils.env.VirtualEnv` and :class:`tox.venv.VirtualEnv`"""
|
||||
|
||||
class MockTestenvConfig: # pylint: disable=missing-class-docstring
|
||||
envdir = FAKE_VENV_PATH
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.envconfig = self.MockTestenvConfig()
|
||||
self.env_dir = FAKE_VENV_PATH
|
||||
self.installed = []
|
||||
|
||||
@staticmethod
|
||||
@ -36,32 +34,38 @@ class MockVirtualEnv:
|
||||
return (1, 2, 3)
|
||||
|
||||
|
||||
class MockPipInstaller:
|
||||
"""Mock class for the :class:`poetry.installation.pip_installer.PipInstaller`"""
|
||||
class MockExecutor:
|
||||
"""Mock class for the :class:`poetry.installation.executor.Executor`"""
|
||||
|
||||
def __init__(self, env: MockVirtualEnv, **kwargs):
|
||||
self.env = env
|
||||
|
||||
def install(self, package: PoetryPackage):
|
||||
self.env.installed.append(package)
|
||||
def execute(
|
||||
self, operations: List[poetry.installation.operations.operation.Operation]
|
||||
):
|
||||
self.env.installed.extend([operation.package for operation in operations])
|
||||
time.sleep(1)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mock_venv(monkeypatch):
|
||||
monkeypatch.setattr(utilities, "convert_virtualenv", lambda venv: venv)
|
||||
monkeypatch.setattr(
|
||||
poetry.installation.pip_installer, "PipInstaller", MockPipInstaller
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers,
|
||||
"convert_virtualenv",
|
||||
lambda venv: venv,
|
||||
)
|
||||
monkeypatch.setattr(poetry.installation.executor, "Executor", MockExecutor)
|
||||
monkeypatch.setattr(
|
||||
tox.tox_env.python.virtual_env.runner, "VirtualEnvRunner", MockVirtualEnv
|
||||
)
|
||||
monkeypatch.setattr(tox.venv, "VirtualEnv", MockVirtualEnv)
|
||||
monkeypatch.setattr(poetry.utils.env, "VirtualEnv", MockVirtualEnv)
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def mock_poetry_factory(monkeypatch):
|
||||
pypoetry = poetry.factory.Factory().create_poetry(cwd=TEST_PROJECT_PATH)
|
||||
project = poetry.factory.Factory().create_poetry(cwd=TEST_PROJECT_PATH)
|
||||
|
||||
def mock_factory(*args, **kwargs):
|
||||
return pypoetry
|
||||
return project
|
||||
|
||||
monkeypatch.setattr(poetry.factory.Factory, "create_poetry", mock_factory)
|
||||
|
||||
@ -1,35 +1,40 @@
|
||||
# pylint: disable=missing-module-docstring, redefined-outer-name, unused-argument, wrong-import-order, unused-import
|
||||
# pylint: disable=missing-module-docstring,redefined-outer-name,unused-argument,unused-import,protected-access
|
||||
import time
|
||||
from unittest import mock
|
||||
|
||||
import tox.venv
|
||||
from poetry.factory import Factory
|
||||
import poetry.factory
|
||||
import poetry.installation.executor
|
||||
import pytest
|
||||
import tox.tox_env.python.virtual_env.runner
|
||||
|
||||
import tox_poetry_installer.hooks._tox_on_install_helpers
|
||||
|
||||
from .fixtures import mock_poetry_factory
|
||||
from .fixtures import mock_venv
|
||||
from tox_poetry_installer import installer
|
||||
from tox_poetry_installer import utilities
|
||||
|
||||
|
||||
def test_deduplication(mock_venv, mock_poetry_factory):
|
||||
"""Test that the installer does not install duplicate dependencies"""
|
||||
poetry = Factory().create_poetry(None)
|
||||
packages: utilities.PackageMap = {
|
||||
item.name: item for item in poetry.locker.locked_repository(False).packages
|
||||
project = poetry.factory.Factory().create_poetry(None)
|
||||
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
|
||||
item.name: item for item in project.locker.locked_repository().packages
|
||||
}
|
||||
|
||||
venv = tox.venv.VirtualEnv()
|
||||
venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
|
||||
to_install = [packages["toml"], packages["toml"]]
|
||||
|
||||
installer.install(poetry, venv, to_install)
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
|
||||
project, venv, to_install
|
||||
)
|
||||
|
||||
assert len(set(to_install)) == len(venv.installed) # pylint: disable=no-member
|
||||
|
||||
|
||||
def test_parallelization(mock_venv, mock_poetry_factory):
|
||||
"""Test that behavior is consistent between parallel and non-parallel usage"""
|
||||
poetry = Factory().create_poetry(None)
|
||||
packages: utilities.PackageMap = {
|
||||
item.name: item for item in poetry.locker.locked_repository(False).packages
|
||||
project = poetry.factory.Factory().create_poetry(None)
|
||||
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
|
||||
item.name: item for item in project.locker.locked_repository().packages
|
||||
}
|
||||
|
||||
to_install = [
|
||||
@ -41,14 +46,18 @@ def test_parallelization(mock_venv, mock_poetry_factory):
|
||||
packages["attrs"],
|
||||
]
|
||||
|
||||
venv_sequential = tox.venv.VirtualEnv()
|
||||
venv_sequential = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
|
||||
start_sequential = time.time()
|
||||
installer.install(poetry, venv_sequential, to_install, 0)
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
|
||||
project, venv_sequential, to_install, 0
|
||||
)
|
||||
sequential = time.time() - start_sequential
|
||||
|
||||
venv_parallel = tox.venv.VirtualEnv()
|
||||
venv_parallel = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
|
||||
start_parallel = time.time()
|
||||
installer.install(poetry, venv_parallel, to_install, 5)
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
|
||||
project, venv_parallel, to_install, 5
|
||||
)
|
||||
parallel = time.time() - start_parallel
|
||||
|
||||
# The mock delay during package install is static (one second) so these values should all
|
||||
@ -57,3 +66,32 @@ def test_parallelization(mock_venv, mock_poetry_factory):
|
||||
assert round(parallel * 5) == round(sequential)
|
||||
assert round(sequential) == len(set(to_install))
|
||||
assert round(parallel * 5) == len(set(to_install))
|
||||
|
||||
|
||||
@pytest.mark.parametrize("num_threads", (0, 8))
|
||||
def test_propagates_exceptions_during_installation(
|
||||
mock_venv, mock_poetry_factory, num_threads
|
||||
):
|
||||
"""Assert that an exception which occurs during installation is properly raised.
|
||||
|
||||
Regression test for https://github.com/enpaul/tox-poetry-installer/issues/86
|
||||
"""
|
||||
project = poetry.factory.Factory().create_poetry(None)
|
||||
packages: tox_poetry_installer.hooks._tox_on_install_helpers.PackageMap = {
|
||||
item.name: item for item in project.locker.locked_repository().packages
|
||||
}
|
||||
to_install = [packages["toml"]]
|
||||
venv = tox.tox_env.python.virtual_env.runner.VirtualEnvRunner()
|
||||
fake_exception = ValueError("my testing exception")
|
||||
|
||||
with mock.patch.object(
|
||||
poetry.installation.executor,
|
||||
"Executor",
|
||||
**{"return_value.execute.side_effect": fake_exception},
|
||||
):
|
||||
with pytest.raises(ValueError) as exc_info:
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.install_package(
|
||||
project, venv, to_install, num_threads
|
||||
)
|
||||
|
||||
assert exc_info.value is fake_exception
|
||||
|
||||
@ -3,6 +3,7 @@
|
||||
The next best thing to having one source of truth is having a way to ensure all of your
|
||||
sources of truth agree with each other.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import toml
|
||||
|
||||
@ -1,33 +1,23 @@
|
||||
# pylint: disable=missing-module-docstring, redefined-outer-name, unused-argument, wrong-import-order, unused-import
|
||||
# pylint: disable=missing-module-docstring,redefined-outer-name,unused-argument,unused-import,protected-access
|
||||
import poetry.factory
|
||||
import poetry.utils.env
|
||||
import pytest
|
||||
from poetry.puzzle.provider import Provider
|
||||
|
||||
import tox_poetry_installer.hooks._tox_on_install_helpers
|
||||
from tox_poetry_installer import exceptions
|
||||
|
||||
from .fixtures import mock_poetry_factory
|
||||
from .fixtures import mock_venv
|
||||
from tox_poetry_installer import constants
|
||||
from tox_poetry_installer import exceptions
|
||||
from tox_poetry_installer import utilities
|
||||
|
||||
|
||||
def test_exclude_unsafe():
|
||||
"""Test that the unsafe packages are properly excluded
|
||||
|
||||
Also ensure that the internal constant matches the value from Poetry
|
||||
"""
|
||||
assert Provider.UNSAFE_PACKAGES == constants.UNSAFE_PACKAGES
|
||||
|
||||
for dep in constants.UNSAFE_PACKAGES:
|
||||
assert not utilities.identify_transients(dep, {}, None)
|
||||
|
||||
|
||||
def test_allow_missing():
|
||||
"""Test that the ``allow_missing`` parameter works as expected"""
|
||||
with pytest.raises(exceptions.LockedDepNotFoundError):
|
||||
utilities.identify_transients("luke-skywalker", {}, None)
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.identify_transients(
|
||||
"luke-skywalker", {}, None
|
||||
)
|
||||
|
||||
assert not utilities.identify_transients(
|
||||
assert not tox_poetry_installer.hooks._tox_on_install_helpers.identify_transients(
|
||||
"darth-vader", {}, None, allow_missing=["darth-vader"]
|
||||
)
|
||||
|
||||
@ -47,7 +37,9 @@ def test_exclude_pep508():
|
||||
"=>foo",
|
||||
]:
|
||||
with pytest.raises(exceptions.LockedDepVersionConflictError):
|
||||
utilities.identify_transients(version, {}, None)
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.identify_transients(
|
||||
version, {}, None
|
||||
)
|
||||
|
||||
|
||||
def test_functional(mock_poetry_factory, mock_venv):
|
||||
@ -56,8 +48,10 @@ def test_functional(mock_poetry_factory, mock_venv):
|
||||
Trivially test that it resolves dependencies properly and that the parent package
|
||||
is always the last in the returned list.
|
||||
"""
|
||||
pypoetry = poetry.factory.Factory().create_poetry(None)
|
||||
packages = utilities.build_package_map(pypoetry)
|
||||
project = poetry.factory.Factory().create_poetry(None)
|
||||
packages = tox_poetry_installer.hooks._tox_on_install_helpers.build_package_map(
|
||||
project
|
||||
)
|
||||
venv = poetry.utils.env.VirtualEnv() # pylint: disable=no-value-for-parameter
|
||||
|
||||
requests_requires = [
|
||||
@ -68,12 +62,18 @@ def test_functional(mock_poetry_factory, mock_venv):
|
||||
packages["requests"][0],
|
||||
]
|
||||
|
||||
transients = utilities.identify_transients("requests", packages, venv)
|
||||
transients = tox_poetry_installer.hooks._tox_on_install_helpers.identify_transients(
|
||||
"requests", packages, venv
|
||||
)
|
||||
|
||||
assert all((item in requests_requires) for item in transients)
|
||||
assert all((item in transients) for item in requests_requires)
|
||||
|
||||
for package in [packages["requests"][0], packages["tox"][0], packages["flask"][0]]:
|
||||
transients = utilities.identify_transients(package.name, packages, venv)
|
||||
transients = (
|
||||
tox_poetry_installer.hooks._tox_on_install_helpers.identify_transients(
|
||||
package.name, packages, venv
|
||||
)
|
||||
)
|
||||
assert transients[-1] == package
|
||||
assert len(transients) == len(set(transients))
|
||||
|
||||
22
tox.ini
22
tox.ini
@ -1,14 +1,11 @@
|
||||
[tox]
|
||||
envlist = py36, py37, py38, py39, py310, static, static-tests, security
|
||||
isolated_build = true
|
||||
envlist = py3{8,9,10,11,12} static, static-tests, security
|
||||
skip_missing_interpreters = true
|
||||
|
||||
[testenv]
|
||||
description = Run the tests
|
||||
require_locked_deps = true
|
||||
require_poetry = true
|
||||
extras =
|
||||
poetry
|
||||
locked_deps =
|
||||
pytest
|
||||
pytest-cov
|
||||
@ -21,16 +18,16 @@ commands =
|
||||
|
||||
[testenv:static]
|
||||
description = Static formatting and quality enforcement
|
||||
basepython = python3.8
|
||||
basepython = py310
|
||||
platform = linux
|
||||
ignore_errors = true
|
||||
locked_deps =
|
||||
black
|
||||
blacken-docs
|
||||
isort
|
||||
mdformat
|
||||
mdformat-gfm
|
||||
mypy
|
||||
reorder-python-imports
|
||||
pre-commit
|
||||
pre-commit-hooks
|
||||
pylint
|
||||
@ -46,13 +43,14 @@ commands =
|
||||
|
||||
[testenv:static-tests]
|
||||
description = Static formatting and quality enforcement for the tests
|
||||
basepython = python3.8
|
||||
basepython = py310
|
||||
platform = linux
|
||||
ignore_errors = true
|
||||
locked_deps =
|
||||
pylint
|
||||
pytest
|
||||
mypy
|
||||
toml
|
||||
types-toml
|
||||
commands =
|
||||
pylint {toxinidir}/tests/ \
|
||||
@ -63,7 +61,7 @@ commands =
|
||||
|
||||
[testenv:security]
|
||||
description = Security checks
|
||||
basepython = python3.8
|
||||
basepython = py310
|
||||
platform = linux
|
||||
ignore_errors = true
|
||||
skip_install = true
|
||||
@ -79,11 +77,3 @@ commands =
|
||||
--recursive \
|
||||
--quiet \
|
||||
--skip B101
|
||||
poetry export \
|
||||
--format requirements.txt \
|
||||
--output {envtmpdir}/requirements.txt \
|
||||
--without-hashes \
|
||||
--dev
|
||||
safety check \
|
||||
--file {envtmpdir}/requirements.txt \
|
||||
--json
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# pylint: disable=missing-docstring
|
||||
__title__ = "tox-poetry-installer"
|
||||
__summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
|
||||
__version__ = "0.8.4"
|
||||
__version__ = "1.0.0b1"
|
||||
__url__ = "https://github.com/enpaul/tox-poetry-installer/"
|
||||
__license__ = "MIT"
|
||||
__authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
# pylint: disable=missing-docstring
|
||||
from tox_poetry_installer.hooks import tox_addoption
|
||||
from tox_poetry_installer.hooks import tox_testenv_install_deps
|
||||
from tox_poetry_installer.hooks import tox_add_env_config
|
||||
from tox_poetry_installer.hooks import tox_add_option
|
||||
from tox_poetry_installer.hooks import tox_on_install
|
||||
|
||||
@ -1,39 +0,0 @@
|
||||
"""You've heard of vendoirization, now get ready for internal namespace shadowing
|
||||
|
||||
Poetry is an optional dependency of this package explicitly to support the use case of having the
|
||||
plugin and the `poetry` package installed to the same python environment; this is most common in
|
||||
containers and/or CI. In this case there are two potential problems that can arise in this case:
|
||||
|
||||
* The installation of the plugin overwrites the installed version of Poetry resulting in
|
||||
compatibility issues.
|
||||
* Running `poetry install --no-dev`, when this plugin is in the dev-deps, results in poetry being
|
||||
uninstalled from the environment.
|
||||
|
||||
To support these edge cases, and more broadly to support not messing with a system package manager,
|
||||
the `poetry` package dependency is listed as optional dependency. This allows the plugin to be
|
||||
installed to the same environment as Poetry and import that same Poetry installation here.
|
||||
|
||||
However, simply importing Poetry on the assumption that it is installed breaks another valid use
|
||||
case: having this plugin installed alongside Tox when not using a Poetry-based project. To account
|
||||
for this the imports in this module are isolated and the resultant import error that would result
|
||||
is converted to an internal error that can be caught by callers. Rather than importing this module
|
||||
at the module scope it is imported into function scope wherever Poetry components are needed. This
|
||||
moves import errors from load time to runtime which allows the plugin to be skipped if Poetry isn't
|
||||
installed and/or a more helpful error be raised within the Tox framework.
|
||||
"""
|
||||
# pylint: disable=unused-import
|
||||
import sys
|
||||
|
||||
from tox_poetry_installer import exceptions
|
||||
|
||||
|
||||
try:
|
||||
from poetry.factory import Factory
|
||||
from poetry.installation.pip_installer import PipInstaller
|
||||
from poetry.io.null_io import NullIO
|
||||
from poetry.poetry import Poetry
|
||||
from poetry.utils.env import VirtualEnv
|
||||
except ImportError:
|
||||
raise exceptions.PoetryNotInstalledError(
|
||||
f"No version of Poetry could be imported under the current environment for '{sys.executable}'"
|
||||
) from None
|
||||
@ -5,7 +5,7 @@ in this module.
|
||||
|
||||
All constants should be type hinted.
|
||||
"""
|
||||
from typing import Set
|
||||
|
||||
from typing import Tuple
|
||||
|
||||
from tox_poetry_installer import __about__
|
||||
@ -19,8 +19,5 @@ PEP508_VERSION_DELIMITERS: Tuple[str, ...] = ("~=", "==", "!=", ">", "<")
|
||||
# console output.
|
||||
REPORTER_PREFIX: str = f"{__about__.__title__}:"
|
||||
|
||||
# Internal list of packages that poetry has deemed unsafe and are excluded from the lockfile
|
||||
UNSAFE_PACKAGES: Set[str] = {"distribute", "pip", "setuptools", "wheel"}
|
||||
|
||||
# Number of threads to use for installing dependencies by default
|
||||
DEFAULT_INSTALL_THREADS: int = 10
|
||||
|
||||
@ -11,7 +11,7 @@ All exceptions should inherit from the common base exception :exc:`ToxPoetryInst
|
||||
+-- LockedDepNotFoundError
|
||||
+-- ExtraNotFoundError
|
||||
+-- LockedDepsRequiredError
|
||||
+-- RequiresUnsafeDepError
|
||||
+-- LockfileParsingError
|
||||
|
||||
"""
|
||||
|
||||
@ -44,5 +44,5 @@ class LockedDepsRequiredError(ToxPoetryInstallerException):
|
||||
"""Environment cannot specify unlocked dependencies when locked dependencies are required"""
|
||||
|
||||
|
||||
class RequiresUnsafeDepError(ToxPoetryInstallerException):
|
||||
"""Package under test depends on an unsafe dependency and cannot be installed"""
|
||||
class LockfileParsingError(ToxPoetryInstallerException):
|
||||
"""Failed to load or parse the Poetry lockfile"""
|
||||
|
||||
@ -1,259 +0,0 @@
|
||||
"""Main hook definition module
|
||||
|
||||
All implementations of tox hooks are defined here, as well as any single-use helper functions
|
||||
specifically related to implementing the hooks (to keep the size/readability of the hook functions
|
||||
themselves manageable).
|
||||
"""
|
||||
from typing import Optional
|
||||
|
||||
import tox
|
||||
from tox.action import Action as ToxAction
|
||||
from tox.config import Parser as ToxParser
|
||||
from tox.venv import VirtualEnv as ToxVirtualEnv
|
||||
|
||||
from tox_poetry_installer import __about__
|
||||
from tox_poetry_installer import constants
|
||||
from tox_poetry_installer import exceptions
|
||||
from tox_poetry_installer import installer
|
||||
from tox_poetry_installer import logger
|
||||
from tox_poetry_installer import utilities
|
||||
|
||||
|
||||
def _postprocess_install_project_deps(
|
||||
testenv_config, value: Optional[str] # pylint: disable=unused-argument
|
||||
) -> Optional[bool]:
|
||||
"""An awful hack to patch on three-state boolean logic to a config parameter
|
||||
|
||||
.. warning: This logic should 100% be removed in the next feature release. It's here to work
|
||||
around a bad design for now but should not persist.
|
||||
|
||||
The bug filed in `#61`_ is caused by a combination of poor design and attempted cleverness. The
|
||||
name of the ``install_project_deps`` config option implies that it has ultimate control over
|
||||
whether the project dependencies are installed to the testenv, but this is not actually correct.
|
||||
What it actually allows the user to do is force the project dependencies to not be installed to
|
||||
an environment that would otherwise install them. This was intended behavior, however the
|
||||
intention was wrong.
|
||||
|
||||
.. _`#61`: https://github.com/enpaul/tox-poetry-installer/issues/61
|
||||
|
||||
In an effort to be clever the plugin automatically skips installing project dependencies when
|
||||
the project package is not installed to the testenv (``skip_install = true``) or if packaging
|
||||
as a whole is disabled (``skipsdist = true``). The intention of this behavior is to install only
|
||||
the expected dependencies to a testenv and no more. However, this conflicts with the
|
||||
``install_project_deps`` config option, which cannot override this behavior because it defaults
|
||||
to ``True``. In effect, ``install_project_deps = true`` in fact means "automatically
|
||||
determine whether to install project dependencies" and ``install_project_deps = false`` means
|
||||
"never install the project dependencies". This is not ideal and unintuitive.
|
||||
|
||||
To avoid having to make a breaking change this workaround has been added to support three-state
|
||||
logic between ``True``, ``False``, and ``None``. The ``install_project_deps`` option is now
|
||||
parsed by Tox as a string with a default value of ``None``. If the value is not ``None`` then
|
||||
this post processing function will try to convert it to a boolean the same way that Tox's
|
||||
`SectionReader.getbool()`_ method does, raising an error to mimic the default behavior if it
|
||||
can't.
|
||||
|
||||
.. _`SectionReader.getbool()`: https://github.com/tox-dev/tox/blob/f8459218ee5ab5753321b3eb989b7beee5b391ad/src/tox/config/__init__.py#L1724
|
||||
|
||||
The three states for the ``install_project_deps`` setting are:
|
||||
* ``None`` - User did not configure the setting, package dependency installation is
|
||||
determined automatically
|
||||
* ``True`` - User configured the setting to ``True``, package dependencies will be installed
|
||||
* ``False`` - User configured the setting to ``False``, package dependencies will not be
|
||||
installed
|
||||
|
||||
This config option should be deprecated with the 1.0.0 release and instead an option like
|
||||
``always_install_project_deps`` should be added which overrides the default determination and
|
||||
just installs the project dependencies. The counterpart (``never_install_project_deps``)
|
||||
shouldn't be needed, since I don't think there's a real use case for that.
|
||||
"""
|
||||
if value is None:
|
||||
return value
|
||||
|
||||
if value.lower() == "true":
|
||||
return True
|
||||
if value.lower() == "false":
|
||||
return False
|
||||
|
||||
raise tox.exception.ConfigError(
|
||||
f"install_project_deps: boolean value '{value}' needs to be 'True' or 'False'"
|
||||
)
|
||||
|
||||
|
||||
@tox.hookimpl
|
||||
def tox_addoption(parser: ToxParser):
|
||||
"""Add required configuration options to the tox INI file
|
||||
|
||||
Adds the ``require_locked_deps`` configuration option to the venv to check whether all
|
||||
dependencies should be treated as locked or not.
|
||||
"""
|
||||
|
||||
parser.add_argument(
|
||||
"--require-poetry",
|
||||
action="store_true",
|
||||
dest="require_poetry",
|
||||
help="(deprecated) Trigger a failure if Poetry is not available to Tox",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--parallelize-locked-install",
|
||||
type=int,
|
||||
dest="parallelize_locked_install",
|
||||
default=None,
|
||||
help="(deprecated) Number of worker threads to use for installing dependencies from the Poetry lockfile in parallel",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--parallel-install-threads",
|
||||
type=int,
|
||||
dest="parallel_install_threads",
|
||||
default=constants.DEFAULT_INSTALL_THREADS,
|
||||
help="Number of locked dependencies to install simultaneously; set to 0 to disable parallel installation",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="install_dev_deps",
|
||||
type="bool",
|
||||
default=False,
|
||||
help="Automatically install all Poetry development dependencies to the environment",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="install_project_deps",
|
||||
type="string",
|
||||
default=None,
|
||||
help="Automatically install all Poetry primary dependencies to the environment",
|
||||
postprocess=_postprocess_install_project_deps,
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="require_locked_deps",
|
||||
type="bool",
|
||||
default=False,
|
||||
help="Require all dependencies in the environment be installed using the Poetry lockfile",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="require_poetry",
|
||||
type="bool",
|
||||
default=False,
|
||||
help="Trigger a failure if Poetry is not available to Tox",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="locked_deps",
|
||||
type="line-list",
|
||||
help="List of locked dependencies to install to the environment using the Poetry lockfile",
|
||||
)
|
||||
|
||||
|
||||
@tox.hookimpl
|
||||
def tox_testenv_install_deps(venv: ToxVirtualEnv, action: ToxAction) -> Optional[bool]:
|
||||
"""Install the dependencies for the current environment
|
||||
|
||||
Loads the local Poetry environment and the corresponding lockfile then pulls the dependencies
|
||||
specified by the Tox environment. Finally these dependencies are installed into the Tox
|
||||
environment using the Poetry ``PipInstaller`` backend.
|
||||
|
||||
:param venv: Tox virtual environment object with configuration for the local Tox environment.
|
||||
:param action: Tox action object
|
||||
"""
|
||||
|
||||
try:
|
||||
poetry = utilities.check_preconditions(venv, action)
|
||||
except exceptions.SkipEnvironment as err:
|
||||
if isinstance(err, exceptions.PoetryNotInstalledError) and (
|
||||
venv.envconfig.config.option.require_poetry or venv.envconfig.require_poetry
|
||||
):
|
||||
venv.status = err.__class__.__name__
|
||||
logger.error(str(err))
|
||||
return False
|
||||
logger.info(str(err))
|
||||
return None
|
||||
|
||||
logger.info(f"Loaded project pyproject.toml from {poetry.file}")
|
||||
|
||||
virtualenv = utilities.convert_virtualenv(venv)
|
||||
|
||||
if not poetry.locker.is_fresh():
|
||||
logger.warning(
|
||||
f"The Poetry lock file is not up to date with the latest changes in {poetry.file}"
|
||||
)
|
||||
|
||||
try:
|
||||
if venv.envconfig.require_locked_deps and venv.envconfig.deps:
|
||||
raise exceptions.LockedDepsRequiredError(
|
||||
f"Unlocked dependencies '{venv.envconfig.deps}' specified for environment '{venv.name}' which requires locked dependencies"
|
||||
)
|
||||
|
||||
packages = utilities.build_package_map(poetry)
|
||||
|
||||
if venv.envconfig.install_dev_deps:
|
||||
dev_deps = utilities.find_dev_deps(packages, virtualenv, poetry)
|
||||
logger.info(
|
||||
f"Identified {len(dev_deps)} development dependencies to install to env"
|
||||
)
|
||||
else:
|
||||
dev_deps = []
|
||||
logger.info("Env does not install development dependencies, skipping")
|
||||
|
||||
env_deps = utilities.find_additional_deps(
|
||||
packages, virtualenv, poetry, venv.envconfig.locked_deps
|
||||
)
|
||||
|
||||
logger.info(
|
||||
f"Identified {len(env_deps)} environment dependencies to install to env"
|
||||
)
|
||||
|
||||
install_project_deps = (
|
||||
venv.envconfig.install_project_deps
|
||||
if venv.envconfig.install_project_deps is not None
|
||||
else (
|
||||
not venv.envconfig.skip_install and not venv.envconfig.config.skipsdist
|
||||
)
|
||||
)
|
||||
|
||||
if install_project_deps:
|
||||
project_deps = utilities.find_project_deps(
|
||||
packages, virtualenv, poetry, venv.envconfig.extras
|
||||
)
|
||||
logger.info(
|
||||
f"Identified {len(project_deps)} project dependencies to install to env"
|
||||
)
|
||||
else:
|
||||
project_deps = []
|
||||
logger.info("Env does not install project package dependencies, skipping")
|
||||
except exceptions.ToxPoetryInstallerException as err:
|
||||
venv.status = err.__class__.__name__
|
||||
logger.error(str(err))
|
||||
return False
|
||||
except Exception as err:
|
||||
venv.status = "InternalError"
|
||||
logger.error(f"Internal plugin error: {err}")
|
||||
raise err
|
||||
|
||||
dependencies = dev_deps + env_deps + project_deps
|
||||
if (
|
||||
venv.envconfig.config.option.parallel_install_threads
|
||||
!= constants.DEFAULT_INSTALL_THREADS
|
||||
):
|
||||
parallel_threads = venv.envconfig.config.option.parallel_install_threads
|
||||
else:
|
||||
parallel_threads = (
|
||||
venv.envconfig.config.option.parallelize_locked_install
|
||||
if venv.envconfig.config.option.parallelize_locked_install is not None
|
||||
else constants.DEFAULT_INSTALL_THREADS
|
||||
)
|
||||
log_parallel = f" (using {parallel_threads} threads)" if parallel_threads else ""
|
||||
|
||||
action.setactivity(
|
||||
__about__.__title__,
|
||||
f"Installing {len(dependencies)} dependencies from Poetry lock file{log_parallel}",
|
||||
)
|
||||
installer.install(
|
||||
poetry,
|
||||
venv,
|
||||
dependencies,
|
||||
parallel_threads,
|
||||
)
|
||||
|
||||
return venv.envconfig.require_locked_deps or None
|
||||
4
tox_poetry_installer/hooks/__init__.py
Normal file
4
tox_poetry_installer/hooks/__init__.py
Normal file
@ -0,0 +1,4 @@
|
||||
# pylint: disable=missing-module-docstring
|
||||
from tox_poetry_installer.hooks.tox_add_env_config import tox_add_env_config
|
||||
from tox_poetry_installer.hooks.tox_add_option import tox_add_option
|
||||
from tox_poetry_installer.hooks.tox_on_install import tox_on_install
|
||||
366
tox_poetry_installer/hooks/_tox_on_install_helpers.py
Normal file
366
tox_poetry_installer/hooks/_tox_on_install_helpers.py
Normal file
@ -0,0 +1,366 @@
|
||||
"""Helper functions for the :func:`tox_on_install` hook"""
|
||||
|
||||
import collections
|
||||
import concurrent.futures
|
||||
import contextlib
|
||||
import datetime
|
||||
import pathlib
|
||||
from typing import Collection
|
||||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Sequence
|
||||
from typing import Set
|
||||
|
||||
import cleo.io.null_io
|
||||
import packaging.utils
|
||||
import poetry.config.config
|
||||
import poetry.core.packages.dependency
|
||||
import poetry.core.packages.package
|
||||
import poetry.factory
|
||||
import poetry.installation.executor
|
||||
import poetry.installation.operations.install
|
||||
import poetry.poetry
|
||||
import poetry.utils.env
|
||||
import tox.tox_env.api
|
||||
import tox.tox_env.package
|
||||
|
||||
from tox_poetry_installer import constants
|
||||
from tox_poetry_installer import exceptions
|
||||
from tox_poetry_installer import logger
|
||||
|
||||
|
||||
PackageMap = Dict[str, List[poetry.core.packages.package.Package]]
|
||||
|
||||
|
||||
def check_preconditions(venv: tox.tox_env.api.ToxEnv) -> poetry.poetry.Poetry:
|
||||
"""Check that the local project environment meets expectations"""
|
||||
|
||||
# Skip running the plugin for the provisioning environment. The provisioned environment,
|
||||
# for alternative Tox versions and/or the ``requires`` meta dependencies is specially
|
||||
# handled by Tox and is out of scope for this plugin. Since one of the ways to install this
|
||||
# plugin in the first place is via the Tox provisioning environment, it quickly becomes a
|
||||
# chicken-and-egg problem.
|
||||
if isinstance(venv, tox.tox_env.package.PackageToxEnv):
|
||||
raise exceptions.SkipEnvironment(f"Skipping Tox provisioning env '{venv.name}'")
|
||||
|
||||
try:
|
||||
return poetry.factory.Factory().create_poetry(venv.core["tox_root"])
|
||||
# Support running the plugin when the current tox project does not use Poetry for its
|
||||
# environment/dependency management.
|
||||
#
|
||||
# ``RuntimeError`` is dangerous to blindly catch because it can be (and in Poetry's case,
|
||||
# is) raised in many different places for different purposes.
|
||||
except RuntimeError as err:
|
||||
raise exceptions.SkipEnvironment(
|
||||
f"Skipping installation of locked dependencies due to a Poetry error: {err}"
|
||||
) from None
|
||||
|
||||
|
||||
def identify_transients(
|
||||
dep_name: str,
|
||||
packages: PackageMap,
|
||||
venv: poetry.utils.env.VirtualEnv,
|
||||
allow_missing: Sequence[str] = (),
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Using a pool of packages, identify all transient dependencies of a given package name
|
||||
|
||||
:param dep_name: Either the Poetry dependency or the dependency's bare package name to recursively
|
||||
identify the transient dependencies of
|
||||
:param packages: All packages from the lockfile to use for identifying dependency relationships.
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param allow_missing: Sequence of package names to allow to be missing from the lockfile. Any
|
||||
packages that are not found in the lockfile but their name appears in this
|
||||
list will be silently skipped from installation.
|
||||
:returns: List of packages that need to be installed for the requested dependency.
|
||||
|
||||
.. note:: The package corresponding to the dependency specified by the ``dep`` parameter will
|
||||
be included in the returned list of packages.
|
||||
"""
|
||||
searched: Set[str] = set()
|
||||
|
||||
def _transients(
|
||||
transient: poetry.core.packages.dependency.Dependency,
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
searched.add(transient.name)
|
||||
|
||||
results: List[poetry.core.packages.package.Package] = []
|
||||
for option in packages[transient.name]:
|
||||
if venv.is_valid_for_marker(option.to_dependency().marker):
|
||||
for requirement in option.requires:
|
||||
if requirement.name not in searched:
|
||||
results += _transients(requirement)
|
||||
logger.debug(f"Including {option} for installation")
|
||||
results.append(option)
|
||||
break
|
||||
else:
|
||||
logger.debug(
|
||||
f"Skipping {transient.name}: target python version is {'.'.join([str(item) for item in venv.get_version_info()])} but package requires {transient.marker}"
|
||||
)
|
||||
|
||||
return results
|
||||
|
||||
try:
|
||||
for option in packages[dep_name]:
|
||||
if venv.is_valid_for_marker(option.to_dependency().marker):
|
||||
dep = option.to_dependency()
|
||||
break
|
||||
else:
|
||||
logger.warning(
|
||||
f"Skipping {dep_name}: no locked version found compatible with target python version {'.'.join([str(item) for item in venv.get_version_info()])}"
|
||||
)
|
||||
return []
|
||||
|
||||
return _transients(dep)
|
||||
except KeyError as err:
|
||||
missing = err.args[0]
|
||||
|
||||
if missing in allow_missing:
|
||||
logger.debug(f"Skipping {missing}: package is allowed to be unlocked")
|
||||
return []
|
||||
|
||||
if any(
|
||||
delimiter in missing for delimiter in constants.PEP508_VERSION_DELIMITERS
|
||||
):
|
||||
raise exceptions.LockedDepVersionConflictError(
|
||||
f"Locked dependency '{missing}' cannot include version specifier"
|
||||
) from None
|
||||
|
||||
raise exceptions.LockedDepNotFoundError(
|
||||
f"No version of locked dependency '{missing}' found in the project lockfile"
|
||||
) from None
|
||||
|
||||
|
||||
def find_project_deps(
|
||||
packages: PackageMap,
|
||||
venv: poetry.utils.env.VirtualEnv,
|
||||
project: poetry.poetry.Poetry,
|
||||
extras: Sequence[str] = (),
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Find the root project dependencies
|
||||
|
||||
Recursively identify the dependencies of the root project package
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param project: Poetry object for the current project
|
||||
:param extras: Sequence of extra names to include the dependencies of
|
||||
"""
|
||||
|
||||
required_dep_names = [
|
||||
item.name for item in project.package.requires if not item.is_optional()
|
||||
]
|
||||
|
||||
extra_dep_names: List[str] = []
|
||||
for extra in extras:
|
||||
logger.info(f"Processing project extra '{extra}'")
|
||||
try:
|
||||
extra_dep_names += [
|
||||
item.name
|
||||
for item in project.package.extras[
|
||||
packaging.utils.NormalizedName(extra)
|
||||
]
|
||||
]
|
||||
except KeyError:
|
||||
raise exceptions.ExtraNotFoundError(
|
||||
f"Environment specifies project extra '{extra}' which was not found in the lockfile"
|
||||
) from None
|
||||
|
||||
dependencies: List[poetry.core.packages.package.Package] = []
|
||||
for dep_name in required_dep_names + extra_dep_names:
|
||||
dependencies += identify_transients(
|
||||
dep_name.lower(), packages, venv, allow_missing=[project.package.name]
|
||||
)
|
||||
|
||||
return dedupe_packages(dependencies)
|
||||
|
||||
|
||||
def find_additional_deps(
|
||||
packages: PackageMap,
|
||||
venv: poetry.utils.env.VirtualEnv,
|
||||
project: poetry.poetry.Poetry,
|
||||
dep_names: Sequence[str],
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Find additional dependencies
|
||||
|
||||
Recursively identify the dependencies of an arbitrary list of package names
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param project: Poetry object for the current project
|
||||
:param dep_names: Sequence of additional dependency names to recursively find the transient
|
||||
dependencies for
|
||||
"""
|
||||
dependencies: List[poetry.core.packages.package.Package] = []
|
||||
for dep_name in dep_names:
|
||||
dependencies += identify_transients(
|
||||
dep_name.lower(), packages, venv, allow_missing=[project.package.name]
|
||||
)
|
||||
|
||||
return dedupe_packages(dependencies)
|
||||
|
||||
|
||||
def find_group_deps(
|
||||
group: str,
|
||||
packages: PackageMap,
|
||||
venv: poetry.utils.env.VirtualEnv,
|
||||
project: poetry.poetry.Poetry,
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Find the dependencies belonging to a dependency group
|
||||
|
||||
Recursively identify the Poetry dev dependencies
|
||||
|
||||
:param group: Name of the dependency group from the project's ``pyproject.toml``
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param project: Poetry object for the current project
|
||||
"""
|
||||
return find_additional_deps(
|
||||
packages,
|
||||
venv,
|
||||
project,
|
||||
# the type ignore here is due to the difficulties around getting nested data
|
||||
# from the inherrently unstructured toml structure (which necessarily is flexibly
|
||||
# typed) but in a situation where there is a meta-structure applied to it (i.e. a
|
||||
# pyproject.toml structure).
|
||||
project.pyproject.data["tool"]["poetry"] # type: ignore
|
||||
.get("group", {})
|
||||
.get(group, {})
|
||||
.get("dependencies", {})
|
||||
.keys(),
|
||||
)
|
||||
|
||||
|
||||
def find_dev_deps(
|
||||
packages: PackageMap,
|
||||
venv: poetry.utils.env.VirtualEnv,
|
||||
project: poetry.poetry.Poetry,
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Find the dev dependencies
|
||||
|
||||
Recursively identify the Poetry dev dependencies
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param project: Poetry object for the current project
|
||||
"""
|
||||
dev_group_deps = find_group_deps("dev", packages, venv, project)
|
||||
|
||||
# Legacy pyproject.toml poetry format:
|
||||
legacy_dev_group_deps = find_additional_deps(
|
||||
packages,
|
||||
venv,
|
||||
project,
|
||||
# the type ignore here is due to the difficulties around getting nested data
|
||||
# from the inherrently unstructured toml structure (which necessarily is flexibly
|
||||
# typed) but in a situation where there is a meta-structure applied to it (i.e. a
|
||||
# pyproject.toml structure).
|
||||
project.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(), # type: ignore
|
||||
)
|
||||
|
||||
# Poetry 1.2 unions these two toml sections.
|
||||
return dedupe_packages(dev_group_deps + legacy_dev_group_deps)
|
||||
|
||||
|
||||
@contextlib.contextmanager
|
||||
def _optional_parallelize(parallels: int):
|
||||
"""A bit of cheat, really
|
||||
|
||||
A context manager that exposes a common interface for the caller that optionally
|
||||
enables/disables the usage of the parallel thread pooler depending on the value of
|
||||
the ``parallels`` parameter.
|
||||
"""
|
||||
if parallels > 0:
|
||||
with concurrent.futures.ThreadPoolExecutor(max_workers=parallels) as executor:
|
||||
yield executor.submit
|
||||
else:
|
||||
yield lambda func, arg: func(arg)
|
||||
|
||||
|
||||
def install_package(
|
||||
project: poetry.poetry.Poetry,
|
||||
venv: tox.tox_env.api.ToxEnv,
|
||||
packages: Collection[poetry.core.packages.package.Package],
|
||||
parallels: int = 0,
|
||||
):
|
||||
"""Install a bunch of packages to a virtualenv
|
||||
|
||||
:param project: Poetry object the packages were sourced from
|
||||
:param venv: Tox virtual environment to install the packages to
|
||||
:param packages: List of packages to install to the virtual environment
|
||||
:param parallels: Number of parallel processes to use for installing dependency packages, or
|
||||
``None`` to disable parallelization.
|
||||
"""
|
||||
|
||||
logger.info(f"Installing {len(packages)} packages to environment at {venv.env_dir}")
|
||||
|
||||
install_executor = poetry.installation.executor.Executor(
|
||||
env=convert_virtualenv(venv),
|
||||
io=cleo.io.null_io.NullIO(),
|
||||
pool=project.pool,
|
||||
config=poetry.config.config.Config(),
|
||||
)
|
||||
|
||||
installed: Set[poetry.core.packages.package.Package] = set()
|
||||
|
||||
def logged_install(dependency: poetry.core.packages.package.Package) -> None:
|
||||
start = datetime.datetime.now()
|
||||
logger.debug(f"Installing {dependency}")
|
||||
install_executor.execute(
|
||||
[poetry.installation.operations.install.Install(package=dependency)]
|
||||
)
|
||||
end = datetime.datetime.now()
|
||||
logger.debug(f"Finished installing {dependency} in {end - start}")
|
||||
|
||||
with _optional_parallelize(parallels) as executor:
|
||||
futures = []
|
||||
for dependency in packages:
|
||||
if dependency not in installed:
|
||||
installed.add(dependency)
|
||||
logger.debug(f"Queuing {dependency}")
|
||||
future = executor(logged_install, dependency)
|
||||
if future is not None:
|
||||
futures.append(future)
|
||||
else:
|
||||
logger.debug(f"Skipping {dependency}, already installed")
|
||||
logger.debug("Waiting for installs to finish...")
|
||||
|
||||
for future in concurrent.futures.as_completed(futures):
|
||||
# Don't actually care about the return value, just waiting on the
|
||||
# future to ensure any exceptions that were raised in the called
|
||||
# function are propagated.
|
||||
future.result()
|
||||
|
||||
|
||||
def dedupe_packages(
|
||||
packages: Sequence[poetry.core.packages.package.Package],
|
||||
) -> List[poetry.core.packages.package.Package]:
|
||||
"""Deduplicates a sequence of Packages while preserving ordering
|
||||
|
||||
Adapted from StackOverflow: https://stackoverflow.com/a/480227
|
||||
"""
|
||||
seen: Set[poetry.core.packages.package.Package] = set()
|
||||
# Make this faster, avoid method lookup below
|
||||
seen_add = seen.add
|
||||
return [item for item in packages if not (item in seen or seen_add(item))]
|
||||
|
||||
|
||||
def convert_virtualenv(venv: tox.tox_env.api.ToxEnv) -> poetry.utils.env.VirtualEnv:
|
||||
"""Convert a Tox venv to a Poetry venv
|
||||
|
||||
:param venv: Tox ``VirtualEnv`` object representing a tox virtual environment
|
||||
:returns: Poetry ``VirtualEnv`` object representing a poetry virtual environment
|
||||
"""
|
||||
return poetry.utils.env.VirtualEnv(path=pathlib.Path(venv.env_dir))
|
||||
|
||||
|
||||
def build_package_map(project: poetry.poetry.Poetry) -> PackageMap:
|
||||
"""Build the mapping of package names to objects
|
||||
|
||||
:param project: Populated poetry object to load locked packages from
|
||||
:returns: Mapping of package names to Poetry package objects
|
||||
"""
|
||||
packages = collections.defaultdict(list)
|
||||
for package in project.locker.locked_repository().packages:
|
||||
packages[str(package.name)].append(package)
|
||||
|
||||
return packages
|
||||
47
tox_poetry_installer/hooks/tox_add_env_config.py
Normal file
47
tox_poetry_installer/hooks/tox_add_env_config.py
Normal file
@ -0,0 +1,47 @@
|
||||
"""Add required env configuration options to the tox INI file"""
|
||||
|
||||
from typing import List
|
||||
|
||||
import tox.config.sets
|
||||
import tox.plugin
|
||||
|
||||
|
||||
# pylint: disable=missing-function-docstring
|
||||
@tox.plugin.impl
|
||||
def tox_add_env_config(
|
||||
env_conf: tox.config.sets.EnvConfigSet,
|
||||
):
|
||||
env_conf.add_config(
|
||||
"poetry_dep_groups",
|
||||
of_type=List[str],
|
||||
default=[],
|
||||
desc="List of Poetry dependency groups to install to the environment",
|
||||
)
|
||||
|
||||
env_conf.add_config(
|
||||
"install_project_deps",
|
||||
of_type=bool,
|
||||
default=True,
|
||||
desc="Automatically install all Poetry primary dependencies to the environment",
|
||||
)
|
||||
|
||||
env_conf.add_config(
|
||||
"require_locked_deps",
|
||||
of_type=bool,
|
||||
default=False,
|
||||
desc="Require all dependencies in the environment be installed using the Poetry lockfile",
|
||||
)
|
||||
|
||||
env_conf.add_config(
|
||||
"require_poetry",
|
||||
of_type=bool,
|
||||
default=False,
|
||||
desc="Trigger a failure if Poetry is not available to Tox",
|
||||
)
|
||||
|
||||
env_conf.add_config(
|
||||
"locked_deps",
|
||||
of_type=List[str],
|
||||
default=[],
|
||||
desc="List of locked dependencies to install to the environment using the Poetry lockfile",
|
||||
)
|
||||
18
tox_poetry_installer/hooks/tox_add_option.py
Normal file
18
tox_poetry_installer/hooks/tox_add_option.py
Normal file
@ -0,0 +1,18 @@
|
||||
"""Add additional command line arguments to tox to configure plugin behavior"""
|
||||
|
||||
import tox.config.cli.parser
|
||||
import tox.plugin
|
||||
|
||||
from tox_poetry_installer import constants
|
||||
|
||||
|
||||
# pylint: disable=missing-function-docstring
|
||||
@tox.plugin.impl
|
||||
def tox_add_option(parser: tox.config.cli.parser.ToxParser):
|
||||
parser.add_argument(
|
||||
"--parallel-install-threads",
|
||||
type=int,
|
||||
dest="parallel_install_threads",
|
||||
default=constants.DEFAULT_INSTALL_THREADS,
|
||||
help="Number of locked dependencies to install simultaneously; set to 0 to disable parallel installation",
|
||||
)
|
||||
114
tox_poetry_installer/hooks/tox_on_install.py
Normal file
114
tox_poetry_installer/hooks/tox_on_install.py
Normal file
@ -0,0 +1,114 @@
|
||||
"""Install the dependencies for the current environment
|
||||
|
||||
Loads the local Poetry environment and the corresponding lockfile then pulls the dependencies
|
||||
specified by the Tox environment. Finally these dependencies are installed into the Tox
|
||||
environment using the Poetry ``PipInstaller`` backend.
|
||||
"""
|
||||
|
||||
import itertools
|
||||
|
||||
import tox.plugin
|
||||
import tox.tox_env.api
|
||||
|
||||
from tox_poetry_installer import exceptions
|
||||
from tox_poetry_installer import logger
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import build_package_map
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import check_preconditions
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import convert_virtualenv
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import dedupe_packages
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import find_additional_deps
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import find_group_deps
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import find_project_deps
|
||||
from tox_poetry_installer.hooks._tox_on_install_helpers import install_package
|
||||
|
||||
|
||||
# pylint: disable=missing-function-docstring,unused-argument
|
||||
@tox.plugin.impl
|
||||
def tox_on_install(tox_env: tox.tox_env.api.ToxEnv, *args) -> None:
|
||||
try:
|
||||
poetry = check_preconditions(tox_env)
|
||||
except exceptions.SkipEnvironment as err:
|
||||
if (
|
||||
isinstance(err, exceptions.PoetryNotInstalledError)
|
||||
and tox_env.conf["require_poetry"]
|
||||
):
|
||||
logger.error(str(err))
|
||||
raise err
|
||||
logger.info(str(err))
|
||||
return
|
||||
|
||||
logger.info(f"Loaded project pyproject.toml from {poetry.file}")
|
||||
|
||||
virtualenv = convert_virtualenv(tox_env)
|
||||
|
||||
try:
|
||||
if not poetry.locker.is_fresh():
|
||||
logger.warning(
|
||||
f"The Poetry lock file is not up to date with the latest changes in {poetry.file}"
|
||||
)
|
||||
except FileNotFoundError as err:
|
||||
logger.error(f"Could not parse lockfile: {err}")
|
||||
raise exceptions.LockfileParsingError(
|
||||
f"Could not parse lockfile: {err}"
|
||||
) from err
|
||||
|
||||
try:
|
||||
if tox_env.conf["require_locked_deps"] and tox_env.conf["deps"].lines():
|
||||
raise exceptions.LockedDepsRequiredError(
|
||||
f"Unlocked dependencies '{tox_env.conf['deps']}' specified for environment '{tox_env.name}' which requires locked dependencies"
|
||||
)
|
||||
|
||||
packages = build_package_map(poetry)
|
||||
|
||||
group_deps = dedupe_packages(
|
||||
list(
|
||||
itertools.chain(
|
||||
*[
|
||||
find_group_deps(group, packages, virtualenv, poetry)
|
||||
for group in tox_env.conf["poetry_dep_groups"]
|
||||
]
|
||||
)
|
||||
)
|
||||
)
|
||||
logger.info(
|
||||
f"Identified {len(group_deps)} group dependencies to install to env"
|
||||
)
|
||||
|
||||
env_deps = find_additional_deps(
|
||||
packages, virtualenv, poetry, tox_env.conf["locked_deps"]
|
||||
)
|
||||
|
||||
logger.info(
|
||||
f"Identified {len(env_deps)} environment dependencies to install to env"
|
||||
)
|
||||
|
||||
# extras are not set in a testenv if skip_install=true
|
||||
try:
|
||||
extras = tox_env.conf["extras"]
|
||||
except KeyError:
|
||||
extras = []
|
||||
|
||||
if tox_env.conf["install_project_deps"]:
|
||||
project_deps = find_project_deps(packages, virtualenv, poetry, extras)
|
||||
logger.info(
|
||||
f"Identified {len(project_deps)} project dependencies to install to env"
|
||||
)
|
||||
else:
|
||||
project_deps = []
|
||||
logger.info("Env does not install project package dependencies, skipping")
|
||||
except exceptions.ToxPoetryInstallerException as err:
|
||||
logger.error(str(err))
|
||||
raise err
|
||||
except Exception as err:
|
||||
logger.error(f"Internal plugin error: {err}")
|
||||
raise err
|
||||
|
||||
dependencies = dedupe_packages(group_deps + env_deps + project_deps)
|
||||
|
||||
logger.info(f"Installing {len(dependencies)} dependencies from Poetry lock file")
|
||||
install_package(
|
||||
poetry,
|
||||
tox_env,
|
||||
dependencies,
|
||||
tox_env.options.parallel_install_threads,
|
||||
)
|
||||
@ -1,81 +0,0 @@
|
||||
"""Funcationality for performing virtualenv installation"""
|
||||
# Silence this one globally to support the internal function imports for the proxied poetry module.
|
||||
# See the docstring in 'tox_poetry_installer._poetry' for more context.
|
||||
# pylint: disable=import-outside-toplevel
|
||||
import concurrent.futures
|
||||
import contextlib
|
||||
import typing
|
||||
from datetime import datetime
|
||||
from typing import Sequence
|
||||
from typing import Set
|
||||
|
||||
from poetry.core.packages import Package as PoetryPackage
|
||||
from tox.venv import VirtualEnv as ToxVirtualEnv
|
||||
|
||||
from tox_poetry_installer import logger
|
||||
from tox_poetry_installer import utilities
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
|
||||
def install(
|
||||
poetry: "_poetry.Poetry",
|
||||
venv: ToxVirtualEnv,
|
||||
packages: Sequence[PoetryPackage],
|
||||
parallels: int = 0,
|
||||
):
|
||||
"""Install a bunch of packages to a virtualenv
|
||||
|
||||
:param poetry: Poetry object the packages were sourced from
|
||||
:param venv: Tox virtual environment to install the packages to
|
||||
:param packages: List of packages to install to the virtual environment
|
||||
:param parallels: Number of parallel processes to use for installing dependency packages, or
|
||||
``None`` to disable parallelization.
|
||||
"""
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
logger.info(
|
||||
f"Installing {len(packages)} packages to environment at {venv.envconfig.envdir}"
|
||||
)
|
||||
|
||||
pip = _poetry.PipInstaller(
|
||||
env=utilities.convert_virtualenv(venv),
|
||||
io=_poetry.NullIO(),
|
||||
pool=poetry.pool,
|
||||
)
|
||||
|
||||
installed: Set[PoetryPackage] = set()
|
||||
|
||||
def logged_install(dependency: PoetryPackage) -> None:
|
||||
start = datetime.now()
|
||||
logger.debug(f"Installing {dependency}")
|
||||
pip.install(dependency)
|
||||
end = datetime.now()
|
||||
logger.debug(f"Finished installing {dependency} in {end - start}")
|
||||
|
||||
@contextlib.contextmanager
|
||||
def _optional_parallelize():
|
||||
"""A bit of cheat, really
|
||||
|
||||
A context manager that exposes a common interface for the caller that optionally
|
||||
enables/disables the usage of the parallel thread pooler depending on the value of
|
||||
the ``parallels`` parameter.
|
||||
"""
|
||||
if parallels > 0:
|
||||
with concurrent.futures.ThreadPoolExecutor(
|
||||
max_workers=parallels
|
||||
) as executor:
|
||||
yield executor.submit
|
||||
else:
|
||||
yield lambda func, arg: func(arg)
|
||||
|
||||
with _optional_parallelize() as executor:
|
||||
for dependency in packages:
|
||||
if dependency not in installed:
|
||||
installed.add(dependency)
|
||||
logger.debug(f"Queuing {dependency}")
|
||||
executor(logged_install, dependency)
|
||||
else:
|
||||
logger.debug(f"Skipping {dependency}, already installed")
|
||||
logger.debug("Waiting for installs to finish...")
|
||||
@ -4,26 +4,27 @@ Calling ``tox.reporter.something()`` and having to format a string with the pref
|
||||
gets really old fast, but more importantly it also makes the flow of the main code
|
||||
more difficult to follow because of the added complexity.
|
||||
"""
|
||||
import tox
|
||||
|
||||
import logging
|
||||
|
||||
from tox_poetry_installer import constants
|
||||
|
||||
|
||||
def error(message: str):
|
||||
"""Wrapper around :func:`tox.reporter.error`"""
|
||||
tox.reporter.error(f"{constants.REPORTER_PREFIX} {message}")
|
||||
"""Wrapper around :func:`logging.error` that prefixes the reporter prefix onto the message"""
|
||||
logging.error(f"{constants.REPORTER_PREFIX} {message}")
|
||||
|
||||
|
||||
def warning(message: str):
|
||||
"""Wrapper around :func:`tox.reporter.warning`"""
|
||||
tox.reporter.warning(f"{constants.REPORTER_PREFIX} {message}")
|
||||
"""Wrapper around :func:`logging.warning`"""
|
||||
logging.warning(f"{constants.REPORTER_PREFIX} {message}")
|
||||
|
||||
|
||||
def info(message: str):
|
||||
"""Wrapper around :func:`tox.reporter.verbosity1`"""
|
||||
tox.reporter.verbosity1(f"{constants.REPORTER_PREFIX} {message}")
|
||||
"""Wrapper around :func:`logging.info`"""
|
||||
logging.info(f"{constants.REPORTER_PREFIX} {message}")
|
||||
|
||||
|
||||
def debug(message: str):
|
||||
"""Wrapper around :func:`tox.reporter.verbosity2`"""
|
||||
tox.reporter.verbosity2(f"{constants.REPORTER_PREFIX} {message}")
|
||||
"""Wrapper around :func:`logging.debug`"""
|
||||
logging.debug(f"{constants.REPORTER_PREFIX} {message}")
|
||||
|
||||
@ -1,265 +0,0 @@
|
||||
"""Helper utility functions, usually bridging Tox and Poetry functionality"""
|
||||
# Silence this one globally to support the internal function imports for the proxied poetry module.
|
||||
# See the docstring in 'tox_poetry_installer._poetry' for more context.
|
||||
# pylint: disable=import-outside-toplevel
|
||||
import collections
|
||||
import typing
|
||||
from pathlib import Path
|
||||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Sequence
|
||||
from typing import Set
|
||||
|
||||
from poetry.core.packages import Dependency as PoetryDependency
|
||||
from poetry.core.packages import Package as PoetryPackage
|
||||
from tox.action import Action as ToxAction
|
||||
from tox.venv import VirtualEnv as ToxVirtualEnv
|
||||
|
||||
from tox_poetry_installer import constants
|
||||
from tox_poetry_installer import exceptions
|
||||
from tox_poetry_installer import logger
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
|
||||
PackageMap = Dict[str, List[PoetryPackage]]
|
||||
|
||||
|
||||
def check_preconditions(venv: ToxVirtualEnv, action: ToxAction) -> "_poetry.Poetry":
|
||||
"""Check that the local project environment meets expectations"""
|
||||
# Skip running the plugin for the provisioning environment. The provisioned environment,
|
||||
# for alternative Tox versions and/or the ``requires`` meta dependencies is specially
|
||||
# handled by Tox and is out of scope for this plugin. Since one of the ways to install this
|
||||
# plugin in the first place is via the Tox provisioning environment, it quickly becomes a
|
||||
# chicken-and-egg problem.
|
||||
if action.name == venv.envconfig.config.provision_tox_env:
|
||||
raise exceptions.SkipEnvironment(
|
||||
f"Skipping Tox provisioning env '{action.name}'"
|
||||
)
|
||||
|
||||
# Skip running the plugin for the packaging environment. PEP-517 front ends can handle
|
||||
# that better than we can, so let them do their thing. More to the point: if you're having
|
||||
# problems in the packaging env that this plugin would solve, god help you.
|
||||
if action.name == venv.envconfig.config.isolated_build_env:
|
||||
raise exceptions.SkipEnvironment(
|
||||
f"Skipping isolated packaging build env '{action.name}'"
|
||||
)
|
||||
|
||||
if venv.envconfig.config.option.require_poetry:
|
||||
logger.warning(
|
||||
"DEPRECATION: The '--require-poetry' runtime option is deprecated and will be "
|
||||
"removed in version 1.0.0. Please update test environments that require Poetry to "
|
||||
"set the 'require_poetry = true' option in tox.ini"
|
||||
)
|
||||
|
||||
if venv.envconfig.config.option.parallelize_locked_install is not None:
|
||||
logger.warning(
|
||||
"DEPRECATION: The '--parallelize-locked-install' option is deprecated and will "
|
||||
"be removed in version 1.0.0. Please use the '--parallel-install-threads' option."
|
||||
)
|
||||
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
try:
|
||||
return _poetry.Factory().create_poetry(venv.envconfig.config.toxinidir)
|
||||
# Support running the plugin when the current tox project does not use Poetry for its
|
||||
# environment/dependency management.
|
||||
#
|
||||
# ``RuntimeError`` is dangerous to blindly catch because it can be (and in Poetry's case,
|
||||
# is) raised in many different places for different purposes.
|
||||
except RuntimeError:
|
||||
raise exceptions.SkipEnvironment(
|
||||
"Project does not use Poetry for env management, skipping installation of locked dependencies"
|
||||
) from None
|
||||
|
||||
|
||||
def convert_virtualenv(venv: ToxVirtualEnv) -> "_poetry.VirtualEnv":
|
||||
"""Convert a Tox venv to a Poetry venv
|
||||
|
||||
:param venv: Tox ``VirtualEnv`` object representing a tox virtual environment
|
||||
:returns: Poetry ``VirtualEnv`` object representing a poetry virtual environment
|
||||
"""
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
return _poetry.VirtualEnv(path=Path(venv.envconfig.envdir))
|
||||
|
||||
|
||||
def build_package_map(poetry: "_poetry.Poetry") -> PackageMap:
|
||||
"""Build the mapping of package names to objects
|
||||
|
||||
:param poetry: Populated poetry object to load locked packages from
|
||||
:returns: Mapping of package names to Poetry package objects
|
||||
"""
|
||||
packages = collections.defaultdict(list)
|
||||
for package in poetry.locker.locked_repository(True).packages:
|
||||
packages[package.name].append(package)
|
||||
|
||||
return packages
|
||||
|
||||
|
||||
def identify_transients(
|
||||
dep_name: str,
|
||||
packages: PackageMap,
|
||||
venv: "_poetry.VirtualEnv",
|
||||
allow_missing: Sequence[str] = (),
|
||||
) -> List[PoetryPackage]:
|
||||
"""Using a pool of packages, identify all transient dependencies of a given package name
|
||||
|
||||
:param dep_name: Either the Poetry dependency or the dependency's bare package name to recursively
|
||||
identify the transient dependencies of
|
||||
:param packages: All packages from the lockfile to use for identifying dependency relationships.
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param allow_missing: Sequence of package names to allow to be missing from the lockfile. Any
|
||||
packages that are not found in the lockfile but their name appears in this
|
||||
list will be silently skipped from installation.
|
||||
:returns: List of packages that need to be installed for the requested dependency.
|
||||
|
||||
.. note:: The package corresponding to the dependency specified by the ``dep`` parameter will
|
||||
be included in the returned list of packages.
|
||||
"""
|
||||
searched: Set[str] = set()
|
||||
|
||||
def _transients(transient: PoetryDependency) -> List[PoetryPackage]:
|
||||
searched.add(transient.name)
|
||||
|
||||
results: List[PoetryPackage] = []
|
||||
for option in packages[transient.name]:
|
||||
if venv.is_valid_for_marker(option.to_dependency().marker):
|
||||
for requirement in option.requires:
|
||||
if requirement.name not in searched:
|
||||
results += _transients(requirement)
|
||||
logger.debug(f"Including {option} for installation")
|
||||
results.append(option)
|
||||
break
|
||||
else:
|
||||
logger.debug(
|
||||
f"Skipping {transient.name}: target python version is {'.'.join([str(item) for item in venv.get_version_info()])} but package requires {transient.marker}"
|
||||
)
|
||||
|
||||
return results
|
||||
|
||||
try:
|
||||
for option in packages[dep_name]:
|
||||
if venv.is_valid_for_marker(option.to_dependency().marker):
|
||||
dep = option.to_dependency()
|
||||
break
|
||||
else:
|
||||
logger.warning(
|
||||
f"Skipping {dep_name}: no locked version found compatible with target python version {'.'.join([str(item) for item in venv.get_version_info()])}"
|
||||
)
|
||||
return []
|
||||
|
||||
return _transients(dep)
|
||||
except KeyError as err:
|
||||
missing = err.args[0]
|
||||
|
||||
if missing in constants.UNSAFE_PACKAGES:
|
||||
logger.warning(
|
||||
f"Installing package '{missing}' using Poetry is not supported and will be skipped"
|
||||
)
|
||||
logger.debug(f"Skipping {missing}: designated unsafe by Poetry")
|
||||
return []
|
||||
|
||||
if missing in allow_missing:
|
||||
logger.debug(f"Skipping {missing}: package is allowed to be unlocked")
|
||||
return []
|
||||
|
||||
if any(
|
||||
delimiter in missing for delimiter in constants.PEP508_VERSION_DELIMITERS
|
||||
):
|
||||
raise exceptions.LockedDepVersionConflictError(
|
||||
f"Locked dependency '{missing}' cannot include version specifier"
|
||||
) from None
|
||||
|
||||
raise exceptions.LockedDepNotFoundError(
|
||||
f"No version of locked dependency '{missing}' found in the project lockfile"
|
||||
) from None
|
||||
|
||||
|
||||
def find_project_deps(
|
||||
packages: PackageMap,
|
||||
venv: "_poetry.VirtualEnv",
|
||||
poetry: "_poetry.Poetry",
|
||||
extras: Sequence[str] = (),
|
||||
) -> List[PoetryPackage]:
|
||||
"""Find the root project dependencies
|
||||
|
||||
Recursively identify the dependencies of the root project package
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param poetry: Poetry object for the current project
|
||||
:param extras: Sequence of extra names to include the dependencies of
|
||||
"""
|
||||
|
||||
if any(dep.name in constants.UNSAFE_PACKAGES for dep in poetry.package.requires):
|
||||
raise exceptions.RequiresUnsafeDepError(
|
||||
f"Project package requires one or more unsafe dependencies ({', '.join(constants.UNSAFE_PACKAGES)}) which cannot be installed with Poetry"
|
||||
)
|
||||
|
||||
required_dep_names = [
|
||||
item.name for item in poetry.package.requires if not item.is_optional()
|
||||
]
|
||||
|
||||
extra_dep_names: List[str] = []
|
||||
for extra in extras:
|
||||
logger.info(f"Processing project extra '{extra}'")
|
||||
try:
|
||||
extra_dep_names += [item.name for item in poetry.package.extras[extra]]
|
||||
except KeyError:
|
||||
raise exceptions.ExtraNotFoundError(
|
||||
f"Environment specifies project extra '{extra}' which was not found in the lockfile"
|
||||
) from None
|
||||
|
||||
dependencies: List[PoetryPackage] = []
|
||||
for dep_name in required_dep_names + extra_dep_names:
|
||||
dependencies += identify_transients(
|
||||
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
||||
)
|
||||
|
||||
return dependencies
|
||||
|
||||
|
||||
def find_additional_deps(
|
||||
packages: PackageMap,
|
||||
venv: "_poetry.VirtualEnv",
|
||||
poetry: "_poetry.Poetry",
|
||||
dep_names: Sequence[str],
|
||||
) -> List[PoetryPackage]:
|
||||
"""Find additional dependencies
|
||||
|
||||
Recursively identify the dependencies of an arbitrary list of package names
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param poetry: Poetry object for the current project
|
||||
:param dep_names: Sequence of additional dependency names to recursively find the transient
|
||||
dependencies for
|
||||
"""
|
||||
dependencies: List[PoetryPackage] = []
|
||||
for dep_name in dep_names:
|
||||
dependencies += identify_transients(
|
||||
dep_name.lower(), packages, venv, allow_missing=[poetry.package.name]
|
||||
)
|
||||
|
||||
return dependencies
|
||||
|
||||
|
||||
def find_dev_deps(
|
||||
packages: PackageMap, venv: "_poetry.VirtualEnv", poetry: "_poetry.Poetry"
|
||||
) -> List[PoetryPackage]:
|
||||
"""Find the dev dependencies
|
||||
|
||||
Recursively identify the Poetry dev dependencies
|
||||
|
||||
:param packages: Mapping of all locked package names to their corresponding package object
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param poetry: Poetry object for the current project
|
||||
"""
|
||||
return find_additional_deps(
|
||||
packages,
|
||||
venv,
|
||||
poetry,
|
||||
poetry.pyproject.data["tool"]["poetry"].get("dev-dependencies", {}).keys(),
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user