fix: Move the named_pipe_helper.py under the folder `adaptor_runtim…

…e_client` (#87) Signed-off-by: Hongli Chen <honglich@amazon.com>
OpenJobDescription · Mar 20, 2024 · 1398c56 · 1398c56
1 parent d68ab72
commit 1398c56
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 20 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -139,7 +139,8 @@ source = [
   "src/openjd/adaptor_runtime/_named_pipe/*.py",
   "src/openjd/adaptor_runtime/application_ipc/_win_adaptor_server.py",
   "src/openjd/adaptor_runtime/application_ipc/_named_pipe_request_handler.py",
-  "src/openjd/adaptor_runtime_client/win_client_interface.py"
+  "src/openjd/adaptor_runtime_client/win_client_interface.py",
+  "src/openjd/adaptor_runtime_client/named_pipe/*.py"
 ]
 # Source files to exclude from coverage on Windows
 "sys_platform == 'win32'" = [

diff --git a/src/openjd/adaptor_runtime/_background/backend_runner.py b/src/openjd/adaptor_runtime/_background/backend_runner.py
@@ -19,7 +19,7 @@
 if OSName.is_posix():
     from .http_server import BackgroundHTTPServer
 if OSName.is_windows():
-    from .._named_pipe.named_pipe_helper import NamedPipeHelper
+    from ...adaptor_runtime_client.named_pipe.named_pipe_helper import NamedPipeHelper
     from .backend_named_pipe_server import WinBackgroundNamedPipeServer
 from .log_buffers import LogBuffer
 from .model import ConnectionSettings

diff --git a/src/openjd/adaptor_runtime/_background/frontend_runner.py b/src/openjd/adaptor_runtime/_background/frontend_runner.py
@@ -31,7 +31,7 @@
 )
 
 if OSName.is_windows():
-    from openjd.adaptor_runtime._named_pipe.named_pipe_helper import NamedPipeHelper
+    from ...adaptor_runtime_client.named_pipe.named_pipe_helper import NamedPipeHelper
     import pywintypes
 
 _logger = logging.getLogger(__name__)

diff --git a/src/openjd/adaptor_runtime/_named_pipe/named_pipe_request_handler.py b/src/openjd/adaptor_runtime/_named_pipe/named_pipe_request_handler.py
@@ -6,7 +6,7 @@
 if TYPE_CHECKING:  # pragma: no cover because pytest will think we should test for this.
     from openjd.adaptor_runtime._named_pipe import NamedPipeServer
 
-from openjd.adaptor_runtime._named_pipe.named_pipe_helper import (
+from ...adaptor_runtime_client.named_pipe.named_pipe_helper import (
     NamedPipeHelper,
     PipeDisconnectedException,
 )

diff --git a/src/openjd/adaptor_runtime/_named_pipe/named_pipe_server.py b/src/openjd/adaptor_runtime/_named_pipe/named_pipe_server.py
@@ -8,17 +8,19 @@
 
 from typing import List
 
-from openjd.adaptor_runtime._background.server_config import DEFAULT_NAMED_PIPE_TIMEOUT_MILLISECONDS
+from ...adaptor_runtime_client.named_pipe.named_pipe_config import (
+    DEFAULT_NAMED_PIPE_TIMEOUT_MILLISECONDS,
+)
 from typing import TYPE_CHECKING
 
-from openjd.adaptor_runtime._named_pipe.named_pipe_helper import (
+from ...adaptor_runtime_client.named_pipe.named_pipe_helper import (
     NamedPipeHelper,
     NamedPipeTimeoutError,
 )
 
 if TYPE_CHECKING:
-    from openjd.adaptor_runtime._named_pipe import ResourceRequestHandler
-from openjd.adaptor_runtime._osname import OSName
+    from .._named_pipe import ResourceRequestHandler
+from .._osname import OSName
 
 import win32pipe
 import win32file

diff --git a/src/openjd/adaptor_runtime/application_ipc/_win_adaptor_server.py b/src/openjd/adaptor_runtime/application_ipc/_win_adaptor_server.py
@@ -7,7 +7,7 @@
 
 from ._named_pipe_request_handler import WinAdaptorServerResourceRequestHandler
 from .._named_pipe import ResourceRequestHandler
-from .._named_pipe.named_pipe_helper import NamedPipeHelper
+from ...adaptor_runtime_client.named_pipe.named_pipe_helper import NamedPipeHelper
 from .._named_pipe.named_pipe_server import NamedPipeServer
 
 

diff --git a/src/openjd/adaptor_runtime_client/named_pipe/__init__.py b/src/openjd/adaptor_runtime_client/named_pipe/__init__.py
@@ -0,0 +1 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
diff --git a/...ptor_runtime/_background/server_config.py → ...me_client/named_pipe/named_pipe_config.py b/...ptor_runtime/_background/server_config.py → ...me_client/named_pipe/named_pipe_config.py
diff --git a/..._runtime/_named_pipe/named_pipe_helper.py → ...me_client/named_pipe/named_pipe_helper.py b/..._runtime/_named_pipe/named_pipe_helper.py → ...me_client/named_pipe/named_pipe_helper.py
@@ -19,7 +19,7 @@
 import os
 
 
-from openjd.adaptor_runtime._background.server_config import (
+from .named_pipe_config import (
     NAMED_PIPE_BUFFER_SIZE,
     DEFAULT_MAX_NAMED_PIPE_INSTANCES,
 )

diff --git a/src/openjd/adaptor_runtime_client/win_client_interface.py b/src/openjd/adaptor_runtime_client/win_client_interface.py
@@ -9,10 +9,7 @@
 
 from .base_client_interface import BaseClientInterface
 
-# TODO: We need to remove this relative import, since it won't work with how
-#       we inject this module into DCCs. Likely by copying the function
-#       NamedPipeHelper.send_named_pipe_request into this adaptor_runtime_client namespace.
-from ..adaptor_runtime._named_pipe.named_pipe_helper import NamedPipeHelper
+from .named_pipe.named_pipe_helper import NamedPipeHelper
 
 _DEFAULT_TIMEOUT_IN_SECONDS = 15
 

diff --git a/test/openjd/adaptor_runtime/integ/_named_pipe/test_named_pipe_helper.py b/test/openjd/adaptor_runtime/integ/_named_pipe/test_named_pipe_helper.py
@@ -13,7 +13,7 @@
     import win32pipe
     import win32security
     import win32api
-    from openjd.adaptor_runtime._named_pipe.named_pipe_helper import NamedPipeHelper
+    from openjd.adaptor_runtime_client.named_pipe.named_pipe_helper import NamedPipeHelper
 else:
     # Cannot put this on the top of this file or mypy will complain
     pytest.mark.skip(reason="NamedPipe is only implemented in Windows.")

diff --git a/test/openjd/adaptor_runtime/integ/application_ipc/test_integration_adaptor_ipc.py b/test/openjd/adaptor_runtime/integ/application_ipc/test_integration_adaptor_ipc.py
@@ -16,7 +16,7 @@
 from openjd.adaptor_runtime.application_ipc import AdaptorServer as _AdaptorServer
 
 if OSName.is_windows():
-    from openjd.adaptor_runtime._named_pipe.named_pipe_helper import NamedPipeHelper
+    from openjd.adaptor_runtime_client.named_pipe.named_pipe_helper import NamedPipeHelper
 
 
 @pytest.fixture

diff --git a/test/openjd/adaptor_runtime/unit/named_pipe/test_named_pipe_helper.py b/test/openjd/adaptor_runtime/unit/named_pipe/test_named_pipe_helper.py
@@ -10,7 +10,9 @@
 win32pipe = pytest.importorskip("win32pipe")
 win32file = pytest.importorskip("win32file")
 winerror = pytest.importorskip("winerror")
-named_pipe_helper = pytest.importorskip("openjd.adaptor_runtime._named_pipe.named_pipe_helper")
+named_pipe_helper = pytest.importorskip(
+    "openjd.adaptor_runtime_client.named_pipe.named_pipe_helper"
+)
 
 
 class MockReadFile:
@@ -70,7 +72,7 @@ def test_read_from_pipe_timeout_raises_exception(self, mock_win32file):
 
     @patch("os.getpid", return_value=1)
     @patch(
-        "openjd.adaptor_runtime._named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
+        "openjd.adaptor_runtime_client.named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
         return_value=False,
     )
     def test_generate_pipe_name(self, mock_check_named_pipe_exists, mock_getpid):
@@ -79,7 +81,7 @@ def test_generate_pipe_name(self, mock_check_named_pipe_exists, mock_getpid):
 
     @patch("os.getpid", return_value=1)
     @patch(
-        "openjd.adaptor_runtime._named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
+        "openjd.adaptor_runtime_client.named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
         side_effect=[True, False],
     )
     def test_generate_pipe_name2(self, mock_check_named_pipe_exists, mock_getpid):
@@ -89,7 +91,7 @@ def test_generate_pipe_name2(self, mock_check_named_pipe_exists, mock_getpid):
 
     @patch("os.getpid", return_value=1)
     @patch(
-        "openjd.adaptor_runtime._named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
+        "openjd.adaptor_runtime_client.named_pipe.named_pipe_helper.NamedPipeHelper.check_named_pipe_exists",
         return_value=True,
     )
     def test_failed_to_generate_pipe_name(self, mock_check_named_pipe_exists, mock_getpid):