vhdl-style-guide/tests/severity/test_main.py

158 lines
7.2 KiB
Python

# -*- coding: utf-8 -*-
import os
import pathlib
import shutil
import subprocess
import unittest
from tempfile import TemporaryDirectory
from tests import utils
sEntityFileName = "entity.vhd"
sArchitectureFileName = "architecture.vhd"
sJUnitFileName = "junit_output.xml"
sEntityFile = os.path.join(os.path.dirname(__file__), sEntityFileName)
sArchitectureFile = os.path.join(os.path.dirname(__file__), sArchitectureFileName)
sJUnitFile = os.path.join(os.path.dirname(__file__), sJUnitFileName)
sConfigFile = os.path.join(os.path.dirname(__file__), "config.yaml")
sOutputFileWoConfig = os.path.join(os.path.dirname(__file__), "output_wo_config.txt")
sOutputFileWithConfig = os.path.join(os.path.dirname(__file__), "output_w_config.txt")
sOutputFileWithConfigFixed = os.path.join(os.path.dirname(__file__), "output_w_config_fixed.txt")
sArchitectureOutputFileWoConfig = os.path.join(os.path.dirname(__file__), "output_wo_config.architecture.txt")
sArchitectureOutputFileWithConfig = os.path.join(os.path.dirname(__file__), "output_w_config.architecture.txt")
sArchitectureOutputFileWithConfigFixed = os.path.join(os.path.dirname(__file__), "output_w_config_fixed.architecture.txt")
class test_severity_using_main(unittest.TestCase):
def setUp(self):
self._tmpdir = TemporaryDirectory()
self._sEntityFileName = os.path.join(self._tmpdir.name, sEntityFileName)
self._sArchitectureFileName = os.path.join(self._tmpdir.name, sArchitectureFileName)
self._sJUnitFileName = os.path.join(self._tmpdir.name, sJUnitFileName)
shutil.copyfile(sEntityFile, self._sEntityFileName)
shutil.copyfile(sArchitectureFile, self._sArchitectureFileName)
shutil.copyfile(sJUnitFile, self._sJUnitFileName)
def tearDown(self):
self._tmpdir.cleanup()
def test_entity_without_configuration(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName])
except subprocess.CalledProcessError as e:
lActual = e.output.decode("utf-8").split("\n")
iExitStatus = e.returncode
lExpected = pathlib.Path(sOutputFileWoConfig).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sEntityFileName, sEntityFileName), lExpected)
def test_entity_with_configuration(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName, "-c", sConfigFile])
except subprocess.CalledProcessError as e:
lActual = e.output.decode("utf-8").split("\n")
iExitStatus = e.returncode
lExpected = pathlib.Path(sOutputFileWithConfig).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sEntityFileName, sEntityFileName), lExpected)
def test_entity_with_configuration_and_fixed(self):
lActual = subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName, "-c", sConfigFile, "--fix"]).decode("utf-8").split("\n")
lExpected = pathlib.Path(sOutputFileWithConfigFixed).read_text().split("\n")
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sEntityFileName, sEntityFileName), lExpected)
def test_architecture_without_configuration(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sArchitectureFileName])
except subprocess.CalledProcessError as e:
lActual = e.output.decode("utf-8").split("\n")
iExitStatus = e.returncode
lExpected = pathlib.Path(sArchitectureOutputFileWoConfig).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sArchitectureFileName, sArchitectureFileName), lExpected)
def test_architecture_with_configuration(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sArchitectureFileName, "-c", sConfigFile])
except subprocess.CalledProcessError as e:
lActual = e.output.decode("utf-8").split("\n")
iExitStatus = e.returncode
lExpected = pathlib.Path(sArchitectureOutputFileWithConfig).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sArchitectureFileName, sArchitectureFileName), lExpected)
def test_architecture_with_configuration_and_fixed(self):
lActual = subprocess.check_output(["bin/vsg", "-f", self._sArchitectureFileName, "-c", sConfigFile, "--fix"]).decode("utf-8").split("\n")
lExpected = pathlib.Path(sArchitectureOutputFileWithConfigFixed).read_text().split("\n")
self.assertEqual(utils.replace_token(utils.replace_total_count(lActual), self._sArchitectureFileName, sArchitectureFileName), lExpected)
def test_both_with_configuration(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName, self._sArchitectureFileName, "-c", sConfigFile])
except subprocess.CalledProcessError as e:
lActual = e.output.decode("utf-8").split("\n")
iExitStatus = e.returncode
lExpected1 = pathlib.Path(sOutputFileWithConfig).read_text().rstrip("\n").split("\n")
lExpected2 = pathlib.Path(sArchitectureOutputFileWithConfig).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(
utils.replace_token(
utils.replace_token(utils.replace_total_count(lActual), self._sEntityFileName, sEntityFileName),
self._sArchitectureFileName,
sArchitectureFileName,
),
lExpected1 + lExpected2,
)
def test_both_with_configuration_and_fixed(self):
lActual = (
subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName, self._sArchitectureFileName, "-c", sConfigFile, "--fix"])
.decode("utf-8")
.split("\n")
)
lExpected1 = pathlib.Path(sOutputFileWithConfigFixed).read_text().rstrip("\n").split("\n")
lExpected2 = pathlib.Path(sArchitectureOutputFileWithConfigFixed).read_text().split("\n")
self.assertEqual(
utils.replace_token(
utils.replace_token(utils.replace_total_count(lActual), self._sEntityFileName, sEntityFileName),
self._sArchitectureFileName,
sArchitectureFileName,
),
lExpected1 + lExpected2,
)
def test_junit_output(self):
try:
subprocess.check_output(["bin/vsg", "-f", self._sEntityFileName, "-c", sConfigFile, "-j", self._sJUnitFileName])
except subprocess.CalledProcessError as e:
iExitStatus = e.returncode
lActual = pathlib.Path(self._sJUnitFileName).read_text().split("\n")
lExpected = pathlib.Path(sJUnitFile).read_text().split("\n")
self.assertEqual(iExitStatus, 1)
self.assertEqual(len(lActual), len(lExpected))
for iIndex, sLine in enumerate(lExpected):
if not iIndex == 1:
self.assertEqual(lActual[iIndex].replace(self._sEntityFileName, sEntityFileName), sLine)