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

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
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
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
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;
}

527 528 529
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
530
    my %binfiles;
531 532 533 534
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
535 536 537
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
538
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
539 540 541
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
542 543 544 545 546
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

boklm's avatar
boklm committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
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 ];
}

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

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) = @_;
638 639 640 641 642 643
    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
644 645 646 647
    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'}
    }
648 649 650 651
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
652
    $test->{clean_strace} //= !%bad_connections;
653
    $test->{results}{bad_connections} = \%bad_connections;
654 655 656 657
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
658
    my @bad_modified_files = @{$test->{results}{modified_files}};
659 660 661 662
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
663
    $test->{clean_strace} //= !@bad_modified_files;
664 665 666
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

667 668
sub clean_strace {
    my ($tbbinfos, $test) = @_;
669
    return unless $test->{clean_strace};
670 671
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
672
    unlink "$logfile.tmp";
673 674
}

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

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
729
export HOME="$tbbinfos->{tbbdir}"
730
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
731 732
export FONTCONFIG_PATH="\${HOME}/TorBrowser/Data/fontconfig"
export FONTCONFIG_FILE="fonts.conf"
733 734 735 736 737 738 739
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

740
sub ff_strace_wrapper {
741 742
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
743
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
744 745
    my $wrapper = <<EOF;
#!/bin/sh
746 747 748 749 750 751
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
752 753 754 755 756
strace -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
757 758 759 760 761 762 763 764 765 766 767 768
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");
    }
769
    my %t = map { $_ => 1 } qw(marionette);
770
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
771 772
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
773
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
774
    return ff_wrapper($tbbinfos, $test);
775 776
}

777 778 779 780 781 782 783 784 785 786 787 788
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;
}

789 790 791 792 793 794 795
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

796 797
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
798 799
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
800 801
    $test->{workspace} = "$tbbinfos->{'results-dir'}/$test->{name}_ws";
    mkdir $test->{workspace};
802 803
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
804
    my $marionette_test = $test->{marionette_test} // $test->{name};
805
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
806 807 808 809
    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;
810 811 812
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
813 814 815 816 817
    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}),
818
        $OSNAME eq 'cygwin' ? () : ('--workspace', $test->{workspace}),
819
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
820
    $ENV{PYTHONPATH} = $pypath;
821
    my @txt_log = -f $result_file_txt ? read_file($result_file_txt) : ('NoFile');
822 823 824
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
825 826 827
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
828
        screenshot_thumbnail($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
829 830 831
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
832 833 834 835
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
836
    clean_strace($tbbinfos, $test);
837 838
}

839 840
sub set_tbbpaths {
    my ($tbbinfos) = @_;
841 842 843
    $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
    $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
    $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
boklm's avatar
boklm committed
844 845
    if ($tbbinfos->{os} eq 'MacOSX') {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/Contents/MacOS/firefox";
846 847 848 849 850 851 852 853 854
        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
855
    }
856 857
    $tbbinfos->{torrcdefaults} //= "$tbbinfos->{datadir}/Tor/torrc-defaults";
    $tbbinfos->{torgeoip} //= "$tbbinfos->{datadir}/Tor/geoip";
858
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
859
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
860
    $tbbinfos->{ffprofiledir} //= "$tbbinfos->{datadir}/Browser/profile.default";
861 862
}

boklm's avatar
boklm committed
863 864 865 866
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
867 868
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
869 870 871
    return bless $testsuite, $ts;
}

872 873 874 875 876 877 878 879 880 881
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);
882 883 884 885
    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;
886
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
887
    copy "$FindBin::Bin/data/cert_override.txt",
boklm's avatar
boklm committed
888
          "$tbbinfos->{ffprofiledir}/cert_override.txt";
889
    $ENV{TOR_SKIP_LAUNCH} = 1;
890 891
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
892 893 894
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
895 896 897 898 899
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
900
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
901 902 903
}

1;