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 32.6 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;
19
use TBBTestSuite::Common qw(exit_error winpath clone_strip_coderef);
20 21
use TBBTestSuite::Options qw($options);
use TBBTestSuite::Tests::VirusTotal qw(virustotal_run);
22
use TBBTestSuite::Tests::Command qw(command_run);
23
use TBBTestSuite::Tests::TorBootstrap;
boklm's avatar
boklm committed
24
use TBBTestSuite::XServer qw(start_X stop_X set_Xmode);
25 26 27 28 29 30 31

my $screenshot_thumbnail;
BEGIN {
    # For some reason that I did not understand yet, Image::Magick does
    # not work on Windows, so we're not creating thumbnails if we're
    # on Windows. In that case, the thumbnails should be created by the
    # server that receives the results.
boklm's avatar
boklm committed
32
    if ($OSNAME ne 'cygwin' && $OSNAME ne 'darwin') {
33 34 35 36 37 38 39
        require TBBTestSuite::Thumbnail;
        $screenshot_thumbnail = \&TBBTestSuite::Thumbnail::screenshot_thumbnail;
    } else {
        $screenshot_thumbnail = sub { };
    }
}

boklm's avatar
boklm committed
40 41 42 43
sub test_types {
    return {
        tor_bootstrap => \&TBBTestSuite::Tests::TorBootstrap::start_tor,
        mozmill       => \&mozmill_run,
44
        marionette    => \&marionette_run,
boklm's avatar
boklm committed
45 46 47 48 49
        selenium      => \&selenium_run,
        virustotal    => \&virustotal_run,
        command       => \&command_run,
    };
}
50

boklm's avatar
boklm committed
51 52 53
sub type {
    'browserbundle';
}
54

boklm's avatar
boklm committed
55 56 57
sub description {
    'Tor Browser Bundle integration tests';
}
58

59 60
our @tests = (
    {
boklm's avatar
boklm committed
61 62 63 64 65 66 67 68 69
        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' },
70 71
    },
    {
boklm's avatar
boklm committed
72 73 74 75 76 77 78 79
        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' },
80 81
    },
    {
boklm's avatar
boklm committed
82 83 84 85 86 87 88
        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' },
89 90
    },
    {
boklm's avatar
boklm committed
91 92 93 94 95 96 97
        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' },
98 99
    },
    {
boklm's avatar
boklm committed
100 101 102 103 104 105 106 107
        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' },
108 109
    },
    {
boklm's avatar
boklm committed
110 111 112 113 114 115 116
        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' },
117 118
    },
    {
boklm's avatar
boklm committed
119 120 121 122 123
        name            => 'tor_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
124
        run_once        => 1,
125 126
    },
    {
boklm's avatar
boklm committed
127 128 129
        name            => 'tor_bridge',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge',
130
        enable          => sub { $OSNAME eq 'linux' },
131
        run_once        => 1,
132 133
    },
    {
boklm's avatar
boklm committed
134 135 136 137
        name            => 'tor_bridge_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using a bridge and an http proxy',
        httpproxy       => 1,
138
        enable          => sub { $OSNAME eq 'linux' },
139
        run_once        => 1,
140 141
    },
    {
boklm's avatar
boklm committed
142 143 144 145
        name            => 'tor_obfs3',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3',
        enable          => sub { $OSNAME eq 'linux' },
146
        run_once        => 1,
147 148
    },
    {
boklm's avatar
boklm committed
149 150 151 152 153
        name            => 'tor_obfs3_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs3 and an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
154
        run_once        => 1,
155
    },
156
    {
boklm's avatar
boklm committed
157 158 159 160
        name            => 'tor_obfs4',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4',
        enable          => sub { $OSNAME eq 'linux' && $_[0]->{version} !~ m/^4.0/ },
161
        run_once        => 1,
162 163
    },
    {
boklm's avatar
boklm committed
164 165 166 167 168
        name            => 'tor_obfs4_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using obfs4 and an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' && $_[0]->{version} !~ m/^4.0/ },
169
        run_once        => 1,
170
    },
171
    {
boklm's avatar
boklm committed
172 173 174 175
        name            => 'tor_fte',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy',
        enable          => sub { $OSNAME eq 'linux' },
176
        run_once        => 1,
177 178
    },
    {
boklm's avatar
boklm committed
179 180 181 182 183
        name            => 'tor_fte_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using fteproxy and an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
184
        run_once        => 1,
185
    },
186 187 188 189 190
    {
        name            => 'tor_scramblesuit',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit',
        enable          => sub { $OSNAME eq 'linux' },
191
        run_once        => 1,
192 193 194 195 196 197 198
    },
    {
        name            => 'tor_scramblesuit_httpproxy',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using scramblesuit and an http proxy',
        httpproxy       => 1,
        enable          => sub { $OSNAME eq 'linux' },
199
        run_once        => 1,
200
    },
201 202 203 204 205
    {
        name            => 'tor_meek-google',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-google',
        enable          => sub { $OSNAME eq 'linux' },
206
        run_once        => 1,
207 208 209 210 211 212
    },
    {
        name            => 'tor_meek-amazon',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-amazon',
        enable          => sub { $OSNAME eq 'linux' },
213
        run_once        => 1,
214 215 216 217 218 219
    },
    {
        name            => 'tor_meek-azure',
        type            => 'tor_bootstrap',
        descr           => 'Access tor using meek-azure',
        enable          => sub { $OSNAME eq 'linux' },
220
        run_once        => 1,
221
    },
222
    {
boklm's avatar
boklm committed
223 224 225 226 227
        name            => 'tor_bootstrap',
        type            => 'tor_bootstrap',
        descr           => 'Check that we can bootstrap tor',
        fail_type       => 'fatal',
        no_kill         => 1,
228 229 230
        use_default_config => 1,
    },
    {
boklm's avatar
boklm committed
231
        name            => 'screenshots',
232
        type            => 'marionette',
boklm's avatar
boklm committed
233
        descr           => 'Take some screenshots',
234 235
    },
    {
boklm's avatar
boklm committed
236
        name            => 'check',
237
        type            => 'marionette',
boklm's avatar
boklm committed
238 239
        use_net         => 1,
        descr           => 'Check that http://check.torproject.org/ think we are using tor',
240 241
    },
    {
boklm's avatar
boklm committed
242
        name            => 'https-everywhere',
243
        type            => 'marionette',
boklm's avatar
boklm committed
244 245
        use_net         => 1,
        descr           => 'Check that https everywhere is enabled and working',
246 247
    },
    {
boklm's avatar
boklm committed
248
        name            => 'https-everywhere-disabled',
249 250
        marionette_test => 'https-everywhere',
        type            => 'marionette',
boklm's avatar
boklm committed
251 252 253 254
        descr           => 'Check that https everywhere is not doing anything when disabled',
        use_net         => 1,
        pre             => sub { toggle_https_everywhere($_[0], 0) },
        post            => sub { toggle_https_everywhere($_[0], 1) },
255 256
    },
    {
boklm's avatar
boklm committed
257
        name            => 'settings',
258
        type            => 'marionette',
boklm's avatar
boklm committed
259
        descr           => 'Check that some important settings are correctly set',
260
    },
boklm's avatar
boklm committed
261
    {
boklm's avatar
boklm committed
262
        name            => 'acid3',
boklm's avatar
boklm committed
263
        type            => 'marionette',
boklm's avatar
boklm committed
264 265
        descr           => 'acid3 tests',
        use_net         => 1,
boklm's avatar
boklm committed
266
        retry           => 4,
boklm's avatar
boklm committed
267
    },
boklm's avatar
boklm committed
268
    {
boklm's avatar
boklm committed
269
        name            => 'slider_settings_1',
270 271
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
272 273 274 275 276
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 1,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
        enable          => sub { $_[0]->{version} !~ m/^4.0/ },
boklm's avatar
boklm committed
277 278
    },
    {
boklm's avatar
boklm committed
279
        name            => 'slider_settings_2',
280 281
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
282 283 284 285 286
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 2,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
        enable          => sub { $_[0]->{version} !~ m/^4.0/ },
boklm's avatar
boklm committed
287 288
    },
    {
boklm's avatar
boklm committed
289
        name            => 'slider_settings_3',
290 291
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
292 293 294 295 296
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 3,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
        enable          => sub { $_[0]->{version} !~ m/^4.0/ },
boklm's avatar
boklm committed
297 298
    },
    {
boklm's avatar
boklm committed
299
        name            => 'slider_settings_4',
300 301
        marionette_test => 'slider_settings',
        type            => 'marionette',
boklm's avatar
boklm committed
302 303 304 305 306
        descr           => 'Check that settings are set according to security slider mode',
        slider_mode     => 4,
        pre             => \&set_slider_mode,
        post            => \&reset_slider_mode,
        enable          => sub { $_[0]->{version} !~ m/^4.0/ },
boklm's avatar
boklm committed
307
    },
boklm's avatar
boklm committed
308
    {
boklm's avatar
boklm committed
309
        name            => 'dom-objects-enumeration',
310
        type            => 'marionette',
boklm's avatar
boklm committed
311
        descr           => 'Check the list of DOM Objects exposed in the global namespace',
boklm's avatar
boklm committed
312
    },
313
    {
boklm's avatar
boklm committed
314
        name            => 'navigation-timing',
315
        type            => 'marionette',
boklm's avatar
boklm committed
316 317
        descr           => 'Check that the Navigation Timing API is really disabled',
        use_net         => 1,
318
    },
319
    {
boklm's avatar
boklm committed
320
        name            => 'resource-timing',
321
        type            => 'marionette',
322
        descr           => 'Check that the Resource Timing API is really disabled',
boklm's avatar
boklm committed
323
        use_net         => 1,
324 325
        # To check that the test fails when resource timing is enabled,
        # uncomment this:
326 327
        #prefs           => {
        #    'dom.enable_resource_timing' => 'true',
328 329 330 331 332 333 334 335 336 337
        #},
    },
    {
        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           => {
338
        #    'dom.enable_user_timing' => 'true',
339
        #},
340
    },
341
    {
boklm's avatar
boklm committed
342
        name            => 'searchengines',
343
        type            => 'marionette',
boklm's avatar
boklm committed
344
        descr           => 'Check that we have the default search engines set',
345
    },
boklm's avatar
boklm committed
346
    {
boklm's avatar
boklm committed
347
        name            => 'noscript',
348
        type            => 'marionette',
boklm's avatar
boklm committed
349 350 351
        descr           => 'Check that noscript options are working',
        use_net         => 1,
        prefs           => {
352
            'extensions.torbutton.security_slider' => 2,
boklm's avatar
boklm committed
353
        },
boklm's avatar
boklm committed
354
        enable          => sub { $_[0]->{version} !~ m/^4.0/ },
boklm's avatar
boklm committed
355
    },
boklm's avatar
boklm committed
356
    {
boklm's avatar
boklm committed
357
        name            => 'fp_screen_dimensions',
358
        type            => 'marionette',
boklm's avatar
boklm committed
359
        descr           => 'Check that screen dimensions are spoofed correctly',
360 361
    },
    {
boklm's avatar
boklm committed
362
        name            => 'fp_screen_coords',
363
        type            => 'marionette',
boklm's avatar
boklm committed
364
        descr           => 'Check that screenX, screenY, screenLeft, screenTop, mozInnerScreenX, mozInnerScreenY are 0',
365 366
    },
    {
boklm's avatar
boklm committed
367
        name            => 'fp_plugins',
368
        type            => 'marionette',
boklm's avatar
boklm committed
369
        descr           => 'Check that plugins are disabled',
370 371
    },
    {
boklm's avatar
boklm committed
372
        name            => 'fp_useragent',
373
        type            => 'marionette',
boklm's avatar
boklm committed
374
        descr           => 'Check that userAgent is as expected',
375 376
    },
    {
boklm's avatar
boklm committed
377
        name            => 'fp_navigator',
378
        type            => 'marionette',
boklm's avatar
boklm committed
379 380 381 382
        descr           => 'Check that navigator properties are as expected',
    },
    {
        name            => 'play_videos',
383
        type            => 'marionette',
boklm's avatar
boklm committed
384 385
        descr           => 'Play some videos',
        use_net         => 1,
386
        marionette_test => 'page',
boklm's avatar
boklm committed
387 388 389 390 391
        remote          => 1,
        timeout         => 50000,
    },
    {
        name            => 'svg-disable',
boklm's avatar
boklm committed
392
        type            => 'marionette',
boklm's avatar
boklm committed
393
        descr           => 'Check if disabling svg is working',
boklm's avatar
boklm committed
394
        marionette_test => 'svg',
boklm's avatar
boklm committed
395 396
        use_net         => 1,
        prefs           => {
397 398 399
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'false',
        },
boklm's avatar
boklm committed
400
        enable          => sub { $OSNAME eq 'linux' },
401 402
    },
    {
boklm's avatar
boklm committed
403
        name            => 'svg-enable',
boklm's avatar
boklm committed
404
        type            => 'marionette',
boklm's avatar
boklm committed
405
        descr           => 'Check if enabling svg is working',
boklm's avatar
boklm committed
406
        marionette_test => 'svg',
boklm's avatar
boklm committed
407 408
        use_net         => 1,
        prefs           => {
409 410 411
            'extensions.torbutton.security_custom' => 'true',
            'svg.in-content.enabled' => 'true',
        },
boklm's avatar
boklm committed
412
        enable          => sub { $OSNAME eq 'linux' },
413
    },
414 415 416 417 418 419
);

sub toggle_https_everywhere {
    my ($tbbinfos, $t) = @_;
    my $prefs = $tbbinfos->{ffprofiledir} . '/extensions/'
        . 'https-everywhere@eff.org/defaults/preferences/preferences.js';
420 421 422
    my $prefs_eff = $tbbinfos->{ffprofiledir} . '/extensions/'
        . 'https-everywhere-eff@eff.org/defaults/preferences/preferences.js';
    $prefs = $prefs_eff unless -f $prefs;
423 424 425 426 427 428 429 430 431 432 433 434 435
    my @f = read_file($prefs);
    foreach (@f) {
        if ($t) {
            s/pref\("extensions\.https_everywhere\.globalEnabled",false\);
             /pref("extensions.https_everywhere.globalEnabled",true);/x;
        } else {
            s/pref\("extensions\.https_everywhere\.globalEnabled",true\);
             /pref("extensions.https_everywhere.globalEnabled",false);/x;
        }
    }
    write_file($prefs, @f);
}

436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
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
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
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;
}

470 471 472
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
473
    my %binfiles;
474 475 476 477
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
478 479 480
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
481
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
482 483 484
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
    };
    find($wanted, $tbbinfos->{tbbdir});
    return $tbbinfos->{binfiles} = [ keys %binfiles ];
}

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);
523 524 525 526 527
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
528
        $tbbinfos->{tbbdir} .= '/Browser';
529 530 531 532
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
533
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
534 535 536 537 538
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser") if -d "$tmpdir/\$_OUTDIR";
        if (-d "$tmpdir/Browser") {
            mkdir "$tmpdir/torbrowser";
            move("$tmpdir/Browser", "$tmpdir/torbrowser/Browser");
        }
539
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
boklm's avatar
boklm committed
540 541 542 543 544 545
    } 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";
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    }
}

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 mozmill_cmd {
    if ($OSNAME eq 'cygwin') {
        return ( "$options->{'mozmill-dir'}\\run.cmd", 'mozmill' );
    }
    return ("$options->{virtualenv}/bin/mozmill");
}

sub check_opened_connections {
    my ($tbbinfos, $test) = @_;
566 567 568 569 570 571
    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
572 573 574 575
    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'}
    }
576 577 578 579
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
580
    $test->{results}{bad_connections} = \%bad_connections;
581 582 583 584
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
585
    my @bad_modified_files = @{$test->{results}{modified_files}};
586 587 588 589
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
590 591 592
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

593 594 595 596
sub clean_strace {
    my ($tbbinfos, $test) = @_;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
597
    unlink "$logfile.tmp";
598 599
}

600 601 602 603 604
sub parse_strace {
    my ($tbbinfos, $test) = @_;
    my %ignore_files = map { $_ => 1 } qw(/dev/null /dev/tty);
    my %files;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
boklm's avatar
boklm committed
605
    my $logfile_tmp = "$tbbinfos->{'results-dir'}/$test->{name}.strace.tmp";
606 607 608
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
609 610 611 612 613
    if (-f "$logfile.tmp") {
        my $txt = read_file("$logfile.tmp");
        write_file($logfile, { append => 1 }, $txt);
        unlink "$logfile.tmp";
    }
614
    my @lines = read_file($logfile) if -f $logfile;
615
    push @lines, read_file($logfile_tmp) if -f $logfile_tmp;
616
    foreach my $line (@lines) {
617 618 619 620 621
        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};
622 623 624
            if ($ENV{'MOZMILL_SCREENSHOTS'}) {
                next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
            }
625 626 627 628 629 630 631 632 633
            $modified_files{$1}++;
        }
        if ($line =~ m/^\d+ unlink\("((?:[^"\\]++|\\.)*+)"/) {
            next if $1 =~ m/^$tbbinfos->{tbbdir}/;
            $removed_files{$1}++;
            delete $modified_files{$1} unless -f $1;
        }
        if ($line =~ m/^\d+ connect\(\d+, {sa_family=AF_INET, sin_port=htons\((\d+)\), sin_addr=inet_addr\("((?:[^"\\]++|\\.)*+)"\)/) {
            $test->{results}{connections}{"$2:$1"}++;
634 635
        }
    }
636 637
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
638 639 640 641 642 643 644 645 646
}

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
647
export HOME="$tbbinfos->{tbbdir}"
648
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
649 650 651 652 653 654 655
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

656
sub ff_strace_wrapper {
657 658
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
659
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
660 661
    my $wrapper = <<EOF;
#!/bin/sh
662 663 664 665 666 667
if [ -f $logfile.tmp ]
then
   cat $logfile.tmp >> $logfile
   rm $logfile.tmp
fi
echo \$@ >> /tmp/ff_run.log
668 669 670 671 672
strace -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
673 674 675 676 677 678 679 680 681 682 683 684
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");
    }
685 686
    my %t = map { $_ => 1 } qw(mozmill marionette);
    if ($options->{use_strace} && $t{$test->{type}}) {
boklm's avatar
boklm committed
687 688
        return ff_strace_wrapper($tbbinfos, $test);
    }
boklm's avatar
boklm committed
689
    return $tbbinfos->{ffbin} if $OSNAME eq 'darwin';
690
    return ff_wrapper($tbbinfos, $test);
691 692
}

693 694 695
sub mozmill_export_options {
    my ($tbbinfos, $test) = @_;
    my $options_file = winpath("$FindBin::Bin/mozmill-tests/lib/testsuite.js");
696 697
    my $json_opts = encode_json clone_strip_coderef $options;
    my $json_test = encode_json clone_strip_coderef $test;
boklm's avatar
boklm committed
698 699
    my $json_tbbinfos = encode_json clone_strip_coderef
                                { %$tbbinfos, tests => undef };
700 701 702
    my $content = <<EOF;
var options = $json_opts;
var test = $json_test;
boklm's avatar
boklm committed
703
var tbbinfos = $json_tbbinfos;
704 705
exports.options = options;
exports.test = test;
boklm's avatar
boklm committed
706
exports.tbbinfos = tbbinfos;
707 708 709 710
EOF
    write_file($options_file, $content);
}

711 712 713 714 715 716 717 718 719 720 721 722
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;
}

723 724 725 726 727 728 729
sub marionette_run {
    my ($tbbinfos, $test) = @_;
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
    set_test_prefs($tbbinfos, $test);

730 731
    my $options_file = marionette_export_options($tbbinfos, $test);
    $ENV{TESTSUITE_DATA_FILE} = winpath($options_file);
732 733 734 735
    my $result_file_html = "$tbbinfos->{'results-dir'}/$test->{name}.html";
    my $result_file_txt = "$tbbinfos->{'results-dir'}/$test->{name}.txt";
    #--log-unittest  ./res.txt --log-html ./res.html
    my $bin = $OSNAME eq 'cygwin' ? 'Scripts' : 'bin';
736
    my $marionette_test = $test->{marionette_test} // $test->{name};
737
    my $pypath = $ENV{PYTHONPATH};
boklm's avatar
boklm committed
738 739 740 741
    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;
742 743 744
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MARIONETTE_SCREENSHOTS'} = winpath($screenshots_tmp);
745 746 747 748 749
    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}),
750
        winpath("$FindBin::Bin/marionette/tor_browser_tests/test_${marionette_test}.py"));
751
    $ENV{PYTHONPATH} = $pypath;
752 753 754 755
    my @txt_log = read_file($result_file_txt);
    my $res_line = shift @txt_log;
    $test->{results}{success} = $res_line eq ".\n" || $res_line eq ".\r\n";
    $test->{results}{log} = join '', @txt_log;
756 757 758 759 760 761 762
    my $i = 0;
    for my $screenshot_file (sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
        $screenshot_thumbnail->($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
763 764 765 766 767 768
    reset_test_prefs($tbbinfos, $test);
    parse_strace($tbbinfos, $test);
    check_opened_connections($tbbinfos, $test);
    check_modified_files($tbbinfos, $test);
}

769 770 771
sub mozmill_run {
    my ($tbbinfos, $test) = @_;
    return unless $options->{mozmill};
772 773 774
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
775
    clean_strace($tbbinfos, $test) if $options->{use_strace};
776
    mozmill_export_options($tbbinfos, $test);
777
    set_test_prefs($tbbinfos, $test);
778 779 780 781
    $test->{screenshots} = [];
    my $screenshots_tmp = File::Temp::newdir('XXXXXX', DIR => $options->{tmpdir});
    $ENV{'MOZMILL_SCREENSHOTS'} = winpath($screenshots_tmp);
    my $results_file = "$tbbinfos->{'results-dir'}/$test->{name}.json";
782
    my $mozmill_test = $test->{mozmill_test} // $test->{name};
783 784
    system(xvfb_run($test), mozmill_cmd(), '-b', ffbin_path($tbbinfos, $test),
        '-p', winpath($tbbinfos->{ffprofiledir}),
785
        '-t', winpath("$FindBin::Bin/mozmill-tests/tbb-tests/$mozmill_test.js"),
786 787 788 789 790 791 792 793
        '--report', 'file://' . winpath($results_file));
    my $i = 0;
    for my $screenshot_file (reverse sort glob "$screenshots_tmp/*.png") {
        move($screenshot_file, "$tbbinfos->{'results-dir'}/$test->{name}-$i.png");
        $screenshot_thumbnail->($tbbinfos->{'results-dir'}, "$test->{name}-$i.png");
        push @{$test->{screenshots}}, "$test->{name}-$i.png";
        $i++;
    }
794 795 796 797 798 799 800
    if (-f $results_file) {
        $test->{results} = decode_json(read_file($results_file));
        $test->{results}{success} = $test->{results}{results}->[0]->{passed} ?
                                !$test->{results}{results}->[0]->{failed} : 0;
    } else {
        $test->{results}{success} = 0;
    }
801
    reset_test_prefs($tbbinfos, $test);
boklm's avatar
boklm committed
802 803 804 805
    if ($options->{use_strace}) {
        parse_strace($tbbinfos, $test);
        check_opened_connections($tbbinfos, $test);
        check_modified_files($tbbinfos, $test);
806
        clean_strace($tbbinfos, $test) if $test->{results}{success};
boklm's avatar
boklm committed
807
    }
808 809 810 811 812
}

sub selenium_run {
    my ($tbbinfos, $test) = @_;
    return unless $options->{selenium};
813 814 815
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
816 817 818 819 820 821 822 823 824 825 826
    my $result_file = $ENV{SELENIUM_TEST_RESULT_FILE} =
        "$tbbinfos->{'results-dir'}/$test->{name}.json";
    $ENV{TBB_BIN} = ffbin_path($tbbinfos, $test);
    $ENV{TBB_PROFILE} = $tbbinfos->{ffprofiledir};
    system(xvfb_run($test), "$options->{virtualenv}/bin/python",
        "$FindBin::Bin/selenium-tests/run_test", $test->{name});
    $test->{results} = decode_json(read_file($result_file));
}

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

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

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

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

1;