mahara_jenkins.php 19.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
#!/usr/bin/php
<?php
/**
 * This is the script that Jenkins executes to run the tests.
 * If it exits with a status of "0" (success) then Jenkins counts
 * the test as a success.
 *
 * If it exits with a non-0 status, Jenkins count the test as
 * a failure.
 *
 * (Specifically, in the "mahara-gerrit" project on our Jenkins
 * server, the one and only build step is to update the
 * mahara-scripts project and then execute this command.)
 */

/**
 * Environment variables passed to us by Jenkins.
 * This is not an exhaustive list, just the ones we're currently using.
 * For a list of variables provided by Jenkins see:
 *    http://test.mahara.org/env-vars.html/
*  For a list of variables provided by the Gerrit Trigger plugin see
*     http://test.mahara.org/plugin/gerrit-trigger/help-whatIsGerritTrigger.html
*  For a list of variables provided by the Git plugin see
*     https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin#GitPlugin-Environmentvariables
 */
$GERRIT_REFSPEC = getenv('GERRIT_REFSPEC');
$GERRIT_BRANCH = getenv('GERRIT_BRANCH');
28 29
$GERRIT_CHANGE_ID = getenv('GERRIT_CHANGE_ID');
$GERRIT_PATCHSET_REVISION = getenv('GERRIT_PATCHSET_REVISION');
30 31 32
$JOB_NAME = getenv('JOB_NAME');
$HOME = getenv('HOME');

33 34 35 36 37 38 39 40 41 42
/**
 * Environment variables set by us in the Jenkins project itself.
 */
$RESTUSERNAME = getenv('RESTUSERNAME');
$RESTPASSWORD = getenv('RESTPASSWORD');
if (!$RESTUSERNAME || !$RESTPASSWORD) {
    echo "\n";
    echo "WARNING: Username and password for the REST api are not present, which prevents posting comments in gerrit.\n";
}

43 44 45 46 47 48 49 50 51 52 53 54
/**
 * Configuration variables
 */
// If a commit is more than $MAXBEHIND commits behind the current tip of the branch, we require
// it to be rebased before running the tests.
$MAXBEHIND = 30;
// The string to look for in commit messages to indicate that it's okay the commit contains no
// new Behat tests.
$BEHATNOTNEEDED = "behatnotneeded";
// The regex we use to check for whether a commit includes new Behat tests (any changes to files)
// that match this regex)
$BEHATTESTREGEX = "^test/behat/features/";
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
// If a user belongs to one of these groups in Gerrit, it means that a member of the Mahara community
// has manually checked them out and added them to the group, so we can trust they're probably not
// an attacker.
$TRUSTED_GERRIT_GROUPS = array(
    'Mahara Reviewers',
    'Mahara Testers'
);
// If a user's primary email address is one of these, we can trust they're probably not an attacker.
// (Gerrit verifies user email addresses to make sure the account's user also controls the email
// address.)
$TRUSTED_EMAIL_DOMAINS = array(
    'catalyst.net.nz',
    'catalyst-au.net',
    'catalyst-eu.net'
);
70

71 72
passthru_or_die("git clean -df");
passthru_or_die("git reset --hard");
73

74 75 76 77 78 79 80
echo "\n";
echo "########## Check the patch is less than $MAXBEHIND patches behind remote branch HEAD\n";
echo "\n";
passthru_or_die("git fetch origin $GERRIT_BRANCH");
echo "";
$behindby = shell_exec_or_die("git rev-list HEAD..origin/$GERRIT_BRANCH | wc -l");
echo "This patch is behind $GERRIT_BRANCH by $behindby commit(s)\n";
81
if ($behindby > $MAXBEHIND) {
82 83 84 85
    gerrit_comment(
            "This patch is more than {$MAXBEHIND} commits behind {$GERRIT_BRANCH}.\n\n"
            ."Please rebase it."
    );
86 87 88
    exit(1);
}

89
echo "\n";
90 91 92
echo "########## Check the patch and its parents are not already rejected\n";
echo "\n";

93 94
# Fetch the git commit ids that exist between this commit and the origin
# that exists when the patch was made.
95
$headcommithash = shell_exec_or_die("git rev-parse HEAD");
96 97 98 99 100 101 102
exec_or_die("git log --pretty=format:'%H' origin/$GERRIT_BRANCH..$headcommithash", $commitancestors);
if (empty($commitancestors)) {
    // No ancestors means this commit is the head of the branch, or is an ancestor of the branch.
    // In which case... well, it's not really either a pass or a failure. But a pass makes more sense.
    echo "Patch already merged\n";
    exit(0);
}
103 104 105 106 107 108 109 110
else {
    if (count($commitancestors) === 1) {
        echo "Patch has no unmerged dependencies. That's good. :)\n";
    }
    else {
        echo "Patch has " . (count($commitancestors)-1) . " unmerged ancestor(s).\n";
    }
}
111 112 113
$firstcommit = true;
$i = 0;

114
$trustedusers = array();
115 116 117
foreach ($commitancestors as $commit) {
    $commit = trim($commit);

118
    $content = gerrit_get('/changes/?q=commit:' . $commit . '+branch:' . $GERRIT_BRANCH . '&o=LABELS&o=CURRENT_REVISION&pp=0');
119 120 121 122 123 124 125 126 127 128 129 130 131 132
    // Because we queried by commit and branch, should return exactly one record.
    $content = $content[0];

    // Doublecheck to see if this has already been merged
    if ($content->status == 'MERGED') {
        // If this commit has been merged, then there's no reason to check it or any earlier ones.
        break;
    }

    $myurl = 'https://reviews.mahara.org/' . $content->_number;

    // Check that the patch we are testing is the latest (current) patchset in series
    if ($content->current_revision != $commit) {
        if ($firstcommit) {
133 134 135 136
            gerrit_comment(
                    "This patchset has been made obsolete by a later patchset in the same Gerrit change set.\n\n"
                        ."This requires no further action; the latest for this change patchset will be tested automatically instead."
            );
137 138
        }
        else {
139 140 141 142 143 144 145 146 147
            $comment = "This patchset is descended from a patchset that is not the latest in its Gerrit change set: $myurl\n\n";
            // This patch is the direct child of the obsolete patch, so just rebase it.
            if ($i === 1) {
                $comment .= "You will need to rebase this patch for the automated tests to pass.";
            }
            else {
                $comment .= "You will need to rebase the descendents of that change, up to and including this change, for the automated tests to pass.";
            }
            gerrit_comment($comment);
148 149 150 151 152 153
        }
        exit(1);
    }

    if ($content->status == 'ABANDONED') {
        if ($firstcommit) {
154
            gerrit_comment("This patch has been abandoned, so there is no need to test it.");
155 156
        }
        else {
157 158 159 160 161
            gerrit_comment(
                    "This patch is descended from an abandoned Gerrit patch: $myurl\n\n"
                        ."You will need to either: restore its abandoned parent patch (probably a bad idea), "
                        ."rebase it onto a different parent (if this patch is still useful), or abandon this patch."
            );
162 163 164 165 166 167
        }
        exit(1);
    }

    if (!empty($content->labels->{'Verified'}->rejected)) {
        if ($firstcommit) {
168 169 170 171
            gerrit_comment(
                    "This patch was marked \"Verified:-1\", which means that it has failed manual testing\n\n"
                        ."Please fix the problems found by the manual testers and submit a revision to this patch."
            );
172
        } else {
173 174 175 176 177
            gerrit_comment(
                    "This patch is descended from a patch that has failed manual testing: $myurl\n\n"
                        ."Please fix the problems in the parent patch. Once the parent patch has passed manual testing, "
                        ."rebase this patch onto the latest version of the parent."
            );
178 179 180
        }
        exit(1);
    }
181

182
    if (!empty($content->labels->{'Code-Review'}->rejected) || !empty($content->labels->{'Code-Review'}->disliked)) {
183
        if ($firstcommit) {
184 185 186 187
            gerrit_comment(
                    "This patch failed manual code review.\n\n"
                    ."Please fix the problems pointed out by the code reviewers, and submit a new revision of this patch."
            );
188
        } else {
189 190 191 192 193
            gerrit_comment(
                    "This patch is descended from a patch that has failed code review: $myurl\n\n"
                        ."Please fix the problems in the parent patch. Once the parent patch has passed code review, "
                        ."rebase this patch onto the latest version of the parent."
            );
194
        }
195 196 197
        exit(1);
    }

198
    if (!$firstcommit && !empty($content->labels->{'Automated-Tests'}->rejected)) {
199 200 201 202 203
        gerrit_comment(
                "This patch is descended from a patch that has failed automated testing: $myurl\n\n"
                    ."Please fix the problems in the parent patch. Once the parent patch has passed automated testing, "
                    ."rebase this patch onto the latest version of the parent."
        );
204 205 206
        exit(1);
    }

207 208 209 210 211 212 213 214 215 216 217 218
    // To prevent attackers from using our Jenkins to execute arbitrary unsafe code, reject any
    // code that was uploaded by someone who has not been manually added to the Mahara Reviewers
    // or Mahara Testers group. Or if the code has a +2 code review, then it's also okay to run.
    $uploader = $content->revisions->{$commit}->uploader->_account_id;

    // Cacheing the list of trusted users to reduce the number of queries we have to make.
    if (!array_key_exists($uploader, $trustedusers)) {
        // Assume we don't trust them, until we find that they belong to a trusted group.
        $trustedusers[$uploader] = false;

        // (note that because we're not authenticating, this will only return their membership
        // in groups that are set to make their list of members public)
219
        $groups = gerrit_get('/accounts/' . $uploader . '/groups/?pp=0');
220
        foreach ($groups as $group) {
221
            if (in_array($group->owner, $TRUSTED_GERRIT_GROUPS)) {
222
                $trustedusers[$uploader] = true;
223 224 225 226 227 228 229 230 231 232 233
                break;
            }
        }

        // If they're not in a trusted group, we can still trust them if they have an email
        // address that marks them as an employee of a Mahara contributor organization
        if (!$trustedusers[$uploader]) {
            $account = gerrit_get('/accounts/' . $uploader . '?pp=0');
            foreach ($TRUSTED_EMAIL_DOMAINS as $domain) {
                // Verify that the user's email address ends with "@" and this domain
                // (Security of this relies on Gerrit to have properly validated their email address's structure)
234
                if (strpos(strrev($account->email), strrev('@' . $domain)) === 0) {
235 236 237
                    $trustedusers[$uploader] = true;
                    break;
                }
238 239 240 241 242 243 244 245
            }
        }
    }

    // If they're not a trusted user, then only run their code if it has passed code review.
    if (!$trustedusers[$uploader]) {
        if (empty($content->labels->{'Code-Review'}->approved)) {
            if ($firstcommit) {
246
                $comment = "This patch was uploaded by an unvetted user in Gerrit.\n\n";
247 248
            }
            else {
249
                $comment = "This patch is descended from a patch that was uploaded by an unvetted user in Gerrit: $myurl\n\n";
250
            }
251 252
            $comment .= "For security purposes, it needs to be code reviewed before it is put through automated testing.";
            gerrit_comment($comment);
253 254 255 256 257 258 259
            exit(1);
        }
        else {
            echo "Commit {$commit} was uploaded by an unvetted user in Gerrit, however it has passed code review, so it is assumed safe for automated testing.\n";
        }
    }

260 261 262 263 264 265
    // SUCCESS!
    if ($firstcommit) {
        echo "$i. This patch is ready for automated testing, so we will continue\n";
    }
    else {
        echo "$i. Ancestor patch with git commit id $commit looks ok so we will continue\n";
266
    }
267
    $firstcommit = false;
268
    $i++;
269 270 271 272 273
}

echo "\n";
echo "########## Run make minaccept\n";
echo "\n";
274 275 276 277 278
passthru_or_die(
        "make minaccept",
        "This patch did not pass the minaccept script.\n\n"
            ."Please run \"make minaccept\" in your local workspace and fix any problems it finds."
);
279 280 281 282 283 284 285

echo "\n";
echo "########## Run install\n";
echo "\n";
passthru("dropdb $JOB_NAME");
passthru_or_die("rm -Rf $HOME/mahara/sitedata/$JOB_NAME/*");
passthru_or_die("rm -Rf $HOME/mahara/sitedata/behat_$JOB_NAME/*");
286
passthru_or_die("createdb -O jenkins -E utf8 $JOB_NAME");
287 288 289 290 291

chdir('htdocs');
passthru_or_die("cp $HOME/mahara/mahara-scripts/jenkins/mahara_config.php config.php");
passthru_or_die(PHP_BINARY . " admin/cli/install.php --adminpassword='password' --adminemail=never@example.com");
chdir('..');
292

293
# Check if composer is not available
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
if (!file_exists("external/composer.json")) {
    exit(0);
}

echo "\n";
echo "########## Install composer\n";
echo "\n";
chdir('external');
passthru_or_die("curl -sS https://getcomposer.org/installer | php");
passthru_or_die(PHP_BINARY . ' composer.phar update');
chdir('..');

echo "\n";
echo "########## Run unit tests\n";
echo "\n";
309 310 311 312 313
passthru_or_die(
        'external/vendor/bin/phpunit htdocs/',
            "This patch caused one or more phpunit tests to fail.\n\n"
            ."Please see the console output on test.mahara.org for details, and fix any failing tests."
);
314

315 316 317 318 319 320 321 322 323
echo "\n";
echo "########## Verify that the patch contains a Behat test\n";
echo "\n";
if (trim(shell_exec("git diff-tree --no-commit-id --name-only -r HEAD | grep -c $BEHATTESTREGEX")) >= 1) {
    echo "Patch includes a Behat test.\n";
}
else {
    # Check whether the commit message has "behatnotneeded" in it.
    if (trim(shell_exec("git log -1 | grep -i -c $BEHATNOTNEEDED")) >= 1) {
324
        echo "This patch does not include a Behat test!\n... but the patch is marked with \"$BEHATNOTNEEDED\", so we will continue.\n";
325 326
    }
    else {
327 328 329 330
        gerrit_comment(
                "This patch does not include a Behat test (an automated test plan).\n\n"
                    ."Please write a Behat test for it, or, if it cannot be tested in Behat or is covered by existing tests, put \"$BEHATNOTNEEDED\" in its commit message."
        );
331 332 333 334
        exit(1);
    }
}

335 336 337
echo "\n";
echo "########## Build & Minify CSS\n";
echo "\n";
338
passthru('make clean-css');
339 340 341 342 343
passthru_or_die(
        'make',
        "This patch encountered an error while attempting to build its CSS.\n\n"
            ."This may be an error in Jenkins"
);
344 345 346 347 348

echo "\n";
echo "########## Run Behat\n";
echo "\n";

349 350 351 352 353
passthru_or_die(
        'test/behat/mahara_behat.sh runheadless',
        "This patch caused one or more Behat tests to fail.\n\n"
            ."Please see the console output on test.mahara.org for details, and fix any failing tests."
);
354 355 356 357 358 359 360 361 362

exit(0);


///////////////////////////////////// FUNCTIONS ///////////////////////////////////////
/**
 * Call this function to do passthru(), but die if the command that was being
 * invoked exited with a non-success return value.
 *
363 364
 * @param string $command The command to run
 * @param string $diemsg If we die, then print this message explaining why we died.
365
 */
366
function passthru_or_die($command, $diemsg = null) {
367 368
    passthru($command, $return_var);
    if ($return_var !== 0) {
369 370 371 372 373 374 375 376 377 378
        if ($diemsg) {
            gerrit_comment($diemsg);
        }
        else {
            gerrit_comment(
                    "This patch failed attempting to run this command:\n{$command}\n\n"
                    ."This is probably an error in Jenkins. Please retrigger this patch when the problem in Jenkins has been resolved."
                    ,false
            );
        }
379 380 381 382 383 384 385 386 387 388 389
        log_and_die($command, $return_var);
    }
}

/**
 * Call this function to do exec() but die if the command errored out.
 * @param unknown $command
 */
function exec_or_die($command, &$output = null, &$return_var = null) {
    $returnstring = exec($command, $output, $return_var);
    if ($return_var !== 0) {
390 391 392 393 394
        gerrit_comment(
                "This patch failed attempting to run this command:\n{$command}\n\n"
                ."This is probably an error in Jenkins. Please retrigger this patch when the problem in Jenkins has been resolved."
                , false
        );
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
        log_and_die($command, $return_var);
    }

    return $returnstring;
}


/**
 * This function emulates shellexec(), but dies if the command that was being
 * invoked exited with a non-success exit value.
 *
 * Because it calls exec() on the backend, it also has the side effect of
 * trimming whitespace from the return value (unlike shellexec(), which normally
 * includes the ending "\n" on the output)
 *
 * @param unknown $command
 */
function shell_exec_or_die($command) {
    // shellexec() doesn't normally give you access to the command's exit code,
    // so we instead will call exec()
    exec_or_die($command, $output);

    return implode("\n", $output);
}

420

421 422 423 424 425 426 427 428 429 430 431 432 433 434
/**
 * Call this method to die after a bad command. It prints an error message
 * about the command that failed, and then exits with status code 1.
 * @param string $commandtolog The command to log a message about
 * @param integer $itsreturnvar The return value of that command
 */
function log_and_die($commandtolog, $itsreturnvar) {
    echo "\nEXITING WITH FAILURE\n";
    echo "ERROR: Return value of '$itsreturnvar' on this command:\n";
    echo "$commandtolog\n";
    echo "\n";
    debug_print_backtrace();
    echo "\n";
    exit(1);
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 462 463
 * Post this message as a comment in gerrit, and optionally print it to the Jenkins console too.
 * @param string $comment (Shouldn't have a newline on the end)
 * @param boolean $printtoconsole If true, also print this message to the Jenkins console (STDOUT)
 */
function gerrit_comment($comment, $printtoconsole = true) {
    global $GERRIT_CHANGE_ID, $GERRIT_BRANCH, $GERRIT_PATCHSET_REVISION;

    if ($printtoconsole) {
        echo $comment;
        echo "\n";
    }

    $reviewinput = (object) array(
            'message' => $comment . " :)",
            'notify' => 'NONE',
    );
    $changeid = rawurlencode("mahara~{$GERRIT_BRANCH}~{$GERRIT_CHANGE_ID}");
    $revisionid = $GERRIT_PATCHSET_REVISION;
    $url = "/changes/{$changeid}/revisions/{$revisionid}/review?pp=0";
    gerrit_post($url, $reviewinput, true);
}


/**
 * Make an unauthenticated GET request to gerrit's REST service.
464 465
 *
 * @param string $relurl The relative URL of the REST service. URL query component should include 'pp=0'
466
 * @return mixed The json-decoded return value from Gerrit.
467
 */
468
function gerrit_get($relurl) {
469 470 471 472 473 474 475 476
    $ch = curl_init();
    if ($relurl[0] !== '/') {
        $relurl = '/' . $relurl;
    }
    curl_setopt($ch, CURLOPT_URL, 'https://reviews.mahara.org' . $relurl);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    $content = curl_exec($ch);
    curl_close($ch);
477 478 479 480 481 482 483 484 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 523 524 525 526 527 528 529
    // We need to fetch the json line from the result
    $content = explode("\n", $content);
    return json_decode($content[1]);
}

/**
 * Make a POST request to gerrit's REST service.
 *
 * @param string $relurl Relative URL of the REST service. URL query component should include 'pp=0'
 * @param unknown $postobj A PHP object to include in the POST body (will be json-encoded by this function)
 * @param string boolean Whether or not to use authentication
 * @return mixed The json-decoded return value from Gerrit.
 */
function gerrit_post($relurl, $postobj, $authenticated = false) {
    global $RESTUSERNAME, $RESTPASSWORD;

    $ch = curl_init();
    if ($relurl[0] !== '/') {
        $relurl = '/' . $relurl;
    }
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    $postbody = urldecode(json_encode($postobj));
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $postbody);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=UTF-8'));

    if ($authenticated) {
        // Can't make an authenticated request if the usernme and password aren't provided.
        if (!$RESTUSERNAME || !$RESTPASSWORD) {
            // No need to log this because we already posted a warning about it at the top
            // of the page.
            return array();
        }
        $relurl = '/a' . $relurl;
        curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
        curl_setopt($ch, CURLOPT_USERPWD, "$RESTUSERNAME:$RESTPASSWORD");
    }

    curl_setopt($ch, CURLOPT_URL, 'https://reviews.mahara.org' . $relurl);
    $content = curl_exec($ch);

    $responsecode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($responsecode !== 200) {
        echo "WARNING: Error attempting to access Gerrit REST api.\n";
        echo "URL: $relurl\n";
        echo "Response:\n";
        echo $content;
        echo "\n";
        return array();
    }

530 531 532
    // We need to fetch the json line from the result
    $content = explode("\n", $content);
    return json_decode($content[1]);
533
}