grep-tests-from-pull-requests
Grabs the test tags to run from the pull request text
Read the blog post Pick Tests To Run Using The Pull Request Text.
Install
# add this plugin as a dev dependency using NPM
$ npm i -D grep-tests-from-pull-requests
# or using Yarn
$ yarn add -D grep-tests-from-pull-requests
Register the plugin in your plugins file before cypress-grep registration.
const pickTestsFromPullRequest = require('grep-tests-from-pull-requests')
module.exports = async (on, config) => {
const pullOptions = {
tags: ['@log', '@sanity', '@user'],
owner: 'bahmutov',
repo: 'todomvc-no-tests-vercel',
token: process.env.PERSONAL_GH_TOKEN || process.env.GITHUB_TOKEN,
}
await pickTestsFromPullRequest(on, config, pullOptions)
return config
}
Important: notice the plugin registration is an async function, thus you must await the registration. This makes your plugin file function async
. Make sure to return the config
object, as it might be changed by this plugin.
Tip: you can find the test tags, but skip using them using an option
const pickTestsFromPullRequest = require('grep-tests-from-pull-requests')
const pullOptions = {
...,
setTests: true
}
await pickTestsFromPullRequest(on, config, pullOptions)
baseUrl
If the pull request text OR its comments have a line with just baseUrl <URL>
the it will be extracted too. This makes it convenient to specify a custom deploy to be tested for this specific pull request.
// pull request text
some test tags
These tests should be run against this URL
baseUrl https://preview-1.acme.co
The base URL is found if it is a single line of text in the pull request body or its comment in one of these formats:
baseUrl https://preview-1.acme.co
TestURL: https://preview-1.acme.co
If the URL is present in the body and in several comments, the URL found in the latest comment wins.
Tip: you can control if you want to set the baseUrl based on the pull request text using an option
const pickTestsFromPullRequest = require('grep-tests-from-pull-requests')
const pullOptions = {
...,
setBaseUrl: true
}
await pickTestsFromPullRequest(on, config, pullOptions)
additionalSpecs
Sometimes you want to be explicit and run some specs by name or wildcard. Simply add a list of such specs:
Run these Cypress specs too:
- `cypress/e2e/spec-b.cy.js`
- cypress/e2e/**/*.cy.js
The entire list will be returned in the property additionalSpecs
. Back ticks will be removed.
Resolved value
The function might resolve with an object if the pull request was found. You can check if the user wants to run all the tests, or a list of tags
const pickTestsFromPullRequest = require('grep-tests-from-pull-requests')
const testsToRun = await pickTestsFromPullRequest(...)
if (testsToRun) {
if (testsToRun.baseUrl) {
console.log('testing deploy at %s', testsToRun.baseUrl)
}
if (testsToRun.all) {
console.log('running all tests')
} else if (testsToRun.tags.length) {
console.log('the user picked %s tags to run', testsToRun.tags.join(', '))
} else {
console.log('the user did not pick any tests to run')
}
}
Additional environment variables
If the pull request has lines that start with CYPRESS_...=value
then they are automatically are parsed and cast and added to the Cypress.env
object. For example
CYPRESS_num=1
CYPRESS_correct=true
CYPRESS_FRIENDLY_GREETING=Hello
Will add the values {num: 1, correct: true, FRIENDLY_GREETING: "Hello"}
to the Cypress.env
. Note: an empty value is converted to undefined
.
CYPRESS_age=
# will produce
{ age: undefined }
If you really want to skip a value, prefix it somehow, like xCYPRESS_...=value
If the string value is a valid JSON, it is automatically parsed
CYPRESS_person={"name":"Joe"}
// produces Cypress.env('person') object { name: 'Joe' }
Skip / enable Cypress tests
You can find a checkbox in the pull request text to skip / run Cypress tests. This makes it simple to skip the E2E testing steps temporarily. Include the following checkbox line in the pull request body.
- [x] run Cypress tests
Aliases
This package includes several scripts that let you find the pull request body and the test tags and the base URL of a given pull request.
get-pr-body
Prints the test tags found in the pull request text
$ npx get-pr-body --owner bahmutov --repo todomvc-no-tests-vercel --pull 12
Prints all pull request comments
$ npx get-pr-comments --owner bahmutov --repo todomvc-no-tests-vercel --pull 12
get-pr-tests
Prints all test tags found in the pull request
$ npx get-pr-tests --owner bahmutov --repo todomvc-no-tests-vercel --pull 12
You can pass the list of allowed tags
$ npx get-pr-tests --owner bahmutov --repo todomvc-no-tests-vercel --pull 12 \
--tags one,two,three
should-pr-run-cypress-tests
Tells if the pull request body has a checkbox to run or skip the Cypress tests. If the tests should run, this script exits with code 0. If the PR disables the Cypress tests, it exits with code 1.
$ npx should-pr-run-cypress-tests --owner bahmutov --repo todomvc-no-tests-vercel --pull 12
$ echo $?
# 0 - we need to run the Cypress tests
Tip: you can pass the full GitHub pull request URL instead of passing the individual command line arguments
$ npx should-pr-run-cypress-tests --owner bahmutov --repo todomvc-no-tests-vercel --pull 15
# is the same as
$ npx should-pr-run-cypress-tests --pr-url https://github.com/bahmutov/todomvc-tests-circleci/pull/15
Open vs all pull requests
By default this library gets the pull request that is open
. If you want to fetch the info from a closed pull request, use an option all
. For example, the bin scripts accept --all
argument to fetch all pull requests when searching for specific one.
Debugging
This plugin uses debug module to output verbose log messages. Run with environment variable DEBUG=grep-tests-from-pull-requests
to see those logs.
Small print
Author: Gleb Bahmutov © 2022
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
open issue on Github
MIT License
Copyright (c) 2022 Gleb Bahmutov <gleb.bahmutov@gmail.com>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.