GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

BrowserBundleTests.pm 35.1 KB
Newer Older
1
package TBBTestSuite::TestSuite::BrowserBundleTests;
2 3 4

use warnings;
use strict;
boklm's avatar
boklm committed
5 6 7

use parent 'TBBTestSuite::TestSuite';

8 9 10 11 12 13 14
use English;
use FindBin;
use File::Slurp;
use File::Spec;
use File::Find;
use File::Type;
use File::Copy;
15
use File::Temp;
16 17 18
use JSON;
use Digest::SHA qw(sha256_hex);
use LWP::UserAgent;
boklm's avatar
boklm committed
19
use IO::CaptureOutput qw(capture_exec);
20
use TBBTestSuite::Common qw(exit_error winpath clone_strip_coderef screenshot_thumbnail);
21 22
use TBBTestSuite::Options qw($options);
use TBBTestSuite::Tests::VirusTotal qw(virustotal_run);
23
use TBBTestSuite::Tests::Command qw(command_run);
24
use TBBTestSuite::Tests::TorBootstrap;
boklm's avatar
boklm committed
25
use TBBTestSuite::XServer qw(start_X stop_X set_Xmode);
26

boklm's avatar
boklm committed
27 28 29
sub test_types {
    return {
        tor_bootstrap => \&TBBTestSuite::Tests::TorBootstrap::start_tor,
30
        marionette    => \&marionette_run,
boklm's avatar
boklm committed
31 32 33 34
        virustotal    => \&virustotal_run,
        command       => \&command_run,
    };
}
35

boklm's avatar
boklm committed
36 37 38
sub type {
    'browserbundle';
}
39

boklm's avatar
boklm committed
40 41 42
sub description {
    'Tor Browser Bundle integration tests';
}
43

44
our @tests = (
boklm's avatar
boklm committed
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
    {
        name         => 'win_DEP_ASLR',
        type         => 'command',
        retry        => 1,
        descr        => 'Check DEP/ASLR',
        files        => \&tbb_binfiles,
        command      => [ "$FindBin::Bin/data/check-windows-dep-aslr.sh" ],
        enable       => sub { $_[0]->{os} eq 'Windows' },
        # ticket 16417
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/_ctypes.pyd
            TorBrowser/Tor/PluggableTransports/_hashlib.pyd
            TorBrowser/Tor/PluggableTransports/_socket.pyd
            TorBrowser/Tor/PluggableTransports/_ssl.pyd
            TorBrowser/Tor/PluggableTransports/bz2.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Cipher._AES.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Hash._SHA256.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Hash._SHA512.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Random.OSRNG.winrandom.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Util._counter.pyd
            TorBrowser/Tor/PluggableTransports/Crypto.Util.strxor.pyd
            TorBrowser/Tor/PluggableTransports/flashproxy-client.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-appspot.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-email.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-http.exe
            TorBrowser/Tor/PluggableTransports/flashproxy-reg-url.exe
            TorBrowser/Tor/PluggableTransports/fte.cDFA.pyd
            TorBrowser/Tor/PluggableTransports/fteproxy.exe
            TorBrowser/Tor/PluggableTransports/M2Crypto.__m2crypto.pyd
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser.exe
            TorBrowser/Tor/PluggableTransports/meek-client.exe
            TorBrowser/Tor/PluggableTransports/obfs4proxy.exe
            TorBrowser/Tor/PluggableTransports/obfsproxy.exe
            TorBrowser/Tor/PluggableTransports/pyexpat.pyd
            TorBrowser/Tor/PluggableTransports/python27.dll
            TorBrowser/Tor/PluggableTransports/select.pyd
            TorBrowser/Tor/PluggableTransports/terminateprocess-buffer.exe
            TorBrowser/Tor/PluggableTransports/unicodedata.pyd
            TorBrowser/Tor/PluggableTransports/w9xpopen.exe
            TorBrowser/Tor/PluggableTransports/zope.interface._zope_interface_coptimizations.pyd
            ) ],
    },
87
    {
boklm's avatar
boklm committed
88 89 90 91 92 93 94 95
        name            => 'readelf_RELRO',
        type            => 'command',
        descr           => 'Check if binaries are RELocation Read-Only',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-ld' ],
        check_output    => sub { ( $_[0] =~ m/GNU_RELRO/ )
                                 && ( $_[0] =~ m/BIND_NOW/ ) },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
96 97 98 99 100
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
boklm's avatar
boklm committed
101
            TorBrowser/Tor/PluggableTransports/zope/interface/_zope_interface_coptimizations.so
boklm's avatar
boklm committed
102
            ) ],
103 104
    },
    {
boklm's avatar
boklm committed
105 106 107 108 109 110 111
        name            => 'readelf_stack_canary',
        type            => 'command',
        descr           => 'Check for stack canary support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-s' ],
        check_output    => sub { $_[0] =~ m/__stack_chk_fail/ },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
112 113
        # ticket 13056
        skip_files   => [ qw(
114 115
            abicheck
            gtk2/libmozgtk.so
boklm's avatar
boklm committed
116
            libmozalloc.so
117
            libmozgtk.so
boklm's avatar
boklm committed
118 119 120
            libnssckbi.so
            libplc4.so
            libplds4.so
121
            TorBrowser/Tor/libstdc++/libstdc++.so.6
boklm's avatar
boklm committed
122 123 124 125 126 127 128 129 130 131 132 133
            TorBrowser/Tor/PluggableTransports/Crypto/Cipher/_ARC4.so
            TorBrowser/Tor/PluggableTransports/Crypto/Cipher/_XOR.so
            TorBrowser/Tor/PluggableTransports/Crypto/Util/_counter.so
            TorBrowser/Tor/PluggableTransports/fte/cDFA.so
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/twisted/python/_initgroups.so
            TorBrowser/Tor/PluggableTransports/twisted/runner/portmap.so
            TorBrowser/Tor/PluggableTransports/twisted/test/raiser.so
            TorBrowser/Tor/PluggableTransports/zope/interface/_zope_interface_coptimizations.so
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
134 135
    },
    {
boklm's avatar
boklm committed
136 137 138 139 140 141 142
        name            => 'readelf_NX',
        type            => 'command',
        descr           => 'Check for NX support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-W', '-l' ],
        check_output    => sub { ! ($_[0] =~ m/GNU_STACK.+RWE/) },
        enable          => sub { $OSNAME eq 'linux' },
143 144
    },
    {
boklm's avatar
boklm committed
145 146 147 148 149 150 151
        name            => 'readelf_PIE',
        type            => 'command',
        descr           => 'Check for PIE support',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-h' ],
        check_output    => sub { $_[0] =~ m/Type:\s+DYN/ },
        enable          => sub { $OSNAME eq 'linux' },
boklm's avatar
boklm committed
152 153 154 155
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
156
            TorBrowser/Tor/PluggableTransports/snowflake-client
boklm's avatar
boklm committed
157
            ) ],
158 159
    },
    {
boklm's avatar
boklm committed
160 161 162 163 164 165 166
        name            => 'readelf_no_rpath',
        type            => 'command',
        descr           => 'Check for no rpath',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-d' ],
        check_output    => sub { ! ( $_[0] =~ m/RPATH/ ) },
        enable          => sub { $OSNAME eq 'linux' },
167 168
    },
    {
boklm's avatar
boklm committed
169 170 171 172 173 174 175
        name            => 'readelf_no_runpath',
        type            => 'command',
        descr           => 'Check for no runpath',
        files           => \&tbb_binfiles,
        command         => [ 'readelf', '-d' ],
        check_output    => sub { ! ( $_[0] =~ m/runpath/ ) },
        enable          => sub { $OSNAME eq 'linux' },
176
    },
boklm's avatar
boklm committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    {
        name            => 'otool_PIE',
        type            => 'command',
        descr           => 'Check for PIE support',
        files           => \&tbb_osx_executable_files,
        command         => [ 'otool', '-hv' ],
        check_output    => sub {
            my @lines = split("\n", $_[0]);
            my $last_line = pop @lines;
            my ($flags) = $last_line =~ m/^\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+(.*)/;
            my %flags = map { $_ => 1 } split(/\s+/, $flags);
            return $flags{PIE};
        },
        enable          => sub { $OSNAME eq 'darwin' },
        retry           => 1,
boklm's avatar
boklm committed
192 193 194 195 196
        skip_files   => [ qw(
            Contents/MacOS/Tor/PluggableTransports/meek-client
            Contents/MacOS/Tor/PluggableTransports/meek-client-torbrowser
            Contents/MacOS/Tor/PluggableTransports/obfs4proxy
            ) ],
boklm's avatar
boklm committed
197
    },
198
    {
boklm's avatar
boklm committed
199 200 201 202 203
        name            => 'tor_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
204
        run_once        => 1,
205 206
    },
    {
boklm's avatar
boklm committed
207 208 209
        name            => 'tor_bridge',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge',
210
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
211
        run_once        => 1,
212 213
    },
    {
boklm's avatar
boklm committed
214 215 216 217
        name            => 'tor_bridge_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge and an http proxy',
        httpproxy       => 1,
218
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
219
        run_once        => 1,
220
    },
221
    {
boklm's avatar
boklm committed
222 223 224
        name            => 'tor_obfs4',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4',
225
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
226
        run_once        => 1,
227 228
    },
    {
boklm's avatar
boklm committed
229 230 231 232
        name            => 'tor_obfs4_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4 and an http proxy',
        httpproxy       => 1,
233
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
234
        run_once        => 1,
235
    },
236 237 238 239
    {
        name            => 'tor_meek-azure',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-azure',
240
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
241
        run_once        => 1,
242
    },
243
    {
boklm's avatar
boklm committed
244 245 246 247 248
        name            => 'tor_bootstrap',
        type            => 'tor_bootstrap',
        descr           => 'Check that we can bootstrap tor',
        fail_type       => 'fatal',
        no_kill         => 1,
249 250 251
        use_default_config => 1,
    },
    {
boklm's avatar
boklm committed
252
        name            => 'screenshots',
253
        type            => 'marionette',
boklm's avatar
boklm committed
254
        descr           => 'Take some screenshots',
255 256
    },
    {
boklm's avatar
boklm committed
257
        name            => 'check',
258
        type            => 'marionette',
boklm's avatar
boklm committed
259 260
        use_net         => 1,
        descr           => 'Check that http://check.torproject.org/ think we are using tor',
261 262
    },
    {
boklm's avatar
boklm committed
263
        name            => 'https-everywhere-disabled',
264 265
        marionette_test => 'https-everywhere',
        type            => 'marionette',
boklm's avatar
boklm committed
266 267
        descr           => 'Check that https everywhere is not doing anything when disabled',
        use_net         => 1,
boklm's avatar
boklm committed
268 269 270 271 272 273 274 275 276 277 278 279
        pre             => sub {
            my ($tbbinfos, $t) = @_;
            my $hdir = "$tbbinfos->{tmpdir}/https-everywhere";
            mkdir "$hdir";
            move($tbbinfos->{ffprofiledir} . '/extensions/https-everywhere-eff@eff.org.xpi',
                $hdir . '/https-everywhere-eff@eff.org.xpi');
        },
        post            => sub {
            my ($tbbinfos, $t) = @_;
            my $hdir = "$tbbinfos->{tmpdir}/https-everywhere";
            move($hdir . '/https-everywhere-eff@eff.org.xpi',
                $tbbinfos->{ffprofiledir} . '/extensions/https-everywhere-eff@eff.org.xpi');
boklm's avatar
boklm committed
280
        },
281
    },
boklm's avatar
boklm committed
282 283 284 285 286
    {
        name            => 'https-everywhere',
        type            => 'marionette',
        use_net         => 1,
        descr           => 'Check that https everywhere is working',
287 288
        # Bug 30431: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
289
    },
290
    {
boklm's avatar
boklm committed
291
        name            => 'settings',
292
        type            => 'marionette',
boklm's avatar
boklm committed
293
        descr           => 'Check that some important settings are correctly set',
294
    },
boklm's avatar
boklm committed
295
    {
boklm's avatar
boklm committed
296
        name            => 'acid3',
boklm's avatar
boklm committed
297
        type            => 'marionette',
boklm's avatar
boklm committed
298 299
        descr           => 'acid3 tests',
        use_net         => 1,
boklm's avatar
boklm committed
300
        retry           => 4,
boklm's avatar
boklm committed
301 302
        # the acid3 test is disabled for now
        enable          => sub { 0; },
boklm's avatar
boklm committed
303
    },
boklm's avatar
boklm committed
304
    {
boklm's avatar
boklm committed
305
        name            => 'slider_settings_1',
306 307
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
308 309 310 311
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 1,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
312 313
    },
    {
boklm's avatar
boklm committed
314
        name            => 'slider_settings_2',
315 316
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
317 318 319 320
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 2,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
321 322
    },
    {
boklm's avatar
boklm committed
323
        name            => 'slider_settings_4',
324 325
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
326 327 328 329
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 4,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
330
    },
boklm's avatar
boklm committed
331
    {
boklm's avatar
boklm committed
332
        name            => 'dom-objects-enumeration',
333
        type            => 'marionette',
boklm's avatar
boklm committed
334
        descr           => 'Check the list of DOM Objects exposed in the global namespace',
boklm's avatar
boklm committed
335
    },
336 337 338 339 340
    {
        name            => 'dom-objects-enumeration-worker',
        type            => 'marionette',
        descr           => 'Check the list of DOM Objects exposed in a Worker context',
    },
341
    {
boklm's avatar
boklm committed
342
        name            => 'navigation-timing',
343
        type            => 'marionette',
boklm's avatar
boklm committed
344 345
        descr           => 'Check that the Navigation Timing API is really disabled',
        use_net         => 1,
346
    },
347
    {
boklm's avatar
boklm committed
348
        name            => 'resource-timing',
349
        type            => 'marionette',
350
        descr           => 'Check that the Resource Timing API is really disabled',
boklm's avatar
boklm committed
351
        use_net         => 1,
352 353
        # To check that the test fails when resource timing is enabled,
        # uncomment this:
354 355
        #prefs           => {
        #    'dom.enable_resource_timing' => 'true',
356
        #    'privacy.resistFingerprinting' => 'false',
357 358 359 360 361 362 363 364 365 366
        #},
    },
    {
        name            => 'user-timing',
        type            => 'marionette',
        descr           => 'Check that the User Timing API is really disabled',
        use_net         => 1,
        # To check that the test fails when user timing is enabled,
        # uncomment this:
        #prefs           => {
367
        #    'dom.enable_user_timing' => 'true',
boklm's avatar
boklm committed
368
        #    'privacy.resistFingerprinting' => 'false',
369
        #},
370
    },
371 372 373 374 375 376 377 378 379 380 381 382
    {
        name            => 'user-timing-worker',
        type            => 'marionette',
        marionette_test => 'page',
        remote          => 0,
        timeout         => 500,
        descr           => 'Check that the User Timing API in Worker context is really disabled',
        use_net         => 1,
        # To check that the test fails when user timing is enabled,
        # uncomment this:
        #prefs           => {
        #    'dom.enable_user_timing' => 'true',
383
        #    'privacy.resistFingerprinting' => 'false',
384 385
        #},
    },
386 387 388 389 390 391 392 393 394 395
    {
        name            => 'performance-observer',
        type            => 'marionette',
        descr           => 'Check that the Performance Observer API is really disabled',
        use_net         => 1,
        # To check that the test fails when performance observer is enabled,
        # uncomment this:
        #prefs           => {
        #    'dom.enable_performance_observer' => 'true',
        #},
396 397
        # Bug 27137: temporarily disable test
        enable          => sub { undef },
398
    },
399
    {
boklm's avatar
boklm committed
400
        name            => 'searchengines',
401
        type            => 'marionette',
boklm's avatar
boklm committed
402
        descr           => 'Check that we have the default search engines set',
403 404
        # Bug 30340: temporarily disable test
        enable          => sub { undef },
405
    },
boklm's avatar
boklm committed
406
    {
boklm's avatar
boklm committed
407
        name            => 'noscript',
408
        type            => 'marionette',
boklm's avatar
boklm committed
409 410 411
        descr           => 'Check that noscript options are working',
        use_net         => 1,
        prefs           => {
412
            'extensions.torbutton.security_slider' => 2,
boklm's avatar
boklm committed
413
        },
414 415
        # Bug 28876: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
416
    },
boklm's avatar
boklm committed
417
    {
boklm's avatar
boklm committed
418
        name            => 'fp_screen_dimensions',
419
        type            => 'marionette',
boklm's avatar
boklm committed
420
        descr           => 'Check that screen dimensions are spoofed correctly',
421 422
    },
    {
boklm's avatar
boklm committed
423
        name            => 'fp_screen_coords',
424
        type            => 'marionette',
boklm's avatar
boklm committed
425
        descr           => 'Check that screenX, screenY, screenLeft, screenTop, mozInnerScreenX, mozInnerScreenY are 0',
426 427
    },
    {
boklm's avatar
boklm committed
428
        name            => 'fp_plugins',
429
        type            => 'marionette',
boklm's avatar
boklm committed
430
        descr           => 'Check that plugins are disabled',
431 432
    },
    {
boklm's avatar
boklm committed
433
        name            => 'fp_useragent',
434
        type            => 'marionette',
boklm's avatar
boklm committed
435
        descr           => 'Check that userAgent is as expected',
436 437
    },
    {
boklm's avatar
boklm committed
438
        name            => 'fp_navigator',
439
        type            => 'marionette',
boklm's avatar
boklm committed
440
        descr           => 'Check that navigator properties are as expected',
441 442
        # Bug 28665: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
443 444 445
    },
    {
        name            => 'play_videos',
446
        type            => 'marionette',
boklm's avatar
boklm committed
447 448
        descr           => 'Play some videos',
        use_net         => 1,
449
        marionette_test => 'page',
boklm's avatar
boklm committed
450 451
        remote          => 1,
        timeout         => 50000,
452 453
        # Bug 30339: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
454 455 456
    },
    {
        name            => 'svg-disable',
boklm's avatar
boklm committed
457
        type            => 'marionette',
boklm's avatar
boklm committed
458
        descr           => 'Check if disabling svg is working',
boklm's avatar
boklm committed
459
        marionette_test => 'svg',
boklm's avatar
boklm committed
460 461
        use_net         => 1,
        prefs           => {
462 463 464
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'false',
        },
465
        # Bug 28798: temporarily disable test
466
        enable          => sub { undef },
467
        #enable          => sub { $OSNAME eq 'linux' },
468 469
    },
    {
boklm's avatar
boklm committed
470
        name            => 'svg-enable',
boklm's avatar
boklm committed
471
        type            => 'marionette',
boklm's avatar
boklm committed
472
        descr           => 'Check if enabling svg is working',
boklm's avatar
boklm committed
473
        marionette_test => 'svg',
boklm's avatar
boklm committed
474 475
        use_net         => 1,
        prefs           => {
476 477 478
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'true',
        },
479
        # Bug 28798: temporarily disable test
480
        enable          => sub { undef },
481
        #enable          => sub { $OSNAME eq 'linux' },
482
    },
483 484 485 486 487
    {
        name            => 'download_pdf',
        type            => 'marionette',
        descr           => 'Check if download of PDF is working (#19402)',
        use_net         => 1,
488
        # Bug 30333: temporarily disable test
489
        enable          => sub { undef },
490
    },
boklm's avatar
boklm committed
491 492 493 494 495 496 497
    {
        name            => 'pinning_now',
        type            => 'marionette',
        descr           => 'Check if static public key pinning is working (#20149)',
        marionette_test => 'pinning',
        use_net         => 1,
    },
boklm's avatar
boklm committed
498 499 500 501
    {
        name            => 'fpcentral',
        type            => 'marionette',
        descr           => 'Check the browser fingerprint using fpcentral',
boklm's avatar
boklm committed
502
        fpcentral_url   => 'https://fpcentral.tbb.torproject.org/fp?automated_test',
boklm's avatar
boklm committed
503
        use_net         => 1,
504 505
        # Bug 30432: temporarily disable test
        enable          => sub { undef },
boklm's avatar
boklm committed
506
    },
507 508
);

509 510 511
sub set_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
512
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
513 514 515
    copy $prefs, "$prefs.backup";
    my $new_prefs = '';
    foreach my $prefname (sort keys %{$t->{prefs}}) {
516
        $new_prefs .= "user_pref(\"$prefname\", $t->{prefs}{$prefname});\n";
517 518 519 520 521 522 523
    }
    write_file($prefs, {append => 1}, $new_prefs);
}

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
524
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
525 526 527
    move "$prefs.backup", $prefs;
}

boklm's avatar
boklm committed
528 529
sub set_slider_mode {
    my ($tbbinfos, $t) = @_;
530
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
531 532
    copy $prefs, "$prefs.slider_backup";
    write_file($prefs, {append => 1},
533 534
      'user_pref("extensions.torbutton.security_custom", false);' . "\n" .
      "user_pref(\"extensions.torbutton.security_slider\", $t->{slider_mode});\n");
boklm's avatar
boklm committed
535 536 537 538
}

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
539
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
540 541 542
    move "$prefs.slider_backup", $prefs;
}

543 544 545
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
546
    my %binfiles;
547 548 549 550
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
551 552 553
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
554
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
555 556 557
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
558 559 560 561 562
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
sub tbb_osx_executable_files {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{osx_executable_files} if $tbbinfos->{osx_executable_files};
    my %exec_files;
    my $wanted = sub {
        return unless -f $File::Find::name;
        $ENV{LC_ALL}= 'C';
        my ($out, $err, $success) = capture_exec('otool', '-hv', $File::Find::name);
        return unless $success;
        my @out_lines = split("\n", $out);
        return if $out_lines[0] =~ m/is not an object file/;
        my $last_line = pop @out_lines;
        my ($type) = $last_line =~ m/^\s*[^\s]+\s+[^\s]+\s+[^\s]+\s+[^\s]+\s+([^\s]+)\s+[^\s]+\s+[^\s]+\s+/;
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $exec_files{$name} = 1 if $type eq 'EXECUTE';
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{osx_executable_files} = [ keys %exec_files ];
}

584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
sub list_tests {
    foreach my $test (@tests) {
        print "$test->{name} ($test->{type})\n   $test->{descr}\n\n";
    }
}

sub get_tbbfile {
    my ($tbbinfos) = @_;
    $tbbinfos->{tbbfile_orig} = $tbbinfos->{tbbfile};
    if ($tbbinfos->{tbbfile} =~ m/^https?:\/\//) {
        my (undef, undef, $file) = File::Spec->splitpath($tbbinfos->{tbbfile});
        my $output = $options->{'download-dir'} ?
                "$options->{'download-dir'}/$file" : "$tbbinfos->{tmpdir}/$file";
        return $output if -f $output;
        print "Downloading $tbbinfos->{tbbfile}\n";
        my $ua = LWP::UserAgent->new;
        my $resp = $ua->get($tbbinfos->{tbbfile}, ':content_file' => $output);
        exit_error "Error downloading $tbbinfos->{tbbfile}:\n" . $resp->status_line
                unless $resp->is_success;
        $tbbinfos->{tbbfile} = $output;
    }
    exit_error "File $tbbinfos->{tbbfile} does not exist"
                unless -f $tbbinfos->{tbbfile};
}

sub extract_tbb {
    my ($tbbinfos) = @_;
    exit_error "Can't open file $tbbinfos->{tbbfile}" unless -f $tbbinfos->{tbbfile};
    my $tbbfile = File::Spec->rel2abs($tbbinfos->{tbbfile});
    my $tmpdir = $tbbinfos->{tmpdir};
    chdir $tmpdir;
    if ($tbbinfos->{os} eq 'Linux') {
        system('tar', 'xf', $tbbfile);
617 618 619 620 621
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
622
        $tbbinfos->{tbbdir} .= '/Browser';
623 624 625 626
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
627
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
628 629 630 631 632
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
633
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
634
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
635 636 637 638 639 640
    } elsif ($tbbinfos->{os} eq 'MacOSX') {
        my $mountpoint = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
        system('hdiutil', 'mount', '-mountpoint', $mountpoint, $tbbfile);
        system('cp', '-a', "$mountpoint/TorBrowser.app", "$tmpdir/TorBrowser.app");
        system('hdiutil', 'unmount', $mountpoint);
        $tbbinfos->{tbbdir} = "$tmpdir/TorBrowser.app";
641 642 643 644 645 646 647 648 649 650 651 652 653
    }
}

sub xvfb_run {
    my ($test) = @_;
    return () unless $options->{xvfb};
    my $resolution = $test->{resolution} ? $test->{resolution}
                                         : $options->{resolution};
    return ('xvfb-run', '--auto-servernum', '-s', "-screen 0 ${resolution}x24");
}

sub check_opened_connections {
    my ($tbbinfos, $test) = @_;
654 655 656 657 658 659
    my %bad_connections =  %{$test->{results}{connections}};
    delete $bad_connections{"127.0.0.1:$options->{'tor-control-port'}"};
    delete $bad_connections{"127.0.0.1:$options->{'tor-socks-port'}"};
    # For some reasons, tor-browser creates two connections to the default
    # socks port even when when TOR_SOCKS_PORT is set
    # https://lists.torproject.org/pipermail/tbb-dev/2014-May/000050.html
boklm's avatar
boklm committed
660 661 662 663
    if (defined $bad_connections{'127.0.0.1:9150'}
        && $bad_connections{'127.0.0.1:9150'} <= 2) {
        delete $bad_connections{'127.0.0.1:9150'}
    }
664 665 666 667
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
668
    $test->{clean_strace} //= !%bad_connections;
669
    $test->{results}{bad_connections} = \%bad_connections;
670 671 672 673
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
674
    my @bad_modified_files = @{$test->{results}{modified_files}};
675 676 677 678
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
679
    $test->{clean_strace} //= !@bad_modified_files;
680 681 682
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

683 684
sub clean_strace {
    my ($tbbinfos, $test) = @_;
685
    return unless $test->{clean_strace};
686 687
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
688
    unlink "$logfile.tmp";
689 690
}

691 692 693
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
694
    my @ignore_re = ( qr/^\/dev\/(dri)|(shm)/ );
695
    push @ignore_re, qr/^$test->{workspace}/ if $test->{workspace};
696 697 698 699 700
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
701 702 703 704 705
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
706
    my @lines = read_file($logfile) if -f $logfile;
707
    LINE: foreach my $line (@lines) {
708 709 710 711 712
        if ($line =~ m/^\d+ open\("((?:[^"\\]++|\\.)*+)", ([^\)]+)/ ||
            $line =~ m/^\d+ openat\([^,]+, "((?:[^"\\]++|\\.)*+)", ([^\)]+)/) {
            next if $2 =~ m/O_RDONLY/;
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
            next if $ignore_files{$1};
713 714 715
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
716 717 718
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
719 720 721 722
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
723 724 725 726
            next if $ignore_files{$1};
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
727 728 729
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
boklm's avatar
boklm committed
730
        if ($line =~ m/^\d+ connect\(\d+, \{sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
731
            $test->{results}{connections}{"$2:$1"}++;
732 733
        }
    }
734 735
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
736 737 738 739 740 741 742 743 744
}

sub ff_wrapper {
    my ($tbbinfos, $test) = @_;
    my $wrapper_file = "$tbbinfos->{tbbdir}/ff_wrapper";
    return $wrapper_file if -f $wrapper_file;
    my $wrapper = <<EOF;
#!/bin/sh
set -e
745
export HOME="$tbbinfos->{tbbdir}"
746
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
747 748
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
749 750 751 752 753 754 755
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

756
sub ff_strace_wrapper {
757 758
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
759
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
760 761
    my $wrapper = <<EOF;
#!/bin/sh
762 763 764 765 766 767
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
768
strace -e trace=file,network -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
769 770 771 772
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
773 774 775 776 777 778 779 780 781 782 783 784
EOF
    my $wrapper_file = "$tbbinfos->{tbbdir}/ff_$test->{name}";
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

sub ffbin_path {
    my ($tbbinfos, $test) = @_;
    if ($OSNAME eq 'cygwin') {
        return winpath("$tbbinfos->{ffbin}.exe");
    }
785
    my %t = map { $_ => 1 } qw(marionette);
786
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
787 788
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
789
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
790
    return ff_wrapper($tbbinfos, $test);
791 792
}

793 794 795 796 797 798 799 800 801 802 803 804
sub marionette_export_options {
    my ($tbbinfos, $test) = @_;
    my $options_file = File::Temp->new();
    my $json = {
        options  => clone_strip_coderef($options),
        test     => clone_strip_coderef($test),
        tbbinfos => clone_strip_coderef({ %$tbbinfos, tests => undef }),
    };
    write_file($options_file, encode_json($json));
    return $options_file;
}

805 806 807 808 809 810 811
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

812 813
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
814 815
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
816 817
    $test->{workspace} = "$tbbinfos->{'results-dir'}/$test->{name}_ws";
    mkdir $test->{workspace};
818 819
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
820
    my $marionette_test = $test->{marionette_test} // $test->{name};
821
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
822 823 824 825
    my $old_pypath = $ENV{PYTHONPATH};
    $ENV{PYTHONPATH} = winpath("$FindBin::Bin/marionette/tor_browser_tests/lib");
    my $sep = $OSNAME eq 'cygwin' ? ';' : ':';
    $ENV{PYTHONPATH} .= $sep . $old_pypath if $old_pypath;
826 827 828
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
829
    system(xvfb_run($test), "$FindBin::Bin/virtualenv-marionette-5.0.0/$bin/tor-browser-tests",
830 831 832 833
        '--log-unittest', winpath($result_file_txt),
        '--log-html', winpath($result_file_html),
        '--binary', ffbin_path($tbbinfos, $test),
        '--profile', winpath($tbbinfos->{ffprofiledir}),
834
        $OSNAME eq 'cygwin' ? () : ('--workspace', $test->{workspace}),
835
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
836
    $ENV{PYTHONPATH} = $pypath;
837
    my @txt_log = -f $result_file_txt ? read_file($result_file_txt) : ('NoFile');
838 839 840
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
841 842 843
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
844
        screenshot_thumbnail($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
845 846 847
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
848 849 850 851
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
852
    clean_strace($tbbinfos, $test);
853 854
}

855 856
sub set_tbbpaths {
    my ($tbbinfos) = @_;
857 858 859
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
860 861
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
862 863 864 865 866 867 868 869 870
        unless ($tbbinfos->{version} =~ m/^5./) {
            $tbbinfos->{ffprofiledir} = "$tbbinfos->{tbbdir}/Contents/Resources/distribution";
            $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/Contents/Resources/TorBrowser/Tor";
            $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/../TorBrowser-data";
            $tbbinfos->{torrcdefaults} = "$tbbinfos->{tordir}/torrc-defaults";
            $tbbinfos->{torgeoip} = "$tbbinfos->{tordir}/geoip";
            mkdir $tbbinfos->{datadir} unless -d $tbbinfos->{datadir};
            mkdir "$tbbinfos->{datadir}/Tor" unless -d "$tbbinfos->{datadir}/Tor";
        }
boklm's avatar
boklm committed
871
    }
872 873
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
874
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
875
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
876
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
877 878
}

boklm's avatar
boklm committed
879 880 881 882
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
883 884
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
885 886 887
    return bless $testsuite, $ts;
}

888 889 890 891 892 893 894 895 896 897
sub pre_tests {
    my ($tbbinfos) = @_;
    get_tbbfile($tbbinfos);
    if ($tbbinfos->{sha256sum} &&
        $tbbinfos->{sha256sum} ne sha256_hex(read_file($tbbinfos->{tbbfile}))) {
        exit_error "Wrong sha256sum for $tbbinfos->{tbbfile}";
    }
    $tbbinfos->{sha256sum} //= sha256_hex(read_file($tbbinfos->{tbbfile}));
    extract_tbb($tbbinfos);
    set_tbbpaths($tbbinfos);
898
    my $prefs_file = "$tbbinfos->{ffprofiledir}/user.js";
899
    open(my $prefs_fh, '>>', $prefs_file);
900
    print $prefs_fh 'user_pref("privacy.spoof_english", 1);', "\n";
901
    close $prefs_fh;