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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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"),

Copy link
Copy Markdown

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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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 DownExpand 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 numberDiff line numberDiff 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 numberDiff line numberDiff 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
Copy Markdown
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

Copy link
Copy Markdown

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):

Copy link
Copy Markdown

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(

Copy link
Copy Markdown

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_runneritself 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,

Copy link
Copy Markdown

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
Copy Markdown
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 numberDiff line numberDiff 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(

Copy link
Copy Markdown

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,

Copy link
Copy Markdown

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,
)