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

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

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
529
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
530 531 532
    move "$prefs.backup", $prefs;
}

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

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
544
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
545 546 547
    move "$prefs.slider_backup", $prefs;
}

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

boklm's avatar
boklm committed
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
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 ];
}

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 617 618 619 620 621
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);
622 623 624 625 626
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
627
        $tbbinfos->{tbbdir} .= '/Browser';
628 629 630 631
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
632
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
633 634 635 636 637
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
638
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
639
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
640 641 642 643 644 645
    } 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";
646 647 648 649 650 651 652 653 654 655 656 657 658
    }
}

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) = @_;
659 660 661 662 663 664
    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
665 666 667 668
    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'}
    }
669 670 671 672
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
673
    $test->{clean_strace} //= !%bad_connections;
674
    $test->{results}{bad_connections} = \%bad_connections;
675 676 677 678
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
679
    my @bad_modified_files = @{$test->{results}{modified_files}};
680 681 682 683
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
684
    $test->{clean_strace} //= !@bad_modified_files;
685 686 687
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

688 689
sub clean_strace {
    my ($tbbinfos, $test) = @_;
690
    return unless $test->{clean_strace};
691 692
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
693
    unlink "$logfile.tmp";
694 695
}

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

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
750
export HOME="$tbbinfos->{tbbdir}"
751
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
752 753
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
754 755 756 757 758 759 760
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

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

798 799 800 801 802 803 804 805 806 807 808 809
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;
}

810 811 812 813 814 815 816
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

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

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

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

893 894 895 896 897 898 899 900 901 902
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);
903
    my $prefs_file = "$tbbinfos->{ffprofiledir}/user.js";
904
    open(my $prefs_fh, '>>', $prefs_file);
905
    print $prefs_fh 'user_pref("privacy.spoof_english", 1);', "\n";
906
    close $prefs_fh;
907
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
908
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
909
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
910
    $ENV{TOR_SKIP_LAUNCH} = 1;
911 912
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
913 914 915
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
916 917 918 919