Cypress Tests
Check out our blog post to follow tutorial steps for end-to-end testing of your Kubernetes applications with Cypress.
Testkube makes running Cypress tests simple. As Cypress is organized in projects, Testkube allows tests to be defined in a Github repository.
To create a new Cypress test, you will need a Git repository with an example Cypress project. Please follow the Cypress documentation for details - https://docs.cypress.io/guides/dashboard/projects.
Creating a New Test
Let's assume we've created a Cypress project in https://github.com/kubeshop/testkube-executor-cypress/tree/main/examples, which contains a really simple test that checks for the existence of a particular string on a web site. We'll also check if the env parameter exists to show how to pass additional parameters into the test.
describe('The Home Page', () => {
it('successfully loads', () => {
cy.visit('https://testkube.io')
expect(Cypress.env('testparam')).to.equal('testvalue')
cy.contains('Efficient testing of k8s applications')
})
})
Creating the Testkube Test Script
Create the Testkube test script from this example. The parameters passed are repository, branch and the path where the project exists. In the case of a mono repository, the parameters are name and type. We will use the default Cypress executor (Testkube Cypress image).
kubectl testkube create test --git-uri https://github.com/kubeshop/testkube-executor-cypress.git --git-branch main --git-path examples --name kubeshop-cypress --type cypress/project
| If your test files are located in root path of the repository, you can omit the --git-path flag.
Check that script is created:
kubectl get tests
Output:
NAME AGE
kubeshop-cypress 51s
Starting the Test
Start the test:
kubectl testkube run test kubeshop-cypress
Output:
Type : cypress/project
Name : kubeshop-cypress
Execution ID : 615d5265b046f8fbd3d955d0
Execution name: wildly-popular-worm
Test queued for execution
Use the following command to get test execution details:
$ kubectl testkube get execution 615d5265b046f8fbd3d955d0
or watch test execution until complete:
$ kubectl testkube watch execution 615d5265b046f8fbd3d955d0
Getting Execution Results
Let's watch our test execution:
kubectl testkube watch execution 615d43d3b046f8fbd3d955ca
Output:
Type : cypress/project
Name : cypress-example
Execution ID : 615d43d3b046f8fbd3d955ca
Execution name: early-vast-turtle
Watching for changes
Status: error, Duration: 1m16s
Getting results
Name: early-vast-turtle, Status: error, Duration: 1m16s
process error: exit status 1
output:
====================================================================================================
(Run Starting)
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Cypress: 8.3.0 │
│ Browser: Electron 91 (headless) │
│ Specs: 1 found (simple-test.js) │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
────────────────────────────────────────────────────────────────────────────────────────────────────
Running: simple-test.js (1 of 1)
The Home Page
1) successfully loads
0 passing (2s)
1 failing
1) The Home Page
successfully loads:
AssertionError: expected undefined to equal 'testvalue'
at Context.eval (http://localhost:34845/__cypress/tests?p=cypress/integration/simple-test.js:102:41)
(Results)
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Tests: 1 │
│ Passing: 0 │
│ Failing: 1 │
│ Pending: 0 │
│ Skipped: 0 │
│ Screenshots: 1 │
│ Video: true │
│ Duration: 2 seconds │
│ Spec Ran: simple-test.js │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
(Screenshots)
- /tmp/testkube-scripts1127226423/repo/examples/cypress/screenshots/simple-test.js/ (1280x720)
The Home Page -- successfully loads (failed).png
(Video)
- Started processing: Compressing to 32 CRF
Compression progress: 35%
- Finished processing: /tmp/testkube-scripts1127226423/repo/examples/cypress/videos (19 seconds)
/simple-test.js.mp4
====================================================================================================
(Run Finished)
Spec Tests Passing Failing Pending Skipped
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ ✖ simple-test.js 00:02 1 - 1 - - │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
✖ 1 of 1 failed (100%) 00:02 1 - 1 - -
Test execution completed in 1m17s
Adding Parameters
The test failed because of AssertionError: expected undefined to equal 'testvalue'.
The test parameter was not passed into the test script. In this test, the parameter will have the name testparam and its value will be testvalue.
Add the -f flag to follow the execution and watch for changes. Currently, we're only looking for test completion, but, in the future, we'll pipe test output in real time.
kubectl testkube run test kubeshop-cypress -v testparam=testvalue -f
Tip: If you want to pass secret variables pass -s somesecretvar=secretvalue (or --secret-variable)
Testkube will convert value of this variable into Kubernetes Secret rescource.
Output:
Type : cypress/project
Name : kubeshop-cypress
Execution ID : 615d5372b046f8fbd3d955d2
Execution name: nominally-able-glider
Test queued for execution
Use the following command to get test execution details:
$ kubectl testkube get execution 615d5372b046f8fbd3d955d2
or watch test execution until complete:
$ kubectl testkube watch execution 615d5372b046f8fbd3d955d2
Watching for changes
Status: queued, Duration: 0s
Status: pending, Duration: 383.064ms
....
Status: pending, Duration: 1m45.405939s
Status: success, Duration: 1m45.405939s
Getting results
Name: nominally-able-glider, Status: success, Duration: 2562047h47m16.854775807s
====================================================================================================
(Run Starting)
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Cypress: 8.5.0 │
│ Browser: Electron 91 (headless) │
│ Specs: 1 found (simple-test.js) │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
────────────────────────────────────────────────────────────────────────────────────────────────────
Running: simple-test.js (1 of 1)
(Results)
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ Tests: 1 │
│ Passing: 1 │
│ Failing: 0 │
│ Pending: 0 │
│ Skipped: 0 │
│ Screenshots: 0 │
│ Video: true │
│ Duration: 19 seconds │
│ Spec Ran: simple-test.js │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
(Video)
- Started processing: Compressing to 32 CRF
Compression progress: 39%
Compression progress: 81%
- Finished processing: /tmp/testkube-scripts531364188/repo/examples/cypress/videos/ (30 seconds)
simple-test.js.mp4
Compression progress: 100%
====================================================================================================
(Run Finished)
Spec Tests Passing Failing Pending Skipped
┌────────────────────────────────────────────────────────────────────────────────────────────────┐
│ ✔ simple-test.js 00:19 1 1 - - - │
└────────────────────────────────────────────────────────────────────────────────────────────────┘
✔ All specs passed! 00:19 1 1 - - -
Use the following command to get test execution details:
$ kubectl testkube get execution 615d5372b046f8fbd3d955d2
Test execution completed in 1m45.405939s
Using Different Cypress Images
In the Cypress world, there are instances when you want to have control over your Runtime environment. Testkube can easily handle that for you! We're building several Cypress images to handle features that different versions of Cypress can support.
To use a different executor you can use one of our pre-built ones (for Cypress 8, 9, 10 and Custom Testkube images) or build your own Docker image based on a Cypress executor.
Let's assume we need official Cypress 10 for our test runs. To handle that issue, create a new Cypress executor:
content of cypress-v10-executor.yaml
apiVersion: executor.testkube.io/v1
kind: Executor
metadata:
name: cypress-v10-executor
namespace: testkube
spec:
image: kubeshop/testkube-cypress-executor:1.1.7-cypress10 # <-- we're buidling cypress versions
types:
- cypress:v10/test # <-- just create different test type with naming convention "framework:version/type"
Tip: Look for recent executor versions here https://hub.docker.com/repository/registry-1.docker.io/kubeshop/testkube-cypress-executor/tags?page=1&ordering=last_updated.
And add it to your cluster:
kubectl apply -f cypress-v10-executor.yaml
Now, create a new test with a type which our new executor can handle e.g.: cypress:v10/test
# create test
kubectl testkube create test --git-uri https://github.com/kubeshop/testkube-executor-cypress.git --git-path examples --type cypress:v10/test --name cypress-v10-example-test --git-branch main
# and run it
kubectl testkube run test cypress-v10-example-test -f
Summary
Our first test completed successfully! As we've seen above, it's really easy to run Cypress tests with Testkube!