File: test_mach_commands.py

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (298 lines) | stat: -rw-r--r-- 11,294 bytes parent folder | download
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
#!/usr/bin/env python
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

import os
import sys
import unittest
from unittest import mock

from mach.registrar import Registrar
from mozunit import main

# Ensure testing category is registered before importing mach_commands
Registrar.categories["testing"] = []
Registrar.commands_by_category["testing"] = set()
Registrar.register_category("testing", "testing", "testing")

# Add parent directory to path to import mach_commands
sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
from mach_commands import (
    classname_for_test,
    flavor_for_test,
    project_for_ac,
    project_for_test,
)


class TestAndroidMachCommands(unittest.TestCase):
    TEST_CASES = [
        # (test_path, expected_project, expected_component, expected_flavor, expected_class)
        (
            "mobile/android/geckoview/src/test/java/org/mozilla/gecko/util/GeckoBundleTest.java",
            "geckoview",
            None,
            "unit",
            "org.mozilla.gecko.util.GeckoBundleTest",
        ),
        (
            "mobile/android/android-components/components/concept/engine/src/test/java/mozilla/components/concept/engine/EngineTest.kt",
            "android-components",
            "concept-engine",
            "unit",
            "mozilla.components.concept.engine.EngineTest",
        ),
        (
            "mobile/android/android-components/components/browser/engine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineTest.kt",
            "android-components",
            "browser-engine-gecko",
            "unit",
            "mozilla.components.browser.engine.gecko.GeckoEngineTest",
        ),
        (
            "mobile/android/fenix/app/src/test/java/org/mozilla/fenix/home/HomeFragmentTest.kt",
            "fenix",
            None,
            "unit",
            "org.mozilla.fenix.home.HomeFragmentTest",
        ),
        (
            "mobile/android/focus-android/app/src/test/java/org/mozilla/focus/components/EngineProviderTest.kt",
            "focus-android",
            None,
            "unit",
            "org.mozilla.focus.components.EngineProviderTest",
        ),
        (
            "mobile/android/fenix/app/src/androidTest/java/org/mozilla/fenix/components/MenuItemTest.kt",
            "fenix",
            None,
            "android",
            "org.mozilla.fenix.components.MenuItemTest",
        ),
    ]

    def cleanup_gradle_args(self, args):
        """Given a list of arguments for a gradle invocation, remove those that are not
        interesting for this test suite to simplify matching."""
        IGNORE = ["-q", "--rerun"]
        return [x for x in args if x not in IGNORE]

    def test_classname_for_test(self):
        """Test extraction of class name from test path."""
        TEST_PATH_PREFIX = "src/test/java"
        ANDROIDTEST_PATH_PREFIX = "src/androidTest/java"
        for test_path, _, _, _, expected in self.TEST_CASES:
            with self.subTest(test_path=test_path):
                if flavor_for_test(test_path) == "unit":
                    result = classname_for_test(test_path, TEST_PATH_PREFIX)
                else:
                    result = classname_for_test(test_path, ANDROIDTEST_PATH_PREFIX)
                self.assertEqual(result, expected)

    def test_project_for_test(self):
        """Test extraction of project name from test path."""
        PROJECT_PREFIX = "mobile/android"

        for test_path, expected, _, _, _ in self.TEST_CASES:
            with self.subTest(project=expected):
                result = project_for_test(test_path, PROJECT_PREFIX)
                self.assertEqual(result, expected)

    def test_project_for_ac(self):
        """Test extraction of android-components subproject name."""
        COMPONENT_PREFIX = "mobile/android/android-components/components"
        TEST_PATH_PREFIX = "src/test/java"
        for test_path, project, expected, _, _ in self.TEST_CASES:
            if project != "android-components":
                continue
            with self.subTest(component=expected):
                result = project_for_ac(test_path, COMPONENT_PREFIX, TEST_PATH_PREFIX)
                self.assertEqual(result, expected)

    def test_flavor_for_test(self):
        """Test extraction of test flavor from test path."""
        for test_path, _, _, expected, _ in self.TEST_CASES:
            with self.subTest(flavor=expected):
                result = flavor_for_test(test_path)
                self.assertEqual(result, expected)

    def test_android_test_implicit_subproject(self):
        """Test that run_android_test derives subproject if a specific test is requested."""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = command_context._mach_context.commands.dispatch = (
            mock.MagicMock(return_value=0)
        )

        TEST_PATH = "mobile/android/focus-android/app/src/test/java/org/mozilla/focus/components/EngineProviderTest.kt"
        run_android_test(command_context, subproject=None, test=TEST_PATH)

        mock_dispatch.assert_called_once()
        gradle_args = mock_dispatch.call_args[1]["args"]
        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            [
                "-p",
                "mobile/android/focus-android/app",
                "testFocusDebugUnitTest",
                "--tests",
                "org.mozilla.focus.components.EngineProviderTest",
            ],
        )

    def test_run_android_test_fenix(self):
        """Test that run_android_test calls dispatch with correct arguments for fenix."""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = command_context._mach_context.commands.dispatch = (
            mock.MagicMock(return_value=0)
        )

        run_android_test(
            command_context,
            subproject="fenix",
        )

        mock_dispatch.assert_called_once()
        gradle_args = mock_dispatch.call_args[1]["args"]

        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            ["-p", "mobile/android/fenix/app", "testDebugUnitTest"],
        )

    def test_run_android_test_androidTest(self):
        """Test that run_android_test can run instrumented test types."""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = command_context._mach_context.commands.dispatch = (
            mock.MagicMock(return_value=0)
        )

        TEST_PATH = "mobile/android/fenix/app/src/androidTest/java/org/mozilla/fenix/components/MenuItemTest.kt"
        run_android_test(
            command_context,
            subproject=None,
            test=TEST_PATH,
        )

        mock_dispatch.assert_called_once()
        gradle_args = mock_dispatch.call_args[1]["args"]

        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            [
                "-p",
                "mobile/android/fenix/app",
                "connectedDebugAndroidTest",
                "-Pandroid.testInstrumentationRunnerArguments.class=org.mozilla.fenix.components.MenuItemTest",
            ],
        )

    def test_run_android_test_gradle_variant(self):
        """Test that run_android_test handles --gradle-variant."""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = command_context._mach_context.commands.dispatch = (
            mock.MagicMock(return_value=0)
        )

        run_android_test(
            command_context,
            subproject="geckoview",
            gradle_variant="Release",
        )

        mock_dispatch.assert_called_once()
        gradle_args = mock_dispatch.call_args[1]["args"]

        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            ["-p", "mobile/android/geckoview", "testReleaseUnitTest"],
        )

    def test_run_android_test_flavor(self):
        """Test that run_android_test handles --flavor."""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = command_context._mach_context.commands.dispatch = (
            mock.MagicMock(return_value=0)
        )

        run_android_test(
            command_context,
            subproject="geckoview",
            flavor="both",
        )

        mock_dispatch.assert_called_once()
        gradle_args = mock_dispatch.call_args[1]["args"]

        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            [
                "-p",
                "mobile/android/geckoview",
                "testDebugUnitTest",
                "connectedDebugAndroidTest",
            ],
        )

    def test_run_android_test_with_multi_component(self):
        """Test that multiple android-component tests resolve the their component projects"""
        from mach_commands import run_android_test

        command_context = mock.MagicMock()
        mock_dispatch = mock.MagicMock(return_value=0)
        command_context._mach_context.commands.dispatch = mock_dispatch

        test_objects = [
            {
                "name": "mobile/android/android-components/components/concept/engine/src/test/java/mozilla/components/concept/engine/EngineTest.kt",
            },
            {
                "name": "mobile/android/android-components/components/concept/engine/src/test/java/mozilla/components/concept/engine/EngineViewTest.kt",
            },
            {
                "name": "mobile/android/android-components/components/browser/engine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineTest.kt",
            },
            {
                "name": "mobile/android/android-components/components/browser/engine-gecko/src/androidTest/java/mozilla/components/browser/engine/gecko/fetch/geckoview/GeckoViewFetchTestCases.kt",
            },
        ]

        run_android_test(
            command_context,
            subproject="android-components",
            test_objects=test_objects,
        )

        gradle_args = mock_dispatch.call_args[1]["args"]
        self.assertEqual(
            self.cleanup_gradle_args(gradle_args),
            [
                "-p",
                "mobile/android/android-components",
                ":components:concept-engine:testDebugUnitTest",
                ":components:browser-engine-gecko:testDebugUnitTest",
                "--tests",
                "mozilla.components.concept.engine.EngineTest",
                "--tests",
                "mozilla.components.concept.engine.EngineViewTest",
                "--tests",
                "mozilla.components.browser.engine.gecko.GeckoEngineTest",
                ":components:browser-engine-gecko:connectedDebugAndroidTest",
                "-Pandroid.testInstrumentationRunnerArguments.class=mozilla.components.browser.engine.gecko.fetch.geckoview.GeckoViewFetchTestCases",
            ],
        )


if __name__ == "__main__":
    main()