RoboFile.php

<?php
/**
 * This is project's console commands configuration for Robo task runner.
 *
 * Download robo.phar from http://robo.li/robo.phar and type in the root of the repo: $ php robo.phar
 * Or do: $ composer update, and afterwards you will be able to execute robo like $ php vendor/bin/robo
 *
 * @see  http://robo.li/
 * @copyright   Copyright (C) 2008 - 2020 redCOMPONENT.com. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */
require_once 'vendor/autoload.php';

/**
 * Class RoboFile
 *
 * @since  1.0.0
 */
class RoboFile extends \Robo\Tasks
{
	// Load tasks from composer, see composer.json
	use Joomla\Testing\Robo\Tasks\LoadTasks;

	/**
	 * @var   array
	 * @var   array
	 * @since __DEPLOY_VERSION__
	 */
	private $defaultArgs = [
		'--tap',
		'--fail-fast'
	];

	/**
	 * Downloads and prepares a Joomla CMS site for testing
	 *
	 * @param   integer  $use_htaccess  (1/0) Rename and enable embedded Joomla .htaccess file
	 * @param   integer  $cleanUp       Clean up the directory when present (or skip the cloning process)
	 *
	 * @return  void
	 * @since   1.0.0
	 */
	public function testsSitePreparation($use_htaccess = 1, $cleanUp = 1)
	{
		$skipCleanup = false;
		// Get Joomla Clean Testing sites
		if (is_dir('tests/joomla-cms'))
		{
			if (!$cleanUp)
			{
				$skipCleanup = true;
				$this->say('Using cached version of Joomla CMS and skipping clone process');
			}
			else
			{
				$this->taskDeleteDir('tests/joomla-cms')->run();
			}
		}
		if (!$skipCleanup)
		{
			$version = 'staging';

			/*
			* When joomla Staging branch has a bug you can uncomment the following line as a tmp fix for the tests layer.
			* Use as $version value the latest tagged stable version at: https://github.com/joomla/joomla-cms/releases
			*/
			$version = '3.9.18';

			$this->_exec("git clone -b $version --single-branch --depth 1 https://github.com/joomla/joomla-cms.git tests/joomla-cms");
			$this->say("Joomla CMS ($version) site created at tests/joomla-cms");
		}
		// Optionally uses Joomla default htaccess file
		if ($use_htaccess == 1)
		{
			$this->_copy('tests/joomla-cms/htaccess.txt', 'tests/joomla-cms/.htaccess');
			$this->_exec('sed -e "s,# RewriteBase /,RewriteBase /tests/joomla-cms/,g" --in-place tests/joomla-cms/.htaccess');
		}
	}

	/**
	 * Downloads Paid Extensions for Integration Testing testing
	 *
	 * @param   integer  $cleanUp  Clean up the directory when present (or skip the cloning process)
	 *
	 * @return  void
	 * @since   2.1.2
	 */
	public function testsPaidExtensionsForIntegrationTests($cleanUp = 1)
	{
		// Delete any previous core
		if (is_dir('tests/extension/paid-extensions'))
		{
			if (!$cleanUp)
			{
				$this->say('Using cached version of Aesir Core and skipping clone process');

				return;
			}

			$this->taskDeleteDir('tests/extension/paid-extensions')->run();
		}

		$version = 'master';
		$this->_exec("git clone --recursive -b $version --single-branch https://REDWEB_QA_TOKEN:aXpne9NyZmDVt2R5cxjY@gitlab.redweb.dk/redshop-extensions/redshop-paid-extensions tests/extension/paid-extensions");

		$this->say("paid-extensions ($version) cloned at tests/extension/");
	}

	/**
	 * Tests setup
	 *
	 * @param   boolean  $debug         Add debug to the parameters
	 * @param   boolean  $steps         Add steps to the parameters
	 * @param   boolean  $extraVerbose  Add extra verbosity
	 *
	 * @return  void
	 * @since   __DEPLOY_VERSION__
	 */
	public function testsSetup($debug = true, $steps = true, $extraVerbose = false)
	{
		$args = [];

		if ($debug)
		{
			$args[] = '--debug';
		}

		if ($steps)
		{
			$args[] = '--steps';
		}

		if ($extraVerbose)
		{
			$args[] = '-vvv';
		}

		$args = array_merge(
			$args,
			$this->defaultArgs
		);

		// Sets the output_append variable in case it's not yet
		if (getenv('output_append') === false)
		{
			putenv('output_append=');
		}

		// Builds codeception
		$this->_exec("vendor/bin/codecept build");

		// Executes the initial set up
		$this->taskCodecept()
			->args($args)
			->arg('tests/acceptance/install/core')
			->run()
			->stopOnFail();
	}

	/**
	 * Individual test folder execution
	 *
	 * @param   string   $folder        Folder to execute codecept run to
	 * @param   boolean  $debug         Add debug to the parameters
	 * @param   boolean  $steps         Add steps to the parameters
	 * @param   boolean  $extraVerbose  Add extra verbosity
	 *
	 * @return  void
	 * @since   __DEPLOY_VERSION__
	 */
	public function testsRun($folder, $debug = true, $steps = true, $extraVerbose = false)
	{
		$args = [];

		if ($debug)
		{
			$args[] = '--debug';
		}

		if ($steps)
		{
			$args[] = '--steps';
		}

		if ($extraVerbose)
		{
			$args[] = '-vvv';
		}

		$args = array_merge(
			$args,
			$this->defaultArgs
		);

		// Sets the output_append variable in case it's not yet
		if (getenv('output_append') === false)
		{
			putenv('output_append=');
		}

		// Codeception build
		$this->_exec("vendor/bin/codecept build");

		// Actual execution of Codeception test
		$this->taskCodecept()
			->args($args)
			->arg('tests/' . $folder . '/')
			->run()
			->stopOnFail();
	}

	/**
	 * Sends the build report error back to Slack
	 *
	 * @param   string  $cloudinaryName       Cloudinary cloud name
	 * @param   string  $cloudinaryApiKey     Cloudinary API key
	 * @param   string  $cloudinaryApiSecret  Cloudinary API secret
	 * @param   string  $githubRepository     GitHub repository (owner/repo)
	 * @param   string  $githubPRNo           GitHub PR #
	 * @param   string  $slackWebhook         Slack Webhook URL
	 * @param   string  $slackChannel         Slack channel
	 * @param   string  $buildURL             Build URL
	 *
	 * @return  void
	 * @since   __DEPLOY_VERSION__
	 */
	public function sendBuildReportErrorSlack($cloudinaryName, $cloudinaryApiKey, $cloudinaryApiSecret, $githubRepository, $githubPRNo, $slackWebhook, $slackChannel, $buildURL = '')
	{
		$directories = glob('tests/_output/*' , GLOB_ONLYDIR);

		foreach ($directories as $directory)
		{
			$this->sendBuildReportErrorSlackDirectory($directory, $cloudinaryName, $cloudinaryApiKey, $cloudinaryApiSecret, $githubRepository, $githubPRNo, $slackWebhook, $slackChannel, $buildURL);
		}
	}

	/**
	 * Sends the build report error back to Slack
	 *
	 * @param   string  $directory            Directory to explore
	 * @param   string  $cloudinaryName       Cloudinary cloud name
	 * @param   string  $cloudinaryApiKey     Cloudinary API key
	 * @param   string  $cloudinaryApiSecret  Cloudinary API secret
	 * @param   string  $githubRepository     GitHub repository (owner/repo)
	 * @param   string  $githubPRNo           GitHub PR #
	 * @param   string  $slackWebhook         Slack Webhook URL
	 * @param   string  $slackChannel         Slack channel
	 * @param   string  $buildURL             Build URL
	 *
	 * @return  void
	 * @since   __DEPLOY_VERSION__
	 */
	public function sendBuildReportErrorSlackDirectory($directory, $cloudinaryName, $cloudinaryApiKey, $cloudinaryApiSecret, $githubRepository, $githubPRNo, $slackWebhook, $slackChannel, $buildURL = '')
	{
		$errorSelenium = true;
		$reportError = false;
		$reportFile = $directory . '/selenium.log';
		$errorLog = 'Selenium log in ' . $directory . ':' . chr(10). chr(10);
		$this->say('Starting to Prepare Build Report');

		$this->say('Exploring folder ' . $directory . ' for error reports');
		// Loop through Codeception snapshots
		if (file_exists($directory) && $handler = opendir($directory))
		{
			$reportFile = $directory . '/report.tap.log';
			$errorLog = 'Codeception tap log in ' . $directory . ':' . chr(10). chr(10);
			$errorSelenium = false;
		}

		if (file_exists($reportFile))
		{
			$this->say('Report File Prepared');
			if ($reportFile)
			{
				$errorLog .= file_get_contents($reportFile, null, null, 15);
			}

			if (!$errorSelenium)
			{
				$handler = opendir($directory);
				$errorImage = '';

				while (!$reportError && false !== ($errorSnapshot = readdir($handler)))
				{
					// Avoid sending system files or html files
					if (!('png' === pathinfo($errorSnapshot, PATHINFO_EXTENSION)))
					{
						continue;
					}

					$reportError = true;
					$errorImage = $directory . '/' . $errorSnapshot;
				}
			}

			if ($reportError || $errorSelenium)
			{
				// Sends the error report to Slack
				$this->say('Sending Error Report');
				$reportingTask = $this->taskReporting()
					->setCloudinaryCloudName($cloudinaryName)
					->setCloudinaryApiKey($cloudinaryApiKey)
					->setCloudinaryApiSecret($cloudinaryApiSecret)
					->setGithubRepo($githubRepository)
					->setGithubPR($githubPRNo)
					->setBuildURL($buildURL . 'display/redirect')
					->setSlackWebhook($slackWebhook)
					->setSlackChannel($slackChannel)
					->setTapLog($errorLog);

				if (!empty($errorImage))
				{
					$reportingTask->setImagesToUpload($errorImage)
						->publishCloudinaryImages();
				}

				$reportingTask->publishBuildReportToSlack()
					->run()
					->stopOnFail();
			}
		}
	}
}