bwt/nginx-config-formatter
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

fix regular expression with { } like in server_name,rewrite,location and if.

Browse Source
This commit is contained in:
yongfu 2019-03-01 09:33:55 +08:00
parent 2a210daad6
commit 24ed37352f
2 changed files with 38 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
nginxfmt.py
View File

@ -20,6 +20,8 @@ INDENTATION = ' ' * 4
TEMPLATE_VARIABLE_OPENING_TAG = '___TEMPLATE_VARIABLE_OPENING_TAG___'
TEMPLATE_VARIABLE_CLOSING_TAG = '___TEMPLATE_VARIABLE_CLOSING_TAG___'
TEMPLATE_REG_OPENING_TAG = '___TEMPLATE_REG_OPENING_TAG___'
TEMPLATE_REG_CLOSING_TAG = '___TEMPLATE_REG_CLOSING_TAG___'
def strip_line(single_line):
"""Strips the line and replaces neighbouring whitespaces with single space (except when within quotation marks)."""
@ -45,7 +47,7 @@ def multi_semicolon(single_line):
return single_line, 0
m1 = re.match(r"^([^;#]*;)([\s]*#.*)?$", single_line)
m2 = re.match(r"^([^#]+)(;[\s]*)(#.*)?$", single_line)
m2 = re.match(r"^([^#]+)([;][\s]*)(#.*)?$", single_line)
if m1 is not None:
return single_line, 0
@ -74,6 +76,30 @@ def multi_semicolon(single_line):
return single_line, 0
def apply_reg_template_tags(line: str) -> str:
"""Replaces rewrite/server_name/if/location regular expression have { } in quotes with tags"""
parts = []
within_quotes = False
for part in re.split('"', line):
if within_quotes:
part = part.replace("{", TEMPLATE_REG_OPENING_TAG)
part = part.replace("}", TEMPLATE_REG_CLOSING_TAG)
parts.append(part)
else:
parts.append(part)
within_quotes = not within_quotes
line = '"'.join(parts)
return line
def strip_reg_template_tags(line: str) -> str:
"""Replaces rewrite/server_name/if/location regular expression have { } in quotes with tags"""
line = line.replace(TEMPLATE_REG_OPENING_TAG, "{")
line = line.replace(TEMPLATE_REG_CLOSING_TAG, "}")
return line
def apply_variable_template_tags(line: str) -> str:
"""Replaces variable indicators ${ and } with tags, so subsequent formatting is easier."""
return re.sub(r'\${\s*(\w+)\s*}',
@ -96,22 +122,20 @@ def clean_lines(orig_lines) -> list:
for line in orig_lines:
line = strip_line(line)
line = apply_variable_template_tags(line)
line = apply_reg_template_tags(line)
if line == "":
cleaned_lines.append("")
continue
else:
if line.startswith("#"):
cleaned_lines.append(strip_variable_template_tags(line))
cleaned_lines.append(strip_reg_template_tags(strip_variable_template_tags(line)))
else:
mline, c = multi_semicolon(line)
if c > 0:
cleaned_lines.extend(clean_lines(mline.splitlines()))
else:
if mline.startswith("rewrite"):
cleaned_lines.append(strip_variable_template_tags(mline))
else:
cleaned_lines.extend(
[strip_variable_template_tags(l).strip() for l in re.split(r"([{}])", mline) if l != ""])
cleaned_lines.extend(
[strip_reg_template_tags(strip_variable_template_tags(l)).strip() for l in re.split(r"([{}])", mline) if l != ""])
return cleaned_lines

10
test_nginxfmt.py
View File

@ -37,8 +37,8 @@ class TestFormatter(unittest.TestCase):
self.assertEqual(["{", "ala", "# ma {{", "kota", "}", "to", "}", "# }"],
clean_lines(("{", "ala ", "# ma {{", " kota ", "}", " to} ", "# }")))
self.assertEqual(["{", "ala", "# ma {{", "rewrite /([\d]{2}) /up/$1.html last;", "}", "to", "}"],
clean_lines(("{", "ala ", "# ma {{", " rewrite /([\d]{2}) /up/$1.html last; ", "}", " to", "}")))
self.assertEqual(["{", "ala", "# ma {{", "rewrite \"/([\d]{2})\" /up/$1.html last;", "}", "to", "}"],
clean_lines(("{", "ala ", "# ma {{", " rewrite \"/([\d]{2})\" /up/$1.html last; ", "}", " to", "}")))
self.assertEqual(["{", "ala", "# ma {{", "aa last;", "bb to;", "}"],
clean_lines(("{", "ala ", "# ma {{", " aa last; bb to; ", "}")))
@ -48,7 +48,7 @@ class TestFormatter(unittest.TestCase):
self.assertEqual(["{", "a aa;", "bb b \"ccc; dddd;\";", "ee e; # ff; ee ;", "}"],
clean_lines(("{", "a aa; bb b \"ccc; dddd;\"; ee e; # ff; ee ;", "}")))
self.assertEqual(["location ~ /\.ht", "{"], clean_lines(["location ~ /\.ht {", ]))
def test_perform_indentation(self):
@ -200,6 +200,10 @@ class TestFormatter(unittest.TestCase):
' deny all;\n' +
'}\n')
def test_reg_template_tags(self):
self.assertEqual('server_name "~^(?<tag>[0-9a-f]___TEMPLATE_REG_OPENING_TAG___8___TEMPLATE_REG_CLOSING_TAG___)\.a\.b\.com$";',
apply_reg_template_tags('server_name "~^(?<tag>[0-9a-f]{8})\.a\.b\.com$";'))
def test_loading_utf8_file(self):
tmp_file = tempfile.mkstemp('utf-8')[1]
shutil.copy('test-files/umlaut-utf8.conf', tmp_file)