b2b116a8e2
* Generate description and metadata for rules with no language, so that they get indexed. * Index rules with different types in language specializations. * Improve validation to reject new rules with no language specialization (i.e. only a predefined set of such rules is allowed because they were imported from Jira and kept for historical purposes). * Write smaller JSON files, reduce their size by 30%. * Improve test coverage of CLI application.
57 lines
2.2 KiB
Python
57 lines
2.2 KiB
Python
from pathlib import Path
|
|
from typing import List
|
|
from unittest.mock import patch
|
|
|
|
from click.testing import CliRunner
|
|
from rspec_tools.cli import cli
|
|
from rspec_tools.rules import RulesRepository
|
|
|
|
|
|
class TestCLIValidateRulesMetadata:
|
|
'''Unit test for the Command Line Interface.'''
|
|
|
|
def _run(self, rules: List[str]):
|
|
runner = CliRunner()
|
|
arguments = ['validate-rules-metadata'] + rules
|
|
return runner.invoke(cli, arguments)
|
|
|
|
def _mock_rule_ressources(self):
|
|
mock_path = Path(__file__).parent.joinpath('resources', 'invalid-rules')
|
|
return patch.object(RulesRepository.__init__, '__defaults__', (mock_path,))
|
|
|
|
def test_missing_parameters(self):
|
|
result = self._run([])
|
|
assert 'Missing argument \'RULES...\'' in result.output
|
|
assert result.exit_code == 2
|
|
|
|
def test_valid_rule(self):
|
|
'''This test uses the actual rules data, not the mock resources.'''
|
|
result = self._run(['S100'])
|
|
assert result.output == ''
|
|
assert result.exit_code == 0
|
|
|
|
@patch('rspec_tools.validation.metadata.RULES_WITH_NO_LANGUAGES', ['S501'])
|
|
def test_invalid_rule_in_allow_list(self):
|
|
with self._mock_rule_ressources():
|
|
result = self._run(['S501'])
|
|
assert result.output == ''
|
|
assert result.exit_code == 0
|
|
|
|
@patch('rspec_tools.validation.metadata.RULES_WITH_NO_LANGUAGES', [])
|
|
def test_invalid_rule(self):
|
|
with self._mock_rule_ressources():
|
|
result = self._run(['S501'])
|
|
assert 'Rule S501 has no language-specific data' in result.output
|
|
assert 'Validation failed due to 1 errors out of 1 analyzed rules' in result.output
|
|
assert result.exit_code == 1
|
|
|
|
@patch('rspec_tools.validation.metadata.RULES_WITH_NO_LANGUAGES', [])
|
|
def test_invalid_rules(self):
|
|
with self._mock_rule_ressources():
|
|
result = self._run(['S501', 'S502'])
|
|
assert 'Rule S501 has no language-specific data' in result.output
|
|
assert 'Rule S502 failed validation for these reasons:' in result.output
|
|
assert 'Rule scala:S502 has invalid metadata : \'remediation\' is a required property' in result.output
|
|
assert 'Validation failed due to 2 errors out of 2 analyzed rules' in result.output
|
|
assert result.exit_code == 1
|