Skip to content

Commit

Permalink
chore: remove duplicate/no-op tests from meta/test_ensure_type_hints
Browse files Browse the repository at this point in the history
Before we were generating 725 tests for the
meta/test_ensure_type_hints.py tests.  Which isn't a huge concern as
it was fairly fast. But when we had a failure we would usually get two
failures for each problem as the same test was being run multiple
times.

Changed it so that:
  1. Don't add tests that are not for *Manager classes
  2. Use a set so that we don't have duplicate tests.

After doing that our generated test count in
meta/test_ensure_type_hints.py went from 725 to 178 tests.

Additionally removed the parsing of `pyproject.toml` to generate files
to ignore as we have finished adding type-hints to all files in
gitlab/v4/objects/. This also means we no longer use the toml library
so remove installation of `types-toml`.

To determine the test count the following command was run:
  $ tox -e py39 -- -k test_ensure_type_hints
  • Loading branch information
JohnVillalovos committed Nov 24, 2021
1 parent 7ba5995 commit a2f59f4
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 22 deletions.
1 change: 0 additions & 1 deletion requirements-lint.txt
Expand Up @@ -6,4 +6,3 @@ pytest
types-PyYAML==6.0.1
types-requests==2.26.0
types-setuptools==57.4.3
types-toml==0.10.1
28 changes: 7 additions & 21 deletions tests/meta/test_ensure_type_hints.py
Expand Up @@ -8,7 +8,6 @@
from typing import Tuple, Type

import _pytest
import toml

import gitlab.mixins
import gitlab.v4.objects
Expand All @@ -18,20 +17,8 @@ def pytest_generate_tests(metafunc: _pytest.python.Metafunc) -> None:
"""Find all of the classes in gitlab.v4.objects and pass them to our test
function"""

# Ignore any modules that we are ignoring in our pyproject.toml
excluded_modules = set()
with open("pyproject.toml", "r") as in_file:
pyproject = toml.load(in_file)
overrides = pyproject.get("tool", {}).get("mypy", {}).get("overrides", [])
for override in overrides:
if not override.get("ignore_errors"):
continue
for module in override.get("module", []):
if module.startswith("gitlab.v4.objects"):
excluded_modules.add(module)

class_info_list = []
for module_name, module_value in inspect.getmembers(gitlab.v4.objects):
class_info_set = set()
for _, module_value in inspect.getmembers(gitlab.v4.objects):
if not inspect.ismodule(module_value):
# We only care about the modules
continue
Expand All @@ -41,17 +28,16 @@ def pytest_generate_tests(metafunc: _pytest.python.Metafunc) -> None:
continue

module_name = class_value.__module__
# Ignore modules that mypy is ignoring
if module_name in excluded_modules:
continue

# Ignore imported classes from gitlab.base
if module_name == "gitlab.base":
continue

class_info_list.append((class_name, class_value))
if not class_name.endswith("Manager"):
continue

class_info_set.add((class_name, class_value))

metafunc.parametrize("class_info", class_info_list)
metafunc.parametrize("class_info", class_info_set)


class TestTypeHints:
Expand Down

0 comments on commit a2f59f4

Please sign in to comment.