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.

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

Remove dependency on build package being installed while running tests #755

Merged
merged 8 commits into from
Feb 13, 2024
Merged
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ __pycache__/
.Python
build/
develop-eggs/
dist/
/dist/
downloads/
eggs/
.eggs/
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# **Upcoming release**

- #730 Match on module aliases for autoimport suggestions
- #755 Remove dependency on `build` package being installed while running tests

# Release 1.12.0

Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include README.rst COPYING setup.py MANIFEST.in CHANGELOG.md
include README.rst COPYING setup.py MANIFEST.in CHANGELOG.md ropetest-package-fixtures/external_fixturepkg/dist/external_fixturepkg-1.0.0-py3-none-any.whl ropetest-package-fixtures/external_fixturepkg/dist/external_fixturepkg-1.0.0.tar.gz
recursive-include rope *.py
recursive-include docs *.rst
recursive-include ropetest *.py
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ profile = "black"

[tool.pytest.ini_options]

testpaths = "ropetest"
python_files = [
"*test.py",
"__init__.py",
Expand Down
2 changes: 1 addition & 1 deletion rope/contrib/autoimport/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def get_package_source(
if "site-packages" in package.parts:
return Source.SITE_PACKAGE
if sys.version_info < (3, 10, 0):
if str(package).startswith(sys.prefix):
if str(package).startswith(sys.base_prefix):
return Source.STANDARD
else:
if name in sys.stdlib_module_names:
Expand Down
12 changes: 12 additions & 0 deletions ropetest-package-fixtures/external_fixturepkg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# example_project

Just an example project for testing rope.


To build this package, run:

```bash
$ python -m build
```

This generates packages in `dist` folder.
Binary file not shown.
Binary file not shown.
18 changes: 18 additions & 0 deletions ropetest-package-fixtures/external_fixturepkg/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[build-system]
requires = ["flit-core >= 3.8"]
build-backend = "flit_core.buildapi"

[project]
name = "external_fixturepkg"
version = "1.0.0"
description = "Just an example project built with build/flit for testing purpose"
readme = "README.md"
requires-python = ">= 3.7"

dependencies = [ ]

[project.scripts]
pyproject-build = "build.__main__:entrypoint"

[tool.flit.sdist]
exclude = ["**/__pycache__", "**/*.egg-info"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def sample_function():
pass
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
def main() -> None:
pass


if __name__ == '__main__':
main()
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
foo = None
23 changes: 16 additions & 7 deletions ropetest/conftest.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import pathlib
import sys
from subprocess import check_call

import pytest

Expand All @@ -13,13 +15,6 @@ def project():
testutils.remove_project(project)


@pytest.fixture
def project2():
project = testutils.sample_project("another_project")
yield project
testutils.remove_project(project)


@pytest.fixture
def project_path(project):
yield pathlib.Path(project.address)
Expand Down Expand Up @@ -52,3 +47,17 @@ def pkg1(project) -> resources.Folder:
@pytest.fixture
def mod2(project, pkg1) -> resources.Folder:
return testutils.create_module(project, "mod2", pkg1)


@pytest.fixture(scope="session")
def external_fixturepkg():
check_call([
sys.executable,
"-m",
"pip",
"install",
"--force-reinstall",
"ropetest-package-fixtures/external_fixturepkg/dist/external_fixturepkg-1.0.0-py3-none-any.whl",
])
yield
check_call([sys.executable, "-m", "pip", "uninstall", "--yes", "external-fixturepkg"])
13 changes: 6 additions & 7 deletions ropetest/contrib/autoimport/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,18 @@ def typing_path():


@pytest.fixture
def build_env_path():
from build import env

yield pathlib.Path(env.__file__)
def example_external_package_module_path(external_fixturepkg):
from external_fixturepkg import mod1
yield pathlib.Path(mod1.__file__)


@pytest.fixture
def build_path():
import build
def example_external_package_path(external_fixturepkg):
import external_fixturepkg

# Uses __init__.py so we need the parent

yield pathlib.Path(build.__file__).parent
yield pathlib.Path(external_fixturepkg.__file__).parent


@pytest.fixture
Expand Down
20 changes: 12 additions & 8 deletions ropetest/contrib/autoimport/utilstest.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,35 @@ def test_get_package_source_not_project(mod1_path):
assert utils.get_package_source(mod1_path, None, "") == Source.UNKNOWN


def test_get_package_source_pytest(build_path):
def test_get_package_source_pytest(example_external_package_path):
# pytest is not installed as part of the standard library
# but should be installed into site_packages,
# so it should return Source.SITE_PACKAGE
assert utils.get_package_source(build_path, None, "build") == Source.SITE_PACKAGE
source = utils.get_package_source(example_external_package_path, None, "mod1")
assert source == Source.SITE_PACKAGE


def test_get_package_source_typing(typing_path):

assert utils.get_package_source(typing_path, None, "typing") == Source.STANDARD


def test_get_modname_project_no_add(mod1_path, project_path):

assert utils.get_modname_from_path(mod1_path, project_path, False) == "mod1"


def test_get_modname_single_file(typing_path):

assert utils.get_modname_from_path(typing_path, typing_path) == "typing"


def test_get_modname_folder(build_path, build_env_path):

assert utils.get_modname_from_path(build_env_path, build_path) == "build.env"
def test_get_modname_folder(
example_external_package_path,
example_external_package_module_path,
):
modname = utils.get_modname_from_path(
example_external_package_module_path,
example_external_package_path,
)
assert modname == "external_fixturepkg.mod1"


def test_get_package_tuple_sample(project_path):
Expand Down
17 changes: 10 additions & 7 deletions ropetest/contrib/autoimporttest.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,6 @@ def test_handling_builtin_modules(self):
self.importer.update_module("sys")
self.assertIn("sys", self.importer.get_modules("exit"))

def test_search_submodule(self):
self.importer.update_module("build")
import_statement = ("from build import env", "env")
self.assertIn(import_statement, self.importer.search("env", exact_match=True))
self.assertIn(import_statement, self.importer.search("en"))
self.assertIn(import_statement, self.importer.search("env"))

def test_search_module(self):
self.importer.update_module("os")
import_statement = ("import os", "os")
Expand Down Expand Up @@ -184,6 +177,16 @@ def test_skipping_directories_not_accessible_because_of_permission_error(self):
self.assertGreater(len(self.importer._dump_all()), 0)


def test_search_submodule(external_fixturepkg):
project = testutils.sample_project(extension_modules=["sys"])
importer = autoimport.AutoImport(project, observe=False)
importer.update_module("external_fixturepkg")
import_statement = ("from external_fixturepkg import mod1", "mod1")
assert import_statement in importer.search("mod1", exact_match=True)
assert import_statement in importer.search("mo")
assert import_statement in importer.search("mod1")


class AutoImportObservingTest(unittest.TestCase):
def setUp(self):
super().setUp()
Expand Down
Loading