|
| 1 | +import ast |
| 2 | +import os |
| 3 | + |
| 4 | +import pytest |
| 5 | + |
| 6 | +yaml = pytest.importorskip("yaml") |
| 7 | + |
| 8 | +PLUGIN_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), '..')) |
| 9 | +REQUIREMENTS_PATH = os.path.join(PLUGIN_DIR, 'requirements.txt') |
| 10 | +HOOK_PATH = os.path.join(PLUGIN_DIR, 'hook.py') |
| 11 | +CONF_DIR = os.path.join(PLUGIN_DIR, 'conf') |
| 12 | +DATA_DIR = os.path.join(PLUGIN_DIR, 'data') |
| 13 | + |
| 14 | + |
| 15 | +class TestRequirementsSecurity: |
| 16 | + """Test that requirements.txt documents known CVE risks.""" |
| 17 | + |
| 18 | + def test_pyminizip_has_cve_warning_comment(self): |
| 19 | + """pyminizip has known CVEs; requirements.txt should document this. |
| 20 | +
|
| 21 | + pyminizip uses zlib and has had vulnerabilities reported. A comment |
| 22 | + in requirements.txt should warn maintainers about this risk so it |
| 23 | + is not overlooked during dependency reviews. |
| 24 | + """ |
| 25 | + with open(REQUIREMENTS_PATH, 'r', encoding='utf-8') as f: |
| 26 | + content = f.read() |
| 27 | + |
| 28 | + # Verify pyminizip is listed |
| 29 | + assert 'pyminizip' in content, ( |
| 30 | + "pyminizip not found in requirements.txt" |
| 31 | + ) |
| 32 | + |
| 33 | + # Check for a CVE-related comment near the pyminizip line |
| 34 | + lines = content.splitlines() |
| 35 | + found_cve_comment = False |
| 36 | + for i, line in enumerate(lines): |
| 37 | + if 'pyminizip' in line.lower(): |
| 38 | + # Check this line and surrounding lines for CVE warning |
| 39 | + context_start = max(0, i - 2) |
| 40 | + context_end = min(len(lines), i + 3) |
| 41 | + context = '\n'.join(lines[context_start:context_end]) |
| 42 | + if 'cve' in context.lower() or 'vulnerab' in context.lower(): |
| 43 | + found_cve_comment = True |
| 44 | + break |
| 45 | + assert found_cve_comment, ( |
| 46 | + "requirements.txt should have a comment warning about known " |
| 47 | + "CVEs for pyminizip (e.g., '# WARNING: pyminizip has known " |
| 48 | + "CVE vulnerabilities')" |
| 49 | + ) |
| 50 | + |
| 51 | + |
| 52 | +class TestHookParseable: |
| 53 | + """Verify that hook.py is syntactically valid.""" |
| 54 | + |
| 55 | + def test_hook_file_exists(self): |
| 56 | + """hook.py must exist as the plugin entry point.""" |
| 57 | + assert os.path.isfile(HOOK_PATH), ( |
| 58 | + f"hook.py not found at {HOOK_PATH}" |
| 59 | + ) |
| 60 | + |
| 61 | + def test_hook_can_be_parsed(self): |
| 62 | + """hook.py should be valid Python parseable by ast.parse.""" |
| 63 | + with open(HOOK_PATH, 'r', encoding='utf-8') as f: |
| 64 | + source = f.read() |
| 65 | + try: |
| 66 | + tree = ast.parse(source) |
| 67 | + except SyntaxError as e: |
| 68 | + pytest.fail(f"hook.py has a syntax error: {e}") |
| 69 | + assert tree is not None |
| 70 | + |
| 71 | + def test_hook_defines_enable_function(self): |
| 72 | + """hook.py must define an async 'enable' function.""" |
| 73 | + with open(HOOK_PATH, 'r', encoding='utf-8') as f: |
| 74 | + source = f.read() |
| 75 | + tree = ast.parse(source) |
| 76 | + enable_funcs = [ |
| 77 | + node for node in ast.walk(tree) |
| 78 | + if isinstance(node, ast.AsyncFunctionDef) and node.name == 'enable' |
| 79 | + ] |
| 80 | + assert len(enable_funcs) > 0, ( |
| 81 | + "hook.py must define an 'async def enable(...)' function" |
| 82 | + ) |
| 83 | + |
| 84 | + def test_hook_defines_plugin_name(self): |
| 85 | + """hook.py should define a 'name' variable.""" |
| 86 | + with open(HOOK_PATH, 'r', encoding='utf-8') as f: |
| 87 | + source = f.read() |
| 88 | + tree = ast.parse(source) |
| 89 | + name_assignments = [ |
| 90 | + node for node in ast.walk(tree) |
| 91 | + if isinstance(node, ast.Assign) |
| 92 | + and any( |
| 93 | + isinstance(target, ast.Name) and target.id == 'name' |
| 94 | + for target in node.targets |
| 95 | + ) |
| 96 | + ] |
| 97 | + assert len(name_assignments) > 0, ( |
| 98 | + "hook.py should define a 'name' variable for the plugin" |
| 99 | + ) |
| 100 | + |
| 101 | + |
| 102 | +class TestAbilitiesYAML: |
| 103 | + """Validate YAML configuration files are well-formed.""" |
| 104 | + |
| 105 | + def _get_yaml_files(self, directory): |
| 106 | + """Recursively collect all YAML files from a directory.""" |
| 107 | + yaml_files = [] |
| 108 | + if not os.path.isdir(directory): |
| 109 | + return yaml_files |
| 110 | + for root, dirs, files in os.walk(directory): |
| 111 | + for fname in files: |
| 112 | + if fname.endswith('.yml') or fname.endswith('.yaml'): |
| 113 | + yaml_files.append(os.path.join(root, fname)) |
| 114 | + return sorted(yaml_files) |
| 115 | + |
| 116 | + def test_conf_yaml_files_are_valid(self): |
| 117 | + """All YAML files in conf/ should be parseable.""" |
| 118 | + yaml_files = self._get_yaml_files(CONF_DIR) |
| 119 | + assert len(yaml_files) > 0, ( |
| 120 | + f"No YAML files found in {CONF_DIR}" |
| 121 | + ) |
| 122 | + for fpath in yaml_files: |
| 123 | + with open(fpath, 'r', encoding='utf-8') as f: |
| 124 | + try: |
| 125 | + data = yaml.safe_load(f) |
| 126 | + except yaml.YAMLError as e: |
| 127 | + pytest.fail(f"Failed to parse {fpath}: {e}") |
| 128 | + assert data is not None, ( |
| 129 | + f"YAML file is empty: {fpath}" |
| 130 | + ) |
| 131 | + |
| 132 | + def test_data_yaml_files_are_valid_if_present(self): |
| 133 | + """If data/ contains YAML files (post-setup), they should be parseable.""" |
| 134 | + yaml_files = self._get_yaml_files(DATA_DIR) |
| 135 | + if not yaml_files: |
| 136 | + pytest.skip( |
| 137 | + "No YAML files in data/ — run plugin setup to populate" |
| 138 | + ) |
| 139 | + for fpath in yaml_files: |
| 140 | + with open(fpath, 'r', encoding='utf-8') as f: |
| 141 | + try: |
| 142 | + data = yaml.safe_load(f) |
| 143 | + except yaml.YAMLError as e: |
| 144 | + pytest.fail(f"Failed to parse {fpath}: {e}") |
0 commit comments