summaryrefslogtreecommitdiff
path: root/SCons/Tool/MSCommon/MSVC/WinSDKTests.py
blob: 10e68f3d6e7b6a52285d39066cd9661b7a3b367e (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
# 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.

"""
Test Windows SDK functions for Microsoft Visual C/C++.
"""

import unittest

from SCons.Tool.MSCommon.MSVC import Config
from SCons.Tool.MSCommon.MSVC import WinSDK
from SCons.Tool.MSCommon.MSVC import Registry
from SCons.Tool.MSCommon.MSVC.Exceptions import MSVCInternalError

class Patch:

    class Config:

        class MSVC_SDK_VERSIONS:

            MSVC_SDK_VERSIONS = Config.MSVC_SDK_VERSIONS

            @classmethod
            def enable_copy(cls):
                hook = set(cls.MSVC_SDK_VERSIONS)
                Config.MSVC_SDK_VERSIONS = hook
                return hook

            @classmethod
            def restore(cls) -> None:
                Config.MSVC_SDK_VERSIONS = cls.MSVC_SDK_VERSIONS

    class Registry:

        class sdk_query_paths:

            sdk_query_paths = Registry.sdk_query_paths

            @classmethod
            def sdk_query_paths_duplicate(cls, version):
                sdk_roots = cls.sdk_query_paths(version)
                sdk_roots = sdk_roots + sdk_roots if sdk_roots else sdk_roots
                return sdk_roots

            @classmethod
            def enable_duplicate(cls):
                hook = cls.sdk_query_paths_duplicate
                Registry.sdk_query_paths = hook
                return hook

            @classmethod
            def restore(cls) -> None:
                Registry.sdk_query_paths = cls.sdk_query_paths

class WinSDKTests(unittest.TestCase):

    @classmethod
    def setUpClass(cls) -> None:
        Patch.Registry.sdk_query_paths.enable_duplicate()

    @classmethod
    def tearDownClass(cls) -> None:
        Patch.Registry.sdk_query_paths.restore()

    def test_verify(self) -> None:
        MSVC_SDK_VERSIONS = Patch.Config.MSVC_SDK_VERSIONS.enable_copy()
        MSVC_SDK_VERSIONS.add('99.0')
        with self.assertRaises(MSVCInternalError):
            WinSDK.verify()
        Patch.Config.MSVC_SDK_VERSIONS.restore()

    def _run_reset(self) -> None:
        WinSDK.reset()
        self.assertFalse(WinSDK._sdk_map_cache, "WinSDK._sdk_map_cache was not reset")
        self.assertFalse(WinSDK._sdk_cache, "WinSDK._sdk_cache was not reset")

    def _run_get_msvc_sdk_version_list(self) -> None:
        for vcver in Config.MSVC_VERSION_SUFFIX.keys():
            for msvc_uwp_app in (True, False):
                _ = WinSDK.get_msvc_sdk_version_list(vcver, msvc_uwp_app=msvc_uwp_app)

    def _run_version_list_sdk_map(self) -> None:
        for vcver in Config.MSVC_VERSION_SUFFIX.keys():
            vs_def = Config.MSVC_VERSION_SUFFIX.get(vcver)
            if not vs_def.vc_sdk_versions:
                continue
            _ = WinSDK._version_list_sdk_map(vs_def.vc_sdk_versions)

    def test_version_list_sdk_map(self) -> None:
        self._run_version_list_sdk_map()
        self._run_version_list_sdk_map()
        self.assertTrue(WinSDK._sdk_map_cache, "WinSDK._sdk_map_cache is empty")

    def test_get_msvc_sdk_version_list(self) -> None:
        self._run_get_msvc_sdk_version_list()
        self._run_get_msvc_sdk_version_list()
        self.assertTrue(WinSDK._sdk_cache, "WinSDK._sdk_cache is empty")

    def test_get_msvc_sdk_version_list_empty(self) -> None:
        func = WinSDK.get_msvc_sdk_version_list
        for vcver in [None, '', '99', '99.9']:
            sdk_versions = func(vcver)
            self.assertFalse(sdk_versions, "{}: sdk versions list was not empty for msvc version {}".format(
                func.__name__, repr(vcver)
            ))

    def test_reset(self) -> None:
        self._run_reset()

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