Appendix C - Automated Testing

DATABASE_DRIVER=MYSQL
DATABASE_NAME=automated_tests
DATABASE_HOST=localhost
DATABASE_USER=automated_tests
DATABASE_PASSWORD=automated_tests
INSTANCE_URL=http://path/to/instance
INSTANCE_ADMIN_USER=admin
INSTANCE_ADMIN_PASSWORD=admin
INSTANCE_CLIENT_ID=suitecrm_client
INSTANCE_CLIENT_SECRET=secret

version: '3'
services:
  php:
      image: php:7.0-apache
      restart: always
      ports:
        - 9001:80
      environment:
       - DATABASE_DRIVER: $DATABASE_DRIVER
       - DATABASE_NAME: $DATABASE_NAME
       - DATABASE_HOST: $DATABASE_HOST
       - DATABASE_USER: $DATABASE_USER
       - DATABASE_PASSWORD: $DATABASE_PASSWORD
       - INSTANCE_URL: $INSTANCE_URL
       - INSTANCE_ADMIN_USER: $INSTANCE_ADMIN_USER
       - INSTANCE_ADMIN_PASSWORD: $INSTANCE_ADMIN_PASSWORD
       - INSTANCE_CLIENT_ID: $INSTANCE_CLIENT_ID
       - INSTANCE_CLIENT_SECRET: $INSTANCE_CLIENT_SECRET

version: '3'
services:
    selenium-hub:
      image: selenium/hub
      restart: always
      ports:
        - 4444:4444
    selenium-node-chrome:
      image: selenium/node-chrome-debug
      restart: always
      ports:
        - 5900:5900
      links:
        - selenium-hub:hub
      environment:
              - "HUB_PORT_4444_TCP_ADDR=selenium-hub"
              - "HUB_PORT_4444_TCP_PORT=4444"
    selenium-node-firefox:
      image: selenium/node-firefox-debug
      restart: always
      ports:
        - 5901:5900
      links:
        - selenium-hub:hub
      environment:
              - "HUB_PORT_4444_TCP_ADDR=selenium-hub"
              - "HUB_PORT_4444_TCP_PORT=4444"

use SuiteCRM;

// note: SuiteCRM\StateCheckerPHPUnitTestCaseAbstract extends PHPUnit_Framework_TestCase;

class ExampleTest extends StateCheckerPHPUnitTestCaseAbstract {

    public function testDoingSomething() {
        $example = new Example();
        $results = $example->goSomthing();
        $this->assertSame('expected value', $results);
    }

}

use SuiteCRM;

// note: SuiteCRM\StateCheckerUnitAbstract extends \Codeception\Test\Unit;


class ExampleTest extends StateCheckerUnitAbstract
{
    public function testDoingSomething()
    {
        $example = new Example();
        $results = $example->goSomthing();
        $this->assertSame('expected value', $results);
    }
}

use SuiteCRM;

class SigninCest extends StateCheckerCestAbstract
{
    public function tryToTest(AcceptanceTester $I)
    {
        $I->wantTo('test my page');
    }
}

use SuiteCRM;

$_POST['foo'] = 'bar';

// create a new instance of StateChecker:
$stateSaver = new StateSaver();

// save all superglobals
$stateSaver->pushGlobals();

$_POST['foo'] = 'bazz';

// restore super globals
$stateSaver->popGlobals();

echo $_POST['foo']; // output: bar

use SuiteCRM;

// create a new instance of StateChecker:
$stateSaver = new StateSaver();
$stateSaver->pushTable('stufftable');

// modify your database table here. (insert/update/delete..)
...

$stateSaver->popTable('stufftable');

// restore your database table 'stufftable' here.

`$_POST['foo'] = 'bar';`

"/usr/bin/php" "/var/www/html/SuiteCRM/vendor/bin/codecept" "run" "unit" "-f" "--steps" "-vvv" "--debug"
Cannot load Xdebug - extension already loaded
Codeception PHP Testing Framework v2.4.0
Powered by PHPUnit 4.8.36 by Sebastian Bergmann and contributors.

Unit Tests (1583) --------------------------------------------------------------
Modules: Asserts, \Helper\Unit
--------------------------------------------------------------------------------
- configTest: Test_config
✖ configTest: Test_config (16.57s)
--------------------------------------------------------------------------------


Time: 29.52 seconds, Memory: 2288.50MB

There was 1 failure:

---------
1) configTest: Test_config
 Test  tests/unit/configTest.php:test_config
Incorrect state hash: Hash doesn't match at key "globals::_POST"
...

`file_put_contents('foo.txt', rand(0, 1234));`

"/usr/bin/php" "/var/www/html/SuiteCRM/vendor/bin/codecept" "run" "unit" "-f" "--steps" "-vvv" "--debug"
Cannot load Xdebug - extension already loaded
Codeception PHP Testing Framework v2.4.0
Powered by PHPUnit 4.8.36 by Sebastian Bergmann and contributors.

Unit Tests (1583) --------------------------------------------------------------
Modules: Asserts, \Helper\Unit
--------------------------------------------------------------------------------
- configTest: Test_config
✖ configTest: Test_config (10.79s)
--------------------------------------------------------------------------------


Time: 23.12 seconds, Memory: 1875.00MB

There was 1 failure:

---------
1) configTest: Test_config
 Test  tests/unit/configTest.php:test_config
Incorrect state hash: Hash doesn't match at key "filesys::/var/www/html/SuiteCRM/foo.txt".
...

	// Save state

        // Create an instance of StateChecker
        $state = new \SuiteCRM\StateSaver();
        $state->pushGlobals();    // saving superglobals
        $state->pushTable('your_module_stuffs'); // saving a database table
        $state->pushFile('your_file.txt');

        // Tests

	// Do some test changes in superglobals
        $_POST['foo'] = 'bar';

        // Test changes in database tables (example only)
        $stuff = BeanFactory::getBean('YourModuleStuff', '{your-module-stuff-id}');
        $stuff->your_property = 'baz';
        $stuff->save();

        // Some changes in your test file:
        file_put_contents('your-file.txt', 'New contents here: ' . rand(1, 10000));


        // Clean up

        $state->popFile('your_file.txt');
        $state->popTable('your_module_stuffs');  // restore table
        $state->popGlobals();  // restore globals

        // ... here you should get the restored super globals, database tables and files.

    /**
     * Retrieve if any error occurred in storing/restoring processes.
     *
     * @return array
     */
    public function getErrors();

    /**
     * Clear all collected error information about latest storing/restoring processes.
     */
    public function clearErrors();

    /**
     * Retrieve if any error occurred in storing/restoring processes and
     * clear all collected error information about latest storing/restoring processes.
     *
     * @return array
     */
    public function getErrorsClear();

    /**
     * Save any value into state store at a key and namespace.
     *
     * @param mixed $value
     * @param string $key
     * @param string $namespace
     */
    public function push($value, $key, $namespace);

    /**
     * Restore any value from state store at a key and namespace.
     *
     * @param string $key
     * @param string $namespace
     * @return mixed
     */
    public function pop($key, $namespace);

    /**
     * Save a global variable into storage at an optional namespace.
     *
     * @param string $key
     * @param string $namespace
     */
    public function pushGlobal($key, $namespace = 'GLOBALS');

    /**
     * Restore a global value from storage at an optional namespace.
     *
     * @param string $key
     * @param string $namespace
     */
    public function popGlobal($key, $namespace = 'GLOBALS');

    /**
     * Save all super globals which are specified in configuration.
     * @see StateCheckerConfig
     *
     * pushGlobals
     */
    public function pushGlobals();

    /**
     * Restore all super globals which are specified in configuration.
     * @see StateCheckerConfig
     *
     * popGlobals
     */
    public function popGlobals();

    /**
     * Save all defined global variable name.
     * (note: this function does not store the values, so use it carefully)
     *
     * pushGlobalKeys
     */
    public function pushGlobalKeys();

    /**
     * Restore all defined global variable name.
     * (note: this function does not restore the values, so use it carefully)
     *
     * popGlobalKeys
     */
    public function popGlobalKeys();

    /**
     * Save Error Reporting Level into the store at an optional key and namespace.
     * (note: error level should not be changed for any reason, so use it for own risk)
     *
     * @param string $key
     * @param string $namespace
     */
    public function pushErrorLevel($key = 'level', $namespace = 'error_reporting');

    /**
     * Restore Error Reporting Level from the store at an optional key and namespace.
     * (note: error level should not be changed for any reason, so use it for own risk)
     *
     * @param string $key
     * @param string $namespace
     */
    public function popErrorLevel($key = 'level', $namespace = 'error_reporting');

    /**
     * Save all data from a database table into store at an optional namespace.
     *
     * @param string $table
     * @param string $namespace
     * @throws StateSaverException
     */
    public function pushTable($table, $namespace = 'db_table');

    /**
     * Restore all data into a database table from store at an optional namespace.
     *
     * @param string $table
     * @param string $namespace
     */
    public function popTable($table, $namespace = 'db_table');

    /**
     * Save a file contents.
     *
     * @param string $filename
     * @throws StateSaverException
     */
    public function pushFile($filename);

    /**
     * Restore a file contents.
     *
     * @param string $filename
     * @return boolean
     * @throws StateSaverException
     */
    public function popFile($filename);

    /**
     * Getter for PHP Configuration Options
     * @see more at StateCheckerConfig::$phpConfigOptionKeys
     *
     * @return array
     */
    public static function getPHPConfigOptions();

    /**
     * Setter for PHP Configuration Options
     * @see more at StateCheckerConfig::$phpConfigOptionKeys
     *
     * @param array $configOptions
     * @throws StateSaverException
     */
    public static function setPHPConfigOptions($configOptions);

    /**
     * Store PHP Configuration Options
     * @see more at StateCheckerConfig::$phpConfigOptionKeys
     *
     * @param string $key
     * @param string $namespace
     */
    public function pushPHPConfigOptions($key = 'all', $namespace = 'php_config_options');

    /**
     * Restore PHP Configuration Options
     * @see more at StateCheckerConfig::$phpConfigOptionKeys
     *
     * @param string $key
     * @param string $namespace
     */
    public function popPHPConfigOptions($key = 'all', $namespace = 'php_config_options');

use SuiteCRM;

// saving a hash of the current state at this point.
$stateChecker = new StateChecker();

// ... do something to change the current system state

try {

    // getting a hash of the current state or
    // throws an exception if the state doesn't match with the previously saved state.

    $hash = $stateChecker->getStateHash();

} catch (StateCheckerException $e) {

    // state is changed!
    // use the following exception to detect / debug the problem: (optional)

    $info = $e->getMessage();

}

$value = SuiteCRM\StateCheckerConfig::get('globalKeys')

array('_POST', '_GET', '_REQUEST', '_SESSION', '_SERVER', '_ENV', '_FILES', '_COOKIE')

$sugar_config['state_checker']['global_keys']

$value = SuiteCRM\StateCheckerConfig::get('fileExludeRegexes')

array(
    '/\/\.git\//',
    '/\/cache\//',
    '/\.log$/',
    '/\/tests\/_output\//',
    '/\/blowfish\//',
    '/\/upload\//',
    '/\/vendor\//',
    '/\/sugarfield_jjwg_maps_/',
    '/\/vardefs.ext.php$/',
    '/\/modules\/AOD_Index\/Index\/Index\//',
    '/\/travis\/build\//',
)

$sugar_config['state_checker']['file_exclude_regexes']

$value = SuiteCRM\StateCheckerConfig::get('autoRun')

true

$sugar_config['state_checker']['auto_run']

$value = SuiteCRM\StateCheckerConfig::get('saveTraces')

false

$sugar_config['state_checker']['save_traces']

$value = SuiteCRM\StateCheckerConfig::get('redefineMemoryLimit')

false

$sugar_config['state_checker']['redefine_memory_limit']

$value = SuiteCRM\StateCheckerConfig::get('storeDetails')

true

$sugar_config['state_checker']['store_details']

$value = SuiteCRM\StateCheckerConfig::get('testStateCheckMode')

SuiteCRM\StateCheckerConfig::RUN_PER_CLASSES

$sugar_config['state_checker']['test_state_check_mode']

$value = SuiteCRM\StateCheckerConfig::get('testsUseStateChecker')

true

$sugar_config['state_checker']['tests_use_state_checker']

$value = SuiteCRM\StateCheckerConfig::get('testsUseAssertionFailureOnError')

true

$sugar_config['state_checker']['tests_use_assertion_failure_on_error']

$value = SuiteCRM\StateCheckerConfig::get('testsFailureExcludeKeys')

array()

$sugar_config['state_checker']['tests_failure_exclude_keys']

$value = SuiteCRM\StateCheckerConfig::get('phpConfigOptionKeys')

array('max_execution_time', 'display_errors', 'display_startup_errors')

$sugar_config['state_checker']['php_configuration_option_keys']