• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# -*- coding: utf-8 -*-
2#                     The LLVM Compiler Infrastructure
3#
4# This file is distributed under the University of Illinois Open Source
5# License. See LICENSE.TXT for details.
6
7import libear
8import libscanbuild.runner as sut
9import unittest
10import re
11import os
12import os.path
13
14
15class FilteringFlagsTest(unittest.TestCase):
16
17    def test_language_captured(self):
18        def test(flags):
19            cmd = ['clang', '-c', 'source.c'] + flags
20            opts = sut.classify_parameters(cmd)
21            return opts['language']
22
23        self.assertEqual(None, test([]))
24        self.assertEqual('c', test(['-x', 'c']))
25        self.assertEqual('cpp', test(['-x', 'cpp']))
26
27    def test_arch(self):
28        def test(flags):
29            cmd = ['clang', '-c', 'source.c'] + flags
30            opts = sut.classify_parameters(cmd)
31            return opts['arch_list']
32
33        self.assertEqual([], test([]))
34        self.assertEqual(['mips'], test(['-arch', 'mips']))
35        self.assertEqual(['mips', 'i386'],
36                         test(['-arch', 'mips', '-arch', 'i386']))
37
38    def assertFlagsChanged(self, expected, flags):
39        cmd = ['clang', '-c', 'source.c'] + flags
40        opts = sut.classify_parameters(cmd)
41        self.assertEqual(expected, opts['flags'])
42
43    def assertFlagsUnchanged(self, flags):
44        self.assertFlagsChanged(flags, flags)
45
46    def assertFlagsFiltered(self, flags):
47        self.assertFlagsChanged([], flags)
48
49    def test_optimalizations_pass(self):
50        self.assertFlagsUnchanged(['-O'])
51        self.assertFlagsUnchanged(['-O1'])
52        self.assertFlagsUnchanged(['-Os'])
53        self.assertFlagsUnchanged(['-O2'])
54        self.assertFlagsUnchanged(['-O3'])
55
56    def test_include_pass(self):
57        self.assertFlagsUnchanged([])
58        self.assertFlagsUnchanged(['-include', '/usr/local/include'])
59        self.assertFlagsUnchanged(['-I.'])
60        self.assertFlagsUnchanged(['-I', '.'])
61        self.assertFlagsUnchanged(['-I/usr/local/include'])
62        self.assertFlagsUnchanged(['-I', '/usr/local/include'])
63        self.assertFlagsUnchanged(['-I/opt', '-I', '/opt/otp/include'])
64        self.assertFlagsUnchanged(['-isystem', '/path'])
65        self.assertFlagsUnchanged(['-isystem=/path'])
66
67    def test_define_pass(self):
68        self.assertFlagsUnchanged(['-DNDEBUG'])
69        self.assertFlagsUnchanged(['-UNDEBUG'])
70        self.assertFlagsUnchanged(['-Dvar1=val1', '-Dvar2=val2'])
71        self.assertFlagsUnchanged(['-Dvar="val ues"'])
72
73    def test_output_filtered(self):
74        self.assertFlagsFiltered(['-o', 'source.o'])
75
76    def test_some_warning_filtered(self):
77        self.assertFlagsFiltered(['-Wall'])
78        self.assertFlagsFiltered(['-Wnoexcept'])
79        self.assertFlagsFiltered(['-Wreorder', '-Wunused', '-Wundef'])
80        self.assertFlagsUnchanged(['-Wno-reorder', '-Wno-unused'])
81
82    def test_compile_only_flags_pass(self):
83        self.assertFlagsUnchanged(['-std=C99'])
84        self.assertFlagsUnchanged(['-nostdinc'])
85        self.assertFlagsUnchanged(['-isystem', '/image/debian'])
86        self.assertFlagsUnchanged(['-iprefix', '/usr/local'])
87        self.assertFlagsUnchanged(['-iquote=me'])
88        self.assertFlagsUnchanged(['-iquote', 'me'])
89
90    def test_compile_and_link_flags_pass(self):
91        self.assertFlagsUnchanged(['-fsinged-char'])
92        self.assertFlagsUnchanged(['-fPIC'])
93        self.assertFlagsUnchanged(['-stdlib=libc++'])
94        self.assertFlagsUnchanged(['--sysroot', '/'])
95        self.assertFlagsUnchanged(['-isysroot', '/'])
96
97    def test_some_flags_filtered(self):
98        self.assertFlagsFiltered(['-g'])
99        self.assertFlagsFiltered(['-fsyntax-only'])
100        self.assertFlagsFiltered(['-save-temps'])
101        self.assertFlagsFiltered(['-init', 'my_init'])
102        self.assertFlagsFiltered(['-sectorder', 'a', 'b', 'c'])
103
104
105class Spy(object):
106    def __init__(self):
107        self.arg = None
108        self.success = 0
109
110    def call(self, params):
111        self.arg = params
112        return self.success
113
114
115class RunAnalyzerTest(unittest.TestCase):
116
117    @staticmethod
118    def run_analyzer(content, failures_report):
119        with libear.TemporaryDirectory() as tmpdir:
120            filename = os.path.join(tmpdir, 'test.cpp')
121            with open(filename, 'w') as handle:
122                handle.write(content)
123
124            opts = {
125                'clang': 'clang',
126                'directory': os.getcwd(),
127                'flags': [],
128                'direct_args': [],
129                'file': filename,
130                'output_dir': tmpdir,
131                'output_format': 'plist',
132                'output_failures': failures_report
133            }
134            spy = Spy()
135            result = sut.run_analyzer(opts, spy.call)
136            return (result, spy.arg)
137
138    def test_run_analyzer(self):
139        content = "int div(int n, int d) { return n / d; }"
140        (result, fwds) = RunAnalyzerTest.run_analyzer(content, False)
141        self.assertEqual(None, fwds)
142        self.assertEqual(0, result['exit_code'])
143
144    def test_run_analyzer_crash(self):
145        content = "int div(int n, int d) { return n / d }"
146        (result, fwds) = RunAnalyzerTest.run_analyzer(content, False)
147        self.assertEqual(None, fwds)
148        self.assertEqual(1, result['exit_code'])
149
150    def test_run_analyzer_crash_and_forwarded(self):
151        content = "int div(int n, int d) { return n / d }"
152        (_, fwds) = RunAnalyzerTest.run_analyzer(content, True)
153        self.assertEqual('crash', fwds['error_type'])
154        self.assertEqual(1, fwds['exit_code'])
155        self.assertTrue(len(fwds['error_output']) > 0)
156
157
158class ReportFailureTest(unittest.TestCase):
159
160    def assertUnderFailures(self, path):
161        self.assertEqual('failures', os.path.basename(os.path.dirname(path)))
162
163    def test_report_failure_create_files(self):
164        with libear.TemporaryDirectory() as tmpdir:
165            # create input file
166            filename = os.path.join(tmpdir, 'test.c')
167            with open(filename, 'w') as handle:
168                handle.write('int main() { return 0')
169            uname_msg = ' '.join(os.uname()) + os.linesep
170            error_msg = 'this is my error output'
171            # execute test
172            opts = {
173                'clang': 'clang',
174                'directory': os.getcwd(),
175                'flags': [],
176                'file': filename,
177                'output_dir': tmpdir,
178                'language': 'c',
179                'error_type': 'other_error',
180                'error_output': error_msg,
181                'exit_code': 13
182            }
183            sut.report_failure(opts)
184            # verify the result
185            result = dict()
186            pp_file = None
187            for root, _, files in os.walk(tmpdir):
188                keys = [os.path.join(root, name) for name in files]
189                for key in keys:
190                    with open(key, 'r') as handle:
191                        result[key] = handle.readlines()
192                    if re.match(r'^(.*/)+clang(.*)\.i$', key):
193                        pp_file = key
194
195            # prepocessor file generated
196            self.assertUnderFailures(pp_file)
197            # info file generated and content dumped
198            info_file = pp_file + '.info.txt'
199            self.assertTrue(info_file in result)
200            self.assertEqual('Other Error\n', result[info_file][1])
201            self.assertEqual(uname_msg, result[info_file][3])
202            # error file generated and content dumped
203            error_file = pp_file + '.stderr.txt'
204            self.assertTrue(error_file in result)
205            self.assertEqual([error_msg], result[error_file])
206
207
208class AnalyzerTest(unittest.TestCase):
209
210    def test_nodebug_macros_appended(self):
211        def test(flags):
212            spy = Spy()
213            opts = {'flags': flags, 'force_debug': True}
214            self.assertEqual(spy.success,
215                             sut.filter_debug_flags(opts, spy.call))
216            return spy.arg['flags']
217
218        self.assertEqual(['-UNDEBUG'], test([]))
219        self.assertEqual(['-DNDEBUG', '-UNDEBUG'], test(['-DNDEBUG']))
220        self.assertEqual(['-DSomething', '-UNDEBUG'], test(['-DSomething']))
221
222    def test_set_file_relative_path(self):
223        def test(expected, input):
224            spy = Spy()
225            self.assertEqual(spy.success,
226                             sut.set_file_path_relative(input, spy.call))
227            self.assertEqual(expected, spy.arg['file'])
228
229        test('source.c',
230             {'file': '/home/me/source.c', 'directory': '/home/me'})
231        test('me/source.c',
232             {'file': '/home/me/source.c', 'directory': '/home'})
233        test('../home/me/source.c',
234             {'file': '/home/me/source.c', 'directory': '/tmp'})
235
236    def test_set_language_fall_through(self):
237        def language(expected, input):
238            spy = Spy()
239            input.update({'compiler': 'c', 'file': 'test.c'})
240            self.assertEqual(spy.success, sut.language_check(input, spy.call))
241            self.assertEqual(expected, spy.arg['language'])
242
243        language('c',   {'language': 'c', 'flags': []})
244        language('c++', {'language': 'c++', 'flags': []})
245
246    def test_set_language_stops_on_not_supported(self):
247        spy = Spy()
248        input = {
249            'compiler': 'c',
250            'flags': [],
251            'file': 'test.java',
252            'language': 'java'
253        }
254        self.assertIsNone(sut.language_check(input, spy.call))
255        self.assertIsNone(spy.arg)
256
257    def test_set_language_sets_flags(self):
258        def flags(expected, input):
259            spy = Spy()
260            input.update({'compiler': 'c', 'file': 'test.c'})
261            self.assertEqual(spy.success, sut.language_check(input, spy.call))
262            self.assertEqual(expected, spy.arg['flags'])
263
264        flags(['-x', 'c'],   {'language': 'c', 'flags': []})
265        flags(['-x', 'c++'], {'language': 'c++', 'flags': []})
266
267    def test_set_language_from_filename(self):
268        def language(expected, input):
269            spy = Spy()
270            input.update({'language': None, 'flags': []})
271            self.assertEqual(spy.success, sut.language_check(input, spy.call))
272            self.assertEqual(expected, spy.arg['language'])
273
274        language('c',   {'file': 'file.c',   'compiler': 'c'})
275        language('c++', {'file': 'file.c',   'compiler': 'c++'})
276        language('c++', {'file': 'file.cxx', 'compiler': 'c'})
277        language('c++', {'file': 'file.cxx', 'compiler': 'c++'})
278        language('c++', {'file': 'file.cpp', 'compiler': 'c++'})
279        language('c-cpp-output',   {'file': 'file.i', 'compiler': 'c'})
280        language('c++-cpp-output', {'file': 'file.i', 'compiler': 'c++'})
281
282    def test_arch_loop_sets_flags(self):
283        def flags(archs):
284            spy = Spy()
285            input = {'flags': [], 'arch_list': archs}
286            sut.arch_check(input, spy.call)
287            return spy.arg['flags']
288
289        self.assertEqual([], flags([]))
290        self.assertEqual(['-arch', 'i386'], flags(['i386']))
291        self.assertEqual(['-arch', 'i386'], flags(['i386', 'ppc']))
292        self.assertEqual(['-arch', 'sparc'], flags(['i386', 'sparc']))
293
294    def test_arch_loop_stops_on_not_supported(self):
295        def stop(archs):
296            spy = Spy()
297            input = {'flags': [], 'arch_list': archs}
298            self.assertIsNone(sut.arch_check(input, spy.call))
299            self.assertIsNone(spy.arg)
300
301        stop(['ppc'])
302        stop(['ppc64'])
303
304
305@sut.require([])
306def method_without_expecteds(opts):
307    return 0
308
309
310@sut.require(['this', 'that'])
311def method_with_expecteds(opts):
312    return 0
313
314
315@sut.require([])
316def method_exception_from_inside(opts):
317    raise Exception('here is one')
318
319
320class RequireDecoratorTest(unittest.TestCase):
321
322    def test_method_without_expecteds(self):
323        self.assertEqual(method_without_expecteds(dict()), 0)
324        self.assertEqual(method_without_expecteds({}), 0)
325        self.assertEqual(method_without_expecteds({'this': 2}), 0)
326        self.assertEqual(method_without_expecteds({'that': 3}), 0)
327
328    def test_method_with_expecteds(self):
329        self.assertRaises(KeyError, method_with_expecteds, dict())
330        self.assertRaises(KeyError, method_with_expecteds, {})
331        self.assertRaises(KeyError, method_with_expecteds, {'this': 2})
332        self.assertRaises(KeyError, method_with_expecteds, {'that': 3})
333        self.assertEqual(method_with_expecteds({'this': 0, 'that': 3}), 0)
334
335    def test_method_exception_not_caught(self):
336        self.assertRaises(Exception, method_exception_from_inside, dict())
337