Skip to content

Latest commit

 

History

History
265 lines (201 loc) · 13.9 KB

development.md

File metadata and controls

265 lines (201 loc) · 13.9 KB

Thunder Development

Install development environment

Requirements

Install Thunder for development

Follow this instruction to get the code

Now we have to register the created docroot into Acquia's DevDesktop and then we can install the site.

After that, Thunder is successfully installed. Start coding now.

Update profile configuration

The Thunder distributions ships the config_profile module as a dev dependency for easier config updates. The workflow for updating config files that are shipped in the distribution should be:

  • Install the latest dev version of Thunder
  • Enable the Config Profile module 
    drush en config_profile
  • Apply all your changes in the UI
  • Export your configuration 
    drush cex
    The configuration is exported to the chosen config_directory and simultaneously to your profile folder.
  • config_profile has now copied all the config changes to the profile folder
  • Put all new config files to the desired folder and add track it in git
  • Remove all untracked files 
    git clean -fd

Drupal Tests

Thunder distribution comes with a set of drupal tests. They can be used to validate Thunder installation or to use provided traits for your own project drupal tests.

How to run the tests

In order to execute tests follow these steps.

Enable the Simpletest module via the administration UI or by using a drush command.

drush -y en simpletest

To successfully run drupal tests, a Browser with WebDriver is required. Use selenium chrome docker image.

On Mac you have to alias localhost:

sudo ifconfig lo0 alias 172.16.123.1
docker run -d -P -p 4444:4444 -v $(pwd)/$(drush eval "echo drupal_get_path('profile', 'thunder');")/tests:/tests \
 --shm-size 256m --add-host="thunder.dd:172.16.123.1" selenium/standalone-chrome:3.14.0-iron

Note a specific version of chrome is required due to https://bugs.chromium.org/p/chromedriver/issues/detail?id=2198

To debug a browser you can use following commands:

docker run -d -P -p 6000:5900 -p 4444:4444 -v $(pwd)/$(drush eval "echo drupal_get_path('profile', 'thunder');")/tests:/tests \
 --shm-size 256m --add-host="thunder.dd:172.16.123.1" selenium/standalone-chrome-debug:3.14.0-iron

and connect with you vnc client (on mac you can use finder: go to -> connect to server [⌘K]). Address: vnc://localhost:6000, the password is: secret

Thunder tests require Mink Selenium2 Driver and that has to be required manually. If you are in your docroot folder of Thunder installation execute following command:

composer require "behat/mink-selenium2-driver" "behat/mink-goutte-driver"

After that drupal tests can be executed (if you are in docroot folder of Thunder installation and composer requirements are installed):

php ./core/scripts/run-tests.sh --php '/usr/local/bin/php' --verbose --url http://thunder.dev --dburl mysql://[email protected]:3306/thunder Thunder

To speed things up run tests using a database dump:

DEVDESKTOP_DRUPAL_SETTINGS_DIR="${HOME}/.acquia/DevDesktop/DrupalSettings" \
php ./core/scripts/db-tools.php dump-database-d8-mysql | gzip > thunder.sql.gz

thunderDumpFile=thunder.sql.gz php ./core/scripts/run-tests.sh --php '/usr/local/bin/php' \
--verbose --url http://thunder.dd:8083 --dburl mysql://[email protected]:33067/thunder Thunder

and run them individually:

thunderDumpFile=thunder.sql.gz php ./core/scripts/run-tests.sh --php '/usr/local/bin/php' \
--verbose --url http://thunder.dd:8083 --dburl mysql://[email protected]:33067/thunder --class "Drupal\Tests\thunder\Functional\InstalledConfigurationTest"

This is just an example. For a better explanation see Running PHPUnit tests

Sometimes tests are executed inside docker container where selenium is running inside other containers and it's not possible to access it over localhost. Or there are cases when two separated containers are running on the same machine but on different ports (for example Chrome and Firefox selenium containers). For cases like this you can set environment variable MINK_DRIVER_ARGS_WEBDRIVER in following way:

export MINK_DRIVER_ARGS_WEBDRIVER='["chrome", null, "http://localhost:4444/wd/hub"]'

That information will be picked up by testing classes and used for selenium endpoint.

How to run the NightwatchJS performance tests

  1. You need to install Yarn. Please check installation documentation for it.
  2. You have to install thunder/thunder_performance_measurement package. To do that, execute the following command in your project root directory: composer require thunder/thunder_performance_measurement:dev-master --dev and enable module by executing: drush en thunder_performance_measurement in your docroot directory.
  3. You need to install Elastic APM Node.js Agent in Drupal Core node packages. To do that go to your docroot/core directory and execute following command: yarn add elastic-apm-node --dev
  4. You have to adjust your .env file inside docroot/core directory. You can copy the .env.example to .env and edit it accordingly. Thunder tests require the following environment variables: DRUPAL_TEST_BASE_URL, THUNDER_BRANCH, THUNDER_SITE_HOSTNAME and THUNDER_APM_URL. The THUNDER_BRANCH is branch name where tests are executing, for example, 8.x-4.x. The THUNDER_SITE_HOSTNAME is hostname where tests are executing, for example thunder.dev. The THUNDER_APM_URL is URL to Elastic APM Server, for example http://localhost:8200.
  5. After that, you can run NightwatchJS tests by executing the following command inside docroot/core directory: yarn test:nightwatch <path to JS Test file>. Here is an example: yarn test:nightwatch ../profiles/contrib/thunder/tests/src/Nightwatch/Tests/CreateMostUsedContent.js

If you have problem with outdated chromedriver

Drupal core does not update javascript dependencies so fast and chromedriver may be outdated and unable to work with chrome installed on the system. You can provide chrome that can be used by chromedriver inside a docker container. You can do it with the following command:

docker run --name selenium_chrome -d -P -p 6000:5900 -p 4444:4444 --shm-size 256m --add-host="thunder.dd:172.16.123.1" selenium/standalone-chrome-debug:3.141.59-selenium

You have to find what is correct docker image tag for the chrome version you need. To do that you have to take a look at selenium docker releases. This workflow is similar to PHP JavaScript tests and for additional information, you can take a look at How to run the tests section.

After you have running chrome in docker, you have also to change environment variables in .env file. Following environment variable should be set:

DRUPAL_TEST_WEBDRIVER_PORT=4444
DRUPAL_TEST_WEBDRIVER_PATH_PREFIX=/wd/hub
DRUPAL_TEST_CHROMEDRIVER_AUTOSTART=false

You can copy/paste this section to the bottom of your .env file.

Coding style

Documentation how to check your code for coding style issues can be found here.

Thunder GitHub actions

All Thunder pull requests are execute on GitHub actions. On every pull request tests will be executed (or when new commits are pushed into pull request branch). All code will be checked against coding style.

We support some test execution options. They can be provided by pull request labels. Here is list of supported labels:

  • test-upgrade - this option will execute a custom test path, where an update (including execution of update hooks) from Thunder 2 will be tested. This option should be used in case of a pull request with update hooks or module updates.
  • test-min - this options installs the pull request version of Thunder with the oldest possible dependencies and executes the test suite.
  • test-performance - this option pushed the code base to our performance testing infrastructure. A successful test-max build is the required for this.

Updating Thunder

Thunder tries to provide updates for every change that was made. That could be changes on existing configurations or adding of new configurations.

Writing update hooks

To support the creation of update hooks, Thunder integrated the update_helper module. That contains several methods to e.g. update existing configuration or enabling modules.

Outputting results of update hook is highly recommended for that we have provided UpdateLogger, it handles output of result properly for drush or UI (update.php) update workflow. That's why every update hook that changes something should log what is changed and was it successful or it has failed. And last line in update hook should be returning of UpdateLogger output. UpdateLogger service is also used by Thunder Updater and it can be retrieved from it. Here are two examples how to get and use UpdateLogger. All text logged as as INFO, will be outputted as success in drush output.

  // Get service directly.
  /** @var \Drupal\update_helper\UpdateLogger $updateLogger */
  $updateLogger = \Drupal::service('update_helper.logger');

  // Log change success or failures.
  if (...) {
    $updateLogger->info('Change is successful.');
  }
  else {
    $updateLogger->warning('Change has failed.');
  }

  // At end of update hook return result of UpdateLogger::output().
  return $updateLogger->output();

Other way to get UpdateLogger is from Update Helper Updater service.

  // Get service from Thunder Updater service.
  /** @var \Drupal\update_helper\Updater $updater */
  $updater = \Drupal::service('update_helper.updater');
  $updateLogger = $updater->logger();

  ...

  // At end of update hook return result of UpdateLogger::output().
  return $updateLogger->output();

Importing new configurations

You have to create configuration update definition file with global import_configs action. For example:

__global:
  import_configs:
    - config.to.import
    - config.to.import-no2

After that you just have to execute configuration update. For example:

  /** @var \Drupal\update_helper\Updater $updater */
  $updater = \Drupal::service('update_helper.updater');
  $updater->executeUpdate('thunder_article', 'thunder_update_8101');

  return $updater->logger()->output();

This update hook will import configurations, that are in a module or profile config directory.

Updating existing configuration (with manually defined configuration changes)

Before Drupal\update_helper\Updater::updateConfig() updates existing configuration, it could check the current values of that config. That helps to leave modified, existing configuration in a valid state.

  // List of configurations that should be checked for existence.
  $expectedConfig['content']['field_url'] = [
    'type' => 'instagram_embed',
    'weight' => 0,
    'label' => 'hidden',
    'settings' => [
      'width' => 241,
      'height' => 313,
    ],
    'third_party_settings' => [],
  ];

  // New configuration that should be applied.
  $newConfig['content']['thumbnail'] = [
    'type' => 'image',
    'weight' => 0,
    'region' => 'content',
    'label' => 'hidden',
    'settings' => [
      'image_style' => 'media_thumbnail',
      'image_link' => '',
    ],
    'third_party_settings' => [],
  ];

  /** @var \Drupal\update_helper\Updater $updater */
  $updater = \Drupal::service('update_helper.updater');
  $updater->updateConfig('core.entity_view_display.media.instagram.thumbnail', $newConfig, $expectedConfig);

Updating existing configuration (with using of generated configuration changes)

With Thunder Updater module, we have provided Drupal Console command that will generate update configuration changes (it's called configuration update definition or CUD). Configuration update definition (CUD) will be stored in config/update directory of the module and it can be easily executed with Thunder Updater.

Workflow to generate Thunder configuration update is following:

  1. Make clean install of the previous version of Thunder (version for which one you want to create configuration update). For example, if you are merging changes to develop branch, then you should install Thunder for that branch
  2. When Thunder is installed, make code update (with code update also configuration files will be updated, but not active configuration in database)
  3. Execute update hooks if it's necessary (e.g. in case when you have module and/or core updates in your branch)
  4. Now is a moment to generate Thunder configuration update code. For that we have provided following drupal console command: drupal generate:configuration:update. That command should be executed and there are several information that has to be filled, like module name where all generated data will be saved (CUD file, checklist update.yml and update hook function). Then also information for checklist entry, like title, success message and failure message. Command will generate CUD file and save it in config/update folder of the module, it will add entry in update.yml file for the checklist and it will create update hook function in <module_name>.install file.
  5. After the command has finished it will display what files are modified and generated. It's always good to make an additional check of generated code.

Additional information about command options are provided with drupal generate:configuration:update --help and it's also possible to provide all information directly in command line without using the wizard.

When an update for Thunder is created don't forget to commit your update hook with [TEST_UPDATE=true] flag in your commit message, so that it's automatically tested.