derivepassphrase.git

@@ -36,7 +36,11 @@ from typing_extensions import assert_never, overload

 import tests.data

 import tests.machinery

 from derivepassphrase import _types, ssh_agent

-from derivepassphrase._internals import cli_helpers, cli_machinery

+from derivepassphrase._internals import (

+    cli_helpers,

+    cli_machinery,

+    cli_messages,

+)

 from derivepassphrase.ssh_agent import socketprovider

 __all__ = ()

@@ -216,6 +220,33 @@ class Parametrize(types.SimpleNamespace):

             ),

         ],

     )

+    MISSING_AGENT_SUPPORT = pytest.mark.parametrize(

+        ["provider", "sys_action", "exception", "message"],

+        [

+            pytest.param(

+                _types.BuiltinSSHAgentSocketProvider.SSH_AUTH_SOCK_ON_POSIX,

+                tests.data.SystemSupportAction.UNSET_AF_UNIX_AND_ENSURE_USE,

+                socketprovider.UnixDomainSocketsNotAvailableError,

+                str(

+                    cli_messages.TranslatedString(

+                        cli_messages.WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS

+                    )

+                ),

+                id="unix_domain_sockets",

+            ),

+            pytest.param(

+                _types.BuiltinSSHAgentSocketProvider.WINDOWS_NAMED_PIPE,

+                tests.data.SystemSupportAction.UNSET_WINDLL_AND_ENSURE_USE,

+                socketprovider.WindowsNamedPipesNotAvailableError,

+                str(

+                    cli_messages.TranslatedString(

+                        cli_messages.WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES

+                    )

+                ),

+                id="windows_named_pipes",

+            ),

+        ],

+    )

 # Monkeypatchings

@@ -13,18 +13,14 @@ subsystems.)

 from __future__ import annotations

 import contextlib

-import ctypes

 import json

-import socket

 import textwrap

-import types

 from typing import TYPE_CHECKING, ClassVar

 import pytest

-from derivepassphrase import _types, cli, ssh_agent

-from derivepassphrase._internals import cli_helpers, cli_messages

-from derivepassphrase.ssh_agent import socketprovider

+from derivepassphrase import _types, cli

+from derivepassphrase._internals import cli_helpers

 from tests import data, machinery

 from tests.machinery import pytest as pytest_machinery

@@ -36,7 +32,7 @@ DUMMY_PASSPHRASE = data.DUMMY_PASSPHRASE

 DUMMY_CONFIG_SETTINGS = data.DUMMY_CONFIG_SETTINGS

-class Parametrize(types.SimpleNamespace):

+class Parametrize(pytest_machinery.Parametrize):

     """Common test parametrizations."""

     UNICODE_NORMALIZATION_ERROR_INPUTS = pytest.mark.parametrize(

@@ -218,31 +214,6 @@ class Parametrize(types.SimpleNamespace):

             ),

         ],

     )

-    MISSING_AGENT_SUPPORT = pytest.mark.parametrize(

-        ["provider", "exception", "message"],

-        [

-            pytest.param(

-                _types.BuiltinSSHAgentSocketProvider.SSH_AUTH_SOCK_ON_POSIX,

-                socketprovider.UnixDomainSocketsNotAvailableError,

-                str(

-                    cli_messages.TranslatedString(

-                        cli_messages.WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS

-                    )

-                ),

-                id="unix_domain_sockets",

-            ),

-            pytest.param(

-                _types.BuiltinSSHAgentSocketProvider.WINDOWS_NAMED_PIPE,

-                socketprovider.WindowsNamedPipesNotAvailableError,

-                str(

-                    cli_messages.TranslatedString(

-                        cli_messages.WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES

-                    )

-                ),

-                id="windows_named_pipes",

-            ),

-        ],

-    )

 class TestPassphraseUnicodeNormalization:

@@ -389,39 +360,17 @@ class TestUserConfigurationFileOther:

 class TestSSHAgentAvailability:

     """Tests concerning the availability of the SSH agent."""

-    # TODO(the-13th-letter): Decouple tests from exact knowledge of how

-    # to unsupport a certain socket provider.  Coordinate with

-    # tests.test_derivepassphrase_ssh_agent.test_000_basic.TestConstructorFailures.

-    def _unsupport_provider_and_force_use(

-        self,

-        provider: _types.BuiltinSSHAgentSocketProvider,

-        monkeypatch: pytest.MonkeyPatch,

-    ) -> None:

-        """Remove support for the named socket provider."""

-        if (

-            provider

-            == _types.BuiltinSSHAgentSocketProvider.SSH_AUTH_SOCK_ON_POSIX

-        ):

-            monkeypatch.delattr(socket, "AF_UNIX", raising=False)

-        elif (

-            provider == _types.BuiltinSSHAgentSocketProvider.WINDOWS_NAMED_PIPE

-        ):

-            monkeypatch.delattr(ctypes, "WinDLL", raising=False)

-        else:

-            pytest.fail(f"Don't know how to remove support for {provider!r}.")

-        monkeypatch.setattr(

-            ssh_agent.SSHAgentClient, "SOCKET_PROVIDERS", [provider]

-        )

-

     @Parametrize.MISSING_AGENT_SUPPORT

     def test_missing_agent_support(

         self,

         caplog: pytest.LogCaptureFixture,

         provider: _types.BuiltinSSHAgentSocketProvider,

+        sys_action: data.SystemSupportAction,

         exception: type[NotImplementedError],

         message: str,

     ) -> None:

         """Querying the SSH agent without support fails."""

+        del provider

         del exception

         runner = machinery.CliRunner(mix_stderr=False)

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

@@ -439,7 +388,7 @@ class TestSSHAgentAvailability:

             monkeypatch.setenv(

                 "SSH_AUTH_SOCK", "the value doesn't even matter"

             )

-            self._unsupport_provider_and_force_use(provider, monkeypatch)

+            sys_action(monkeypatch)

             result = runner.invoke(

                 cli.derivepassphrase_vault,

                 ["--key", "--config"],

@@ -8,12 +8,9 @@ from __future__ import annotations

 import base64

 import contextlib

-import ctypes

 import importlib.metadata

 import re

-import socket

 import sys

-import types

 from typing import TYPE_CHECKING, Final, cast

 import click

@@ -23,7 +20,7 @@ from hypothesis import strategies

 from typing_extensions import TypeAlias

 from derivepassphrase import _types, ssh_agent, vault

-from derivepassphrase._internals import cli_helpers, cli_messages

+from derivepassphrase._internals import cli_helpers

 from derivepassphrase.ssh_agent import socketprovider

 from tests import data, machinery

 from tests.data import callables

@@ -57,7 +54,7 @@ def use_stub_agent() -> Generator[None, None, None]:

         yield

-class Parametrize(types.SimpleNamespace):

+class Parametrize(pytest_machinery.Parametrize):

     BAD_ENTRY_POINTS = pytest.mark.parametrize(

         "additional_entry_points",

         [

@@ -338,31 +335,6 @@ class Parametrize(types.SimpleNamespace):

             ),

         ],

     )

-    MISSING_AGENT_SUPPORT = pytest.mark.parametrize(

-        ["provider", "exception", "message"],

-        [

-            pytest.param(

-                _types.BuiltinSSHAgentSocketProvider.SSH_AUTH_SOCK_ON_POSIX,

-                socketprovider.UnixDomainSocketsNotAvailableError,

-                str(

-                    cli_messages.TranslatedString(

-                        cli_messages.WarnMsgTemplate.NO_UNIX_DOMAIN_SOCKETS

-                    )

-                ),

-                id="unix_domain_sockets",

-            ),

-            pytest.param(

-                _types.BuiltinSSHAgentSocketProvider.WINDOWS_NAMED_PIPE,

-                socketprovider.WindowsNamedPipesNotAvailableError,

-                str(

-                    cli_messages.TranslatedString(

-                        cli_messages.WarnMsgTemplate.NO_WINDOWS_NAMED_PIPES

-                    )

-                ),

-                id="windows_named_pipes",

-            ),

-        ],

-    )

     PUBLIC_KEY_DATA = pytest.mark.parametrize(

         "public_key_struct",

         list(data.SUPPORTED_KEYS.values()),

@@ -1156,30 +1128,6 @@ class TestSuitableKeys:

 class TestConstructorFailures:

     """Test actually talking to the SSH agent: constructor failures."""

-    # TODO(the-13th-letter): Decouple tests from exact knowledge of how

-    # to unsupport a certain socket provider.  Coordinate with

-    # tests.test_derivepassphrase_cli.test_000_basic.TestSSHAgentAvailability.

-    def _unsupport_provider_and_force_use(

-        self,

-        provider: _types.BuiltinSSHAgentSocketProvider,

-        monkeypatch: pytest.MonkeyPatch,

-    ) -> None:

-        """Remove support for the named socket provider."""

-        if (

-            provider

-            == _types.BuiltinSSHAgentSocketProvider.SSH_AUTH_SOCK_ON_POSIX

-        ):

-            monkeypatch.delattr(socket, "AF_UNIX", raising=False)

-        elif (

-            provider == _types.BuiltinSSHAgentSocketProvider.WINDOWS_NAMED_PIPE

-        ):

-            monkeypatch.delattr(ctypes, "WinDLL", raising=False)

-        else:

-            pytest.fail(f"Don't know how to remove support for {provider!r}.")

-        monkeypatch.setattr(

-            ssh_agent.SSHAgentClient, "SOCKET_PROVIDERS", [provider]

-        )

-

     def test_constructor_bad_running_agent(

         self,

         running_ssh_agent: data.RunningSSHAgentInfo,

@@ -1199,6 +1147,7 @@ class TestConstructorFailures:

     def test_constructor_no_support(

         self,

         provider: _types.BuiltinSSHAgentSocketProvider,

+        sys_action: data.SystemSupportAction,

         exception: type[NotImplementedError],

         message: str,

     ) -> None:

@@ -1209,7 +1158,7 @@ class TestConstructorFailures:

             monkeypatch.setenv(

                 "SSH_AUTH_SOCK", "the value doesn't even matter"

             )

-            self._unsupport_provider_and_force_use(provider, monkeypatch)

+            sys_action(monkeypatch)

             with pytest.raises(exception):

                 ssh_agent.SSHAgentClient(socket=provider)