Skip to content

Fix escaping of options #476

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
softwarefactory-project-zuul merged 1 commit into from
May 20, 2025
Merged

Fix escaping of options #476

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
10 changes: 8 additions & 2 deletions specfile/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,14 @@ def __str__(self) -> str:
# escape double quotes
value = self.value.replace('"', r"\"")
return f'"{value}"'
# escape quotes and whitespace
return re.sub(r"['\"\s]", r"\\\g<0>", self.value)
# escape quotes and whitespace only in string literals
value = ""
for node in ValueParser.parse(self.value):
if isinstance(node, StringLiteral):
value += re.sub(r"['\"\s]", r"\\\g<0>", str(node))
else:
value += str(node)
return value

def _key(self) -> tuple:
return self.type, self.value
Expand Down
112 changes: 112 additions & 0 deletions tests/unit/test_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,119 @@ def test_options_find_option(optstring, tokens, option, result):
Token(TokenType.QUOTED, '%{name}-%{version}%[%{rc}?"-rc":""]'),
],
),
(
"-q %{?prever:-n %{name}-%{prever}}",
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "%{?prever:-n %{name}-%{prever}}"),
],
),
],
)
def test_options_tokenize(option_string, result):
assert Options.tokenize(option_string) == result


@pytest.mark.parametrize(
"tokens, result",
[
(
[
Token(TokenType.DEFAULT, "-p1"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-b"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, ".test"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-E"),
],
"-p1 -b .test -E",
),
(
[
Token(TokenType.DEFAULT, "-p"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "28"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-b"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, ".test escape"),
],
"-p 28 -b .test\\ escape",
),
(
[
Token(TokenType.DEFAULT, "-b"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DOUBLE_QUOTED, '.test "double quotes"'),
],
'-b ".test \\"double quotes\\""',
),
(
[
Token(TokenType.DEFAULT, "-p1"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-b"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, ".test_whitespace_at_the_end"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-M"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "2"),
Token(TokenType.WHITESPACE, " "),
],
"-p1 -b .test_whitespace_at_the_end -M 2 ",
),
(
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-n"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, '%{name}-%{version}%[%{rc}?"-rc":""]'),
],
'-q -n %{name}-%{version}%[%{rc}?"-rc":""]',
),
(
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-n"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.QUOTED, "%{name}-%{version}"),
],
"-q -n '%{name}-%{version}'",
),
(
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-n"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DOUBLE_QUOTED, "%{name}-%{version}"),
],
'-q -n "%{name}-%{version}"',
),
(
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "-n"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.QUOTED, '%{name}-%{version}%[%{rc}?"-rc":""]'),
],
'-q -n \'%{name}-%{version}%[%{rc}?"-rc":""]\'',
),
(
[
Token(TokenType.DEFAULT, "-q"),
Token(TokenType.WHITESPACE, " "),
Token(TokenType.DEFAULT, "%{?prever:-n %{name}-%{prever}}"),
],
"-q %{?prever:-n %{name}-%{prever}}",
),
],
)
def test_options_stringify(tokens, result):
assert str(Options(tokens)) == result
Loading