Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/legacy_pip_import/boto,examples/legacy_pip_import/extras,examples/legacy_pip_import/helloworld,examples/pip_install,examples/pip_parse,examples/py_import
query --deleted_packages=examples/legacy_pip_import/boto,examples/legacy_pip_import/extras,examples/legacy_pip_import/helloworld,examples/pip_install,examples/pip_parse,examples/py_import
build --deleted_packages=examples/legacy_pip_import/boto,examples/legacy_pip_import/extras,examples/legacy_pip_import/helloworld,examples/pip_install,examples/pip_parse,examples/py_import,examples/pytest,examples/wheel,examples/wheel/lib
query --deleted_packages=examples/legacy_pip_import/boto,examples/legacy_pip_import/extras,examples/legacy_pip_import/helloworld,examples/pip_install,examples/pip_parse,examples/py_import,examples/pytest,examples/wheel,examples/wheel/lib

test --test_output=errors
5 changes: 5 additions & 0 deletions examples/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,8 @@ bazel_integration_test(
name = "py_import_example",
timeout = "long",
)

bazel_integration_test(
name="pytest_example",
timeout = "long"
)
31 changes: 31 additions & 0 deletions examples/pytest/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
load("@rules_python//python:defs.bzl", "py_binary",
"py_library", "py_test", "py_test_suite", "pytest_test")
load("@pip//:requirements.bzl", "requirement")

TEST_DEPS = [
requirement("pluggy"),

Choose a reason for hiding this comment

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

Where are these deps coming from? The relevant requirements.txt file is empty in the PR.

requirement("py"),
requirement("pytest"),
requirement("pytest-instafail"),
requirement("pytest-trio"),
requirement("pytest-mock"),
]

py_library(
name="lib",
srcs="main.py"
)

py_test_suite(
name="unit",
size="small",
srcs="main_tests.py",
args=[
"--instafail",
],
deps=[
":lib",
] + TEST_DEPS,
)


15 changes: 15 additions & 0 deletions examples/pytest/WORKSPACE
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
workspace(name="example_repo")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
name="rules_python",
sha256="778197e26c5fbeb07ac2a2c5ae405b30f6cb7ad1f5510ea6fdac03bded96cc6f",
url="https://github.com/bazelbuild/rules_python/releases/download/0.2.0/rules_python-0.2.0.tar.gz",
)

load("@rules_python//python:pip.bzl", "pip_install", "pip_repositories")

pip_install(
requirements="//:requirements.txt",
)
2 changes: 2 additions & 0 deletions examples/pytest/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def add(first, second):
return first + second
9 changes: 9 additions & 0 deletions examples/pytest/main_tests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import pytest

from .main import add


@pytest.mark.parameterize("first,second,expected", [1, 2, 3])
def test_add(first, second, expected):
result = add(first, second)
assert result == expected
Empty file.
4 changes: 4 additions & 0 deletions python/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ filegroup(
"packaging.bzl",
"pip.bzl",
"private/reexports.bzl",
"pytest.bzl",
"suite.bzl",
"whl.bzl",
],
visibility = ["//:__pkg__"],
Expand Down Expand Up @@ -144,4 +146,6 @@ exports_files([
"packaging.bzl",
"pip.bzl",
"whl.bzl",
"pytest.bzl",
"suite.bzl"
])
1 change: 0 additions & 1 deletion python/defs.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ migrated to Starlark, their implementations will be moved here.
load("@bazel_tools//tools/python:srcs_version.bzl", _find_requirements = "find_requirements")
load("@bazel_tools//tools/python:toolchain.bzl", _py_runtime_pair = "py_runtime_pair")
load(":private/reexports.bzl", "internal_PyInfo", "internal_PyRuntimeInfo")

# Exports of native-defined providers.

PyInfo = internal_PyInfo
Expand Down
81 changes: 81 additions & 0 deletions python/pytest.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
load("@rules_python//python:defs.bzl", "PyInfo", "py_test")

def _stringify(paths):
return repr(paths)

def _pytest_runner_impl(ctx):
if len(ctx.attr.srcs) == 0:
fail("No test files specified.")

expanded_args = [ctx.expand_location(arg, ctx.attr.data) for arg in ctx.attr.args]

runner = ctx.actions.declare_file(ctx.attr.name)
ctx.actions.write(
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be a template substitution action.

runner,
"""
if __name__ == "__main__":
import sys
import pytest

args = ["-ra"] + %s + sys.argv[1:] + %s

Choose a reason for hiding this comment

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

Was going to request --long-args for readability but seems it's just -r chars provided by pytest, lame.


sys.exit(pytest.main(args))""" % (_stringify(expanded_args), _stringify([src.path for src in ctx.files.srcs])),
is_executable = True,
)

return [
DefaultInfo(
files = depset([runner]),
runfiles = ctx.runfiles(ctx.files.data),
executable = runner,
),
]

_pytest_runner = rule(
_pytest_runner_impl,
attrs = {
"srcs": attr.label_list(
allow_files = [".py"],
),
"deps": attr.label_list(
providers = [
PyInfo,
],
),
"args": attr.string_list(
default = [],
),
"data": attr.label_list(
allow_empty = True,
allow_files = True,
),
"python_version": attr.string(
values = ["PY2", "PY3"],
default = "PY3",
),
},
)

def pytest_test(name, srcs, deps = None, args = None, data = None, python_version = None, **kwargs):

Choose a reason for hiding this comment

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

py_pytest_test, like Dropbox uses? I like that it preserves the standard py_ prefix.

runner_target = "%s-runner.py" % name

_pytest_runner(

Choose a reason for hiding this comment

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

What necessitates the creation of a separate executable? Can we just have a special py_test.main program? It looks like that's maybe what's happening as the py_test.main value is main = runner_target. The _pytest_runner target creates the runner file. But then why is the _pytest_runner itself executable?

name = runner_target,
testonly = True,
srcs = srcs,
deps = deps,
args = args,
data = data,
python_version = python_version,
)

py_test(
name = name,
python_version = python_version,
srcs = srcs + [runner_target],
deps = deps,

Choose a reason for hiding this comment

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

Think that users of the any _pytest_test rule should get pytest as a provided dependency, like here: https://github.com/dropbox/dbx_build_tools/blob/fe5c9e668a9e6951970c0595089742d8a0247b8c/build_tools/py/py.bzl#L1011

Is there an problem with that approach I'm not seeing?

Copy link
Contributor

Choose a reason for hiding this comment

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

Only issue I can think of involves which version of pytest to use. Presumably users need to have it in their requirements.txt, or we inject a default version if not. We should definitely add requirement("pytest") to deps if it doesn't exist.

Other related issues include user provided plugin version eg. pytest_coverage which need to resolve with pytest, and how / when to add those deps to the py_pytest_test rule.

main = runner_target,
legacy_create_init = False,
imports = ["."],
**kwargs
)
37 changes: 37 additions & 0 deletions python/suite.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# load("@rules_python//python:defs.bzl", "py_library")
load(":pytest.bzl", "pytest_test")

def _is_test(file):
return file.startswith("test_") or file.endswith("_tests.py")

def py_test_suite(name, srcs, size = None, deps = None, python_version = None, imports = None, visibility = None, **kwargs):
library_name = "%s-test-lib" % name

py_library(
name = library_name,
testonly = True,
srcs = srcs,
deps = deps,
imports = imports,
)

tests = []
for src in srcs:
if _is_test(src):
test_name = "%s-%s" % (name, src)

tests.append(test_name)

pytest_test(

Choose a reason for hiding this comment

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

Don't think we should have the 'generic py_test_suite delegate to a pytest test implementation. I think everything using pytest (which is a third-party dep and not stock python) should include "pytest" in the rule name.

name = test_name,
size = size,
srcs = [src],
deps = [library_name],
python_version = python_version,
**kwargs
)
native.test_suite(
name = name,
tests = tests,

Choose a reason for hiding this comment

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

If the tests attribute is unspecified or empty, the rule will default to including all test rules in the current BUILD file that are not tagged as manual. source

?? That's unexpected behaviour to me. I would have thought an empty list would do nothing or error. Do you have experience with _test_suite rules that wrap native.test_suite? Do rule authors keep this odd behaviour?

visibility = visibility,
)