Skip to main content

Authoring tests

Vortex uses Bats for testing. Bats is a TAP-compliant testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected.

See Bats documentation for more information.

Installation​

npm install --prefix .vortex/tests

Usage​

# Run a single test.
bats .vortex/tests/bats/helpers.bats

# Some tests require Composer and container registry tokens.
TEST_GITHUB_TOKEN=<yourtoken> TEST_VORTEX_CONTAINER_REGISTRY_USER=<youruser> TEST_VORTEX_CONTAINER_REGISTRY_PASS=<yourpass> bats .vortex/tests/bats/workflow.smoke.bats

# To preserve test run directory.
bats --no-tempdir-cleanup .vortex/tests/bats/helpers.bats

# To override Bats temporary directory where tests are ran (required for container tests).
mkdir -p $HOME/.bats-tmp # run once
TMPDIR=$HOME/.bats-tmp bats .vortex/tests/bats/helpers.bats

# Run all tests, preserving the temporary directory.
TEST_GITHUB_TOKEN=<yourtoken> \
TEST_VORTEX_CONTAINER_REGISTRY_USER=<youruser> \
TEST_VORTEX_CONTAINER_REGISTRY_PASS=<yourpass> \
TMPDIR=$HOME/.bats-tmp \
bats --no-tempdir-cleanup .vortex/tests/bats/*.bats

Updating test assets​

There are demo and test database dumps captured as files and container images.

  • Demo database dump file - demonstration of the database import capabilities from a file during a normal workflow.
  • Demo database container image - demonstration of the database import capabilities from a container image during a normal workflow.
  • Test database dump file - test of the database import capabilities from a file during the normal workflow.
  • Test database container image - test of the database import capabilities from a container image during the normal workflow.

Updating demo database dump file​

  1. Run fresh build of Vortex locally:
rm .data/db.sql || true
VORTEX_PROVISION_TYPE=profile VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 AHOY_CONFIRM_RESPONSE=1 ahoy build
  1. Update content and config:
ahoy cli

drush eval "Drupal::entityTypeManager()->getStorage('node')->create([
  'type' => 'page',
  'title' => 'Welcome to the demo site!',
  'body' => [
    'value' => '<p>This demo page is sourced from the Vortex database dump file to demonstrate database importing capabilities.</p>',
    'format' => 'basic_html',
  ],
])->save();"

drush config:set system.site page.front "/node/1" -y
drush sql:query "SHOW TABLES LIKE 'cache_%'" | xargs -I{} drush sql:query "TRUNCATE TABLE {}" && drush sql:query "TRUNCATE TABLE watchdog"

exit

  1. Export DB:
ahoy export-db db.demo.sql
  1. Upload db.demo.sql to the latest release as an asset and name it db_d11.demo.sql.

Updating demo database container image​

  1. Run fresh build of Vortex locally:
rm .data/db.sql || true
VORTEX_PROVISION_TYPE=profile VORTEX_PROVISION_POST_OPERATIONS_SKIP=1 AHOY_CONFIRM_RESPONSE=1 ahoy build
  1. Update content and config:
ahoy cli

drush eval "Drupal::entityTypeManager()->getStorage('node')->create([
  'type' => 'page',
  'title' => 'Welcome to the demo site!',
  'body' => [
    'value' => '<p>This demo page is sourced from the Vortex database container image to demonstrate database importing capabilities.</p>',
    'format' => 'basic_html',
  ],
])->save();"

drush config:set system.site page.front "/node/1" -y
drush sql:query "SHOW TABLES LIKE 'cache_%'" | xargs -I{} drush sql:query "TRUNCATE TABLE {}" && drush sql:query "TRUNCATE TABLE watchdog"

exit

  1. Export DB:
ahoy export-db db.demo_image.sql
  1. Seed the database container image:
curl -LO https://github.com/drevops/mariadb-drupal-data/releases/latest/download/seed.sh
chmod +x seed.sh
./seed.sh .data/db.demo_image.sql drevops/vortex-dev-mariadb-drupal-data-demo-11.x:latest

Updating test database dump file​

  1. Run a fresh install of Vortex into a new directory and name the project Star Wars:
mkdir /tmp/star-wars
VORTEX_INSTALL_REPO="$(pwd)" .vortex/installer/install /tmp/star-wars --no-interaction
cd /tmp/star-wars
  1. Run fresh build of Vortex locally:
rm .data/db.sql || true
VORTEX_PROVISION_TYPE=profile AHOY_CONFIRM_RESPONSE=1 ahoy build
  1. Update content and config:
ahoy cli

drush eval "Drupal::entityTypeManager()->getStorage('node')->create([
  'type' => 'page',
  'title' => 'Welcome to the test site!',
  'body' => [
    'value' => '<p>This test page is sourced from the Vortex database dump file to demonstrate database importing capabilities.</p>',
    'format' => 'basic_html',
  ],
])->save();"

drush config:set system.site page.front "/node/1" -y
drush sql:query "SHOW TABLES LIKE 'cache_%'" | xargs -I{} drush sql:query "TRUNCATE TABLE {}" && drush sql:query "TRUNCATE TABLE watchdog"

exit

  1. Export DB:
ahoy export-db db.test.sql
  1. Upload db.test.sql to the latest release as an asset and name it db_d11.test.sql.

Updating test database container image​

  1. Run a fresh install of Vortex into a new directory and name the project Star Wars:
mkdir /tmp/star-wars
VORTEX_INSTALL_REPO="$(pwd)" .vortex/installer/install /tmp/star-wars --no-interaction
cd /tmp/star-wars
  1. Run fresh build of Vortex locally:
rm .data/db.sql || true
VORTEX_PROVISION_TYPE=profile AHOY_CONFIRM_RESPONSE=1 ahoy build
  1. Update content and config:
ahoy cli

drush eval "Drupal::entityTypeManager()->getStorage('node')->create([
  'type' => 'page',
  'title' => 'Welcome to the test site!',
  'body' => [
    'value' => '<p>This test page is sourced from the Vortex database container image to demonstrate database importing capabilities.</p>',
    'format' => 'basic_html',
  ],
])->save();"

drush config:set system.site page.front "/node/1" -y
drush sql:query "SHOW TABLES LIKE 'cache_%'" | xargs -I{} drush sql:query "TRUNCATE TABLE {}" && drush sql:query "TRUNCATE TABLE watchdog"

exit

  1. Export DB:
ahoy export-db db.test_image.sql
  1. Seed the database container image:
curl -LO https://github.com/drevops/mariadb-drupal-data/releases/latest/download/seed.sh
chmod +x seed.sh
./seed.sh .data/db.test_image.sql drevops/vortex-dev-mariadb-drupal-data-test-11.x:latest