RoboFile.php

<?php
/**
 * @package     Joomla.Site
 * @subpackage  RoboFile
 *
 * @copyright   Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

use Robo\Tasks;

/**
 * This is joomla project's console command file for Robo.li task runner.
 *
 * Do a `$ composer install` afterwards you will be able to execute robo like
 * `$ ./libraries/vendor/bin/robo` to see a list of commands
 *
 * @see         http://robo.li/
 */
require_once __DIR__ . '/libraries/vendor/autoload.php';

if (!defined('JPATH_BASE'))
{
	define('JPATH_BASE', __DIR__);
}

/**
 * System Test (Codeception) test execution for Joomla!
 *
 * @package  RoboFile
 *
 * @since    3.7.3
 */
class RoboFile extends Tasks
{
	use JoomlaRobo\Tasks;

	/**
	 * Path to the Selenium folder#
	 *
	 * @var   string
	 * @since  3.7.3
	 */
	const SELENIUM_FOLDER = __DIR__ . '/libraries/vendor/joomla-projects/selenium-server-standalone';

	/**
	 * Path to the vendor folder
	 *
	 * @var   string
	 * @since  3.7.3
	 */
	private $vendorPath = 'libraries/vendor/';

	/**
	 * Path to the tests
	 *
	 * @var    string
	 * @since  4.0.0
	 */
	private $testsPath = 'tests/Codeception/';

	/**
	 * @var array | null
	 * @since  3.7.3
	 */
	private $suiteConfig;

	/**
	 * RoboFile constructor.
	 *
	 * @since   3.7.3
	 */
	public function __construct()
	{
		// Set default timezone (so no warnings are generated if it is not set)
		date_default_timezone_set('UTC');
	}

	/**
	 * Creates a testing Joomla site for running the tests (use it before run:test)
	 *
	 * @param   bool  $useHtaccess  (1/0) Rename and enable embedded Joomla .htaccess file
	 *
	 * @return  void
	 * @since   3.7.3
	 *
	 * @throws  Exception
	 */
	public function createTestingSite($useHtaccess = false)
	{
		$cmsPath   = $this->getSuiteConfig()['modules']['config']['Helper\\Acceptance']['cmsPath'];
		$localUser = $this->getSuiteConfig()['modules']['config']['Helper\\Acceptance']['localUser'];

		// Clean old testing site
		if (is_dir($cmsPath))
		{
			try
			{
				$this->taskDeleteDir($cmsPath)->run();
			}
			catch (Exception $e)
			{
				// Sorry, we tried :(
				$this->say('Sorry, you will have to delete ' . $cmsPath . ' manually.');

				exit(1);
			}
		}

		$exclude = [
			'.drone',
			'.github',
			'.git',
			'.run',
			'.idea',
			'build',
			'dev',
			'node_modules',
			'tests',
			'test-install',
			'.appveyor.yml',
			'.babelrc',
			'.drone.yml',
			'.editorconfig',
			'.eslintignore',
			'.eslintrc',
			'.gitignore',
			'.hound.yml',
			'.php_cs',
			'.travis.yml',
			'appveyor-phpunit.xml',
			'build.js',
			'build.xml',
			'codeception.yml',
			'composer.json',
			'composer.lock',
			'configuration.php',
			'drone-package.json',
			'Gemfile',
			'htaccess.txt',
			'karma.conf.js',
			'package.json',
			'package-lock.json',
			'phpunit.xml.dist',
			'RoboFile.dist.ini',
			'RoboFile.php',
			'robots.txt.dist',
			'scss-lint.yml',
			'selenium.log',
			'travisci-phpunit.xml',
		];

		$this->copyJoomla($cmsPath, $exclude);

		// Optionally change owner to fix permissions issues
		if (!empty($localUser))
		{
			$this->_exec('chown -R ' . $localUser . ' ' . $cmsPath);
		}

		// Optionally uses Joomla default htaccess file. Used by TravisCI
		if ($useHtaccess == true)
		{
			$this->say('Renaming htaccess.txt to .htaccess');
			$this->_copy('./htaccess.txt', $cmsPath . '/.htaccess');
			$this->_exec('sed -e "s,# RewriteBase /,RewriteBase /test-install/joomla-cms,g" -in-place test-install/joomla-cms/.htaccess');
		}
	}

	/**
	 * Copy the Joomla installation excluding folders
	 *
	 * @param   string  $dst      Target folder
	 * @param   array   $exclude  Exclude list of folders
	 *
	 * @throws  Exception
	 *
	 * @since   3.7.3
	 *
	 * @return  void
	 */
	protected function copyJoomla($dst, $exclude = array())
	{
		$dir = @opendir(".");

		if (false === $dir)
		{
			throw new Exception($this, "Cannot open source directory");
		}

		if (!is_dir($dst))
		{
			mkdir($dst, 0755, true);
		}

		while (false !== ($file = readdir($dir)))
		{
			if (in_array($file, $exclude))
			{
				continue;
			}

			if (($file !== '.') && ($file !== '..'))
			{
				$srcFile  = "." . '/' . $file;
				$destFile = $dst . '/' . $file;

				if (is_dir($srcFile))
				{
					$this->_copyDir($srcFile, $destFile);
				}
				else
				{
					copy($srcFile, $destFile);
				}
			}
		}

		closedir($dir);
	}

	/**
	 * Executes all the Selenium System Tests in a suite on your machine
	 *
	 * @param   array  $opts  Array of configuration options:
	 *                        - 'use-htaccess': renames and enable embedded Joomla .htaccess file
	 *                        - 'env': set a specific environment to get configuration from
	 *
	 * @return  void
	 * @since   3.7.3
	 *
	 * @throws  Exception
	 */
	public function runTests($opts = ['use-htaccess' => false, 'env' => 'desktop'])
	{
		$this->say("Running tests");

		$pathToCodeception = $this->prepareRun($opts);

		$suites = [
			'acceptance/install/',
			'acceptance/administrator/components/com_content',
			'acceptance/administrator/components/com_media',
			'acceptance/administrator/components/com_menu',
			'acceptance/administrator/components/com_users',
		];

		foreach ($suites as $suite) {
			$this->taskCodecept($pathToCodeception)
				->arg('--fail-fast')
				->arg('--steps')
				->arg('--debug')
				->env($opts['env'])
				->arg($this->testsPath . $suite)
				->run()
				->stopOnFail();
		}
	}

	/**
	 * Install only Joomla
	 *
	 * @param   array  $opts  Additional options
	 *
	 * @return  void
	 * @since   4.0.0
	 *
	 * @throws  Exception
	 */
	public function runInstall($opts = ['use-htaccess' => false, 'env' => 'desktop'])
	{
		$this->say("Running Installation");

		$pathToCodeception = $this->prepareRun($opts);

		$this->taskCodecept($pathToCodeception)
			->arg('--fail-fast')
			->arg('--steps')
			->arg('--debug')
			->env($opts['env'])
			->arg($this->testsPath . 'acceptance/install/')
			->run()
			->stopOnFail();
	}

	/**
	 * Prepare the installation
	 *
	 * @param   array  $opts  Optional Options
	 *
	 * @return  string  Path to codeception
	 *
	 * @since   4.0.0
	 * @throws  Exception
	 */
	protected function prepareRun($opts = ['use-htaccess' => false, 'env' => 'desktop'])
	{
		$this->createTestingSite($opts['use-htaccess']);

		$this->taskRunSelenium(self::SELENIUM_FOLDER, $this->getWebdriver())->run();

		// Wait until the server started
		sleep(3);

		// Make sure to run the build command to generate AcceptanceTester
		if ($this->isWindows())
		{
			$this->_exec('php ' . $this->getWindowsPath($this->vendorPath . 'bin/codecept') . ' build');
			$pathToCodeception = $this->getWindowsPath($this->vendorPath . 'bin/codecept');
		}
		else
		{
			$this->_exec('php ' . $this->vendorPath . 'bin/codecept build');

			$pathToCodeception = $this->vendorPath . 'bin/codecept';
		}

		return $pathToCodeception;
	}

	/**
	 * Executes a specific Selenium System Tests in your machine
	 *
	 * @param   string  $pathToTestFile  Optional name of the test to be run
	 * @param   string  $suite           Optional name of the suite containing the tests, Acceptance by default.
	 *
	 * @since   3.7.3
	 *
	 * @throws  Exception  if test not found
	 *
	 * @return  void
	 */
	public function runTest($pathToTestFile = null, $suite = 'acceptance')
	{
		$this->taskRunSelenium(self::SELENIUM_FOLDER, $this->getWebdriver());

		// Make sure to run the build command to generate AcceptanceTester
		$path = $this->vendorPath . 'bin/codecept';
		$this->_exec('php ' . $this->isWindows() ? $this->getWindowsPath($path) : $path . ' build');

		if (!$pathToTestFile)
		{
			$this->say('Available tests in the system:');

			$iterator = new RecursiveIteratorIterator(
				new RecursiveDirectoryIterator(
					$this->testsPath . '/' . $suite,
					RecursiveDirectoryIterator::SKIP_DOTS
				),
				RecursiveIteratorIterator::SELF_FIRST
			);

			$tests = array();
			$i     = 1;

			$iterator->rewind();

			while ($iterator->valid())
			{
				if (strripos($iterator->getSubPathName(), 'cept.php')
					|| strripos($iterator->getSubPathName(), 'cest.php')
					|| strripos($iterator->getSubPathName(), '.feature')
				)
				{
					$this->say('[' . $i . '] ' . $iterator->getSubPathName());

					$tests[$i] = $iterator->getSubPathName();
					$i++;
				}

				$iterator->next();
			}

			$this->say('');
			$testNumber = $this->ask('Type the number of the test in the list that you want to run...');
			$test       = $tests[$testNumber];
		}

		$pathToTestFile = $this->testsPath . '/' . $suite . '/' . $test;

		// Loading the class to display the methods in the class

		// Logic to fetch the class name from the file name
		$fileName = explode("/", $test);

		// If the selected file is cest only then we will give the option to execute individual methods, we don't need this in cept or feature files
		$i = 1;

		if (isset($fileName[1]) && strripos($fileName[1], 'cest'))
		{
			require $this->testsPath . '/' . $suite . '/' . $test;

			$className     = explode(".", $fileName[1]);
			$class_methods = get_class_methods($className[0]);

			$this->say('[' . $i . '] ' . 'All');

			$methods[$i] = 'All';
			$i++;

			foreach ($class_methods as $method_name)
			{
				$reflect = new ReflectionMethod($className[0], $method_name);

				if (!$reflect->isConstructor() && $reflect->isPublic())
				{
					$this->say('[' . $i . '] ' . $method_name);

					$methods[$i] = $method_name;

					$i++;
				}
			}

			$this->say('');
			$methodNumber = $this->ask('Please choose the method in the test that you would want to run...');
			$method       = $methods[$methodNumber];
		}

		if (isset($method) && $method != 'All')
		{
			$pathToTestFile = $pathToTestFile . ':' . $method;
		}

		$testPathCodecept = $this->vendorPath . 'bin/codecept';

		$this->taskCodecept($this->isWindows() ? $this->getWindowsPath($testPathCodecept) : $testPathCodecept)
			->test($pathToTestFile)
			->arg('--steps')
			->arg('--debug')
			->run()
			->stopOnFail();
	}

	/**
	 * Check if local OS is Windows
	 *
	 * @return  bool
	 *
	 * @since   3.7.3
	 */
	private function isWindows()
	{
		return strtoupper(substr(PHP_OS, 0, 3)) === 'WIN';
	}

	/**
	 * Return the correct path for Windows (needed by CMD)
	 *
	 * @param   string  $path  Linux path
	 *
	 * @return  string
	 *
	 * @since   3.7.3
	 */
	private function getWindowsPath($path)
	{
		return str_replace('/', DIRECTORY_SEPARATOR, $path);
	}

	/**
	 * Detect the correct driver for selenium
	 *
	 * @return  string the webdriver string to use with selenium
	 *
	 * @since   3.7.3
	 */
	public function getWebdriver()
	{
		$suiteConfig = $this->getSuiteConfig();
		$driver      = $suiteConfig['modules']['config']['JoomlaBrowser']['browser'];

		return $driver;
	}

	/**
	 * Get the suite configuration
	 *
	 * @param   string  $suite  Name of the test suite
	 *
	 * @return  array
	 *
	 * @since   3.7.3
	 */
	private function getSuiteConfig($suite = 'acceptance')
	{
		if (!$this->suiteConfig)
		{
			$this->suiteConfig = Symfony\Component\Yaml\Yaml::parse(file_get_contents(__DIR__ . '/tests/Codeception/' . $suite . '.suite.yml'));
		}

		return $this->suiteConfig;
	}
}