mirror of
https://github.com/enpaul/tox-poetry-installer.git
synced 2025-10-27 06:54:23 +00:00
Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
779dd8c56f
|
|||
|
3399bbecc2
|
|||
|
dd61f8c40f
|
|||
| 447475ebe0 | |||
|
d711a17596
|
|||
|
4f69c8b3b2
|
|||
| bd102605b6 | |||
|
469cb251cf
|
|||
| 41ac5423f9 | |||
|
3388553ee0
|
|||
|
52f34cb317
|
|||
|
4c609770f1
|
|||
| d5650f0562 | |||
|
4261d45218
|
|||
|
d0842456cb
|
|||
|
b631a962b2
|
|||
|
453b575159
|
|||
| 50e1aaddcd | |||
|
|
d0efbd06b3 |
2
.github/scripts/setup-env.sh
vendored
2
.github/scripts/setup-env.sh
vendored
@@ -8,7 +8,7 @@
|
||||
set -e;
|
||||
|
||||
CI_CACHE=$HOME/.cache;
|
||||
POETRY_VERSION=1.2.0;
|
||||
POETRY_VERSION=1.3.2;
|
||||
|
||||
mkdir --parents "$CI_CACHE";
|
||||
|
||||
|
||||
2
.github/workflows/ci.yaml
vendored
2
.github/workflows/ci.yaml
vendored
@@ -20,6 +20,8 @@ jobs:
|
||||
toxenv: py39
|
||||
- version: "3.10"
|
||||
toxenv: py310
|
||||
- version: "3.11"
|
||||
toxenv: py311
|
||||
fail-fast: true
|
||||
steps:
|
||||
- name: Checkout
|
||||
|
||||
25
CHANGELOG.md
25
CHANGELOG.md
@@ -2,13 +2,34 @@
|
||||
|
||||
See also: [Github Release Page](https://github.com/enpaul/tox-poetry-installer/releases).
|
||||
|
||||
## 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 (#73)
|
||||
- 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
|
||||
@@ -48,7 +69,7 @@ View this release on:
|
||||
|
||||
- Improve debug-level logging for package installation, and time how long installing each
|
||||
package takes. Contributed by [Rebecca
|
||||
Turner](https://github.com/9999years).
|
||||
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
|
||||
|
||||
2
Makefile
2
Makefile
@@ -33,7 +33,7 @@ test: ## Run the project testsuite(s)
|
||||
poetry run tox --recreate
|
||||
|
||||
dev: ## Create the local dev environment
|
||||
poetry install -E poetry --sync
|
||||
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)
|
||||
|
||||
22
README.md
22
README.md
@@ -41,9 +41,9 @@ release history.
|
||||
- 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.
|
||||
@@ -151,19 +151,23 @@ commands = ...
|
||||
> 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
|
||||
> **Note:** Setting `poetry_dep_groups = [dev]` 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
|
||||
need to remove the `require_locked_deps = true` option, otherwise the environment will
|
||||
@@ -198,9 +202,13 @@ configuration section.
|
||||
| :--------------------- | :-----: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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. |
|
||||
|
||||
> **Note:** The `install_dev_deps` configuration option is deprecated and will be removed in
|
||||
> version 1.0.0. Please set `poetry_dep_groups = [dev]` in `tox.ini` for environments that
|
||||
> install the development dependencies.
|
||||
|
||||
### Runtime Options
|
||||
|
||||
|
||||
3990
poetry.lock
generated
3990
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.9.0"
|
||||
version = "0.10.1"
|
||||
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"
|
||||
@@ -27,6 +27,7 @@ classifiers = [
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: Implementation :: CPython",
|
||||
]
|
||||
|
||||
@@ -38,7 +39,7 @@ poetry = ["poetry", "cleo"]
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.7"
|
||||
cleo = {version = "^1.0.0a5", optional = true, allow-prereleases = true}
|
||||
cleo = {version = ">=1.0,<3.0", optional = true}
|
||||
poetry = {version = "^1.2.0", optional = true}
|
||||
poetry-core = "^1.1.0"
|
||||
tox = "^3.8.0"
|
||||
@@ -47,7 +48,7 @@ tox = "^3.8.0"
|
||||
bandit = "^1.6.2"
|
||||
black = "^22.3.0"
|
||||
blacken-docs = "^1.8.0"
|
||||
ipython = "^7.18.1"
|
||||
ipython = {version = "^8.10.1", python = "^3.8"}
|
||||
mdformat = "^0.6"
|
||||
mdformat-gfm = "^0.2"
|
||||
mypy = "^0.930"
|
||||
@@ -57,10 +58,15 @@ pylint = "^2.13.0"
|
||||
pytest = "^6.0.2"
|
||||
pytest-cov = "^2.10.1"
|
||||
reorder-python-imports = "^2.3.5"
|
||||
safety = "^1.9.0"
|
||||
safety = "^2.2.0"
|
||||
toml = "^0.10.1"
|
||||
tox = "^3.20.0"
|
||||
types-toml = "^0.10.1"
|
||||
# This is a workaround for this issue with the Poetry export
|
||||
# plugin which was blocking the 'security' CI check:
|
||||
#
|
||||
# https://github.com/python-poetry/poetry-plugin-export/issues/176
|
||||
virtualenv = ">=20.15,<20.16"
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core>=1.1.0"]
|
||||
|
||||
9
tox.ini
9
tox.ini
@@ -1,5 +1,5 @@
|
||||
[tox]
|
||||
envlist = py37, py38, py39, py310, static, static-tests, security
|
||||
envlist = py37, py38, py39, py310, py311, static, static-tests, security
|
||||
isolated_build = true
|
||||
skip_missing_interpreters = true
|
||||
|
||||
@@ -83,7 +83,10 @@ commands =
|
||||
--format requirements.txt \
|
||||
--output {envtmpdir}/requirements.txt \
|
||||
--without-hashes \
|
||||
--dev
|
||||
--with dev \
|
||||
--extras poetry
|
||||
safety check \
|
||||
--file {envtmpdir}/requirements.txt \
|
||||
--json
|
||||
--output text \
|
||||
# https://github.com/pytest-dev/py/issues/287
|
||||
--ignore 51457
|
||||
|
||||
@@ -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.9.0"
|
||||
__version__ = "0.10.1"
|
||||
__url__ = "https://github.com/enpaul/tox-poetry-installer/"
|
||||
__license__ = "MIT"
|
||||
__authors__ = ["Ethan Paul <24588726+enpaul@users.noreply.github.com>"]
|
||||
|
||||
@@ -4,6 +4,7 @@ All implementations of tox hooks are defined here, as well as any single-use hel
|
||||
specifically related to implementing the hooks (to keep the size/readability of the hook functions
|
||||
themselves manageable).
|
||||
"""
|
||||
from itertools import chain
|
||||
from typing import Optional
|
||||
|
||||
import tox
|
||||
@@ -114,7 +115,14 @@ def tox_addoption(parser: ToxParser):
|
||||
name="install_dev_deps",
|
||||
type="bool",
|
||||
default=False,
|
||||
help="Automatically install all Poetry development dependencies to the environment",
|
||||
help="(deprecated) Automatically install all Poetry development dependencies to the environment",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
name="poetry_dep_groups",
|
||||
type="line-list",
|
||||
default=[],
|
||||
help="List of Poetry dependency groups to install to the environment",
|
||||
)
|
||||
|
||||
parser.add_testenv_attribute(
|
||||
@@ -196,6 +204,20 @@ def tox_testenv_install_deps(venv: ToxVirtualEnv, action: ToxAction) -> Optional
|
||||
dev_deps = []
|
||||
logger.info("Env does not install development dependencies, skipping")
|
||||
|
||||
group_deps = utilities.dedupe_packages(
|
||||
list(
|
||||
chain(
|
||||
*[
|
||||
utilities.find_group_deps(group, packages, virtualenv, poetry)
|
||||
for group in venv.envconfig.poetry_dep_groups
|
||||
]
|
||||
)
|
||||
)
|
||||
)
|
||||
logger.info(
|
||||
f"Identified {len(group_deps)} group dependencies to install to env"
|
||||
)
|
||||
|
||||
env_deps = utilities.find_additional_deps(
|
||||
packages, virtualenv, poetry, venv.envconfig.locked_deps
|
||||
)
|
||||
@@ -231,7 +253,9 @@ def tox_testenv_install_deps(venv: ToxVirtualEnv, action: ToxAction) -> Optional
|
||||
logger.error(f"Internal plugin error: {err}")
|
||||
raise err
|
||||
|
||||
dependencies = utilities.dedupe_packages(dev_deps + env_deps + project_deps)
|
||||
dependencies = utilities.dedupe_packages(
|
||||
dev_deps + group_deps + env_deps + project_deps
|
||||
)
|
||||
if (
|
||||
venv.envconfig.config.option.parallel_install_threads
|
||||
!= constants.DEFAULT_INSTALL_THREADS
|
||||
|
||||
@@ -59,6 +59,13 @@ def check_preconditions(venv: ToxVirtualEnv, action: ToxAction) -> "_poetry.Poet
|
||||
"be removed in version 1.0.0. Please use the '--parallel-install-threads' option."
|
||||
)
|
||||
|
||||
if venv.envconfig.install_dev_deps:
|
||||
logger.warning(
|
||||
"DEPRECATION: The 'install_dev_deps' option is deprecated and will be removed in "
|
||||
"version 1.0.0. Please update test environments that install development dependencies "
|
||||
"to set the 'poetry_dev_groups = [dev]' option in tox.ini"
|
||||
)
|
||||
|
||||
from tox_poetry_installer import _poetry
|
||||
|
||||
try:
|
||||
@@ -246,6 +253,33 @@ def find_additional_deps(
|
||||
return dedupe_packages(dependencies)
|
||||
|
||||
|
||||
def find_group_deps(
|
||||
group: str,
|
||||
packages: PackageMap,
|
||||
venv: "_poetry.VirtualEnv",
|
||||
poetry: "_poetry.Poetry",
|
||||
) -> List[PoetryPackage]:
|
||||
"""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 poetry: Poetry object for the current project
|
||||
"""
|
||||
return find_additional_deps(
|
||||
packages,
|
||||
venv,
|
||||
poetry,
|
||||
poetry.pyproject.data["tool"]["poetry"]
|
||||
.get("group", {})
|
||||
.get(group, {})
|
||||
.get("dependencies", {})
|
||||
.keys(),
|
||||
)
|
||||
|
||||
|
||||
def find_dev_deps(
|
||||
packages: PackageMap, venv: "_poetry.VirtualEnv", poetry: "_poetry.Poetry"
|
||||
) -> List[PoetryPackage]:
|
||||
@@ -257,16 +291,7 @@ def find_dev_deps(
|
||||
:param venv: Poetry virtual environment to use for package compatibility checks
|
||||
:param poetry: Poetry object for the current project
|
||||
"""
|
||||
dev_group_deps = find_additional_deps(
|
||||
packages,
|
||||
venv,
|
||||
poetry,
|
||||
poetry.pyproject.data["tool"]["poetry"]
|
||||
.get("group", {})
|
||||
.get("dev", {})
|
||||
.get("dependencies", {})
|
||||
.keys(),
|
||||
)
|
||||
dev_group_deps = find_group_deps("dev", packages, venv, poetry)
|
||||
|
||||
# Legacy pyproject.toml poetry format:
|
||||
legacy_dev_group_deps = find_additional_deps(
|
||||
|
||||
Reference in New Issue
Block a user