aboutsummaryrefslogtreecommitdiffstats
path: root/python/servo/testing_commands.py
blob: 0a944eb2795fe28dde89babe8752e415cc9345d4 (plain) (blame)
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
from __future__ import print_function, unicode_literals

import argparse
import os
import os.path as path
import subprocess
from time import time

from mach.registrar import Registrar
from mach.decorators import (
    CommandArgument,
    CommandProvider,
    Command,
)

from servo.command_base import CommandBase
import tidy


@CommandProvider
class MachCommands(CommandBase):
    def __init__(self, context):
        CommandBase.__init__(self, context)
        if not hasattr(self.context, "built_tests"):
            self.context.built_tests = False

    def ensure_built_tests(self):
        if self.context.built_tests:
            return
        Registrar.dispatch('build-tests', context=self.context)
        self.context.built_tests = True

    def find_test(self, prefix):
        target_contents = os.listdir(path.join(self.context.topdir, "target"))
        for filename in target_contents:
            if filename.startswith(prefix + "-"):
                filepath = path.join(self.context.topdir, "target", filename)
                if path.isfile(filepath) and os.access(filepath, os.X_OK):
                    return filepath

    def run_test(self, prefix, args=[]):
        t = self.find_test(prefix)
        if t:
            return subprocess.call([t] + args, env=self.build_env())

    def infer_test_by_dir(self, params):
        maybe_path = path.normpath(params[0])
        mach_command = path.join(self.context.topdir, "mach")
        args = None

        if not path.exists(maybe_path):
            print("%s is not a valid file or directory" % maybe_path)
            return 1

        test_dirs = [
            (path.join("tests", "content"), "test-content"),
            (path.join("tests", "wpt"), "test-wpt"),
        ]

        if path.join("tests", "ref") in maybe_path:
            # test-ref is the outcast here in that it does not accept
            # individual files as arguments unless passed through with --name
            args = [mach_command, "test-ref",
                    "--name", maybe_path] + params[1:]
        else:
            for test_dir, test_name in test_dirs:
                if test_dir in maybe_path:
                    args = [mach_command, test_name, maybe_path] + params[1:]
                    break
            else:
                print("%s is not a valid test file or directory" % maybe_path)
                return 1

        return subprocess.call(args, env=self.build_env())

    @Command('test',
             description='Run all Servo tests',
             category='testing')
    @CommandArgument('params', default=None, nargs="...",
                     help="Optionally select test based on "
                          "test file directory")
    def test(self, params):
        if params:
            return self.infer_test_by_dir(params)

        test_start = time()
        for t in ["tidy", "unit", "ref", "content", "wpt"]:
            Registrar.dispatch("test-%s" % t, context=self.context)
        elapsed = time() - test_start

        print("Tests completed in %0.2fs" % elapsed)

    @Command('test-unit',
             description='Run unit tests',
             category='testing')
    @CommandArgument('test_name', default=None, nargs="...",
                     help="Only run tests that match this pattern")
    def test_unit(self, test_name=None):
        if test_name is None:
            test_name = []
        self.ensure_bootstrapped()
        self.ensure_built_tests()

        ret = self.run_test("servo", test_name) != 0

        def cargo_test(component):
            return 0 != subprocess.call(
                ["cargo", "test", "-p", component], env=self.build_env())

        for component in os.listdir("components"):
            ret = ret or cargo_test(component)

        return ret

    @Command('test-ref',
             description='Run the reference tests',
             category='testing')
    @CommandArgument('--kind', '-k', default=None,
                     help="'cpu' or 'gpu' (default both)")
    @CommandArgument('--name', default=None,
                     help="Only run tests that match this pattern. If the "
                          "path to the ref test directory is included, it "
                          "will automatically be trimmed out.")
    @CommandArgument(
        'servo_params', default=None, nargs=argparse.REMAINDER,
        help="Command-line arguments to be passed through to Servo")
    def test_ref(self, kind=None, name=None, servo_params=None):
        self.ensure_bootstrapped()
        self.ensure_built_tests()

        kinds = ["cpu", "gpu"] if kind is None else [kind]
        test_path = path.join(self.context.topdir, "tests", "ref")
        error = False

        test_start = time()
        for k in kinds:
            print("Running %s reftests..." % k)
            test_args = [k, test_path]
            if name is not None:
                maybe_path = path.normpath(name)
                ref_path = path.join("tests", "ref")

                # Check to see if we were passed something leading with the
                # path to the ref test directory, and trim it so that reftest
                # knows how to filter it.
                if ref_path in maybe_path:
                    test_args.append(path.relpath(maybe_path, ref_path))
                else:
                    test_args.append(name)
            if servo_params is not None:
                test_args += ["--"] + servo_params
            ret = self.run_test("reftest", test_args)
            error = error or ret != 0
        elapsed = time() - test_start

        print("Reference tests completed in %0.2fs" % elapsed)

        if error:
            return 1

    @Command('test-content',
             description='Run the content tests',
             category='testing')
    @CommandArgument('test_name', default=None, nargs="?",
                     help="Only run tests that match this pattern")
    def test_content(self, test_name=None):
        self.ensure_bootstrapped()
        self.ensure_built_tests()

        test_path = path.join(self.context.topdir, "tests", "content")
        test_args = ["--source-dir=%s" % test_path]

        if test_name is not None:
            test_args.append(test_name)

        test_start = time()
        ret = self.run_test("contenttest", test_args)
        elapsed = time() - test_start

        print("Content tests completed in %0.2fs" % elapsed)
        return ret

    @Command('test-tidy',
             description='Run the source code tidiness check',
             category='testing')
    def test_tidy(self):
        return tidy.scan()

    @Command('test-wpt',
             description='Run the web platform tests',
             category='testing')
    @CommandArgument(
        'params', default=None, nargs='...',
        help="Command-line arguments to be passed through to wpt/run.sh")
    def test_wpt(self, params=None):
        if params is None:
            params = []
        else:
            # Allow the first argument to be a relative path from Servo's root
            # directory, converting it to `--include some/wpt/test.html`
            maybe_path = path.normpath(params[0])
            wpt_path = path.join('tests', 'wpt', 'web-platform-tests')

            if path.exists(maybe_path) and wpt_path in maybe_path:
                params = ["--include",
                          path.relpath(maybe_path, wpt_path)] + params[1:]

        return subprocess.call(
            ["bash", path.join("tests", "wpt", "run.sh")] + params,
            env=self.build_env())