import pytest

from pathlib import Path

import sys

from guideline_recategorizations import generate_guideline_recategorizations_report

script_path = Path(__file__)

sys.path.append(str(script_path.parent.parent / 'shared'))

from codeql import CodeQL, CodeQLError

REPO_ROOT = Path(__file__).resolve().parent.parent.parent

SCRIPTS_DIR = REPO_ROOT / 'scripts'

TEST_DATA_DIR = Path(__file__).resolve().parent / 'test-data'

def test_guideline_recategorizations_report(tmp_path):

db_path = tmp_path / 'test-db'

src_root = TEST_DATA_DIR / 'guideline-recategorizations'

codeql = CodeQL()

compile_src_command = "clang -fsyntax-only test.cpp"

index_coding_standards_config_command = f"python3 {SCRIPTS_DIR}/configuration/process_coding_standards_config.py"

try:

codeql.create_database(src_root, 'cpp', db_path, compile_src_command, index_coding_standards_config_command)

except CodeQLError as err:

print(err.stdout)

print(err.stderr)

raise err

generate_guideline_recategorizations_report(db_path, REPO_ROOT, tmp_path)

expected = (TEST_DATA_DIR / 'guideline-recategorizations' / 'guideline_recategorizations_report.md.expected').read_text()

expected = expected.replace("$codeql-version$", codeql.version).replace("$database-path$", str(db_path))

actual = (tmp_path / "guideline_recategorizations_report.md").read_text()

assert(expected == actual)

# Guideline recategorizations report

## Overview

- Report generated with supported CodeQL version $codeql-version$

- Database path: $database-path$

- 8 applicable guideline recategorizations and 5 invalid guideline recategorizations found in the database

## Guideline recategorizations

| Rule ID | Category | Recategorized category

| --- | --- | --- |

| A0-1-1 | required | advisory |

| A0-1-1 | required | mandatory |

| A0-1-2 | required | disapplied |

| RULE-13-6 | mandatory | required |

| CON50-CPP | rule | required |

| A0-1-6 | advisory | disapplied |

| A10-4-1 | advisory | required |

| A11-0-1 | advisory | mandatory |

## Invalid guideline recategorizations

| Path | Reason |

| --- | --- |

| invalid/coding-standards.xml:5:7:8:43 | 'Invalid recategorization from 'required' to 'advisory'.' for rule A0-1-1. |

| invalid/coding-standards.xml:9:7:12:43 | 'Invalid recategorization from 'required' to 'disapplied'.' for rule A0-1-2. |

| invalid/coding-standards.xml:13:7:16:43 | 'Unknown rule id 'A1-4-3'.' for rule A1-4-3. |

| invalid/coding-standards.xml:17:7:20:43 | 'Invalid recategorization from 'mandatory' to 'required'.' for rule RULE-13-6. |

| invalid/coding-standards.xml:21:7:24:43 | 'Invalid recategorization from 'rule' to 'required'.' for rule CON50-CPP. |

guideline-recategorizations:

- rule-id: "A0-1-1"

category: "advisory"

- rule-id: "A0-1-2"

category: "disapplied"

- rule-id: "A1-4-3"

category: "mandatory"

- rule-id: "RULE-13-6"

category: "required"

- rule-id: "CON50-CPP"

category: "required"

guideline-recategorizations:

- rule-id: "A0-1-1"

category: "mandatory"

- rule-id: "A0-1-6"

category: "disapplied"

- rule-id: "A10-4-1"

category: "required"

- rule-id: "A11-0-1"

category: "mandatory"