summaryrefslogtreecommitdiff
path: root/SCons/DefaultsTests.py
blob: c9a6663116a465b7d79fe5196c9899a9dcb15bff (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
# MIT License
#
# Copyright The SCons Foundation
#
# 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.

import os
import unittest
import collections

import TestCmd

from SCons.Defaults import mkdir_func, _defines, processDefines


class DummyEnvironment(collections.UserDict):
    def __init__(self, **kwargs):
        super().__init__()
        self.data.update(kwargs)

    def subst(self, str_subst, target=None, source=None, conv=None):
        if str_subst[0] == '$':
            return self.data[str_subst[1:]]
        return str_subst

    def subst_list(self, str_subst, target=None, source=None, conv=None):
        if str_subst[0] == '$':
            return [self.data[str_subst[1:]]]
        return [[str_subst]]


class DefaultsTestCase(unittest.TestCase):
    def test_mkdir_func0(self):
        test = TestCmd.TestCmd(workdir='')
        test.subdir('sub')
        subdir2 = test.workpath('sub', 'dir1', 'dir2')
        # Simple smoke test
        mkdir_func(subdir2)
        mkdir_func(subdir2)  # 2nd time should be OK too

    def test_mkdir_func1(self):
        test = TestCmd.TestCmd(workdir='')
        test.subdir('sub')
        subdir1 = test.workpath('sub', 'dir1')
        subdir2 = test.workpath('sub', 'dir1', 'dir2')
        # No error if asked to create existing dir
        os.makedirs(subdir2)
        mkdir_func(subdir2)
        mkdir_func(subdir1)

    def test_mkdir_func2(self):
        test = TestCmd.TestCmd(workdir='')
        test.subdir('sub')
        subdir1 = test.workpath('sub', 'dir1')
        subdir2 = test.workpath('sub', 'dir1', 'dir2')
        file = test.workpath('sub', 'dir1', 'dir2', 'file')

        # make sure it does error if asked to create a dir
        # where there's already a file
        os.makedirs(subdir2)
        test.write(file, "test\n")
        try:
            mkdir_func(file)
        except OSError as e:
            pass
        else:
            self.fail("expected OSError")

    def test__defines_no_target_or_source_arg(self):
        """
        Verify that _defines() function can handle either or neither source or
        target being specified
        """
        env = DummyEnvironment()

        with self.subTest():
            # Neither source or target specified
            x = _defines('-D', ['A', 'B', 'C'], 'XYZ', env)
            self.assertEqual(x, ['-DAXYZ', '-DBXYZ', '-DCXYZ'])

        with self.subTest():
            # only source specified
            y = _defines('-D', ['AA', 'BA', 'CA'], 'XYZA', env, 'XYZ')
            self.assertEqual(y, ['-DAAXYZA', '-DBAXYZA', '-DCAXYZA'])

        with self.subTest():
            # source and target specified
            z = _defines('-D', ['AAB', 'BAB', 'CAB'], 'XYZAB', env, 'XYZ', 'abc')
            self.assertEqual(z, ['-DAABXYZAB', '-DBABXYZAB', '-DCABXYZAB'])

    def test_processDefines(self):
        """Verify correct handling in processDefines."""
        env = DummyEnvironment()

        with self.subTest():
            # macro name only
            rv = processDefines('name')
            self.assertEqual(rv, ['name'])

        with self.subTest():
            # macro with value
            rv = processDefines('name=val')
            self.assertEqual(rv, ['name=val'])

        with self.subTest():
            # space-separated macros
            rv = processDefines('name1 name2=val2')
            self.assertEqual(rv, ['name1', 'name2=val2'])

        with self.subTest():
            # single list
            rv = processDefines(['name', 'val'])
            self.assertEqual(rv, ['name', 'val'])

        with self.subTest():
            # single tuple
            rv = processDefines(('name', 'val'))
            self.assertEqual(rv, ['name=val'])

        with self.subTest():
            # single dict
            rv = processDefines({'foo': None, 'name': 'val'})
            self.assertEqual(rv, ['foo', 'name=val'])

        with self.subTest():
            # compound list
            rv = processDefines(['foo', ('name', 'val'), ['name2', 'val2']])
            self.assertEqual(rv, ['foo', 'name=val', 'name2=val2'])


if __name__ == "__main__":
    unittest.main()

# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4: