|
| 1 | +"""pytest configuration for the addon tests. |
| 2 | +
|
| 3 | +The tests exercise addons/cppcheckdata.py against dump files that are |
| 4 | +generated on the fly with the cppcheck binary given by --cppcheck-binary. |
| 5 | +""" |
| 6 | +import os |
| 7 | +import shutil |
| 8 | +import subprocess |
| 9 | +import sys |
| 10 | + |
| 11 | +import pytest |
| 12 | + |
| 13 | +# Make 'import cppcheckdata' resolve to <repo>/addons/cppcheckdata.py |
| 14 | +_ADDONS_DIR = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', '..', 'addons')) |
| 15 | +if _ADDONS_DIR not in sys.path: |
| 16 | + sys.path.insert(0, _ADDONS_DIR) |
| 17 | + |
| 18 | + |
| 19 | +def pytest_addoption(parser): |
| 20 | + parser.addoption('--cppcheck-binary', |
| 21 | + default='cppcheck', |
| 22 | + help='path to the cppcheck binary used to generate dump files ' |
| 23 | + '(default: cppcheck found in PATH)') |
| 24 | + |
| 25 | + |
| 26 | +@pytest.fixture(scope='session') |
| 27 | +def cppcheck_binary(request): |
| 28 | + binary = request.config.getoption('--cppcheck-binary') |
| 29 | + resolved = shutil.which(binary) |
| 30 | + if resolved is None: |
| 31 | + pytest.fail("cppcheck binary '%s' not found - point --cppcheck-binary at a cppcheck executable" % binary) |
| 32 | + return os.path.abspath(resolved) |
| 33 | + |
| 34 | + |
| 35 | +class DumpFactory: |
| 36 | + """Runs 'cppcheck --dump' on a source snippet and parses the result.""" |
| 37 | + |
| 38 | + def __init__(self, binary, tmp_path_factory): |
| 39 | + self.binary = binary |
| 40 | + self.tmp_path_factory = tmp_path_factory |
| 41 | + |
| 42 | + def create(self, code, filename='test.c', extra_args=()): |
| 43 | + """Write the code to a file, dump it and return the dump file path.""" |
| 44 | + directory = self.tmp_path_factory.mktemp('cppcheckdata') |
| 45 | + path = directory / filename |
| 46 | + path.write_text(code) |
| 47 | + cmd = [self.binary, '--dump', '--quiet', str(path)] + list(extra_args) |
| 48 | + proc = subprocess.run(cmd, |
| 49 | + stdout=subprocess.PIPE, |
| 50 | + stderr=subprocess.PIPE, |
| 51 | + check=True, |
| 52 | + universal_newlines=True) |
| 53 | + assert proc.returncode == 0, \ |
| 54 | + 'cppcheck failed with exit code %d:\n%s\n%s' % (proc.returncode, proc.stdout, proc.stderr) |
| 55 | + return str(path) + '.dump' |
| 56 | + |
| 57 | + def parse(self, code, filename='test.c', extra_args=()): |
| 58 | + """Write the code to a file, dump it and return the parsed CppcheckData.""" |
| 59 | + import cppcheckdata |
| 60 | + return cppcheckdata.parsedump(self.create(code, filename, extra_args)) |
| 61 | + |
| 62 | + |
| 63 | +@pytest.fixture(scope='session') |
| 64 | +def dump_factory(cppcheck_binary, tmp_path_factory): |
| 65 | + return DumpFactory(cppcheck_binary, tmp_path_factory) |
| 66 | + |
| 67 | + |
| 68 | +SAMPLE_C = """#define ANSWER 42 |
| 69 | +static int add(int a, int b) |
| 70 | +{ |
| 71 | + return a + b; |
| 72 | +} |
| 73 | +
|
| 74 | +double half(double d) |
| 75 | +{ |
| 76 | + return d / 2.0; |
| 77 | +} |
| 78 | +
|
| 79 | +int main(void) |
| 80 | +{ |
| 81 | + int x = ANSWER; |
| 82 | + int arr[10]; |
| 83 | + arr[0] = add(x, 1); |
| 84 | + int neg = -x; |
| 85 | + return arr[0] + neg; |
| 86 | +} |
| 87 | +""" |
| 88 | + |
| 89 | +SAMPLE_CPP = """namespace ns { |
| 90 | + int twice(int v) { return 2 * v; } |
| 91 | +} |
| 92 | +
|
| 93 | +class Shape { |
| 94 | +public: |
| 95 | + virtual ~Shape() {} |
| 96 | + virtual double area() const = 0; |
| 97 | +protected: |
| 98 | + double mScale; |
| 99 | +}; |
| 100 | +
|
| 101 | +enum Color { RED, GREEN }; |
| 102 | +
|
| 103 | +const int limit = 5; |
| 104 | +bool flag = true; |
| 105 | +const char *msg = "hello"; |
| 106 | +char ch = 'x'; |
| 107 | +
|
| 108 | +int run() |
| 109 | +{ |
| 110 | + Color color = RED; |
| 111 | + if (flag && limit > 1) { |
| 112 | + return ns::twice(21); |
| 113 | + } |
| 114 | + return static_cast<int>(color); |
| 115 | +} |
| 116 | +""" |
| 117 | + |
| 118 | +MULTI_CFG_C = """typedef int myint; |
| 119 | +typedef float myfloat; |
| 120 | +#if defined(FOO) && FOO > 1 |
| 121 | +int foo(void) { return 1; } |
| 122 | +#endif |
| 123 | +myint bar(void) { myint y = 3; return y; } |
| 124 | +""" |
| 125 | + |
| 126 | +MATCH_C = """struct Point { |
| 127 | + int x; |
| 128 | + int y; |
| 129 | +}; |
| 130 | +
|
| 131 | +int calc(int a, int b) |
| 132 | +{ |
| 133 | + int bit_or = a | b; |
| 134 | + int log_or = a || b; |
| 135 | + int mod = a % b; |
| 136 | + int mul = a * b; |
| 137 | + int not_a = !a; |
| 138 | + int neq = a != b; |
| 139 | + int arr[3]; |
| 140 | + arr[0] = a; |
| 141 | + a += 1; |
| 142 | + if (a > b) { |
| 143 | + return a; |
| 144 | + } |
| 145 | + return calc(a, b); |
| 146 | +} |
| 147 | +""" |
| 148 | + |
| 149 | +MATCH_CPP = """class Widget {}; |
| 150 | +
|
| 151 | +bool use(int i, int j) |
| 152 | +{ |
| 153 | + std::vector<int> v; |
| 154 | + bool less = i < j; |
| 155 | + return less && v.empty(); |
| 156 | +} |
| 157 | +""" |
| 158 | + |
| 159 | + |
| 160 | +@pytest.fixture(scope='session') |
| 161 | +def sample_data(dump_factory): |
| 162 | + """Parsed dump of the canonical C sample.""" |
| 163 | + return dump_factory.parse(SAMPLE_C, filename='sample.c') |
| 164 | + |
| 165 | + |
| 166 | +@pytest.fixture(scope='session') |
| 167 | +def sample_cfg(sample_data): |
| 168 | + cfgs = sample_data.configurations |
| 169 | + assert len(cfgs) == 1 |
| 170 | + return cfgs[0] |
| 171 | + |
| 172 | + |
| 173 | +@pytest.fixture(scope='session') |
| 174 | +def sample_cpp_data(dump_factory): |
| 175 | + """Parsed dump of the canonical C++ sample.""" |
| 176 | + return dump_factory.parse(SAMPLE_CPP, filename='sample.cpp') |
| 177 | + |
| 178 | + |
| 179 | +@pytest.fixture(scope='session') |
| 180 | +def sample_cpp_cfg(sample_cpp_data): |
| 181 | + cfgs = sample_cpp_data.configurations |
| 182 | + assert len(cfgs) == 1 |
| 183 | + return cfgs[0] |
| 184 | + |
| 185 | + |
| 186 | +@pytest.fixture(scope='session') |
| 187 | +def multi_cfg_data(dump_factory): |
| 188 | + """Parsed dump of a file with two preprocessor configurations.""" |
| 189 | + return dump_factory.parse(MULTI_CFG_C, filename='multi.c') |
| 190 | + |
| 191 | + |
| 192 | +@pytest.fixture(scope='session') |
| 193 | +def match_cfg(dump_factory): |
| 194 | + """Configuration of a C sample covering the match() pattern syntax.""" |
| 195 | + return dump_factory.parse(MATCH_C, filename='match.c').configurations[0] |
| 196 | + |
| 197 | + |
| 198 | +@pytest.fixture(scope='session') |
| 199 | +def match_cpp_cfg(dump_factory): |
| 200 | + """Configuration of a C++ sample with linked '<' tokens for match().""" |
| 201 | + return dump_factory.parse(MATCH_CPP, filename='match.cpp').configurations[0] |
0 commit comments