No longer mock builtins.open in tests

Author: PawelLipski

ci/checks/enforce-mocking-only-whitelisted-methods.sh

@@ -4,9 +4,10 @@ set -e -o pipefail -u
 
 self_name=$(basename "$0")
 
+# Note that builtins.open should NOT be mocked as it can interfere with coverage.py,
+# see https://github.com/coveragepy/coveragepy/issues/2083#issuecomment-3521840036
 whitelisted_methods="\
 builtins.input
-builtins.open
 git_machete.code_hosting.OrganizationAndRepository.from_url
 git_machete.git_operations.GitContext.fetch_remote
 git_machete.github.GitHubClient.MAX_PULLS_PER_PAGE_COUNT
@@ -18,6 +19,7 @@ git_machete.utils._run_cmd
 git_machete.utils.find_executable
 git_machete.utils.get_current_date
 git_machete.utils.is_stdout_a_tty
+git_machete.utils.slurp_file
 os.path.isfile
 shutil.which
 sys.argv

docs/man/git-machete.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "GIT-MACHETE" "1" "Nov 11, 2025" "" "git-machete"
+.TH "GIT-MACHETE" "1" "Nov 12, 2025" "" "git-machete"
 .SH NAME
 git-machete \- git-machete 3.37.1
 .sp

git_machete/github.py

@@ -9,12 +9,16 @@
 from pathlib import Path
 from typing import Any, Dict, List, NamedTuple, Optional, Tuple
 
-from .code_hosting import (CodeHostingClient, CodeHostingGitConfigKeys,
-                           CodeHostingSpec, OrganizationAndRepository,
-                           OrganizationAndRepositoryAndGitUrl, PullRequest)
-from .exceptions import MacheteException, UnexpectedMacheteException
-from .git_operations import LocalBranchShortName
-from .utils import bold, compact_dict, debug, popen_cmd, warn
+from git_machete import utils
+from git_machete.code_hosting import (CodeHostingClient,
+                                      CodeHostingGitConfigKeys,
+                                      CodeHostingSpec,
+                                      OrganizationAndRepository,
+                                      OrganizationAndRepositoryAndGitUrl,
+                                      PullRequest)
+from git_machete.exceptions import MacheteException, UnexpectedMacheteException
+from git_machete.git_operations import LocalBranchShortName
+from git_machete.utils import bold, compact_dict, debug, popen_cmd, warn
 
 GITHUB_TOKEN_ENV_VAR = 'GITHUB_TOKEN'
 
@@ -48,19 +52,18 @@ def __get_token_from_file_in_home_directory(cls, domain: str) -> Optional["GitHu
 
         if os.path.isfile(file_full_path):
             debug(f"  File `{file_full_path}` exists")
-            with open(file_full_path) as file:
-                # ~/.github-token is a file with a structure similar to:
-                #
-                # ghp_mytoken_for_github_com
-                # ghp_myothertoken_for_git_example_org git.example.org
-                # ghp_yetanothertoken_for_git_example_com git.example.com
-
-                for line in file.readlines():
-                    if line.rstrip().endswith(" " + domain):
-                        token = line.split(" ")[0]
-                        return cls(value=token, provider=provider)
-                    elif domain == GitHubClient.DEFAULT_GITHUB_DOMAIN and " " not in line.rstrip():
-                        return cls(value=line.rstrip(), provider=provider)
+
+            # ~/.github-token is a file with a structure similar to:
+            #
+            # ghp_mytoken_for_github_com
+            # ghp_myothertoken_for_git_example_org git.example.org
+            # ghp_yetanothertoken_for_git_example_com git.example.com
+            for line in utils.slurp_file(file_full_path).splitlines():
+                if line.rstrip().endswith(" " + domain):
+                    token = line.split(" ")[0]
+                    return cls(value=token, provider=provider)
+                elif domain == GitHubClient.DEFAULT_GITHUB_DOMAIN and " " not in line.rstrip():
+                    return cls(value=line.rstrip(), provider=provider)
         return None
 
     @classmethod
@@ -121,26 +124,25 @@ def __get_token_from_hub(cls, domain: str) -> Optional["GitHubToken"]:
         home_path: str = str(Path.home())
         config_hub_path: str = os.path.join(home_path, ".config", "hub")
         if os.path.isfile(config_hub_path):
-            with open(config_hub_path) as config_hub:
-                # ~/.config/hub is a yaml file, with a structure similar to:
-                #
-                # {domain1}:
-                # - user: {username1}
-                #   oauth_token: *******************
-                #   protocol: {protocol}
-                #
-                # {domain2}:
-                # - user: {username2}
-                #   oauth_token: *******************
-                #   protocol: {protocol}
-                found_host = False
-                for line in config_hub.readlines():
-                    if line.rstrip() == domain + ":":
-                        found_host = True
-                    elif found_host and line.lstrip().startswith("oauth_token:"):
-                        result = re.sub(' *oauth_token: +', '', line).rstrip().replace('"', '')
-                        return cls(value=result,
-                                   provider=f'auth token for {domain} from `hub` GitHub CLI')
+            # ~/.config/hub is a yaml file, with a structure similar to:
+            #
+            # {domain1}:
+            # - user: {username1}
+            #   oauth_token: *******************
+            #   protocol: {protocol}
+            #
+            # {domain2}:
+            # - user: {username2}
+            #   oauth_token: *******************
+            #   protocol: {protocol}
+            found_host = False
+            for line in utils.slurp_file(config_hub_path).splitlines():
+                if line.rstrip() == domain + ":":
+                    found_host = True
+                elif found_host and line.lstrip().startswith("oauth_token:"):
+                    result = re.sub(' *oauth_token: +', '', line).rstrip().replace('"', '')
+                    return cls(value=result,
+                               provider=f'auth token for {domain} from `hub` GitHub CLI')
         return None
 
 

git_machete/gitlab.py

@@ -9,6 +9,7 @@
 import urllib.request
 from typing import Any, Dict, List, NamedTuple, Optional
 
+from git_machete import utils
 from git_machete.code_hosting import (CodeHostingClient,
                                       CodeHostingGitConfigKeys,
                                       CodeHostingSpec,
@@ -50,19 +51,18 @@ def __get_token_from_file_in_home_directory(cls, domain: str) -> Optional["GitLa
 
         if os.path.isfile(file_full_path):
             debug(f"  File `{file_full_path}` exists")
-            with open(file_full_path) as file:
-                # ~/.gitlab-token is a file with a structure similar to:
-                #
-                # glpat-mytoken_for_gitlab_com
-                # glpat-myothertoken_for_git_example_org git.example.org
-                # glpat-yetanothertoken_for_git_example_com git.example.com
-
-                for line in file.readlines():
-                    if line.rstrip().endswith(" " + domain):
-                        token = line.split(" ")[0]
-                        return cls(value=token, provider=provider)
-                    elif domain == GitLabClient.DEFAULT_GITLAB_DOMAIN and " " not in line.rstrip():
-                        return cls(value=line.rstrip(), provider=provider)
+
+            # ~/.gitlab-token is a file with a structure similar to:
+            #
+            # glpat-mytoken_for_gitlab_com
+            # glpat-myothertoken_for_git_example_org git.example.org
+            # glpat-yetanothertoken_for_git_example_com git.example.com
+            for line in utils.slurp_file(file_full_path).splitlines():
+                if line.rstrip().endswith(" " + domain):
+                    token = line.split(" ")[0]
+                    return cls(value=token, provider=provider)
+                elif domain == GitLabClient.DEFAULT_GITLAB_DOMAIN and " " not in line.rstrip():
+                    return cls(value=line.rstrip(), provider=provider)
         return None
 
     @classmethod

tests/test_github.py

@@ -2,7 +2,6 @@
 from contextlib import contextmanager
 from textwrap import dedent
 from typing import Iterator
-from unittest.mock import mock_open
 
 from pytest_mock import MockerFixture
 
@@ -233,7 +232,7 @@ def test_github_get_token_from_file_in_home_directory(self, mocker: MockerFixtur
         github_token_contents = ('ghp_mytoken_for_github_com\n'
                                  'ghp_myothertoken_for_git_example_org git.example.org\n'
                                  'ghp_yetanothertoken_for_git_example_com git.example.com')
-        self.patch_symbol(mocker, 'builtins.open', mock_open(read_data=github_token_contents))
+        self.patch_symbol(mocker, 'git_machete.utils.slurp_file', lambda _: github_token_contents)
         self.patch_symbol(mocker, 'os.path.isfile', lambda _file: True)
 
         domain = GitHubClient.DEFAULT_GITHUB_DOMAIN
@@ -320,8 +319,8 @@ def test_github_get_token_from_hub(self, mocker: MockerFixture) -> None:
 
         # Let's pretend that `gh` is available, but fails for whatever reason.
         self.patch_symbol(mocker, 'shutil.which', mock_shutil_which('/path/to/gh'))
-        self.patch_symbol(mocker, 'os.path.isfile', lambda file: '.github-token' not in file)
-        self.patch_symbol(mocker, 'builtins.open', mock_open(read_data=dedent(config_hub_contents)))
+        self.patch_symbol(mocker, 'os.path.isfile', lambda path: '.github-token' not in path)
+        self.patch_symbol(mocker, 'git_machete.utils.slurp_file', lambda _: dedent(config_hub_contents))
 
         fixed_popen_cmd_results = [(0, "gh version 2.31.0 (2099-12-31)\nhttps://github.com/cli/cli/releases/tag/v2.31.0\n", ""),
                                    (1, "", "unknown error")]

tests/test_gitlab.py

@@ -1,7 +1,6 @@
 import itertools
 from contextlib import contextmanager
 from typing import Iterator
-from unittest.mock import mock_open
 
 from pytest_mock import MockerFixture
 
@@ -233,7 +232,7 @@ def test_gitlab_get_token_from_file_in_home_directory(self, mocker: MockerFixtur
         gitlab_token_contents = ('glpat-mytoken_for_gitlab_com\n'
                                  'glpat-myothertoken_for_git_example_org git.example.org\n'
                                  'glpat-yetanothertoken_for_git_example_com git.example.com')
-        self.patch_symbol(mocker, 'builtins.open', mock_open(read_data=gitlab_token_contents))
+        self.patch_symbol(mocker, 'git_machete.utils.slurp_file', lambda _: gitlab_token_contents)
         self.patch_symbol(mocker, 'os.path.isfile', lambda _file: True)
 
         domain = GitLabClient.DEFAULT_GITLAB_DOMAIN