Skip to content

[master] Remove usage of "mock" in favor of "unittest.mock" #65364

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

Closed
meaksh wants to merge 4 commits into from
Closed

[master] Remove usage of "mock" in favor of "unittest.mock" #65364

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
729cd55
Remove usage of mock in favor of unittest.mock
meaksh Oct 9, 2023
4c6fae1
Make pylint happy
meaksh Oct 9, 2023
9fe69ef
Fix unit test after switching to unittest.mock
meaksh Oct 9, 2023
66be917
Merge branch 'master' into master-remove-mock
Nov 27, 2023
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
1 change: 0 additions & 1 deletion requirements/pytest.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
mock >= 3.0.0
# PyTest
docker
pytest >= 7.2.0
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.10/darwin.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/darwin.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.10/darwin.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.10/freebsd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/freebsd.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.10/freebsd.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.10/linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/linux.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.10/linux.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.10/windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,6 @@ markupsafe==2.1.2
# jinja2
# mako
# werkzeug
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.10/windows.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.11/darwin.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/darwin.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.11/darwin.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.11/freebsd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,8 +230,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/freebsd.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.11/freebsd.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.11/linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,8 +254,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/linux.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.11/linux.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.11/windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,6 @@ markupsafe==2.1.2
# jinja2
# mako
# werkzeug
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.11/windows.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.8/freebsd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/freebsd.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.8/freebsd.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.8/linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/linux.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.8/linux.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.8/windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,6 @@ markupsafe==2.1.2
# jinja2
# mako
# werkzeug
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.8/windows.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.9/darwin.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/darwin.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.9/darwin.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.9/freebsd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/freebsd.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.9/freebsd.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.9/linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,6 @@ markupsafe==2.1.2
# werkzeug
mercurial==6.4.4
# via -r requirements/static/ci/linux.in
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.9/linux.txt
Expand Down
2 changes: 0 additions & 2 deletions requirements/static/ci/py3.9/windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,6 @@ markupsafe==2.1.2
# jinja2
# mako
# werkzeug
mock==5.1.0
# via -r requirements/pytest.txt
more-itertools==9.1.0
# via
# -c requirements/static/ci/../pkg/py3.9/windows.txt
Expand Down
7 changes: 2 additions & 5 deletions tests/pytests/unit/cloud/clouds/test_dimensiondata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
from salt.cloud.clouds import dimensiondata
from salt.exceptions import SaltCloudSystemExit
from salt.utils.versions import Version
from tests.support.mock import MagicMock
from tests.support.mock import __version__ as mock_version
from tests.support.mock import patch
from tests.support.mock import MagicMock, patch

try:
import libcloud.security
Expand Down Expand Up @@ -144,8 +142,7 @@ def test_import():
with patch("salt.config.check_driver_dependencies", return_value=True) as p:
get_deps = dimensiondata.get_dependencies()
assert get_deps is True
if Version(mock_version) >= Version("2.0.0"):
assert p.call_count >= 1
assert p.call_count >= 1


def test_provider_matches():
Expand Down
8 changes: 2 additions & 6 deletions tests/pytests/unit/cloud/clouds/test_gce.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

from salt.cloud.clouds import gce
from salt.exceptions import SaltCloudSystemExit
from salt.utils.versions import Version
from tests.support.mock import MagicMock
from tests.support.mock import __version__ as mock_version
from tests.support.mock import call, patch
from tests.support.mock import MagicMock, call, patch


@pytest.fixture
Expand Down Expand Up @@ -281,8 +278,7 @@ def test_import():
with patch("salt.config.check_driver_dependencies", return_value=True) as p:
get_deps = gce.get_dependencies()
assert get_deps is True
if Version(mock_version) >= Version("2.0.0"):
p.assert_called_once()
p.assert_called_once()


@pytest.mark.parametrize(
Expand Down
17 changes: 2 additions & 15 deletions tests/support/mock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
Helper module that wraps `mock` and provides some fake objects in order to
properly set the function/class decorators and yet skip the test case's
execution.

Note: mock >= 2.0.0 required since unittest.mock does not have
MagicMock.assert_called in Python < 3.6.
"""
# pylint: disable=unused-import,function-redefined,blacklisted-module,blacklisted-external-module

Expand All @@ -18,12 +15,10 @@
import errno
import fnmatch
import sys

# By these days, we should blowup if mock is not available
import mock # pylint: disable=blacklisted-external-import
import unittest.mock as mock # pylint: disable=blacklisted-import

# pylint: disable=no-name-in-module,no-member
from mock import (
from unittest.mock import (
ANY,
DEFAULT,
FILTER_DIR,
Expand All @@ -33,7 +28,6 @@
NonCallableMagicMock,
NonCallableMock,
PropertyMock,
__version__,
call,
create_autospec,
patch,
Expand All @@ -42,13 +36,6 @@

import salt.utils.stringutils

# pylint: disable=no-name-in-module,no-member


__mock_version = tuple(
int(part) for part in mock.__version__.split(".") if part.isdigit()
) # pylint: disable=no-member


class MockFH:
def __init__(self, filename, read_data, *args, **kwargs):
Expand Down