arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-04-24 07:17:17 +00:00
Code Issues Projects Releases Wiki Activity

fix: serialize patches inside double quotes if there are variables inside (#137)

Browse Source 
Old behaviour leads to variable to be serialized always in single quotes
(if shlex decides to quote it). It doesn't allow to expand variables during execution,
so those values should be put inside double quotes instead. This commit
checks if there is sign char in the variable and quotes manually,
otherwise returning shlex call
This commit is contained in:
Evgenii Alekseev 2024-11-19 14:04:28 +02:00
parent f5d7085325
commit 3c1fdec0e9
2 changed files with 30 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/ahriman/models/pkgbuild_patch.py
View File

@ -43,8 +43,6 @@ class PkgbuildPatch:
key: str | None key: str | None
value: str | list[str] value: str | list[str]
quote = shlex.quote
def __post_init__(self) -> None: def __post_init__(self) -> None:
""" """
remove empty key remove empty key
@ -132,6 +130,24 @@ class PkgbuildPatch:
return cls(key, value()) return cls(key, value())
@staticmethod
def quote(source: str) -> str:
"""
like :func:`shlex.quote()`, but better. The difference in this method from the library one is that it uses
double quotes on top level instead of single quotes to allow shell variable substitution
Args:
source(str): source value string to quote
Returns:
str: quoted string
"""
if "$" in source:
# copy from library method with double quotes instead
return f"""\"{source.replace("\"", "'\"'")}\""""
# otherwise just return normal call
return shlex.quote(source)
@staticmethod @staticmethod
def unquote(source: str) -> str: def unquote(source: str) -> str:
""" """
@ -175,14 +191,14 @@ class PkgbuildPatch:
str: serialized key-value pair, print-friendly str: serialized key-value pair, print-friendly
""" """
if isinstance(self.value, list): # list like if isinstance(self.value, list): # list like
value = " ".join(map(PkgbuildPatch.quote, self.value)) value = " ".join(map(self.quote, self.value))
return f"""{self.key}=({value})""" return f"""{self.key}=({value})"""
if self.is_plain_diff: # no additional logic for plain diffs if self.is_plain_diff: # no additional logic for plain diffs
return self.value return self.value
# we suppose that function values are only supported in string-like values # we suppose that function values are only supported in string-like values
if self.is_function: if self.is_function:
return f"{self.key} {self.value}" # no quoting enabled here return f"{self.key} {self.value}" # no quoting enabled here
return f"""{self.key}={PkgbuildPatch.quote(self.value)}""" return f"""{self.key}={self.quote(self.value)}"""
def substitute(self, variables: dict[str, str]) -> str | list[str]: def substitute(self, variables: dict[str, str]) -> str | list[str]:
""" """

18
tests/ahriman/models/test_pkgbuild_patch.py
View File

@ -34,14 +34,6 @@ def test_is_plain_diff() -> None:
assert PkgbuildPatch(None, "value").is_plain_diff assert PkgbuildPatch(None, "value").is_plain_diff
def test_quote() -> None:
"""
must quote strings if unsafe flag is not set
"""
assert PkgbuildPatch.quote("value") == """value"""
assert PkgbuildPatch.quote("va'lue") == """'va'"'"'lue'"""
def test_from_env() -> None: def test_from_env() -> None:
""" """
must construct patch from environment variable must construct patch from environment variable
@ -71,6 +63,16 @@ def test_parse() -> None:
assert PkgbuildPatch.parse("key", json.dumps(["array", "value"])).value == ["array", "value"] assert PkgbuildPatch.parse("key", json.dumps(["array", "value"])).value == ["array", "value"]
def test_quote() -> None:
"""
must quote strings if unsafe flag is not set
"""
assert PkgbuildPatch.quote("value") == """value"""
assert PkgbuildPatch.quote("va'lue") == """'va'"'"'lue'"""
assert PkgbuildPatch.quote("https://github.com/arcan1s/ahriman/releases/download/$pkgver/$pkgbase-$pkgver.tar.gz") == \
"""\"https://github.com/arcan1s/ahriman/releases/download/$pkgver/$pkgbase-$pkgver.tar.gz\""""
def test_unquote() -> None: def test_unquote() -> None:
""" """
must remove quotation marks must remove quotation marks