Testim Documentation

Welcome to the Testim documentation. You'll find comprehensive guides to help you get started quickly, example code snippets, and tips for being more productive. You will also find details about advanced features that allow you to customize Testim to fit your environment or special testing conditions. Don't worry, we'll support you if you get stuck. Let's jump right in!

Guides    Changelog

Jenkins integration - using Docker

Using docker is the best way for you to use the Testim CLI, that way we make sure you are always up-to-date with the latest npm package and the required node.js version.

In order to integrate your tests with Jenkins using our docker container, first you need to install the docker engine on the Jenkins machine or one of its slave machines.

Now, just follow these steps:

  1. Create a New item in Jenkins:
  1. Enter job name (e.g. "Testim Tests"), and choose "Freestyle project" and click "OK":
  1. Add "Execute Shell" step:
  1. Set the command with the appropriate parameters, as described in the CLI page. Here is the script template, that pulls and uses our docker file, and the run the CLI command itself:
TESTIM_DOCKER=testim/docker-cli
TESTIM_TOKEN="<YOUR ACCESS TOKEN>"
TESTIM_PROJECT="<YOUR TESTIM PROJECT ID>"
TESTIM_LABEL="<YOUR LABEL>"
SELENIUM_GRID_NAME="<YOUR SELENIUM GRID NAME>"

echo "Pulling latest version"
docker pull ${TESTIM_DOCKER}

echo "Run testim-cli"
docker run --rm -v ${WORKSPACE}:/opt/testim-runner \
  ${TESTIM_DOCKER} \
  --token ${TESTIM_TOKEN} \
  --project "${TESTIM_PROJECT}" \
  --label "${TESTIM_LABEL}" \
  --grid ${SELENIUM_GRID_NAME} \
  -r /opt/testim-runner/testim-sanity-$BUILD_NUMBER-report.xml
echo "Testim finished"\

Note: For the grid name, read here how to set up your grid.

  1. In order for Jenkins to store, analyze and show the results, we generate a standard JUnitXMLReporter XML file. For Jenkins to use the file you need to add a post-build action of type "Publish JUnit test result report":
  1. Set the xml file value, according to the "report-file" parameter in section 4:

Updated 9 months ago

Jenkins integration - using Docker


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.