12 Commits

Author SHA1 Message Date
2b75f74996 Merge pull request #90 from enpaul/enp/block-1.5
Block compatibility with Poetry-1.5 until plugin is updated
2023-05-19 14:25:54 -04:00
449381ca09 Update mdformat to mitigate CVE-2023-26303
Update markdown format with new version of mdformat
2023-05-19 14:21:17 -04:00
bb44db0f9d Update changelog for 0.10.3 2023-05-19 14:08:35 -04:00
afaf025485 Bump version to 0.10.3 2023-05-19 13:56:45 -04:00
c984abbc2f Update poetry requirement to remove compatibility with ^1.5 2023-05-19 13:56:00 -04:00
cee49ff6c0 Update changelog for 0.10.2 2023-03-29 19:29:20 -04:00
11a478bd4e Bump version to 0.10.2 2023-03-29 19:25:29 -04:00
5e26a4e0de Update documentation
Add link to official poetry docs on tox integration
Add emojis to notes/warnings to improve ease of comprehension
Update docs with new poetry command syntax
Remove link to deprecated tox-poetry plugin
Remove docs on unsafe dependencies
2023-03-29 19:24:47 -04:00
c6c35636cd Merge pull request #87 from chriskuehl/raise-exceptions-from-install
Ensure exceptions which occur during install are propagated
2023-03-29 19:04:12 -04:00
Chris Kuehl
bc75c57126 Fix pylint errors 2023-03-29 17:53:14 -05:00
Chris Kuehl
7e5bc30b93 Try inline import in tests to avoid disrupting fixture monkeypatching 2023-03-29 17:53:06 -05:00
Chris Kuehl
593f260278 Ensure exceptions which occur during install are propagated 2023-03-29 17:52:51 -05:00
8 changed files with 734 additions and 600 deletions

View File

@@ -2,6 +2,24 @@
See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases). See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).
## 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 ## Version 0.10.1
View this release on: View this release on:
@@ -50,8 +68,8 @@ View this release on:
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.4), [Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.8.4),
[PyPI](https://pypi.org/project/tox-poetry-installer/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 - Fix issue where incompatible package versions were selected for installation when
package versions were in the lockfile multiple package versions were in the lockfile
## Version 0.8.3 ## Version 0.8.3
@@ -68,9 +86,9 @@ View this release on:
[PyPI](https://pypi.org/project/tox-poetry-installer/0.8.2/) [PyPI](https://pypi.org/project/tox-poetry-installer/0.8.2/)
- Improve debug-level logging for package installation, and time how long installing each - Improve debug-level logging for package installation, and time how long installing each
package takes. Contributed by [Rebecca package takes. Contributed by [Rebecca Turner](https://github.com/9999years) (#63).
Turner](https://github.com/9999years) (#63). - Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies
- Fix crash caused by the package-under-test depending on Poetry's unsafe dependencies ([#65](https://github.com/enpaul/tox-poetry-installer/issues/65)) ([#65](https://github.com/enpaul/tox-poetry-installer/issues/65))
## Version 0.8.1 ## Version 0.8.1
@@ -120,7 +138,8 @@ View this release on:
process process
- Add integration with Poetry's compatibility - Add integration with Poetry's compatibility
[`Marker`](https://github.com/python-poetry/poetry-core/blob/master/poetry/core/version/markers.py) [`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 - Add missing PyPI classifier for Python 3
## Version 0.6.3 ## Version 0.6.3
@@ -145,8 +164,8 @@ View this release on:
[CVE-2020-29651](https://nvd.nist.gov/vuln/detail/CVE-2020-29651) [CVE-2020-29651](https://nvd.nist.gov/vuln/detail/CVE-2020-29651)
- Fix dependency identification failing when the package under test is a transient - Fix dependency identification failing when the package under test is a transient
dependency of a locked dependency specified for installation dependency of a locked dependency specified for installation
- Fix `AttributeError` being raised while creating the Tox self-provisioned environment when - Fix `AttributeError` being raised while creating the Tox self-provisioned environment
using either the when using either the
[`minversion`](https://tox.readthedocs.io/en/latest/config.html#conf-minversion) or [`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 [`requires`](https://tox.readthedocs.io/en/latest/config.html#conf-requires) Tox config
options options
@@ -161,8 +180,8 @@ View this release on:
installation problems installation problems
- Fix regression around handling of Poetry's unsafe packages when the unsafe package is a - 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)) 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 - Fix handling of Poetry's unsafe packages when the unsafe package is a primary
or package) dependency (environment or package) dependency
## Version 0.6.0 ## Version 0.6.0
@@ -186,7 +205,8 @@ View this release on:
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.5.2), [Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.5.2),
[PyPI](https://pypi.org/project/tox-poetry-installer/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 - Fix always attempting to install dependencies with incompatible python platforms
## Version 0.5.1 ## Version 0.5.1
@@ -208,8 +228,8 @@ View this release on:
- Add option `locked_deps` to better support both locked and unlocked dependencies in a - Add option `locked_deps` to better support both locked and unlocked dependencies in a
single environment single environment
- Add blocking functionality when using `require_locked_deps = true` to prevent other hooks - Add blocking functionality when using `require_locked_deps = true` to prevent other
from running after this one hooks from running after this one
- Update documentation to include new configuration options and errors - Update documentation to include new configuration options and errors
- Update documentation to improve future maintainability - Update documentation to improve future maintainability
- Update module structure to move from single-file module to multi-file directory module - Update module structure to move from single-file module to multi-file directory module
@@ -233,7 +253,8 @@ View this release on:
[PyPI](https://pypi.org/project/tox-poetry-installer/0.3.1/) [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 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 - Fix regression causing no project dependencies to be installed
## Version 0.3.0 ## Version 0.3.0
@@ -255,7 +276,8 @@ View this release on:
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.4), [Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.4),
[PyPI](https://pypi.org/project/tox-poetry-installer/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)) - Include tests in sdist ([#8](https://github.com/enpaul/tox-poetry-installer/issues/8))
## Version 0.2.3 ## Version 0.2.3
@@ -264,8 +286,10 @@ View this release on:
[Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.3), [Github](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.2.3),
[PyPI](https://pypi.org/project/tox-poetry-installer/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 usage of the plugin in non-Poetry based projects
- Fix treating dependency names as case sensitive when they shouldn't be ([#7](https://github.com/enpaul/tox-poetry-installer/issues/7)) ([#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 ## Version 0.2.2
@@ -274,7 +298,8 @@ View this release on:
[PyPI](https://pypi.org/project/tox-poetry-installer/0.2.2/) [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 - 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 ## Version 0.2.1
@@ -325,8 +350,8 @@ View this release on:
[PyPI](https://pypi.org/project/tox-poetry-installer/0.1.2/) [PyPI](https://pypi.org/project/tox-poetry-installer/0.1.2/)
- Test trivial functionality on Python-3.6 and Python-3.7 - Test trivial functionality on Python-3.6 and Python-3.7
- Fix disagreement between `pyproject.toml` and module metadata on what the current version - Fix disagreement between `pyproject.toml` and module metadata on what the current
is version is
- Fix constant named for PEP-440 that should have been named for PEP-508 - Fix constant named for PEP-440 that should have been named for PEP-508
## Version 0.1.1 ## Version 0.1.1

View File

@@ -27,9 +27,10 @@ Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind - 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 - Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment - Public or private harassment
- Publishing others' private information, such as a physical or email address, without their - Publishing others' private information, such as a physical or email address, without
explicit permission their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting - Other conduct which could reasonably be considered inappropriate in a professional
setting
## Enforcement Responsibilities ## Enforcement Responsibilities
@@ -52,8 +53,8 @@ offline event.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All community leaders responsible for enforcement at \[INSERT CONTACT METHOD\]. All complaints
complaints will be reviewed and investigated promptly and fairly. will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of All community leaders are obligated to respect the privacy and security of the reporter of
any incident. 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, 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. 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 Community Impact Guidelines were inspired by
enforcement ladder](https://github.com/mozilla/diversity). [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 For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/faq. Translations are available at

152
README.md
View File

@@ -25,7 +25,6 @@ environment dependencies from the [Poetry](https://python-poetry.org/) lockfile.
- [Other Notes](#other-notes) - [Other Notes](#other-notes)
- [Unsupported Tox config options](#unsupported-tox-config-options) - [Unsupported Tox config options](#unsupported-tox-config-options)
- [Updating locked dependencies in a testenv](#updating-locked-dependencies-in-a-testenv) - [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) - [Using with an unmanaged Poetry installation](#using-with-an-unmanaged-poetry-installation)
- [Developing the Plugin](#developer-documentation) - [Developing the Plugin](#developer-documentation)
- [Road Map](#road-map) - [Road Map](#road-map)
@@ -34,7 +33,8 @@ See the
[Changelog](https://github.com/enpaul/tox-poetry-installer/blob/devel/CHANGELOG.md) for [Changelog](https://github.com/enpaul/tox-poetry-installer/blob/devel/CHANGELOG.md) for
release history. release history.
*See also: [official Tox plugins](https://tox.readthedocs.io/en/latest/plugins.html), [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 ## Feature Overview
@@ -53,17 +53,19 @@ release history.
## User Documentation ## 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 ### Installing
The recommended way to install the plugin is to add it to a project using Poetry: The recommended way to install the plugin is to add it to a project using Poetry:
```bash ```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). > [managing the Poetry installation yourself](#externally-managed-poetry-installation).
Alternatively, it can be installed directly to a virtual environment using Pip, though 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 ```ini
requires = 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 After installing, check that Tox recognizes the plugin by running
`poetry run tox --version`. The command should give output similar to below: `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: 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 ### Quick Start
@@ -146,9 +148,9 @@ locked_deps =
commands = ... commands = ...
``` ```
> **Note:** Settings configured on the main `testenv` environment are inherited by child > **Note:** Settings configured on the main `testenv` environment are inherited by
> test environments (for example, `testenv:foo`). To override this, specify the setting in > child test environments (for example, `testenv:foo`). To override this, specify the
> the child environment with a different value. > setting in the child environment with a different value.
Alternatively, we can skip specifying all of our dependencies for a test environment in Alternatively, we can skip specifying all of our dependencies for a test environment in
the Tox config and install Poetry dependency groups directly: the Tox config and install Poetry dependency groups directly:
@@ -162,11 +164,8 @@ poetry_dep_groups =
commands = ... commands = ...
``` ```
> **Note:** Setting `poetry_dep_groups = [dev]` on an environment that also installs the > **Note:** The `install_dev_deps` configuration option is deprecated. See
> project package is functionally equivalent to running `poetry install`. > [Configuration Options](#configuration-options) for more information.
> **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 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 version from the Poetry lockfile) into the test environment alongside the locked ones. We
@@ -194,9 +193,9 @@ 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 environment sections of the `tox.ini` file. They cannot be applied to the global Tox
configuration section. configuration section.
> **Note:** Settings configured on the main `testenv` environment are inherited by child > **Note:** Settings configured on the main `testenv` environment are inherited by
> test environments (for example, `testenv:foo`). To override this, specify the setting in > child test environments (for example, `testenv:foo`). To override this, specify the
> the child environment with a different value. > setting in the child environment with a different value.
| Option | Type | Default | Description | | Option | Type | Default | Description |
| :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -206,9 +205,9 @@ configuration section.
| `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. | | `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. | | `poetry_dep_groups` | List | `[]` | Names of Poetry dependency groups specified in `pyproject.toml` to install to the test environment. |
> **Note:** The `install_dev_deps` configuration option is deprecated and will be removed in > **Note:** The `install_dev_deps` configuration option is deprecated and will be
> version 1.0.0. Please set `poetry_dep_groups = [dev]` in `tox.ini` for environments that > removed in version 1.0.0. Please set `poetry_dep_groups = [dev]` in `tox.ini` for
> install the development dependencies. > environments that install the development dependencies.
### Runtime Options ### Runtime Options
@@ -219,12 +218,12 @@ 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. | | `--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 > **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 > version 1.0.0. Please set `require_poetry = true` in `tox.ini` for environments that
> should fail if Poetry is not available. > should fail if Poetry is not available.
> **Note:** The `--parallelize-locked-install` option is deprecated and will be removed in > **Note:** The `--parallelize-locked-install` option is deprecated and will be removed
> version 1.0.0. Please use the `--parallel-install-threads` option. > in version 1.0.0. Please use the `--parallel-install-threads` option.
### Errors ### Errors
@@ -241,9 +240,9 @@ error will be set to one of the "Status" values below to indicate what the error
| `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and `require_poetry = true` was specified. | | `PoetryNotInstalledError` | Indicates that the `poetry` module could not be imported under the current runtime environment, and `require_poetry = true` was specified. |
| `RequiresUnsafeDepError` | Indicates that the package-under-test depends on a package that Poetry has classified as unsafe and cannot be installed. | | `RequiresUnsafeDepError` | Indicates that the package-under-test depends on a package that Poetry has classified as unsafe and cannot be installed. |
> **Note:** One or more of these errors can be caused by the `pyproject.toml` being out of > **Note:** One or more of these errors can be caused by the `pyproject.toml` being out
> sync with the Poetry lockfile. If this is the case, than a warning will be logged when Tox > of sync with the Poetry lockfile. If this is the case, than a warning will be logged
> is run. > when Tox is run.
### Other Notes ### Other Notes
@@ -254,8 +253,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 equivalent functionality is instead taken directly from the package details Poetry stores
in its lockfile. in its lockfile.
> **Note:** The unsupported Tox config options will still apply to unlocked dependencies > **Note:** The unsupported Tox config options will still apply to unlocked
> being installed with the default Tox installation backend. > dependencies being installed with the default Tox installation backend.
- [`install_command`](https://tox.readthedocs.io/en/latest/config.html#conf-install_command) - [`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) - [`pip_pre`](https://tox.readthedocs.io/en/latest/config.html#conf-pip_pre)
@@ -276,41 +275,24 @@ built-in
[`--recreate`](https://tox.readthedocs.io/en/latest/example/basic.html#forcing-re-creation-of-virtual-environments) [`--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. option) for the new version to be found and installed.
> **Note:** To force Tox to always recreate a test environment the > **Note:** To force Tox to always recreate a test environment the
> [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config option > [`recreate`](https://tox.readthedocs.io/en/latest/config.html#conf-recreate) config
> can be set. > 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`
#### Using with an unmanaged Poetry installation #### Using with an unmanaged Poetry installation
In CI/CD systems, automation environments, or other Python environments where the loaded 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 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 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 `--no-root`, `--without dev`, or `--sync` arguments to the `poetry install` command which,
which, in some situations, can cause Poetry to uninstall itself if Poetry is specified as in some situations, can cause Poetry to uninstall itself if Poetry is specified as a
a dependency of one of the packages it is managing (like this plugin). To support these dependency of one of the packages it is managing (like this plugin). To support these use
use cases, this plugin specifies the `poetry` package as an optional dependency that can cases, this plugin specifies the `poetry` package as an optional dependency that can be
be installed using a setuptools extra also named `poetry`. 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 To skip installing the `poetry` package as a dependency of `tox-poetry-installer`, do not
specify the `poetry` extra when adding the plugin: specify the `poetry` extra when adding the plugin:
@@ -318,11 +300,11 @@ specify the `poetry` extra when adding the plugin:
```bash ```bash
# Adding the package without the "[poetry]" extra specifier so that # Adding the package without the "[poetry]" extra specifier so that
# Poetry is not added as a transient dev-dependency: # 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 # Adding the package with the "[poetry]" extra specifier, so the Poetry
# package will be added to the environment and tracked in the lockfile: # 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 Once the plugin is installed- either with or without the Poetry extra- you can validate
@@ -338,14 +320,15 @@ python -c '\
' '
``` ```
> **Note:** To force Tox to fail if Poetry is not installed, add the `require_poetry = true` > **Note:** To force Tox to fail if Poetry is not installed, add the
> option to the tox `[testenv]` configuration. See the > `require_poetry = true` option to the tox `[testenv]` configuration. See the
> [Config Options](#configuration-options) for more information. > [Config Options](#configuration-options) for more information.
## Developer Documentation ## Developer Documentation
All project contributors and participants are expected to adhere to the 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 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), are tracked on [Github](https://github.com/enpaul/tox-poetry-installer/releases),
@@ -360,8 +343,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) [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). 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 Developing this project requires [Python 3.10+](https://www.python.org/downloads/) and
[Poetry 1.2](https://python-poetry.org/docs/#installation) or later. GNU Make can [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 optionally be used to quickly setup a local development environment, but this is not
required. required.
@@ -386,9 +369,10 @@ make test
make help make help
``` ```
> **Note:** The pre-commit hooks require dependencies in the Poetry environment to run. To > **Note:** The pre-commit hooks require dependencies in the Poetry environment to run.
> make a commit with the pre-commit hooks, you will need to run `poetry run git commit` or, > To make a commit with the pre-commit hooks, you will need to run `poetry run git commit`
> alternatively, [launch an environment shell](https://python-poetry.org/docs/cli/#shell). > or, alternatively,
> [launch an environment shell](https://python-poetry.org/docs/cli/#shell).
## Road Map ## Road Map
@@ -397,35 +381,39 @@ production environments on a provisional basis only.
- Beta classification was assigned with - Beta classification was assigned with
[v0.6.0](https://github.com/enpaul/tox-poetry-installer/releases/tag/0.6.0) [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 - Stable classification will be assigned when the test suite covers an acceptable number
use cases of use cases
### Path to Beta ### Path to Beta
- [x] Verify that primary package dependencies (from the `.package` env) are installed - [x] Verify that primary package dependencies (from the `.package` env) are installed
correctly using the Poetry backend. correctly using the Poetry backend.
- [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras) Tox - [x] Support the [`extras`](https://tox.readthedocs.io/en/latest/config.html#conf-extras)
configuration option ([#4](https://github.com/enpaul/tox-poetry-installer/issues/4)) 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 - [x] Add per-environment Tox configuration option to fall back to default installation
backend. backend.
- [ ] ~Add warnings when an unsupported Tox configuration option is detected while using the - [ ] ~Add warnings when an unsupported Tox configuration option is detected while using
Poetry backend.~ ([#5](https://github.com/enpaul/tox-poetry-installer/issues/5)) 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 - [x] Add trivial tests to ensure the project metadata is consistent between the
and the module constants. pyproject.toml and the module constants.
- [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and improve - [x] Update to use [poetry-core](https://github.com/python-poetry/poetry-core) and
robustness of the Tox and Poetry module imports to avoid potentially breaking API changes improve robustness of the Tox and Poetry module imports to avoid potentially breaking
in upstream packages. ([#2](https://github.com/enpaul/tox-poetry-installer/issues/2)) API changes in upstream packages.
([#2](https://github.com/enpaul/tox-poetry-installer/issues/2))
- [ ] ~Find and implement a way to mitigate the - [ ] ~Find and implement a way to mitigate the
[UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in [UNSAFE_DEPENDENCIES issue](https://github.com/python-poetry/poetry/issues/1584) in
Poetry.~ ([#6](https://github.com/enpaul/tox-poetry-installer/issues/6)) 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] Fix logging to make proper use of Tox's logging reporter infrastructure
- [x] Add configuration option for installing all dev-dependencies to a testenv ([#14](https://github.com/enpaul/tox-poetry-installer/issues/14)) ([#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 ### Path to Stable
Everything in Beta plus... 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 - [x] Add comprehensive unit tests
- [ ] ~Add tests for each feature version of Tox between 3.8 and 3.20~ - [ ] ~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 - [x] Add tests for Python-3.6, 3.7, 3.8, and 3.9

1050
poetry.lock generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "tox-poetry-installer" name = "tox-poetry-installer"
version = "0.10.1" version = "0.10.3"
license = "MIT" license = "MIT"
authors = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"] 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" description = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
@@ -40,7 +40,7 @@ poetry = ["poetry", "cleo"]
[tool.poetry.dependencies] [tool.poetry.dependencies]
python = "^3.7" python = "^3.7"
cleo = {version = ">=1.0,<3.0", optional = true} cleo = {version = ">=1.0,<3.0", optional = true}
poetry = {version = "^1.2.0", optional = true} poetry = {version = ">=1.2.0,<1.5.0", optional = true}
poetry-core = "^1.1.0" poetry-core = "^1.1.0"
tox = "^3.8.0" tox = "^3.8.0"
@@ -49,8 +49,8 @@ bandit = "^1.6.2"
black = "^22.3.0" black = "^22.3.0"
blacken-docs = "^1.8.0" blacken-docs = "^1.8.0"
ipython = {version = "^8.10.1", python = "^3.8"} ipython = {version = "^8.10.1", python = "^3.8"}
mdformat = "^0.6" mdformat = "^0.7"
mdformat-gfm = "^0.2" mdformat-gfm = "^0.3"
mypy = "^0.930" mypy = "^0.930"
pre-commit = "^2.7.1" pre-commit = "^2.7.1"
pre-commit-hooks = "^3.3.0" pre-commit-hooks = "^3.3.0"

View File

@@ -1,6 +1,8 @@
# 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, wrong-import-order, unused-import
import time import time
from unittest import mock
import pytest
import tox.venv import tox.venv
from poetry.factory import Factory from poetry.factory import Factory
@@ -57,3 +59,32 @@ def test_parallelization(mock_venv, mock_poetry_factory):
assert round(parallel * 5) == round(sequential) assert round(parallel * 5) == round(sequential)
assert round(sequential) == len(set(to_install)) assert round(sequential) == len(set(to_install))
assert round(parallel * 5) == 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
"""
from tox_poetry_installer import _poetry # pylint: disable=import-outside-toplevel
poetry = Factory().create_poetry(None)
packages: utilities.PackageMap = {
item.name: item for item in poetry.locker.locked_repository().packages
}
to_install = [packages["toml"]]
venv = tox.venv.VirtualEnv()
fake_exception = ValueError("my testing exception")
with mock.patch.object(
_poetry,
"PipInstaller",
**{"return_value.install.side_effect": fake_exception},
):
with pytest.raises(ValueError) as exc_info:
installer.install(poetry, venv, to_install, num_threads)
assert exc_info.value is fake_exception

View File

@@ -1,7 +1,7 @@
# pylint: disable=missing-docstring # pylint: disable=missing-docstring
__title__ = "tox-poetry-installer" __title__ = "tox-poetry-installer"
__summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile" __summary__ = "A plugin for Tox that lets you install test environment dependencies from the Poetry lockfile"
__version__ = "0.10.1" __version__ = "0.10.3"
__url__ = "https://github.com/enpaul/tox-poetry-installer/" __url__ = "https://github.com/enpaul/tox-poetry-installer/"
__license__ = "MIT" __license__ = "MIT"
__authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"] __authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]

View File

@@ -71,11 +71,20 @@ def install(
yield lambda func, arg: func(arg) yield lambda func, arg: func(arg)
with _optional_parallelize() as executor: with _optional_parallelize() as executor:
futures = []
for dependency in packages: for dependency in packages:
if dependency not in installed: if dependency not in installed:
installed.add(dependency) installed.add(dependency)
logger.debug(f"Queuing {dependency}") logger.debug(f"Queuing {dependency}")
executor(logged_install, dependency) future = executor(logged_install, dependency)
if future is not None:
futures.append(future)
else: else:
logger.debug(f"Skipping {dependency}, already installed") logger.debug(f"Skipping {dependency}, already installed")
logger.debug("Waiting for installs to finish...") 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()