summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Scanner/ScannerTests.py
blob: d9882a69bd1f64d0b3f909d07d682a5a23c922f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
#
# __COPYRIGHT__
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#

__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"

import unittest
import SCons.Scanner
import sys

class ScannerTestBase:
    
    def func(self, filename, env, target, *args):
        self.filename = filename
        self.env = env
        self.target = target

        if len(args) > 0:
            self.arg = args[0]
        
        return self.deps


    def test(self, scanner, env, filename, deps, *args):
        self.deps = deps
        path = scanner.path(env)
        scanned = scanner(filename, env, path)
        scanned_strs = map(lambda x: str(x), scanned)

        self.failUnless(self.filename == filename, "the filename was passed incorrectly")
        self.failUnless(self.env == env, "the environment was passed incorrectly")
        self.failUnless(scanned_strs == deps, "the dependencies were returned incorrectly")
        for d in scanned:
            self.failUnless(type(d) != type(""), "got a string in the dependencies")

        if len(args) > 0:
            self.failUnless(self.arg == args[0], "the argument was passed incorrectly")
        else:
            self.failIf(hasattr(self, "arg"), "an argument was given when it shouldn't have been")

class DummyEnvironment:
    pass


class ScannerPositionalTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class using the position argument"
    def runTest(self):
        s = SCons.Scanner.Base(self.func, "Pos")
        env = DummyEnvironment()
        env.VARIABLE = "var1"
        self.test(s, env, 'f1.cpp', ['f1.h', 'f1.hpp'])

        env = DummyEnvironment()
        env.VARIABLE = "i1"
        self.test(s, env, 'i1.cpp', ['i1.h', 'i1.hpp'])

class ScannerKeywordTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class using the keyword argument"
    def runTest(self):
        s = SCons.Scanner.Base(function = self.func, name = "Key")
        env = DummyEnvironment()
        env.VARIABLE = "var2"
        self.test(s, env, 'f2.cpp', ['f2.h', 'f2.hpp'])

        env = DummyEnvironment()
        env.VARIABLE = "i2"
        self.test(s, env, 'i2.cpp', ['i2.h', 'i2.hpp'])

class ScannerPositionalArgumentTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class using both position and optional arguments"
    def runTest(self):
        arg = "this is the argument"
        s = SCons.Scanner.Base(self.func, "PosArg", arg)
        env = DummyEnvironment()
        env.VARIABLE = "var3"
        self.test(s, env, 'f3.cpp', ['f3.h', 'f3.hpp'], arg)

        env = DummyEnvironment()
        env.VARIABLE = "i3"
        self.test(s, env, 'i3.cpp', ['i3.h', 'i3.hpp'], arg)

class ScannerKeywordArgumentTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class using both keyword and optional arguments"
    def runTest(self):
        arg = "this is another argument"
        s = SCons.Scanner.Base(function = self.func, name = "KeyArg",
                               argument = arg)
        env = DummyEnvironment()
        env.VARIABLE = "var4"
        self.test(s, env, 'f4.cpp', ['f4.h', 'f4.hpp'], arg)

        env = DummyEnvironment()
        env.VARIABLE = "i4"
        self.test(s, env, 'i4.cpp', ['i4.h', 'i4.hpp'], arg)

class ScannerHashTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class __hash__() method"
    def runTest(self):
        s = SCons.Scanner.Base(self.func, "Hash")
        dict = {}
        dict[s] = 777
        self.failUnless(hash(dict.keys()[0]) == hash(repr(s)),
                        "did not hash Scanner base class as expected")

class ScannerCheckTestCase(unittest.TestCase):
    "Test the Scanner.Base class scan_check method"
    def setUp(self):
        self.checked = {}
    def runTest(self):
        def my_scan(filename, env, target, *args):
            return []
        def check(node, s=self):
            s.checked[node] = 1
            return 1
        env = DummyEnvironment()
        s = SCons.Scanner.Base(my_scan, "Check", scan_check = check)
        path = s.path(env)
        scanned = s('x', env, path)
        self.failUnless(self.checked['x'] == 1,
                        "did not call check function")

class ScannerRecursiveTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Base class recursive flag"
    def runTest(self):
        s = SCons.Scanner.Base(function = self.func)
        self.failUnless(s.recursive == None,
                        "incorrect default recursive value")
        s = SCons.Scanner.Base(function = self.func, recursive = None)
        self.failUnless(s.recursive == None,
                        "did not set recursive flag to None")
        s = SCons.Scanner.Base(function = self.func, recursive = 1)
        self.failUnless(s.recursive == 1,
                        "did not set recursive flag to 1")

class CurrentTestCase(ScannerTestBase, unittest.TestCase):
    "Test the Scanner.Current class"
    def runTest(self):
        class MyNode:
            def __init__(self):
                self.called_has_builder = None
                self.called_current = None
                self.func_called = None
        class HasNoBuilder(MyNode):
            def has_builder(self):
                self.called_has_builder = 1
                return None
        class IsNotCurrent(MyNode):
            def has_builder(self):
                self.called_has_builder = 1
                return 1
            def current(self, sig):
                self.called_current = 1
                return None
        class IsCurrent(MyNode):
            def has_builder(self):
                self.called_has_builder = 1
                return 1
            def current(self, sig):
                self.called_current = 1
                return 1
        def func(node, env, path):
            node.func_called = 1
            return []
        env = DummyEnvironment()
        s = SCons.Scanner.Current(func)
        path = s.path(env)
        hnb = HasNoBuilder()
        s(hnb, env, path)
        self.failUnless(hnb.called_has_builder, "did not call has_builder()")
        self.failUnless(not hnb.called_current, "did call current()")
        self.failUnless(hnb.func_called, "did not call func()")
        inc = IsNotCurrent()
        s(inc, env, path)
        self.failUnless(inc.called_has_builder, "did not call has_builder()")
        self.failUnless(inc.called_current, "did not call current()")
        self.failUnless(not inc.func_called, "did call func()")
        ic = IsCurrent()
        s(ic, env, path)
        self.failUnless(ic.called_has_builder, "did not call has_builder()")
        self.failUnless(ic.called_current, "did not call current()")
        self.failUnless(ic.func_called, "did not call func()")

def suite():
    suite = unittest.TestSuite()
    suite.addTest(ScannerPositionalTestCase())
    suite.addTest(ScannerKeywordTestCase())
    suite.addTest(ScannerPositionalArgumentTestCase())
    suite.addTest(ScannerKeywordArgumentTestCase())
    suite.addTest(ScannerHashTestCase())
    suite.addTest(ScannerCheckTestCase())
    suite.addTest(ScannerRecursiveTestCase())
    suite.addTest(CurrentTestCase())
    return suite

if __name__ == "__main__":
    runner = unittest.TextTestRunner()
    result = runner.run(suite())
    if not result.wasSuccessful():
        sys.exit(1)