def test_rule_config(rule_config, monkeypatch):
rule_id = 'rule-0'
monkeypatch.setattr(AnsibleLintRule, 'id', rule_id)
monkeypatch.setitem(options.rules, rule_id, rule_config)
rule = AnsibleLintRule()
assert set(rule.rule_config.items()) == set(rule_config.items())
assert all(rule.get_config(k) == v for k, v in rule_config.items())
def setup_class(self) -> None:
"""Set up few MatchError objects."""
self.rule = AnsibleLintRule()
self.rule.id = "TCF0001"
self.rule.severity = "VERY_HIGH"
self.matches = []
self.matches.append(
MatchError(
message="message",
linenumber=1,
details="hello",
filename="filename.yml",
rule=self.rule,
))
self.matches.append(
MatchError(
message="message",
linenumber=2,
details="hello",
filename="filename.yml",
rule=self.rule,
))
self.formatter = CodeclimateJSONFormatter(pathlib.Path.cwd(),
display_relative_path=True)
def setUp(self):
self.rule = AnsibleLintRule()
self.rule.id = "TCF0001"
self.formatter = Formatter(pathlib.Path.cwd(), True)
class TestCodeclimateJSONFormatter:
"""Unit test for CodeclimateJSONFormatter."""
rule = AnsibleLintRule()
matches: List[MatchError] = []
formatter: Optional[CodeclimateJSONFormatter] = None
def setup_class(self) -> None:
"""Set up few MatchError objects."""
self.rule = AnsibleLintRule()
self.rule.id = "TCF0001"
self.rule.severity = "VERY_HIGH"
self.matches = []
self.matches.append(
MatchError(
message="message",
linenumber=1,
details="hello",
filename="filename.yml",
rule=self.rule,
))
self.matches.append(
MatchError(
message="message",
linenumber=2,
details="hello",
filename="filename.yml",
rule=self.rule,
))
self.formatter = CodeclimateJSONFormatter(pathlib.Path.cwd(),
display_relative_path=True)
def test_format_list(self) -> None:
"""Test if the return value is a string."""
assert isinstance(self.formatter, CodeclimateJSONFormatter)
assert isinstance(self.formatter.format_result(self.matches), str)
def test_result_is_json(self) -> None:
"""Test if returned string value is a JSON."""
assert isinstance(self.formatter, CodeclimateJSONFormatter)
json.loads(self.formatter.format_result(self.matches))
def test_single_match(self) -> None:
"""Test negative case. Only lists are allowed. Otherwise a RuntimeError will be raised."""
assert isinstance(self.formatter, CodeclimateJSONFormatter)
with pytest.raises(RuntimeError):
self.formatter.format_result(self.matches[0]) # type: ignore
def test_result_is_list(self) -> None:
"""Test if the return JSON contains a list with a length of 2."""
assert isinstance(self.formatter, CodeclimateJSONFormatter)
result = json.loads(self.formatter.format_result(self.matches))
assert len(result) == 2
def test_validate_codeclimate_schema(self) -> None:
"""Test if the returned JSON is a valid codeclimate report."""
assert isinstance(self.formatter, CodeclimateJSONFormatter)
result = json.loads(self.formatter.format_result(self.matches))
single_match = result[0]
assert 'type' in single_match
assert single_match['type'] == 'issue'
assert 'check_name' in single_match
assert 'categories' in single_match
assert isinstance(single_match['categories'], list)
assert 'severity' in single_match
assert single_match['severity'] == 'blocker'
assert 'description' in single_match
assert 'fingerprint' in single_match
assert 'location' in single_match
assert 'path' in single_match['location']
assert single_match['location']['path'] == self.matches[0].filename
assert 'lines' in single_match['location']
assert single_match['location']['lines']['begin'] == self.matches[
0].linenumber
def test_unjinja():
text = "{{ a }} {% b %} {# try to confuse parsing inside a comment { {{}} } #}"
output = "JINJA_EXPRESSION JINJA_STATEMENT JINJA_COMMENT"
assert AnsibleLintRule.unjinja(text) == output
def setUp(self) -> None:
self.rule = AnsibleLintRule()
self.rule.id = "TCF0001"
self.formatter = Formatter(pathlib.Path.cwd(),
display_relative_path=True)