Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Run a test scenario generator feature file.

 *

 * @package    tool_generator

 * @copyright  2023 Ferran Recio <ferran@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

if (isset($_SERVER['REMOTE_ADDR'])) {

    die(); // No access from web!

}

define('CLI_SCRIPT', true);

require_once(__DIR__ . '/../../../../config.php');

require_once(__DIR__ . '/../../../../lib/clilib.php');

require_once(__DIR__ . '/../../../../lib/behat/classes/behat_config_manager.php');

require_once(__DIR__ . '/../../../../lib/testing/lib.php');

ini_set('display_errors', '1');

ini_set('log_errors', '1');

list($options, $unrecognised) = cli_get_params(

    [

        'help' => false,

        'feature' => '',

        'disable-composer' => false,

        'composer-upgrade' => true,

        'composer-self-update' => true,

        'cleanup' => false,

    ],

    [

        'h' => 'help',

        'f' => 'feature',

        'c' => 'cleanup',

    ]

);

// Checking run.php CLI script usage.

$help = "

Run a feature file into the current Moodle instance. The feature file can only

contains scenarios with core_data_generator steps. It is not yet compatible

with scenario outlines. All scenarios will be executed at once, event background

steps.

Usage:

    php runtestscenario.php    [--feature=\"value\"] [--help]

                            [--no-composer-self-update] [--no-composer-upgrade]

                            [--disable-composer] [--cleanup]

Options:

-f, --feature      Execute specified feature file (Absolute path of feature file).

-c, --cleanup      Execute the scenarios with @cleanup tag.

--no-composer-self-update

Prevent upgrade of the composer utility using its self-update command

--no-composer-upgrade

Prevent update development dependencies using composer

--disable-composer

A shortcut to disable composer self-update and dependency update

Note: Installation of composer and/or dependencies will still happen as required

-h, --help         Print out this help

Example from Moodle root directory:

\$ php admin/tool/generator/cli/runtestscenario.php --feature=/path/to/some/testing/scenario.feature

\$ php admin/tool/generator/cli/runtestscenario.php --feature=/path/to/some/testing/scenario.feature --cleanup

";

if (!empty($options['help'])) {

    echo $help;

    exit(0);

}

// The command will install composer if not present. Usually composer libraries are

// installed when behat or phpunit are installed, but we do not want to force users

// to create all phpunit or behat databases tables just to run a test scenario locally.

if (!file_exists($CFG->dirroot . '/vendor/autoload.php')) {

    // Force OPcache reset if used, we do not want any stale caches

    // when preparing test environment.

    if (function_exists('opcache_reset')) {

        opcache_reset();

    }

    if ($options['disable-composer']) {

        // Disable self-update and upgrade easily.

        // Note: Installation will still occur regardless of this setting.

        $options['composer-self-update'] = false;

        $options['composer-upgrade'] = false;

    }

    // Install and update composer and dependencies as required.

    testing_update_composer_dependencies($options['composer-self-update'], $options['composer-upgrade']);

}

if (empty($options['feature'])) {

    echo "Missing feature file path.\n";

    exit(0);

}

$featurefile = $options['feature'];

if (!file_exists($featurefile)) {

    echo "Feature file not found.\n";

    exit(0);

}

// Switch to admin user account.

\core\session\manager::set_user(get_admin());

$runner = new tool_generator\local\testscenario\runner();

try {

    $runner->init();

} catch (Exception $e) {

    echo "Something is wrong with the behat setup.\n";

    echo "  Please,try running \"php admin/tool/behat/cli/init.php\" from your Moodle root directory.\n";

    exit(0);

}

$content = file_get_contents($featurefile);

if (empty($content)) {

    echo "The feature file is empty.\n";

    exit(0);

}

try {

    if (!empty($options['cleanup'])) {

        $parsedfeature = $runner->parse_cleanup($content);

    } else {

        $parsedfeature = $runner->parse_feature($content);

    }

} catch (\Exception $error) {

    echo "Error parsing feature file: {$error->getMessage()}\n";

    echo "Use the web version of the tool to see the parsing details:\n";

    echo "  Site administration -> development -> Create testing scenarios\n";

    exit(0);

}

if (!$parsedfeature->is_valid()) {

    echo "The file is not valid: {$parsedfeature->get_general_error()}\n";

    echo "Use the web version of the tool to see the details:\n";

    echo "  Site administration -> development -> Create testing scenarios\n";

    exit(0);

}

$total = 0;

$success = 0;

foreach ($parsedfeature->get_all_steps() as $step) {

    if ($step->execute()) {

        echo "\nOK: {$step->get_text()}\n";

        echo "{$step->get_arguments_string()}\n";

        $success++;

    } else {

        echo "\nFAIL: {$step->get_text()}\n";

        echo "{$step->get_arguments_string()}\n";

        echo "{$step->get_error()}\n";

    }

    $total++;

}

echo "\n{$success}/{$total} steps executed successfully.\n";

if ($success < $total) {

    echo "\nSome steps failed.\n";

    exit(1);

} else {

    echo "\nAll steps executed successfully.\n";

    exit(0);

}