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 26.2 KB
Newer Older
1
package TBBTestSuite::TestSuite::BrowserBundleTests;
2 3 4

use warnings;
use strict;
boklm's avatar
boklm committed
5 6 7

use parent 'TBBTestSuite::TestSuite';

8 9 10 11 12 13 14 15 16 17
use English;
use FindBin;
use File::Slurp;
use File::Spec;
use File::Find;
use File::Type;
use File::Copy;
use JSON;
use Digest::SHA qw(sha256_hex);
use LWP::UserAgent;
18
use TBBTestSuite::Common qw(exit_error winpath clone_strip_coderef);
19 20
use TBBTestSuite::Options qw($options);
use TBBTestSuite::Tests::VirusTotal qw(virustotal_run);
21
use TBBTestSuite::Tests::Command qw(command_run);
22
use TBBTestSuite::Tests::TorBootstrap;
boklm's avatar
boklm committed
23
use TBBTestSuite::XServer qw(start_X stop_X set_Xmode);
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

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.
    if ($OSNAME ne 'cygwin') {
        require TBBTestSuite::Thumbnail;
        $screenshot_thumbnail = \&TBBTestSuite::Thumbnail::screenshot_thumbnail;
    } else {
        $screenshot_thumbnail = sub { };
    }
}

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

boklm's avatar
boklm committed
49 50 51
sub type {
    'browserbundle';
}
52

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

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

sub toggle_https_everywhere {
    my ($tbbinfos, $t) = @_;
    my $prefs = $tbbinfos->{ffprofiledir} . '/extensions/'
        . 'https-everywhere@eff.org/defaults/preferences/preferences.js';
358 359 360
    my $prefs_eff = $tbbinfos->{ffprofiledir} . '/extensions/'
        . 'https-everywhere-eff@eff.org/defaults/preferences/preferences.js';
    $prefs = $prefs_eff unless -f $prefs;
361 362 363 364 365 366 367 368 369 370 371 372 373
    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);
}

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
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);
    print "prefs file: $prefs\n";
}

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
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
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;
}

409 410 411
sub tbb_binfiles {
    my ($tbbinfos, $test) = @_;
    return $tbbinfos->{binfiles} if $tbbinfos->{binfiles};
412
    my %binfiles;
413 414 415 416
    my %wanted_types = (
        'application/x-executable-file' => 1,
        'application/x-ms-dos-executable' => 1,
    );
417 418 419
    my $wanted = sub {
        return unless -f $File::Find::name;
        my $type = File::Type->new->checktype_filename($File::Find::name);
420
        return unless $wanted_types{$type};
boklm's avatar
boklm committed
421 422 423
        my $name = $File::Find::name;
        $name =~ s/^$tbbinfos->{tbbdir}\///;
        $binfiles{$name} = 1;
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
    };
    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);
462 463 464 465 466
        if ($tbbinfos->{language} eq 'ALL') {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser";
        } else {
            $tbbinfos->{tbbdir} = "$tmpdir/tor-browser_$tbbinfos->{language}";
        }
467 468 469 470 471
        $tbbinfos->{tbbdir} .= '/Browser' if $options->{newlayout};
    } elsif ($tbbinfos->{os} eq 'Windows') {
        my (undef, undef, $f) = File::Spec->splitpath($tbbfile);
        copy($tbbfile, "$tmpdir/$f");
        system('7z', 'x', $f);
472
        $tbbinfos->{tbbdir} = "$tmpdir/torbrowser/Browser";
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
        move("$tmpdir/\$_OUTDIR", "$tmpdir/torbrowser");
        move ("$tmpdir/Start Tor Browser.exe", "$tmpdir/torbrowser/");
    }
}

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) = @_;
495 496 497 498 499 500
    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
501 502 503 504
    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'}
    }
505 506 507 508
    if (%bad_connections) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
509
    $test->{results}{bad_connections} = \%bad_connections;
510 511 512 513
}

sub check_modified_files {
    my ($tbbinfos, $test) = @_;
514
    my @bad_modified_files = @{$test->{results}{modified_files}};
515 516 517 518
    if (@bad_modified_files) {
        $test->{results}{success} = 0;
        $test->{retry} = 0;
    }
519 520 521
    $test->{results}{bad_modified_files} = \@bad_modified_files;
}

522 523 524 525
sub clean_strace {
    my ($tbbinfos, $test) = @_;
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
    unlink $logfile;
boklm's avatar
boklm committed
526
    unlink "$logfile.tmp";
527 528
}

529 530 531 532 533
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
534
    my $logfile_tmp = "$tbbinfos->{'results-dir'}/$test->{name}.strace.tmp";
535 536 537
    $test->{results}{connections} = {};
    my %modified_files;
    my %removed_files;
538
    my @lines = read_file($logfile) if -f $logfile;
539
    push @lines, read_file($logfile_tmp) if -f $logfile_tmp;
540
    foreach my $line (@lines) {
541 542 543 544 545
        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};
546
            next if $1 =~ m/^$ENV{'MOZMILL_SCREENSHOTS'}/;
547 548 549 550 551 552 553 554 555
            $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"}++;
556 557
        }
    }
558 559
    $test->{results}{modified_files} = [ keys %modified_files ];
    $test->{results}{removed_files} = [ keys %removed_files ];
560 561 562 563 564 565 566 567 568
}

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
569
export HOME="$tbbinfos->{tbbdir}"
570
export LD_LIBRARY_PATH="$tbbinfos->{tbbdir}:$tbbinfos->{tordir}"
571 572 573 574 575 576 577
exec \'$tbbinfos->{ffbin}\' "\$@"
EOF
    write_file($wrapper_file, $wrapper);
    chmod 0700, $wrapper_file;
    return $wrapper_file;
}

578
sub ff_strace_wrapper {
579 580
    my ($tbbinfos, $test) = @_;
    my $ff_wrapper = ff_wrapper($tbbinfos, $test);
581
    my $logfile = "$tbbinfos->{'results-dir'}/$test->{name}.strace";
582 583
    my $wrapper = <<EOF;
#!/bin/sh
584 585 586 587 588
strace -f -o $logfile.tmp -- \'$ff_wrapper\' "\$@"
exit_code=\$?
cat $logfile.tmp >> $logfile
rm $logfile.tmp
exit \$?
589 590 591 592 593 594 595 596 597 598 599 600
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");
    }
boklm's avatar
boklm committed
601 602 603
    if ($options->{use_strace} && $test->{type} eq 'mozmill') {
        return ff_strace_wrapper($tbbinfos, $test);
    }
604
    return ff_wrapper($tbbinfos, $test);
605 606
}

607 608 609
sub mozmill_export_options {
    my ($tbbinfos, $test) = @_;
    my $options_file = winpath("$FindBin::Bin/mozmill-tests/lib/testsuite.js");
610 611
    my $json_opts = encode_json clone_strip_coderef $options;
    my $json_test = encode_json clone_strip_coderef $test;
boklm's avatar
boklm committed
612 613
    my $json_tbbinfos = encode_json clone_strip_coderef
                                { %$tbbinfos, tests => undef };
614 615 616
    my $content = <<EOF;
var options = $json_opts;
var test = $json_test;
boklm's avatar
boklm committed
617
var tbbinfos = $json_tbbinfos;
618 619
exports.options = options;
exports.test = test;
boklm's avatar
boklm committed
620
exports.tbbinfos = tbbinfos;
621 622 623 624
EOF
    write_file($options_file, $content);
}

625 626 627
sub mozmill_run {
    my ($tbbinfos, $test) = @_;
    return unless $options->{mozmill};
628 629 630
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
631
    clean_strace($tbbinfos, $test) if $options->{use_strace};
632
    mozmill_export_options($tbbinfos, $test);
633
    set_test_prefs($tbbinfos, $test);
634 635 636 637
    $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";
638
    my $mozmill_test = $test->{mozmill_test} // $test->{name};
639 640
    system(xvfb_run($test), mozmill_cmd(), '-b', ffbin_path($tbbinfos, $test),
        '-p', winpath($tbbinfos->{ffprofiledir}),
641
        '-t', winpath("$FindBin::Bin/mozmill-tests/tbb-tests/$mozmill_test.js"),
642 643 644 645 646 647 648 649 650
        '--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++;
    }
    $test->{results} = decode_json(read_file($results_file));
651 652
    $test->{results}{success} = $test->{results}{results}->[0]->{passed} ?
                        !$test->{results}{results}->[0]->{failed} : 0;
653
    reset_test_prefs($tbbinfos, $test);
boklm's avatar
boklm committed
654 655 656 657
    if ($options->{use_strace}) {
        parse_strace($tbbinfos, $test);
        check_opened_connections($tbbinfos, $test);
        check_modified_files($tbbinfos, $test);
658
        clean_strace($tbbinfos, $test) if $test->{results}{success};
boklm's avatar
boklm committed
659
    }
660 661 662 663 664
}

sub selenium_run {
    my ($tbbinfos, $test) = @_;
    return unless $options->{selenium};
665 666 667
    if ($test->{tried} && $test->{use_net}) {
        TBBTestSuite::Tests::TorBootstrap::send_newnym($tbbinfos);
    }
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
    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) = @_;
    if ($options->{newlayout}) {
        $tbbinfos->{ffbin} = "$tbbinfos->{tbbdir}/firefox";
        $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/TorBrowser/Tor";
        $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/TorBrowser/Data";
    } else {
        $tbbinfos->{ffbin} =  "$tbbinfos->{tbbdir}/Browser/firefox";
        $tbbinfos->{tordir} = "$tbbinfos->{tbbdir}/Tor";
        $tbbinfos->{datadir} = "$tbbinfos->{tbbdir}/Data";
    }
    $tbbinfos->{torbin} = "$tbbinfos->{tordir}/tor";
boklm's avatar
boklm committed
689
    $tbbinfos->{ptdir} = winpath("$tbbinfos->{tordir}/PluggableTransports");
690 691 692
    $tbbinfos->{ffprofiledir} = "$tbbinfos->{datadir}/Browser/profile.default";
}

boklm's avatar
boklm committed
693 694 695 696
sub new {
    my ($ts, $testsuite) = @_;
    $testsuite->{type} = 'browserbundle';
    $testsuite->{tests} = [ map { { %$_ } } @tests ];
697 698
    return undef unless $testsuite->{os} eq $options->{os};
    return undef unless $testsuite->{arch} eq $options->{arch};
boklm's avatar
boklm committed
699 700 701
    return bless $testsuite, $ts;
}

702 703 704 705 706 707 708 709 710 711
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);
712 713 714 715
    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;
716
    chdir $tbbinfos->{tbbdir} || exit_error "Can't enter directory $tbbinfos->{tbbdir}";
boklm's avatar
boklm committed
717 718
    copy "$FindBin::Bin/data/cert_override.txt",
          "TorBrowser/Data/Browser/profile.default/cert_override.txt";
719
    $ENV{TOR_SKIP_LAUNCH} = 1;
720 721
    $ENV{TOR_SOCKS_PORT} = $options->{'tor-socks-port'};
    $ENV{TOR_CONTROL_PORT} = $options->{'tor-control-port'};
boklm's avatar
boklm committed
722 723 724
    if ($options->{xdummy}) {
        $tbbinfos->{Xdisplay} = start_X("$tbbinfos->{'results-dir'}/xorg.log");
    }
725 726 727 728 729
}

sub post_tests {
    my ($tbbinfos) = @_;
    TBBTestSuite::Tests::TorBootstrap::stop_tor($tbbinfos);
boklm's avatar
boklm committed
730
    stop_X($tbbinfos->{Xdisplay}) if $options->{xdummy};
731 732 733
}

1;