Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(python): use constraints files to check dependency lower bounds #869

Merged
merged 10 commits into from
Mar 23, 2021
Merged

test(python): use constraints files to check dependency lower bounds #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b9a14fe
test(python): use constraints files to check dependency lower bounds
busunkim96 Dec 1, 2020
785a55f
Merge branch 'master' into use-constraints-file
busunkim96 Dec 3, 2020
9c6f155
fix: don't fail if no constraints file is found
busunkim96 Dec 3, 2020
cc463da
Merge branch 'use-constraints-file' of github.com:googleapis/synthtoo…
busunkim96 Dec 3, 2020
dfda1a0
fix: fail on missing file; add constraints to all dep installs
busunkim96 Dec 3, 2020
2a29047
chore: use path as string
busunkim96 Dec 3, 2020
a9d400a
Merge branch 'master' into use-constraints-file
tseaver Dec 16, 2020
41d18e9
Merge remote-tracking branch 'upstream/master' into use-constraints-file
tswast Mar 23, 2021
897f08f
fix tests
tswast Mar 23, 2021
8f98a99
Merge branch 'master' into use-constraints-file
gcf-merge-on-green[bot] Mar 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions synthtool/gcp/templates/python_library/noxfile.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

from __future__ import absolute_import
import os
import pathlib
import shutil

import nox
Expand All @@ -30,6 +31,8 @@ DEFAULT_PYTHON_VERSION="{{ default_python_version }}"
SYSTEM_TEST_PYTHON_VERSIONS=[{% for v in system_test_python_versions %}"{{v}}"{% if not loop.last %},{% endif %}{% endfor %}]
UNIT_TEST_PYTHON_VERSIONS=[{% for v in unit_test_python_versions %}"{{v}}"{% if not loop.last %},{% endif %}{% endfor %}]

CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()

# 'docfx' is excluded since it only needs to run in 'docs-presubmit'
nox.options.sessions = [
"unit",
Expand Down Expand Up @@ -88,24 +91,27 @@ def lint_setup_py(session):
def default(session):
# Install all test dependencies, then install this package in-place.

constraints_path = str(
CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
)
{%- if microgenerator %}
session.install("asyncmock", "pytest-asyncio")
session.install("asyncmock", "pytest-asyncio", "-c", constraints_path)
{% endif %}
session.install("mock", "pytest", "pytest-cov", {% for d in unit_test_external_dependencies %}"{{d}}"{% if not loop.last %},{% endif %}{% endfor %})
{% for dependency in unit_test_local_dependencies %}session.install("-e", "{{dependency}}")
session.install("mock", "pytest", "pytest-cov", {% for d in unit_test_external_dependencies %}"{{d}}",{% endfor %} "-c", constraints_path)
{% for dependency in unit_test_local_dependencies %}session.install("-e", "{{dependency}}", "-c", constraints_path)
{% endfor %}
{% for dependency in unit_test_dependencies %}session.install("-e", "{{dependency}}"){% endfor %}
{% for dependency in unit_test_dependencies %}session.install("-e", "{{dependency}}", "-c", constraints_path){% endfor %}
{%- if unit_test_extras_by_python %}
{% for extras_python in unit_test_extras_by_python %}
{%- if not loop.first %}el{% endif %}if session.python == "{{extras_python}}":
extras = "[{{",".join(unit_test_extras_by_python[extras_python])}}]"
{% endfor %}else:
extras = "{%- if unit_test_extras %}[{{",".join(unit_test_extras)}}]{% endif %}"
session.install("-e", f".{extras}")
session.install("-e", f".{extras}", "-c", constraints_path)
{% elif unit_test_extras %}
session.install("-e", ".[{{",".join(unit_test_extras)}}]")
session.install("-e", ".[{{",".join(unit_test_extras)}}]", "-c", constraints_path)
{% else %}
session.install("-e", ".")
session.install("-e", ".", "-c", constraints_path)
{% endif %}

# Run py.test against the unit tests.
Expand All @@ -132,6 +138,9 @@ def unit(session):
@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
def system(session):
"""Run the system test suite."""
constraints_path = str(
CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"
)
system_test_path = os.path.join("tests", "system.py")
system_test_folder_path = os.path.join("tests", "system")

Expand All @@ -156,10 +165,10 @@ def system(session):

# Install all test dependencies, then install this package into the
# virtualenv's dist-packages.
session.install("mock", "pytest", "google-cloud-testutils", {% for d in system_test_external_dependencies %}"{{d}}"{% if not loop.last %},{% endif %}{% endfor %})
session.install("mock", "pytest", "google-cloud-testutils"{% for d in system_test_external_dependencies %}, "{{d}}"{% endfor %}, "-c", constraints_path)

{%- if system_test_local_dependencies %}
{% for dependency in system_test_local_dependencies %}session.install("-e", "{{dependency}}")
{% for dependency in system_test_local_dependencies %}session.install("-e", "{{dependency}}", "-c", constraints_path)
{% endfor %}
{%- endif %}
{%- if system_test_extras_by_python %}
Expand All @@ -168,11 +177,11 @@ def system(session):
extras = "[{{",".join(system_test_extras_by_python[extras_python])}}]"
{% endfor %}else:
extras = "{%- if system_test_extras %}[{{",".join(system_test_extras)}}]{% endif %}"
session.install("-e", f".{extras}")
session.install("-e", f".{extras}", "-c", constraints_path)
{% elif system_test_extras %}
session.install("-e", ".[{{",".join(system_test_extras)}}]")
session.install("-e", ".[{{",".join(system_test_extras)}}]", "-c", constraints_path)
{% else %}
session.install("-e", ".")
session.install("-e", ".", "-c", constraints_path)
{% endif %}

# Run py.test against the system tests.
Expand Down
22 changes: 11 additions & 11 deletions tests/test_python_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,43 +27,43 @@
@pytest.mark.parametrize(
["template_kwargs", "expected_text"],
[
({}, ["import nox", 'session.install("-e", ".")']),
({}, ["import nox", 'session.install("-e", ".", "-c", constraints_path)']),
(
{"unit_test_local_dependencies": ["../testutils", "../unitutils"]},
[
'session.install("-e", "../testutils")',
'session.install("-e", "../unitutils")',
'session.install("-e", "../testutils", "-c", constraints_path)',
'session.install("-e", "../unitutils", "-c", constraints_path)',
],
),
(
{"system_test_local_dependencies": ["../testutils", "../sysutils"]},
[
'session.install("-e", "../testutils")',
'session.install("-e", "../sysutils")',
'session.install("-e", "../testutils", "-c", constraints_path)',
'session.install("-e", "../sysutils", "-c", constraints_path)',
],
),
(
{"unit_test_extras": ["abc", "def"]},
['session.install("-e", ".[abc,def]")'],
['session.install("-e", ".[abc,def]", "-c", constraints_path)'],
),
(
{"system_test_extras": ["abc", "def"]},
['session.install("-e", ".[abc,def]")'],
['session.install("-e", ".[abc,def]", "-c", constraints_path)'],
),
(
{"unit_test_extras_by_python": {"3.8": ["abc", "def"]}},
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = ""',
'session.install("-e", f".{extras}")',
'session.install("-e", f".{extras}", "-c", constraints_path)',
],
),
(
{"system_test_extras_by_python": {"3.8": ["abc", "def"]}},
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = ""',
'session.install("-e", f".{extras}")',
'session.install("-e", f".{extras}", "-c", constraints_path)',
],
),
(
Expand All @@ -74,7 +74,7 @@
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = "[tuv,wxyz]"',
'session.install("-e", f".{extras}")',
'session.install("-e", f".{extras}", "-c", constraints_path)',
],
),
(
Expand All @@ -85,7 +85,7 @@
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = "[tuv,wxyz]"',
'session.install("-e", f".{extras}")',
'session.install("-e", f".{extras}", "-c", constraints_path)',
],
),
],
Expand Down