Skip to content

fix!: updates to path mapping #5

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

Merged
mwiebe merged 1 commit into from
Sep 14, 2023
Merged

fix!: updates to path mapping #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/openjd/sessions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

from ._logging import LOG
from ._path_mapping import PathMappingOS, PathMappingRule
from ._path_mapping import PathFormat, PathMappingRule
from ._session import ActionStatus, Session, SessionCallbackType, SessionState
from ._session_user import PosixSessionUser, SessionUser
from ._types import (
Expand All @@ -23,7 +23,7 @@
"LOG",
"Parameter",
"ParameterType",
"PathMappingOS",
"PathFormat",
"PathMappingRule",
"PosixSessionUser",
"Session",
Expand Down
38 changes: 22 additions & 16 deletions src/openjd/sessions/_path_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,33 @@
from pathlib import PurePath, PurePosixPath, PureWindowsPath


class PathMappingOS(str, Enum):
class PathFormat(str, Enum):
POSIX = "POSIX"
WINDOWS = "WINDOWS"


@dataclass(frozen=True)
class PathMappingRule:
source_os: PathMappingOS
source_path_format: PathFormat
source_path: PurePath
destination_path: PurePath

def __init__(
self, *, source_os: PathMappingOS, source_path: PurePath, destination_path: PurePath
self, *, source_path_format: PathFormat, source_path: PurePath, destination_path: PurePath
):
if source_os == PathMappingOS.POSIX:
if source_path_format == PathFormat.POSIX:
if not isinstance(source_path, PurePosixPath):
raise ValueError("Path mapping rule source_os does not match source_path type")
raise ValueError(
"Path mapping rule source_path_format does not match source_path type"
)
else:
if not isinstance(source_path, PureWindowsPath):
raise ValueError("Path mapping rule source_os does not match source_path type")
raise ValueError(
"Path mapping rule source_path_format does not match source_path type"
)

# This roundabout way can set the attributes of a frozen dataclass
object.__setattr__(self, "source_os", source_os)
object.__setattr__(self, "source_path_format", source_path_format)
object.__setattr__(self, "source_path", source_path)
object.__setattr__(self, "destination_path", destination_path)

Expand All @@ -44,9 +48,9 @@ def from_dict(rule: dict[str, str]) -> "PathMappingRule":
if name not in rule:
raise ValueError(f"Path mapping rule requires the following fields: {field_names}")

source_os = PathMappingOS(rule["source_os"].upper())
source_path_format = PathFormat(rule["source_path_format"].upper())
source_path: PurePath
if source_os == PathMappingOS.POSIX:
if source_path_format == PathFormat.POSIX:
source_path = PurePosixPath(rule["source_path"])
else:
source_path = PureWindowsPath(rule["source_path"])
Expand All @@ -59,13 +63,15 @@ def from_dict(rule: dict[str, str]) -> "PathMappingRule":
)

return PathMappingRule(
source_os=source_os, source_path=source_path, destination_path=destination_path
source_path_format=source_path_format,
source_path=source_path,
destination_path=destination_path,
)

def to_dict(self) -> dict[str, str]:
"""Returns a dictionary representation of the PathMappingRule."""
return {
"source_os": self.source_os.name,
"source_path_format": self.source_path_format.name,
"source_path": str(self.source_path),
"destination_path": str(self.destination_path),
}
Expand All @@ -78,7 +84,7 @@ def apply(self, *, path: str) -> tuple[bool, str]:
mapped path. If it doesn't match, then it returns the original path unmodified.
"""
pure_path: PurePath
if self.source_os == PathMappingOS.POSIX:
if self.source_path_format == PathFormat.POSIX:
pure_path = PurePosixPath(path)
else:
pure_path = PureWindowsPath(path)
Expand All @@ -91,17 +97,17 @@ def apply(self, *, path: str) -> tuple[bool, str]:
)
if os_name == "posix":
result = str(PurePosixPath(*remapped_parts))
if self._has_trailing_slash(self.source_os, path):
if self._has_trailing_slash(self.source_path_format, path):
result += "/"
else:
result = str(PureWindowsPath(*remapped_parts))
if self._has_trailing_slash(self.source_os, path):
if self._has_trailing_slash(self.source_path_format, path):
result += "\\"

return True, result

def _has_trailing_slash(self, os: PathMappingOS, path: str) -> bool:
if os == PathMappingOS.POSIX:
def _has_trailing_slash(self, os: PathFormat, path: str) -> bool:
if os == PathFormat.POSIX:
return path.endswith("/")
else:
return path.endswith("\\")
9 changes: 3 additions & 6 deletions src/openjd/sessions/_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,24 +777,21 @@ def _materialize_path_mapping(
"""Materialize path mapping rules to disk and the os environment variables."""
if self._path_mapping_rules:
rules_dict = {
"version": "pathmapping-1.0",
"path_mapping_rules": [
{
"source_os": rule.source_os.value,
"source_path_format": rule.source_path_format.value,
"source_path": str(rule.source_path),
"destination_path": str(rule.destination_path),
}
for rule in self._path_mapping_rules
]
],
}
symtab[ValueReferenceConstants_2023_09.HAS_PATH_MAPPING_RULES.value] = "true"
else:
rules_dict = dict()
symtab[ValueReferenceConstants_2023_09.HAS_PATH_MAPPING_RULES.value] = "false"
rules_json = json.dumps(rules_dict)
# TODO - Remove this environment variable before the formal release of the lib/spec.
# Reason: This is an interim workaround for functionality that was missing.
os_env["PATH_MAPPING_RULES"] = rules_json
# TODO /stop
file_handle, filename = mkstemp(dir=self.working_directory, suffix=".json", text=True)
os.close(file_handle)
write_file_for_user(Path(filename), rules_json, self._user)
Expand Down
60 changes: 30 additions & 30 deletions test/openjd/sessions/test_path_mapping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

import pytest

from openjd.sessions import PathMappingOS, PathMappingRule
from openjd.sessions import PathFormat, PathMappingRule
from openjd.sessions import _path_mapping as path_mapping_impl_mod


Expand All @@ -21,7 +21,7 @@ class TestPathMapping:
[
pytest.param(
PathMappingRule(
source_os=PathMappingOS.POSIX,
source_path_format=PathFormat.POSIX,
source_path=PurePosixPath("/mnt/shared/"),
destination_path=PurePosixPath("/newprefix"),
),
Expand Down Expand Up @@ -52,7 +52,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.POSIX,
source_path_format=PathFormat.POSIX,
source_path=PurePosixPath("/mnt/shared/"),
destination_path=PureWindowsPath("c:\\newprefix"),
),
Expand Down Expand Up @@ -91,7 +91,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("c:\\mnt\\shared\\"),
destination_path=PurePosixPath("/newprefix"),
),
Expand Down Expand Up @@ -130,7 +130,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("c:\\mnt\\shared\\"),
destination_path=PureWindowsPath("c:\\newprefix"),
),
Expand Down Expand Up @@ -173,7 +173,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("\\\\128.0.0.1\\share\\assets"),
destination_path=PureWindowsPath("z:\\assets"),
),
Expand All @@ -198,7 +198,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("z:\\assets"),
destination_path=PureWindowsPath("\\\\128.0.0.1\\share\\assets"),
),
Expand All @@ -223,7 +223,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("\\\\.\\c:\\assets"),
destination_path=PureWindowsPath("z:\\assets"),
),
Expand All @@ -248,7 +248,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("z:\\assets"),
destination_path=PureWindowsPath("\\\\.\\c:\\assets"),
),
Expand All @@ -273,7 +273,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("\\\\?\\c:\\assets"),
destination_path=PureWindowsPath("z:\\assets"),
),
Expand All @@ -298,7 +298,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("z:\\assets"),
destination_path=PureWindowsPath("\\\\?\\c:\\assets"),
),
Expand All @@ -323,7 +323,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath(
"\\\\?\\Volume{b75e2c83-0000-0000-0000-602f12345678}\\assets"
),
Expand All @@ -350,7 +350,7 @@ class TestPathMapping:
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("z:\\assets"),
destination_path=PureWindowsPath(
"\\\\?\\Volume{b75e2c83-0000-0000-0000-602f12345678}\\assets"
Expand Down Expand Up @@ -393,7 +393,7 @@ def test_remaps(
[
pytest.param(
PathMappingRule(
source_os=PathMappingOS.POSIX,
source_path_format=PathFormat.POSIX,
source_path=PurePosixPath("/mnt/shared"),
destination_path=PureWindowsPath("c:\\newprefix"),
),
Expand All @@ -409,7 +409,7 @@ def test_remaps(
+ [
pytest.param(
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("c:\\mnt\\shared\\"),
destination_path=PureWindowsPath("c:\\newprefix"),
),
Expand Down Expand Up @@ -437,18 +437,18 @@ def test_does_not_remap(self, rule: PathMappingRule, given: str) -> None:
"rule_params",
[
{
"source_os": PathMappingOS.WINDOWS,
"source_path_format": PathFormat.WINDOWS,
"source_path": PurePosixPath("C:\\oldprefix"),
"destination_path": PureWindowsPath("c:\\newprefix"),
},
{
"source_os": PathMappingOS.POSIX,
"source_path_format": PathFormat.POSIX,
"source_path": PureWindowsPath("/mnt/oldprefix"),
"destination_path": PureWindowsPath("c:\\newprefix"),
},
],
)
def test_mismatching_source_os_path(self, rule_params):
def test_mismatching_source_path_format_path(self, rule_params):
with pytest.raises(ValueError):
PathMappingRule(**rule_params)

Expand All @@ -457,48 +457,48 @@ def test_mismatching_source_os_path(self, rule_params):
[
(
{
"source_os": "WINDOWS",
"source_path_format": "WINDOWS",
"source_path": "C:\\oldprefix",
"destination_path": "c:\\newprefix",
},
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("C:\\oldprefix"),
destination_path=PurePath("c:\\newprefix"),
),
),
(
{
"source_os": "POSIX",
"source_path_format": "POSIX",
"source_path": "/mnt/oldprefix",
"destination_path": "c:\\newprefix",
},
PathMappingRule(
source_os=PathMappingOS.POSIX,
source_path_format=PathFormat.POSIX,
source_path=PurePosixPath("/mnt/oldprefix"),
destination_path=PurePath("c:\\newprefix"),
),
),
(
{
"source_os": "windows",
"source_path_format": "windows",
"source_path": "C:\\oldprefix",
"destination_path": "c:\\newprefix",
},
PathMappingRule(
source_os=PathMappingOS.WINDOWS,
source_path_format=PathFormat.WINDOWS,
source_path=PureWindowsPath("C:\\oldprefix"),
destination_path=PurePath("c:\\newprefix"),
),
),
(
{
"source_os": "posix",
"source_path_format": "posix",
"source_path": "/mnt/oldprefix",
"destination_path": "c:\\newprefix",
},
PathMappingRule(
source_os=PathMappingOS.POSIX,
source_path_format=PathFormat.POSIX,
source_path=PurePosixPath("/mnt/oldprefix"),
destination_path=PurePath("c:\\newprefix"),
),
Expand All @@ -514,17 +514,17 @@ def test_from_dict_success(self, dict_rule, expected):
[
(
{
"source_os": "WINDOWS10",
"source_path_format": "WINDOWS10",
"source_path": "C:\\oldprefix",
"destination_path": "c:\\newprefix",
}
),
({"source_path": "/mnt/oldprefix", "destination_path": "c:\\newprefix"}),
({"source_os": "POSIX", "destination_path": "c:\\newprefix"}),
({"source_os": "POSIX", "source_path": "/mnt/oldprefix"}),
({"source_path_format": "POSIX", "destination_path": "c:\\newprefix"}),
({"source_path_format": "POSIX", "source_path": "/mnt/oldprefix"}),
(
{
"source_os": "windows",
"source_path_format": "windows",
"source_path": "C:\\oldprefix",
"destination_path": "c:\\newprefix",
"extra_field": "value",
Expand Down
Loading