derivepassphrase.git

@@ -2,7 +2,6 @@

 #

 # SPDX-License-Identifier: Zlib

-# ruff: noqa: TRY400

 """Helper functions for the derivepassphrase command-line.

@@ -275,6 +274,8 @@ def get_tempdir() -> pathlib.Path:

         pathlib.PurePosixPath('/usr/tmp'),

     ]

     windows_paths_to_try = [

+        pathlib.PureWindowsPath(r'~\AppData\Local\Temp'),

+        pathlib.PureWindowsPath(os.path.expandvars(r'%SYSTEMROOT%\Temp')),

         pathlib.PureWindowsPath(r'C:\TEMP'),

         pathlib.PureWindowsPath(r'C:\TMP'),

         pathlib.PureWindowsPath(r'\TEMP'),

@@ -284,7 +285,7 @@ def get_tempdir() -> pathlib.Path:

         windows_paths_to_try if sys.platform == 'win32' else posix_paths_to_try

     )

     for p in paths_to_try:

-        path = pathlib.Path(p)

+        path = pathlib.Path(p).expanduser()

         try:

             points_to_dir = path.is_dir()

         except OSError:

@@ -2,7 +2,6 @@

 #

 # SPDX-License-Identifier: Zlib

-# ruff: noqa: TRY400

 """Command-line machinery for derivepassphrase.

@@ -63,11 +63,21 @@ def get_vault_key() -> bytes:

             Please set `VAULT_KEY` manually to the desired value.

     """

+    if os.supports_bytes_environ:

+

+        def getenv(env_var: str) -> bytes:

+            return os.environb.get(env_var.encode('UTF-8'), b'')  # type: ignore[attr-defined]

+

+    else:

+

+        def getenv(env_var: str) -> bytes:

+            return os.environ.get(env_var, '').encode('UTF-8')

+

     username = (

-        os.environb.get(b'VAULT_KEY')

-        or os.environb.get(b'LOGNAME')

-        or os.environb.get(b'USER')

-        or os.environb.get(b'USERNAME')

+        getenv('VAULT_KEY')

+        or getenv('LOGNAME')

+        or getenv('USER')

+        or getenv('USERNAME')

     )

     if not username:

         env_var = 'VAULT_KEY'

@@ -16,6 +16,7 @@ import pathlib

 import re

 import shlex

 import stat

+import sys

 import tempfile

 import types

 import zipfile

@@ -1603,6 +1604,61 @@ available.  Usually this means that the test targets the

 `derivepassphrase export vault` subcommand, whose functionality depends

 on cryptography support being available.

 """

+skip_if_on_the_annoying_os = pytest.mark.skipif(

+    sys.platform == 'win32',

+    reason='The Annoying OS behaves differently.',

+)

+"""

+A cached pytest mark to skip this test if running on The Annoying

+Operating System, a.k.a. Microsoft Windows.  Usually this is due to

+unnecessary and stupid differences in the OS internals, and these

+differences are deemed irreconcilable in the context of the decorated

+test, so the test is to be skipped.

+

+See also:

+    [`xfail_on_the_annoying_os`][]

+

+"""

+

+

+def xfail_on_the_annoying_os(

+    f: Callable | None = None,

+    /,

+    *,

+    reason: str = '',

+) -> pytest.MarkDecorator | Any:

+    """Annotate a test which fails on The Annoying OS.

+

+    Annotate a test to indicate that it fails on The Annoying Operating

+    System, a.k.a. Microsoft Windows.  Usually this is due to

+    differences in the design of OS internals, and usually, these

+    differences are both unnecessary and stupid.

+

+    Args:

+        f:

+            A callable to decorate.  If not given, return the pytest

+            mark directly.

+        reason:

+            An optional, more detailed reason stating why this test

+            fails on The Annoying OS.

+

+    Returns:

+        The callable, marked as an expected failure on the Annoying OS,

+        or alternatively a suitable pytest mark if no callable was

+        passed.  The reason will begin with the phrase "The Annoying OS

+        behaves differently.", and the optional detailed reason, if not

+        empty, will follow.

+

+    """

+    base_reason = 'The Annoying OS behaves differently.'

+    full_reason = base_reason if not reason else f'{base_reason}  {reason}'

+    mark = pytest.mark.xfail(

+        sys.platform == 'win32',

+        reason=full_reason,

+        raises=(AssertionError, hypothesis.errors.FailedHealthCheck),

+        strict=True,

+    )

+    return mark if f is None else mark(f)

 def list_keys(self: Any = None) -> list[_types.SSHKeyCommentPair]:

@@ -1739,7 +1795,8 @@ def isolated_config(

         )

         cwd = str(pathlib.Path.cwd().resolve())

         monkeypatch.setenv('HOME', cwd)

-        monkeypatch.setenv('USERPROFILE', cwd)

+        monkeypatch.setenv('APPDATA', cwd)

+        monkeypatch.setenv('LOCALAPPDATA', cwd)

         monkeypatch.delenv(env_name, raising=False)

         config_dir = cli_helpers.config_filename(subsystem=None)

         config_dir.mkdir(parents=True, exist_ok=True)

@@ -1934,9 +1991,12 @@ def make_file_readonly(

     """

     fname: int | str | bytes | os.PathLike

     if try_race_free_implementation and {os.stat, os.chmod} <= os.supports_fd:

+        # The Annoying OS (v11 at least) supports fstat and fchmod, but

+        # does not support changing the file mode on file descriptors

+        # for read-only files.

         fname = os.open(

             pathname,

-            os.O_RDONLY

+            os.O_RDWR

             | getattr(os, 'O_CLOEXEC', 0)

             | getattr(os, 'O_NOCTTY', 0),

         )

@@ -12,6 +12,7 @@ import errno

 import io

 import json

 import logging

+import operator

 import os

 import pathlib

 import re

@@ -2176,9 +2177,11 @@ class TestCLI:

     @Parametrize.CONFIG_WITH_KEY

     def test_204a_key_from_config(

         self,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         config: _types.VaultConfig,

     ) -> None:

         """A stored configured SSH key will be used."""

+        del running_ssh_agent

         runner = tests.CliRunner(mix_stderr=False)

         # TODO(the-13th-letter): Rewrite using parenthesized

         # with-statements.

@@ -2214,8 +2217,10 @@ class TestCLI:

     def test_204b_key_from_command_line(

         self,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

     ) -> None:

         """An SSH key requested on the command-line will be used."""

+        del running_ssh_agent

         runner = tests.CliRunner(mix_stderr=False)

         # TODO(the-13th-letter): Rewrite using parenthesized

         # with-statements.

@@ -2817,7 +2822,10 @@ class TestCLI:

                 ['--import', os.fsdecode(dname)],

                 catch_exceptions=False,

             )

-        assert result.error_exit(error=os.strerror(errno.EISDIR)), (

+        # The Annoying OS uses EACCES, other OSes use EISDIR.

+        assert result.error_exit(

+            error=os.strerror(errno.EISDIR)

+        ) or result.error_exit(error=os.strerror(errno.EACCES)), (

             'expected error exit and known error message'

         )

@@ -2983,6 +2991,7 @@ class TestCLI:

             'expected error exit and known error message'

         )

+    @tests.skip_if_on_the_annoying_os

     @Parametrize.EXPORT_FORMAT_OPTIONS

     def test_214e_export_settings_settings_directory_not_a_directory(

         self,

@@ -3681,8 +3690,10 @@ class TestCLI:

     def test_225c_store_config_fail_manual_bad_ssh_agent_connection(

         self,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

     ) -> None:

         """Not running a reachable SSH agent during `--config --key` fails."""

+        del running_ssh_agent

         runner = tests.CliRunner(mix_stderr=False)

         # TODO(the-13th-letter): Rewrite using parenthesized

         # with-statements.

@@ -4851,12 +4862,22 @@ Boo.

         assert _types.is_vault_config(config)

         return self.export_as_sh_helper(config)

+    # The Annoying OS appears to silently truncate spaces at the end of

+    # filenames.

     @hypothesis.given(

         env_var=strategies.sampled_from(['TMPDIR', 'TEMP', 'TMP']),

-        suffix=strategies.text(

+        suffix=strategies.builds(

+            operator.add,

+            strategies.text(

+                tuple(' 0123456789abcdefghijklmnopqrstuvwxyz'),

+                min_size=11,

+                max_size=11,

+            ),

+            strategies.text(

                 tuple('0123456789abcdefghijklmnopqrstuvwxyz'),

-            min_size=12,

-            max_size=12,

+                min_size=1,

+                max_size=1,

+            ),

         ),

     )

     @hypothesis.example(env_var='', suffix='.')

@@ -4873,6 +4894,17 @@ Boo.

         `cli_helpers.get_tempdir` returned the configuration directory.

         """

+

+        @contextlib.contextmanager

+        def make_temporary_directory(

+            path: pathlib.Path,

+        ) -> Iterator[pathlib.Path]:

+            try:

+                path.mkdir()

+                yield path

+            finally:

+                shutil.rmtree(path)

+

         runner = tests.CliRunner(mix_stderr=False)

         # TODO(the-13th-letter): Rewrite using parenthesized

         # with-statements.

@@ -4886,11 +4918,20 @@ Boo.

                     vault_config={'services': {}},

                 )

             )

+            old_tempdir = os.fsdecode(tempfile.gettempdir())

             monkeypatch.delenv('TMPDIR', raising=False)

             monkeypatch.delenv('TEMP', raising=False)

             monkeypatch.delenv('TMP', raising=False)

+            monkeypatch.setattr(tempfile, 'tempdir', None)

+            temp_path = pathlib.Path.cwd() / suffix

             if env_var:

-                monkeypatch.setenv(env_var, str(pathlib.Path.cwd() / suffix))

+                monkeypatch.setenv(env_var, os.fsdecode(temp_path))

+                stack.enter_context(make_temporary_directory(temp_path))

+            new_tempdir = os.fsdecode(tempfile.gettempdir())

+            hypothesis.assume(

+                temp_path.resolve() == pathlib.Path.cwd().resolve()

+                or old_tempdir != new_tempdir

+            )

             system_tempdir = os.fsdecode(tempfile.gettempdir())

             our_tempdir = cli_helpers.get_tempdir()

             assert system_tempdir == os.fsdecode(our_tempdir) or (

@@ -4901,6 +4942,7 @@ Boo.

                 system_tempdir == os.getcwd()  # noqa: PTH109

                 and our_tempdir == cli_helpers.config_filename(subsystem=None)

             )

+        assert not temp_path.exists(), f'temp path {temp_path} not cleaned up!'

     def test_140b_get_tempdir_force_default(self) -> None:

         """[`cli_helpers.get_tempdir`][] returns a temporary directory.

@@ -5031,7 +5073,8 @@ Boo.

             if conn_hint == 'client':

                 hint = ssh_agent.SSHAgentClient()

             elif conn_hint == 'socket':

-                hint = socket.socket(family=socket.AF_UNIX)

+                # socket.AF_UNIX is not defined everywhere.

+                hint = socket.socket(family=socket.AF_UNIX)  # type: ignore[attr-defined]

                 hint.connect(running_ssh_agent.socket)

             else:

                 assert conn_hint == 'none'

@@ -5216,7 +5259,8 @@ class TestCLITransition:

             config2, err = cli_helpers.migrate_and_load_old_config()

             assert config2 == config

             assert isinstance(err, OSError)

-            assert err.errno == errno.EISDIR

+            # The Annoying OS uses EEXIST, other OSes use EISDIR.

+            assert err.errno in {errno.EISDIR, errno.EEXIST}

     @Parametrize.BAD_CONFIGS

     def test_113_migrate_config_error_bad_config_value(

@@ -711,7 +711,8 @@ class TestAgentInteraction:

         """Fail if the agent address is invalid."""

         with pytest.MonkeyPatch.context() as monkeypatch:

             monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent.socket + '~')

-            sock = socket.socket(family=socket.AF_UNIX)

+            # socket.AF_UNIX is not defined everywhere.

+            sock = socket.socket(family=socket.AF_UNIX)  # type: ignore[attr-defined]

             with pytest.raises(OSError):  # noqa: PT011

                 ssh_agent.SSHAgentClient(socket=sock)

@@ -175,6 +175,8 @@ class TestL10nMachineryWithDebugTranslations:

         """TranslatableStrings are hashable even with interpolations."""

         assert len(errnos) == 2

         error1, error2 = [os.strerror(c) for c in errnos]

+        # The Annoying OS has error codes with identical strerror values.

+        hypothesis.assume(error1 != error2)

         ts1 = msg.TranslatedString(

             value, error=error1, filename=None

         ).maybe_without_filename()