|
| 1 | +"""Tests for folder path header encoding. |
| 2 | +
|
| 3 | +Non-ASCII characters in folder paths must be Base64-encoded (UTF-16LE) |
| 4 | +and sent via the X-UIPATH-FolderPath-Encoded header, since HTTP headers |
| 5 | +require ASCII values. The Orchestrator decodes this with |
| 6 | +Convert.FromBase64String + Encoding.Unicode (UTF-16LE). |
| 7 | +""" |
| 8 | + |
| 9 | +from base64 import b64decode |
| 10 | + |
| 11 | +import pytest |
| 12 | + |
| 13 | +from uipath.platform.common._folder_context import ( |
| 14 | + FolderContext, |
| 15 | + folder_path_header, |
| 16 | + header_folder, |
| 17 | +) |
| 18 | +from uipath.platform.common.constants import ( |
| 19 | + HEADER_FOLDER_KEY, |
| 20 | + HEADER_FOLDER_PATH, |
| 21 | + HEADER_FOLDER_PATH_ENCODED, |
| 22 | +) |
| 23 | + |
| 24 | +# --- folder_path_header() --- |
| 25 | + |
| 26 | + |
| 27 | +class TestFolderPathHeader: |
| 28 | + def test_ascii_path_uses_plain_header(self) -> None: |
| 29 | + headers = folder_path_header("MyFolder/SubFolder") |
| 30 | + assert headers == {HEADER_FOLDER_PATH: "MyFolder/SubFolder"} |
| 31 | + |
| 32 | + def test_non_ascii_path_uses_encoded_header(self) -> None: |
| 33 | + path = "VA\xa0Certificate" |
| 34 | + headers = folder_path_header(path) |
| 35 | + assert HEADER_FOLDER_PATH not in headers |
| 36 | + assert HEADER_FOLDER_PATH_ENCODED in headers |
| 37 | + |
| 38 | + def test_encoded_value_is_base64_utf16le(self) -> None: |
| 39 | + path = "Debug_Poétry Writer" |
| 40 | + headers = folder_path_header(path) |
| 41 | + value = headers[HEADER_FOLDER_PATH_ENCODED] |
| 42 | + decoded = b64decode(value).decode("utf-16-le") |
| 43 | + assert decoded == path |
| 44 | + |
| 45 | + def test_encoded_value_is_ascii_safe(self) -> None: |
| 46 | + headers = folder_path_header("VA\xa0Certificate/Poétry") |
| 47 | + headers[HEADER_FOLDER_PATH_ENCODED].encode("ascii") |
| 48 | + |
| 49 | + def test_round_trip_with_non_breaking_space(self) -> None: |
| 50 | + path = "VA\xa0Certificate of Eligibility Agent" |
| 51 | + headers = folder_path_header(path) |
| 52 | + decoded = b64decode(headers[HEADER_FOLDER_PATH_ENCODED]).decode("utf-16-le") |
| 53 | + assert decoded == path |
| 54 | + |
| 55 | + |
| 56 | +# --- header_folder() --- |
| 57 | + |
| 58 | + |
| 59 | +class TestHeaderFolder: |
| 60 | + def test_ascii_folder_path(self) -> None: |
| 61 | + headers = header_folder(None, "MyFolder/SubFolder") |
| 62 | + assert headers == {HEADER_FOLDER_PATH: "MyFolder/SubFolder"} |
| 63 | + |
| 64 | + def test_non_ascii_folder_path_uses_encoded_header(self) -> None: |
| 65 | + headers = header_folder(None, "VA\xa0Certificate") |
| 66 | + assert HEADER_FOLDER_PATH not in headers |
| 67 | + assert HEADER_FOLDER_PATH_ENCODED in headers |
| 68 | + |
| 69 | + def test_folder_key_returned_as_is(self) -> None: |
| 70 | + headers = header_folder("some-uuid-key", None) |
| 71 | + assert headers == {HEADER_FOLDER_KEY: "some-uuid-key"} |
| 72 | + |
| 73 | + def test_none_path_and_key_returns_empty(self) -> None: |
| 74 | + assert header_folder(None, None) == {} |
| 75 | + |
| 76 | + def test_both_key_and_path_raises(self) -> None: |
| 77 | + with pytest.raises(ValueError): |
| 78 | + header_folder("key", "path") |
| 79 | + |
| 80 | + |
| 81 | +# --- FolderContext.folder_headers --- |
| 82 | + |
| 83 | + |
| 84 | +class TestFolderContextHeaders: |
| 85 | + def test_non_ascii_folder_path_uses_encoded_header( |
| 86 | + self, monkeypatch: pytest.MonkeyPatch |
| 87 | + ) -> None: |
| 88 | + path = "VA\xa0Certificate" |
| 89 | + monkeypatch.setenv("UIPATH_FOLDER_PATH", path) |
| 90 | + monkeypatch.delenv("UIPATH_FOLDER_KEY", raising=False) |
| 91 | + ctx = FolderContext() |
| 92 | + headers = ctx.folder_headers |
| 93 | + assert HEADER_FOLDER_PATH not in headers |
| 94 | + value = headers[HEADER_FOLDER_PATH_ENCODED] |
| 95 | + value.encode("ascii") |
| 96 | + assert b64decode(value).decode("utf-16-le") == path |
| 97 | + |
| 98 | + def test_ascii_folder_path_uses_plain_header( |
| 99 | + self, monkeypatch: pytest.MonkeyPatch |
| 100 | + ) -> None: |
| 101 | + monkeypatch.setenv("UIPATH_FOLDER_PATH", "my-folder") |
| 102 | + monkeypatch.delenv("UIPATH_FOLDER_KEY", raising=False) |
| 103 | + ctx = FolderContext() |
| 104 | + assert ctx.folder_headers == {HEADER_FOLDER_PATH: "my-folder"} |
| 105 | + |
| 106 | + def test_folder_key_takes_precedence(self, monkeypatch: pytest.MonkeyPatch) -> None: |
| 107 | + monkeypatch.setenv("UIPATH_FOLDER_KEY", "my-key") |
| 108 | + monkeypatch.setenv("UIPATH_FOLDER_PATH", "my-path") |
| 109 | + ctx = FolderContext() |
| 110 | + assert ctx.folder_headers == {HEADER_FOLDER_KEY: "my-key"} |
| 111 | + |
| 112 | + def test_no_env_vars_returns_empty(self, monkeypatch: pytest.MonkeyPatch) -> None: |
| 113 | + monkeypatch.delenv("UIPATH_FOLDER_KEY", raising=False) |
| 114 | + monkeypatch.delenv("UIPATH_FOLDER_PATH", raising=False) |
| 115 | + ctx = FolderContext() |
| 116 | + assert ctx.folder_headers == {} |
0 commit comments