Eigene Schritte schreiben

Wie werden die einzelnen Schritte eines Tests ausgeführt?

Die einzelnen Testschritte sind jeweils einer PHP-Funktion zugeordnet. Diese Funktionen können schlicht Änderungen an der Moodle-Instanz vornehmen (z. B. Admin-Settings setzen) oder aber auf Verhalten prüfen und bei Fehlschlag eine "Exception" werfen.

Die Zuordnung "Behat-Testschritt → PHP-Funktion" erfolgt über eine Kommentar-Annotation der entsprechenden PHP-Funktion. Werden die Behat-Tests mit der Flag --format=pretty ausgeführt, wird zu jedem durchgeführten Schritt die zugehörige PHP-Funktion angegeben.

Beispiel:

And I log in as "admin"            # behat_auth::i_log_in_as()

Im Scope "behat_auth" befindet sich also eine Funktion "i_log_in_as()". Wird in einem Moodle-Verzeichnis nach "behat_auth" gesucht, so findet sich die Datei "auth\tests\behat\behat_auth.php". In dieser Datei befindet sich die Klasse behat_auth, die von behat_base erbt, und innerhalb der Klasse die entsprechende Funktion i_log_in_as().

auth/tests/behat/behat_auth.php

<?php
[...]
require_once(__DIR__ . '/../../../lib/behat/behat_base.php');
[...]
class behat_auth extends behat_base {
 
    /**
     * Logs in the user. There should exist a user with the same value as username and password.
     *
     * @Given /^I log in as "(?P<username_string>(?:[^"]|\\")*)"$/
     * @Given I am logged in as :username
     * @param string $username the user to log in as.
     * @param moodle_url|null $wantsurl optional, URL to go to after logging in.
     */
    public function i_log_in_as(string $username, moodle_url $wantsurl = null) {
        // In the mobile app the required tasks are different (does not support $wantsurl).
        if ($this->is_in_app()) {
            $this->execute('behat_app::login', [$username]);
            return;
        }
 
        $loginurl = new moodle_url('/auth/tests/behat/login.php', [
            'username' => $username,
        ]);
        if ($wantsurl !== null) {
            $loginurl->param('wantsurl', $wantsurl->out_as_local_url());
        }
 
        // Visit login page.
        $this->execute('behat_general::i_visit', [$loginurl]);
    }
    [...]
}

if (!$this->running_javascript()) {
    throw new DriverException("JavaScript-Engine is not running.");
}
$jsvariable = "<javascript-code-snippet>";
 
$result = $this->evaluate_script($jsvariable);