Skip to content

chore: add noxfile parameters for extra dependencies #906

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

Merged
busunkim96 merged 5 commits into from
Jan 26, 2021
Merged

chore: add noxfile parameters for extra dependencies #906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02d98de
feat: add noxfile parameters for extra dependencies
tswast Jan 14, 2021
e467918
Merge branch 'master' into issue838-extras
tswast Jan 19, 2021
427aa6a
Merge branch 'master' into issue838-extras
tswast Jan 19, 2021
5b31f59
Merge branch 'master' into issue838-extras
SurferJeffAtGoogle Jan 25, 2021
19502ec
Merge branch 'master' into issue838-extras
tswast Jan 26, 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
31 changes: 27 additions & 4 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 @@ -88,9 +88,21 @@ def default(session):
session.install("asyncmock", "pytest-asyncio")
{% endif %}
session.install("mock", "pytest", "pytest-cov", {% for d in unit_test_external_dependencies %}"{{d}}"{% if not loop.last %},{% endif %}{% endfor %})
session.install("-e", ".")
{% for dependency in unit_test_local_dependencies %}session.install("-e", "{{dependency}}"){% endfor %}
{% for dependency in unit_test_local_dependencies %}session.install("-e", "{{dependency}}")
{% endfor %}
{% for dependency in unit_test_dependencies %}session.install("-e", "{{dependency}}"){% 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}")
{% elif unit_test_extras %}
session.install("-e", ".[{{",".join(unit_test_extras)}}]")
{% else %}
session.install("-e", ".")
{% endif %}

# Run py.test against the unit tests.
session.run(
Expand Down Expand Up @@ -139,10 +151,21 @@ def system(session):
session.install("mock", "pytest", "google-cloud-testutils", {% for d in system_test_external_dependencies %}"{{d}}"{% if not loop.last %},{% endif %}{% endfor %})

{%- if system_test_local_dependencies %}
session.install("-e", {% for d in system_test_local_dependencies %}"{{d}}"{% if not loop.last %},{% endif %}{% endfor %})
{% for dependency in system_test_local_dependencies %}session.install("-e", "{{dependency}}")
{% endfor %}
{%- endif %}
{%- if system_test_extras_by_python %}
{% for extras_python in system_test_extras_by_python %}
{%- if not loop.first %}el{% endif %}if session.python == "{{extras_python}}":
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}")
{% elif system_test_extras %}
session.install("-e", ".[{{",".join(system_test_extras)}}]")
{% else %}
session.install("-e", ".")

{% endif %}

# Run py.test against the system tests.
if system_test_exists:
Expand Down
82 changes: 82 additions & 0 deletions tests/test_python_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,89 @@
import os
from pathlib import Path

import pytest

from synthtool import gcp
from synthtool.sources import templates


PYTHON_LIBRARY = Path(__file__).parent.parent / "synthtool/gcp/templates/python_library"


@pytest.mark.parametrize(
["template_kwargs", "expected_text"],
[
({}, ["import nox", 'session.install("-e", ".")']),
(
{"unit_test_local_dependencies": ["../testutils", "../unitutils"]},
[
'session.install("-e", "../testutils")',
'session.install("-e", "../unitutils")',
],
),
(
{"system_test_local_dependencies": ["../testutils", "../sysutils"]},
[
'session.install("-e", "../testutils")',
'session.install("-e", "../sysutils")',
],
),
(
{"unit_test_extras": ["abc", "def"]},
['session.install("-e", ".[abc,def]")'],
),
(
{"system_test_extras": ["abc", "def"]},
['session.install("-e", ".[abc,def]")'],
),
(
{"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}")',
],
),
(
{"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}")',
],
),
(
{
"unit_test_extras": ["tuv", "wxyz"],
"unit_test_extras_by_python": {"3.8": ["abc", "def"]},
},
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = "[tuv,wxyz]"',
'session.install("-e", f".{extras}")',
],
),
(
{
"system_test_extras": ["tuv", "wxyz"],
"system_test_extras_by_python": {"3.8": ["abc", "def"]},
},
[
'if session.python == "3.8":\n extras = "[abc,def]"',
'else:\n extras = "[tuv,wxyz]"',
'session.install("-e", f".{extras}")',
],
),
],
)
def test_library_noxfile(template_kwargs, expected_text):
t = templates.Templates(PYTHON_LIBRARY)
result = t.render("noxfile.py.j2", **template_kwargs,).read_text()
# Validate Python syntax.
result_code = compile(result, "noxfile.py", "exec")
Copy link
Contributor

@busunkim96 busunkim96 Jan 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL about the compile() function. Thanks for adding these tests!

assert result_code is not None
for expected in expected_text:
assert expected in result


def test_python_library():
Expand Down