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.3 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 101
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
102 103
    },
    {
boklm's avatar
boklm committed
104 105 106 107 108 109 110
        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
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
        # ticket 13056
        skip_files   => [ qw(
            libmozalloc.so
            libnssckbi.so
            libplc4.so
            libplds4.so
            TorBrowser/Tor/libstdc++.so.6
            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
            ) ],
130 131
    },
    {
boklm's avatar
boklm committed
132 133 134 135 136 137 138
        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' },
139 140
    },
    {
boklm's avatar
boklm committed
141 142 143 144 145 146 147
        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
148 149 150 151 152
        skip_files   => [ qw(
            TorBrowser/Tor/PluggableTransports/meek-client
            TorBrowser/Tor/PluggableTransports/meek-client-torbrowser
            TorBrowser/Tor/PluggableTransports/obfs4proxy
            ) ],
153 154
    },
    {
boklm's avatar
boklm committed
155 156 157 158 159 160 161
        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' },
162 163
    },
    {
boklm's avatar
boklm committed
164 165 166 167 168 169 170
        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' },
171
    },
boklm's avatar
boklm committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    {
        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,
    },
188
    {
boklm's avatar
boklm committed
189 190 191 192 193
        name            => 'tor_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
194
        run_once        => 1,
195 196
    },
    {
boklm's avatar
boklm committed
197 198 199
        name            => 'tor_bridge',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge',
200
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
201
        run_once        => 1,
202 203
    },
    {
boklm's avatar
boklm committed
204 205 206 207
        name            => 'tor_bridge_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge and an http proxy',
        httpproxy       => 1,
208
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
209
        run_once        => 1,
210 211
    },
    {
boklm's avatar
boklm committed
212 213 214
        name            => 'tor_obfs3',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3',
215
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
216
        run_once        => 1,
217 218
    },
    {
boklm's avatar
boklm committed
219 220 221 222
        name            => 'tor_obfs3_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3 and an http proxy',
        httpproxy       => 1,
223
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
224
        run_once        => 1,
225
    },
226
    {
boklm's avatar
boklm committed
227 228 229
        name            => 'tor_obfs4',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4',
230
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
231
        run_once        => 1,
232 233
    },
    {
boklm's avatar
boklm committed
234 235 236 237
        name            => 'tor_obfs4_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4 and an http proxy',
        httpproxy       => 1,
238
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
239
        run_once        => 1,
240
    },
241
    {
boklm's avatar
boklm committed
242 243 244
        name            => 'tor_fte',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy',
245
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
246
        run_once        => 1,
247 248
    },
    {
boklm's avatar
boklm committed
249 250 251 252
        name            => 'tor_fte_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy and an http proxy',
        httpproxy       => 1,
253
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
254
        run_once        => 1,
255
    },
256 257 258 259
    {
        name            => 'tor_scramblesuit',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit',
260
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
261
        run_once        => 1,
262 263 264 265 266 267
    },
    {
        name            => 'tor_scramblesuit_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit and an http proxy',
        httpproxy       => 1,
268
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
269
        run_once        => 1,
270
    },
271 272 273 274
    {
        name            => 'tor_meek-amazon',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-amazon',
275
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
276
        run_once        => 1,
277 278 279 280 281
    },
    {
        name            => 'tor_meek-azure',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-azure',
282
        enable          => sub { $OSNAME eq 'linux' && $options->{PTtests} },
283
        run_once        => 1,
284
    },
285
    {
boklm's avatar
boklm committed
286 287 288 289 290
        name            => 'tor_bootstrap',
        type            => 'tor_bootstrap',
        descr           => 'Check that we can bootstrap tor',
        fail_type       => 'fatal',
        no_kill         => 1,
291 292 293
        use_default_config => 1,
    },
    {
boklm's avatar
boklm committed
294
        name            => 'screenshots',
295
        type            => 'marionette',
boklm's avatar
boklm committed
296
        descr           => 'Take some screenshots',
297 298
    },
    {
boklm's avatar
boklm committed
299
        name            => 'check',
300
        type            => 'marionette',
boklm's avatar
boklm committed
301 302
        use_net         => 1,
        descr           => 'Check that http://check.torproject.org/ think we are using tor',
303 304
    },
    {
boklm's avatar
boklm committed
305
        name            => 'https-everywhere',
306
        type            => 'marionette',
boklm's avatar
boklm committed
307 308
        use_net         => 1,
        descr           => 'Check that https everywhere is enabled and working',
309 310
    },
    {
boklm's avatar
boklm committed
311
        name            => 'https-everywhere-disabled',
312 313
        marionette_test => 'https-everywhere',
        type            => 'marionette',
boklm's avatar
boklm committed
314 315
        descr           => 'Check that https everywhere is not doing anything when disabled',
        use_net         => 1,
boklm's avatar
boklm committed
316 317 318
        prefs           => {
            'extensions.https_everywhere.globalEnabled' => 'false',
        },
319 320
    },
    {
boklm's avatar
boklm committed
321
        name            => 'settings',
322
        type            => 'marionette',
boklm's avatar
boklm committed
323
        descr           => 'Check that some important settings are correctly set',
324
    },
boklm's avatar
boklm committed
325
    {
boklm's avatar
boklm committed
326
        name            => 'acid3',
boklm's avatar
boklm committed
327
        type            => 'marionette',
boklm's avatar
boklm committed
328 329
        descr           => 'acid3 tests',
        use_net         => 1,
boklm's avatar
boklm committed
330
        retry           => 4,
boklm's avatar
boklm committed
331 332
        # the acid3 test is disabled for now
        enable          => sub { 0; },
boklm's avatar
boklm committed
333
    },
boklm's avatar
boklm committed
334
    {
boklm's avatar
boklm committed
335
        name            => 'slider_settings_1',
336 337
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
338 339 340 341
        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
342 343
    },
    {
boklm's avatar
boklm committed
344
        name            => 'slider_settings_2',
345 346
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
347 348 349 350
        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
351 352
    },
    {
boklm's avatar
boklm committed
353
        name            => 'slider_settings_3',
354 355
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
356 357
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 3,
358
        enable          => sub { $_[0]->{version} =~ m/^6.0/ },
boklm's avatar
boklm committed
359 360
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
boklm's avatar
boklm committed
361 362
    },
    {
boklm's avatar
boklm committed
363
        name            => 'slider_settings_4',
364 365
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
366 367 368 369
        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
370
    },
boklm's avatar
boklm committed
371
    {
boklm's avatar
boklm committed
372
        name            => 'dom-objects-enumeration',
373
        type            => 'marionette',
boklm's avatar
boklm committed
374
        descr           => 'Check the list of DOM Objects exposed in the global namespace',
boklm's avatar
boklm committed
375
    },
376 377 378 379 380
    {
        name            => 'dom-objects-enumeration-worker',
        type            => 'marionette',
        descr           => 'Check the list of DOM Objects exposed in a Worker context',
    },
381
    {
boklm's avatar
boklm committed
382
        name            => 'navigation-timing',
383
        type            => 'marionette',
boklm's avatar
boklm committed
384 385
        descr           => 'Check that the Navigation Timing API is really disabled',
        use_net         => 1,
386
    },
387
    {
boklm's avatar
boklm committed
388
        name            => 'resource-timing',
389
        type            => 'marionette',
390
        descr           => 'Check that the Resource Timing API is really disabled',
boklm's avatar
boklm committed
391
        use_net         => 1,
392 393
        # To check that the test fails when resource timing is enabled,
        # uncomment this:
394 395
        #prefs           => {
        #    'dom.enable_resource_timing' => 'true',
396 397 398 399 400 401 402 403 404 405
        #},
    },
    {
        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           => {
406
        #    'dom.enable_user_timing' => 'true',
407
        #},
408
    },
409 410 411 412 413 414 415 416 417 418 419 420 421 422
    {
        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',
        #},
    },
423 424 425 426 427 428 429 430 431 432 433
    {
        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',
        #},
    },
434
    {
boklm's avatar
boklm committed
435
        name            => 'searchengines',
436
        type            => 'marionette',
boklm's avatar
boklm committed
437
        descr           => 'Check that we have the default search engines set',
438
    },
boklm's avatar
boklm committed
439
    {
boklm's avatar
boklm committed
440
        name            => 'noscript',
441
        type            => 'marionette',
boklm's avatar
boklm committed
442 443 444
        descr           => 'Check that noscript options are working',
        use_net         => 1,
        prefs           => {
445
            'extensions.torbutton.security_slider' => 2,
boklm's avatar
boklm committed
446 447
        },
    },
boklm's avatar
boklm committed
448
    {
boklm's avatar
boklm committed
449
        name            => 'fp_screen_dimensions',
450
        type            => 'marionette',
boklm's avatar
boklm committed
451
        descr           => 'Check that screen dimensions are spoofed correctly',
452 453
    },
    {
boklm's avatar
boklm committed
454
        name            => 'fp_screen_coords',
455
        type            => 'marionette',
boklm's avatar
boklm committed
456
        descr           => 'Check that screenX, screenY, screenLeft, screenTop, mozInnerScreenX, mozInnerScreenY are 0',
457 458
    },
    {
boklm's avatar
boklm committed
459
        name            => 'fp_plugins',
460
        type            => 'marionette',
boklm's avatar
boklm committed
461
        descr           => 'Check that plugins are disabled',
462 463
    },
    {
boklm's avatar
boklm committed
464
        name            => 'fp_useragent',
465
        type            => 'marionette',
boklm's avatar
boklm committed
466
        descr           => 'Check that userAgent is as expected',
467 468
    },
    {
boklm's avatar
boklm committed
469
        name            => 'fp_navigator',
470
        type            => 'marionette',
boklm's avatar
boklm committed
471 472 473 474
        descr           => 'Check that navigator properties are as expected',
    },
    {
        name            => 'play_videos',
475
        type            => 'marionette',
boklm's avatar
boklm committed
476 477
        descr           => 'Play some videos',
        use_net         => 1,
478
        marionette_test => 'page',
boklm's avatar
boklm committed
479 480 481 482 483
        remote          => 1,
        timeout         => 50000,
    },
    {
        name            => 'svg-disable',
boklm's avatar
boklm committed
484
        type            => 'marionette',
boklm's avatar
boklm committed
485
        descr           => 'Check if disabling svg is working',
boklm's avatar
boklm committed
486
        marionette_test => 'svg',
boklm's avatar
boklm committed
487 488
        use_net         => 1,
        prefs           => {
489 490 491
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'false',
        },
boklm's avatar
boklm committed
492
        enable          => sub { $OSNAME eq 'linux' },
493 494
    },
    {
boklm's avatar
boklm committed
495
        name            => 'svg-enable',
boklm's avatar
boklm committed
496
        type            => 'marionette',
boklm's avatar
boklm committed
497
        descr           => 'Check if enabling svg is working',
boklm's avatar
boklm committed
498
        marionette_test => 'svg',
boklm's avatar
boklm committed
499 500
        use_net         => 1,
        prefs           => {
501 502 503
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'true',
        },
boklm's avatar
boklm committed
504
        enable          => sub { $OSNAME eq 'linux' },
505
    },
506 507 508 509 510 511
    {
        name            => 'download_pdf',
        type            => 'marionette',
        descr           => 'Check if download of PDF is working (#19402)',
        use_net         => 1,
    },
boklm's avatar
boklm committed
512 513 514 515 516 517 518
    {
        name            => 'pinning_now',
        type            => 'marionette',
        descr           => 'Check if static public key pinning is working (#20149)',
        marionette_test => 'pinning',
        use_net         => 1,
    },
519 520
);

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
sub set_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    copy $prefs, "$prefs.backup";
    my $new_prefs = '';
    foreach my $prefname (sort keys %{$t->{prefs}}) {
        $new_prefs .= "pref(\"$prefname\", $t->{prefs}{$prefname});\n";
    }
    write_file($prefs, {append => 1}, $new_prefs);
}

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    move "$prefs.backup", $prefs;
}

boklm's avatar
boklm committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
sub set_slider_mode {
    my ($tbbinfos, $t) = @_;
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    copy $prefs, "$prefs.slider_backup";
    write_file($prefs, {append => 1},
      'pref("extensions.torbutton.security_custom", false);' . "\n" .
      "pref(\"extensions.torbutton.security_slider\", $t->{slider_mode});\n");
}

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
    my $prefs = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    move "$prefs.slider_backup", $prefs;
}

555 556 557
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
558
    my %binfiles;
559 560 561 562
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
563 564 565
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
566
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
567 568 569
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
570 571 572 573 574
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
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 ];
}

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
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);
629 630 631 632 633
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
634
        $tbbinfos->{tbbdir} .= '/Browser';
635 636 637 638
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
639
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
640 641 642 643 644
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
645
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
646
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
647 648 649 650 651 652
    } 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";
653 654 655 656 657 658 659 660 661 662 663 664 665
    }
}

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) = @_;
666 667 668 669 670 671
    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
672 673 674 675
    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'}
    }
676 677 678 679
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
680
    $test->{clean_strace} //= !%bad_connections;
681
    $test->{results}{bad_connections} = \%bad_connections;
682 683 684 685
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
686
    my @bad_modified_files = @{$test->{results}{modified_files}};
687 688 689 690
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
691
    $test->{clean_strace} //= !@bad_modified_files;
692 693 694
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

695 696
sub clean_strace {
    my ($tbbinfos, $test) = @_;
697
    return unless $test->{clean_strace};
698 699
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
700
    unlink "$logfile.tmp";
701 702
}

703 704 705
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
706 707
    my @ignore_re = ( qr/^\/dev\/dri/ );
    push @ignore_re, qr/^$test->{workspace}/ if $test->{workspace};
708 709 710 711 712
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
713 714 715 716 717
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
718
    my @lines = read_file($logfile) if -f $logfile;
719
    LINE: foreach my $line (@lines) {
720 721 722 723 724
        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};
725 726 727
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
728 729 730
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
731 732 733 734
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
735 736 737 738
            next if $ignore_files{$1};
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
739 740 741
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
boklm's avatar
boklm committed
742
        if ($line =~ m/^\d+ connect\(\d+, \{sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
743
            $test->{results}{connections}{"$2:$1"}++;
744 745
        }
    }
746 747
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
748 749 750 751 752 753 754 755 756
}

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
757
export HOME="$tbbinfos->{tbbdir}"
758
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
759 760
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
761 762 763 764 765 766 767
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

768
sub ff_strace_wrapper {
769 770
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
771
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
772 773
    my $wrapper = <<EOF;
#!/bin/sh
774 775 776 777 778 779
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
780 781 782 783 784
strace -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
785 786 787 788 789 790 791 792 793 794 795 796
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");
    }
797
    my %t = map { $_ => 1 } qw(marionette);
798
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
799 800
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
801
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
802
    return ff_wrapper($tbbinfos, $test);
803 804
}

805 806 807 808 809 810 811 812 813 814 815 816
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;
}

817 818 819 820 821 822 823
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

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

867 868
sub set_tbbpaths {
    my ($tbbinfos) = @_;
869 870 871
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
872 873
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
874 875 876 877 878 879 880 881 882
        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
883
    }
884 885
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
886
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
887
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
888
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
889 890
}

boklm's avatar
boklm committed
891 892 893 894
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
895 896
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
897 898 899
    return bless $testsuite, $ts;
}

900 901 902 903 904 905 906 907 908 909
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);
910 911 912 913
    my $prefs_file = "$tbbinfos->{ffprofiledir}/preferences/extension-overrides.js";
    open(my $prefs_fh, '>>', $prefs_file);
    print $prefs_fh 'pref("extensions.torbutton.prompted_language", true);', "\n";
    close $prefs_fh;
914
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
915
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
916
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
917
    $ENV{TOR_SKIP_LAUNCH} = 1;
918 919
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
920 921 922
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
923 924 925 926 927
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
928
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
929 930 931
}

1;