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

480 481 482
sub set_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
483
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
484 485 486
    copy $prefs, "$prefs.backup";
    my $new_prefs = '';
    foreach my $prefname (sort keys %{$t->{prefs}}) {
487
        $new_prefs .= "user_pref(\"$prefname\", $t->{prefs}{$prefname});\n";
488 489 490 491 492 493 494
    }
    write_file($prefs, {append => 1}, $new_prefs);
}

sub reset_test_prefs {
    my ($tbbinfos, $t) = @_;
    return unless $t->{prefs};
495
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
496 497 498
    move "$prefs.backup", $prefs;
}

boklm's avatar
boklm committed
499 500
sub set_slider_mode {
    my ($tbbinfos, $t) = @_;
501
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
502 503
    copy $prefs, "$prefs.slider_backup";
    write_file($prefs, {append => 1},
504 505
      'user_pref("extensions.torbutton.security_custom", false);' . "\n" .
      "user_pref(\"extensions.torbutton.security_slider\", $t->{slider_mode});\n");
boklm's avatar
boklm committed
506 507 508 509
}

sub reset_slider_mode {
    my ($tbbinfos, $t) = @_;
510
    my $prefs = "$tbbinfos->{ffprofiledir}/user.js";
boklm's avatar
boklm committed
511 512 513
    move "$prefs.slider_backup", $prefs;
}

514 515 516
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
517
    my %binfiles;
518 519 520 521
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
522 523 524
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
525
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
526 527 528
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
529 530 531 532 533
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
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 ];
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
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);
588 589 590 591 592
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
593
        $tbbinfos->{tbbdir} .= '/Browser';
594 595 596 597
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
598
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
599 600 601 602 603
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
604
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
605
        system('chmod', '-R', '+rx', $tmpdir) if $OSNAME eq 'cygwin';
boklm's avatar
boklm committed
606 607 608 609 610 611
    } 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";
612 613 614 615 616 617 618 619 620 621 622 623 624
    }
}

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) = @_;
625 626 627 628 629 630
    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
631 632 633 634
    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'}
    }
635 636 637 638
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
639
    $test->{clean_strace} //= !%bad_connections;
640
    $test->{results}{bad_connections} = \%bad_connections;
641 642 643 644
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
645
    my @bad_modified_files = @{$test->{results}{modified_files}};
646 647 648 649
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
650
    $test->{clean_strace} //= !@bad_modified_files;
651 652 653
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

654 655
sub clean_strace {
    my ($tbbinfos, $test) = @_;
656
    return unless $test->{clean_strace};
657 658
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
659
    unlink "$logfile.tmp";
660 661
}

662 663 664
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
665
    my @ignore_re = ( qr/^\/dev\/(dri)|(shm)/ );
666
    push @ignore_re, qr/^$test->{workspace}/ if $test->{workspace};
667 668 669 670 671
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
672 673 674 675 676
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
677
    my @lines = read_file($logfile) if -f $logfile;
678
    LINE: foreach my $line (@lines) {
679 680 681 682 683
        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};
684 685 686
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
687 688 689
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
690 691 692 693
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
694 695 696 697
            next if $ignore_files{$1};
            foreach my $re (@ignore_re) {
                next LINE if $1 =~ m/$re/;
            }
698 699 700
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
boklm's avatar
boklm committed
701
        if ($line =~ m/^\d+ connect\(\d+, \{sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
702
            $test->{results}{connections}{"$2:$1"}++;
703 704
        }
    }
705 706
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
707 708 709 710 711 712 713 714 715
}

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
716
export HOME="$tbbinfos->{tbbdir}"
717
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
718 719
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
720 721 722 723 724 725 726
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

727
sub ff_strace_wrapper {
728 729
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
730
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
731 732
    my $wrapper = <<EOF;
#!/bin/sh
733 734 735 736 737 738
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
739
strace -e trace=file,network -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
740 741 742 743
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
744 745 746 747 748 749 750 751 752 753 754 755
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");
    }
756
    my %t = map { $_ => 1 } qw(marionette);
757
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
758 759
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
760
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
761
    return ff_wrapper($tbbinfos, $test);
762 763
}

764 765 766 767 768 769 770 771 772 773 774 775
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;
}

776 777 778 779 780 781 782
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

783 784
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
785 786
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
787 788
    $test->{workspace} = "$tbbinfos->{'results-dir'}/$test->{name}_ws";
    mkdir $test->{workspace};
789 790
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
791
    my $marionette_test = $test->{marionette_test} // $test->{name};
792
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
793 794 795 796
    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;
797 798 799
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
800
    system(xvfb_run($test), "$FindBin::Bin/virtualenv-marionette-5.0.0/$bin/tor-browser-tests",
801 802
        '--log-unittest', winpath($result_file_txt),
        '--log-html', winpath($result_file_html),
803
        '--server-root', winpath("$FindBin::Bin/test-data"),
804 805
        '--binary', ffbin_path($tbbinfos, $test),
        '--profile', winpath($tbbinfos->{ffprofiledir}),
806
        $OSNAME eq 'cygwin' ? () : ('--workspace', $test->{workspace}),
807
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
808
    $ENV{PYTHONPATH} = $pypath;
809
    my @txt_log = -f $result_file_txt ? read_file($result_file_txt) : ('NoFile');
810 811 812
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
813 814 815
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
816
        screenshot_thumbnail($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
817 818 819
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
820 821 822 823
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
824
    clean_strace($tbbinfos, $test);
825 826
}

827 828
sub set_tbbpaths {
    my ($tbbinfos) = @_;
829 830 831
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
832 833
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
834 835 836 837 838 839 840 841 842
        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
843
    }
844 845
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
846
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
847
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
848
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
849 850
}

boklm's avatar
boklm committed
851 852 853 854
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
855 856
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
857 858 859
    return bless $testsuite, $ts;
}

860 861 862 863 864 865 866 867 868 869
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);
870
    my $prefs_file = "$tbbinfos->{ffprofiledir}/user.js";
871
    open(my $prefs_fh, '>>', $prefs_file);
872
    print $prefs_fh 'user_pref("privacy.spoof_english", 1);', "\n";
873
    close $prefs_fh;
874
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
875
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
876
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
877
    $ENV{TOR_SKIP_LAUNCH} = 1;
878 879
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
880 881 882
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
883 884 885 886 887
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
888
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
889 890 891
}

1;