mirror of
https://github.com/certbot/certbot.git
synced 2026-01-26 07:41:33 +03:00
d5de24d9fc
This PR is the second part of #6497 to ease the integration, following the new plan propose by @bmw here: #6497 (comment) This PR creates the module certbot.compat.os, that delegates everything to os, and that will be the safeguard against problematic methods of the standard module. On top of that, a quality check wrapper is called in the lint tox environment. This wrapper calls pylint and ensures that standard os module is no used directly in the certbot codebase. Finally local oldest requirements are updated to ensure that tests will take the new logic when running. * Add executable permissions * Add the delegate certbot.compat.os module, add check coding style to enforce usage of certbot.compat.os instead of standard os * Load certbot.compat.os instead of os * Move existing compat test * Update local oldest requirements * Import sys * Update account_test.py * Update os.py * Update os.py * Update local oldest requirements * Implement the new linter_plugin * Fix local oldest for nginx * Remove check coding style * Update linter_plugin.py * Add several comments * Update the setup.py * Add documentation * Update acme dependencies * Update certbot/compat/os.py * Update docs/contributing.rst * Update linter_plugin.py * Handle os.path. Simplify checker. * Add a comment to a reference implementation * Update changelog * Fix module registering * Update docs/contributing.rst * Update config and changelog
130 lines
4.4 KiB
Python
130 lines
4.4 KiB
Python
"""Tests for certbot_apache.parser."""
|
|
import shutil
|
|
import unittest
|
|
|
|
from certbot import errors
|
|
from certbot.compat import os
|
|
|
|
from certbot_apache.tests import util
|
|
|
|
|
|
class ComplexParserTest(util.ParserTest):
|
|
"""Apache Parser Test."""
|
|
|
|
def setUp(self): # pylint: disable=arguments-differ
|
|
super(ComplexParserTest, self).setUp(
|
|
"complex_parsing", "complex_parsing")
|
|
|
|
self.setup_variables()
|
|
# This needs to happen after due to setup_variables not being run
|
|
# until after
|
|
self.parser.parse_modules() # pylint: disable=protected-access
|
|
|
|
def tearDown(self):
|
|
shutil.rmtree(self.temp_dir)
|
|
shutil.rmtree(self.config_dir)
|
|
shutil.rmtree(self.work_dir)
|
|
|
|
def setup_variables(self):
|
|
"""Set up variables for parser."""
|
|
self.parser.variables.update(
|
|
{
|
|
"COMPLEX": "",
|
|
"tls_port": "1234",
|
|
"fnmatch_filename": "test_fnmatch.conf",
|
|
"tls_port_str": "1234"
|
|
}
|
|
)
|
|
|
|
def test_filter_args_num(self):
|
|
"""Note: This may also fail do to Include conf-enabled/ syntax."""
|
|
matches = self.parser.find_dir("TestArgsDirective")
|
|
|
|
self.assertEqual(len(self.parser.filter_args_num(matches, 1)), 3)
|
|
self.assertEqual(len(self.parser.filter_args_num(matches, 2)), 2)
|
|
self.assertEqual(len(self.parser.filter_args_num(matches, 3)), 1)
|
|
|
|
def test_basic_variable_parsing(self):
|
|
matches = self.parser.find_dir("TestVariablePort")
|
|
|
|
self.assertEqual(len(matches), 1)
|
|
self.assertEqual(self.parser.get_arg(matches[0]), "1234")
|
|
|
|
def test_basic_variable_parsing_quotes(self):
|
|
matches = self.parser.find_dir("TestVariablePortStr")
|
|
|
|
self.assertEqual(len(matches), 1)
|
|
self.assertEqual(self.parser.get_arg(matches[0]), "1234")
|
|
|
|
def test_invalid_variable_parsing(self):
|
|
del self.parser.variables["tls_port"]
|
|
|
|
matches = self.parser.find_dir("TestVariablePort")
|
|
self.assertRaises(
|
|
errors.PluginError, self.parser.get_arg, matches[0])
|
|
|
|
def test_basic_ifdefine(self):
|
|
self.assertEqual(len(self.parser.find_dir("VAR_DIRECTIVE")), 2)
|
|
self.assertEqual(len(self.parser.find_dir("INVALID_VAR_DIRECTIVE")), 0)
|
|
|
|
def test_basic_ifmodule(self):
|
|
self.assertEqual(len(self.parser.find_dir("MOD_DIRECTIVE")), 2)
|
|
self.assertEqual(
|
|
len(self.parser.find_dir("INVALID_MOD_DIRECTIVE")), 0)
|
|
|
|
def test_nested(self):
|
|
self.assertEqual(len(self.parser.find_dir("NESTED_DIRECTIVE")), 3)
|
|
self.assertEqual(
|
|
len(self.parser.find_dir("INVALID_NESTED_DIRECTIVE")), 0)
|
|
|
|
def test_load_modules(self):
|
|
"""If only first is found, there is bad variable parsing."""
|
|
self.assertTrue("status_module" in self.parser.modules)
|
|
self.assertTrue("mod_status.c" in self.parser.modules)
|
|
|
|
# This is in an IfDefine
|
|
self.assertTrue("ssl_module" in self.parser.modules)
|
|
self.assertTrue("mod_ssl.c" in self.parser.modules)
|
|
|
|
def verify_fnmatch(self, arg, hit=True):
|
|
"""Test if Include was correctly parsed."""
|
|
from certbot_apache import parser
|
|
self.parser.add_dir(parser.get_aug_path(self.parser.loc["default"]),
|
|
"Include", [arg])
|
|
if hit:
|
|
self.assertTrue(self.parser.find_dir("FNMATCH_DIRECTIVE"))
|
|
else:
|
|
self.assertFalse(self.parser.find_dir("FNMATCH_DIRECTIVE"))
|
|
|
|
# NOTE: Only run one test per function otherwise you will have
|
|
# inf recursion
|
|
def test_include(self):
|
|
self.verify_fnmatch("test_fnmatch.?onf")
|
|
|
|
def test_include_complex(self):
|
|
self.verify_fnmatch("../complex_parsing/[te][te]st_*.?onf")
|
|
|
|
def test_include_fullpath(self):
|
|
self.verify_fnmatch(os.path.join(self.config_path,
|
|
"test_fnmatch.conf"))
|
|
|
|
def test_include_fullpath_trailing_slash(self):
|
|
self.verify_fnmatch(self.config_path + "//")
|
|
|
|
def test_include_single_quotes(self):
|
|
self.verify_fnmatch("'" + self.config_path + "'")
|
|
|
|
def test_include_double_quotes(self):
|
|
self.verify_fnmatch('"' + self.config_path + '"')
|
|
|
|
def test_include_variable(self):
|
|
self.verify_fnmatch("../complex_parsing/${fnmatch_filename}")
|
|
|
|
def test_include_missing(self):
|
|
# This should miss
|
|
self.verify_fnmatch("test_*.onf", False)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main() # pragma: no cover
|