Testery.io Integration

Wondering how to set up automated testing against your dynamically-generated Tugboat environment? Here’s one way to get started with Tugboat and Testery.io.

Configure Tugboat

Getting started with Tugboat and Testery is similar to setting up any new Tugboat project.

To integrate Tugboat and Testery, you’ll probably want to store your Testery token as an environment variable. In our example here, we’ve saved the Testery token as an environment variable we’re calling: $TESTERY_TOKEN.

Then, you’ll need to create the Tugboat config.yml with some extra build steps to run tests with Testery. Specifically, you’ll need to:

  1. Install pip
  2. Install Testery’s command line interface tool
  3. Invoke a command to run tests against your Tugboat environment at build time

We’ll provide a full example of this below, but in the meantime, you’ll also need to set up Testery.

Configure Testery

You’ll need to create an account with Testery; their free tier should be enough to get up and running as a proof-of-concept.

At the time of this writing, Testery is configured for testing with these frameworks: WebdriverIO, SpecFlow, Cypress, and Nightwatch.js.

Once you’ve got an account, you can create a project in Testery. You’ll need to select the framework you want to use for your tests. Then you can set up your Tugboat config.yml to run your Testery project’s tests against the Tugboat environment that’s automatically generated from your pull requests.

Example Tugboat config for automated testing with Testery

The Tugboat configuration is managed by a YAML file at .tugboat/config.yml in the git repository. In this example Tugboat + Testery configuration, we’re setting up automated testing for a WordPress site. If you want to see more about the WordPress config details, check out the WordPress tutorial; here we’ve redacted some of the WordPress-specific comments and build steps to focus on the Testery setup:

    image: tugboatqa/php:8.1-apache
    default: true
    depends: mysql
    # A set of commands to run while building this service
      # Commands that set up the basic preview infrastructure
        # Install pip so you can get the Testery CLI
        - apt-get update
        - apt-get install -y python3 python3-pip

      # Commands that build the site. This is where you would add things
      # like feature reverts or any other commands required to
      # set up or configure the site. When a preview is built from a
      # base preview, the build workflow starts here, skipping the init
      # and update steps, because the results of those are inherited
      # from the base preview.
        # Check for upgrades to the Testery command line interface
        - pip3 install testery --upgrade
        # Set up Testery to run tests against the Tugboat environment, using Tugboat environment variables
        - testery update-environment
            --token "$TESTERY_TOKEN"
            --key "${TUGBOAT_PREVIEW}"
            --name "${TUGBOAT_PREVIEW}"
      # Commands that run after the build has completed and the Preview is accepting connections.
        # Trigger a test run on Testery against this Preview URL.
        - testery create-test-run
            --token "$TESTERY_TOKEN"
            --git-ref "$TUGBOAT_PREVIEW_SHA"
            --project "testery"
            --environment "${TUGBOAT_PREVIEW}"

Want to know more about something mentioned in the comments of this config file? Check out these topics:

Start testing against your Preview environments

With these steps in place, and depending on configurations you set up in both services, you’ll then be able to see the results of your Tugboat builds and your Testery test runs on your git pull requests:

Screenshot: Testery test results and Tugboat deploy on a pull request in GitHub