Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

add support for pytest describe #24400

Merged
merged 4 commits into from
Nov 8, 2024
Merged

add support for pytest describe #24400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c74a0a
add support for pytest describe
eleanorjboyd Nov 6, 2024
e5ae567
add test requirement
eleanorjboyd Nov 6, 2024
ae92053
linting
eleanorjboyd Nov 6, 2024
be9dfeb
add describe type to class creation function
eleanorjboyd Nov 7, 2024
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
3 changes: 3 additions & 0 deletions build/test-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,6 @@ django-stubs
# for coverage
coverage
pytest-cov

# for pytest-describe related tests
pytest-describe
9 changes: 9 additions & 0 deletions python_files/tests/pytestadapter/.data/pytest_describe_plugin/describe_only.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

def describe_A():
def test_1(): # test_marker--test_1
pass

def test_2(): # test_marker--test_2
pass
31 changes: 31 additions & 0 deletions python_files/tests/pytestadapter/.data/pytest_describe_plugin/nested_describe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

import pytest


def describe_list():
@pytest.fixture
def list():
return []

def describe_append():
def add_empty(list): # test_marker--add_empty
list.append("foo")
list.append("bar")
assert list == ["foo", "bar"]

def remove_empty(list): # test_marker--remove_empty
try:
list.remove("foo")
except ValueError:
pass

def describe_remove():
@pytest.fixture
def list():
return ["foo", "bar"]

def removes(list): # test_marker--removes
list.remove("foo")
assert list == ["bar"]
183 changes: 183 additions & 0 deletions python_files/tests/pytestadapter/expected_discovery_test_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1394,3 +1394,186 @@
],
"id_": TEST_DATA_PATH_STR,
}
# This is the expected output for the describe_only.py tests.
# └── describe_only.py
# └── describe_A
# └── test_1
# └── test_2

describe_only_path = TEST_DATA_PATH / "pytest_describe_plugin" / "describe_only.py"
pytest_describe_plugin_path = TEST_DATA_PATH / "pytest_describe_plugin"

expected_describe_only_output = {
"name": ".data",
"path": TEST_DATA_PATH_STR,
"type_": "folder",
"children": [
{
"name": "pytest_describe_plugin",
"path": os.fspath(pytest_describe_plugin_path),
"type_": "folder",
"id_": os.fspath(pytest_describe_plugin_path),
"children": [
{
"name": "describe_only.py",
"path": os.fspath(describe_only_path),
"type_": "file",
"id_": os.fspath(describe_only_path),
"children": [
{
"name": "describe_A",
"path": os.fspath(describe_only_path),
"type_": "class",
"children": [
{
"name": "test_1",
"path": os.fspath(describe_only_path),
"lineno": find_test_line_number(
"test_1",
describe_only_path,
),
"type_": "test",
"id_": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_1",
describe_only_path,
),
"runID": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_1",
describe_only_path,
),
},
{
"name": "test_2",
"path": os.fspath(describe_only_path),
"lineno": find_test_line_number(
"test_2",
describe_only_path,
),
"type_": "test",
"id_": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_2",
describe_only_path,
),
"runID": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_2",
describe_only_path,
),
},
],
"id_": "pytest_describe_plugin/describe_only.py::describe_A",
}
],
}
],
}
],
"id_": TEST_DATA_PATH_STR,
}
# This is the expected output for the nested_describe.py tests.
# └── nested_describe.py
# └── describe_list
# └── describe_append
# └── add_empty
# └── remove_empty
# └── describe_remove
# └── removes
nested_describe_path = TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py"
expected_nested_describe_output = {
"name": ".data",
"path": TEST_DATA_PATH_STR,
"type_": "folder",
"children": [
{
"name": "pytest_describe_plugin",
"path": os.fspath(pytest_describe_plugin_path),
"type_": "folder",
"id_": os.fspath(pytest_describe_plugin_path),
"children": [
{
"name": "nested_describe.py",
"path": os.fspath(nested_describe_path),
"type_": "file",
"id_": os.fspath(nested_describe_path),
"children": [
{
"name": "describe_list",
"path": os.fspath(nested_describe_path),
"type_": "class",
"children": [
{
"name": "describe_append",
"path": os.fspath(nested_describe_path),
"type_": "class",
"children": [
{
"name": "add_empty",
"path": os.fspath(nested_describe_path),
"lineno": find_test_line_number(
"add_empty",
nested_describe_path,
),
"type_": "test",
"id_": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::add_empty",
nested_describe_path,
),
"runID": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::add_empty",
nested_describe_path,
),
},
{
"name": "remove_empty",
"path": os.fspath(nested_describe_path),
"lineno": find_test_line_number(
"remove_empty",
nested_describe_path,
),
"type_": "test",
"id_": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::remove_empty",
nested_describe_path,
),
"runID": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::remove_empty",
nested_describe_path,
),
},
],
"id_": "pytest_describe_plugin/nested_describe.py::describe_list::describe_append",
},
{
"name": "describe_remove",
"path": os.fspath(nested_describe_path),
"type_": "class",
"children": [
{
"name": "removes",
"path": os.fspath(nested_describe_path),
"lineno": find_test_line_number(
"removes",
nested_describe_path,
),
"type_": "test",
"id_": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_remove::removes",
nested_describe_path,
),
"runID": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_remove::removes",
nested_describe_path,
),
}
],
"id_": "pytest_describe_plugin/nested_describe.py::describe_list::describe_remove",
},
],
"id_": "pytest_describe_plugin/nested_describe.py::describe_list",
}
],
}
],
}
],
"id_": TEST_DATA_PATH_STR,
}
88 changes: 88 additions & 0 deletions python_files/tests/pytestadapter/expected_execution_test_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,3 +646,91 @@
"subtest": None,
}
}


# This is the expected output for the pytest_describe_plugin/describe_only.py file.
# └── pytest_describe_plugin
# └── describe_only.py
# └── describe_A
# └── test_1: success
# └── test_2: success

describe_only_expected_execution_output = {
get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_1",
TEST_DATA_PATH / "pytest_describe_plugin" / "describe_only.py",
): {
"test": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_1",
TEST_DATA_PATH / "pytest_describe_plugin" / "describe_only.py",
),
"outcome": "success",
"message": None,
"traceback": None,
"subtest": None,
},
get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_2",
TEST_DATA_PATH / "pytest_describe_plugin" / "describe_only.py",
): {
"test": get_absolute_test_id(
"pytest_describe_plugin/describe_only.py::describe_A::test_2",
TEST_DATA_PATH / "pytest_describe_plugin" / "describe_only.py",
),
"outcome": "success",
"message": None,
"traceback": None,
"subtest": None,
},
}

# This is the expected output for the pytest_describe_plugin/nested_describe.py file.
# └── pytest_describe_plugin
# └── nested_describe.py
# └── describe_list
# └── describe_append
# └── add_empty: success
# └── remove_empty: success
# └── describe_remove
# └── removes: success
nested_describe_expected_execution_output = {
get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::add_empty",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
): {
"test": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::add_empty",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
),
"outcome": "success",
"message": None,
"traceback": None,
"subtest": None,
},
get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::remove_empty",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
): {
"test": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append::remove_empty",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
),
"outcome": "success",
"message": None,
"traceback": None,
"subtest": None,
},
get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_remove::removes",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
): {
"test": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list::describe_remove::removes",
TEST_DATA_PATH / "pytest_describe_plugin" / "nested_describe.py",
),
"outcome": "success",
"message": None,
"traceback": None,
"subtest": None,
},
}
8 changes: 8 additions & 0 deletions python_files/tests/pytestadapter/test_discovery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,14 @@ def test_parameterized_error_collect():
"text_docstring.txt",
expected_discovery_test_output.doctest_pytest_expected_output,
),
(
"pytest_describe_plugin" + os.path.sep + "describe_only.py",
expected_discovery_test_output.expected_describe_only_output,
),
(
"pytest_describe_plugin" + os.path.sep + "nested_describe.py",
expected_discovery_test_output.expected_nested_describe_output,
),
],
)
def test_pytest_collect(file, expected_const):
Expand Down
Loading
Loading