Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions tests/data/cypress/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This sample project is generated by "Scaffold example specs" in Cypress.
70 changes: 42 additions & 28 deletions tests/data/cypress/record_test_result.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,30 @@
{
"type": "case",
"testPath": [
{ "type": "file", "name": "cypress/e2e/1-getting-started/todo.cy.js" },
{ "type": "class", "name": "displays two todo items by default" },
{
"type": "file",
"name": "cypress/integration/examples/window.spec.js"
},
{
"type": "class",
"name": "cy.window() - get the global window object"
},
"type": "testcase",
"name": "example to-do app displays two todo items by default"
}
],
"duration": 0.0,
"status": 0,
"stdout": "",
"stderr": "AssertionError: Timed out retrying after 4000ms: Not enough elements found. Found '2', expected '3'.\n at Context.eval (webpack://src/./cypress/e2e/1-getting-started/todo.cy.js:27:28)",
"data": null
},
{
"type": "case",
"testPath": [
{ "type": "file", "name": "cypress/e2e/1-getting-started/todo.cy.js" },
{ "type": "class", "name": "can check off an item as completed" },
{
"type": "testcase",
"name": "Window cy.window() - get the global window object"
"name": "example to-do app can check off an item as completed"
}
],
"duration": 0.149,
"duration": 0.151,
"status": 1,
"stdout": "",
"stderr": "",
Expand All @@ -25,20 +35,14 @@
{
"type": "case",
"testPath": [
{
"type": "file",
"name": "cypress/integration/examples/window.spec.js"
},
{
"type": "class",
"name": "cy.document() - get the document object"
},
{ "type": "file", "name": "cypress/e2e/1-getting-started/todo.cy.js" },
{ "type": "class", "name": "can filter for uncompleted tasks" },
{
"type": "testcase",
"name": "Window cy.document() - get the document object"
"name": "example to-do app with a checked task can filter for uncompleted tasks"
}
],
"duration": 0.078,
"duration": 0.216,
"status": 1,
"stdout": "",
"stderr": "",
Expand All @@ -47,20 +51,30 @@
{
"type": "case",
"testPath": [
{ "type": "file", "name": "cypress/e2e/1-getting-started/todo.cy.js" },
{ "type": "class", "name": "can filter for completed tasks" },
{
"type": "file",
"name": "cypress/integration/examples/window.spec.js"
},
{
"type": "class",
"name": "cy.title() - get the title"
},
"type": "testcase",
"name": "example to-do app with a checked task can filter for completed tasks"
}
],
"duration": 0.213,
"status": 1,
"stdout": "",
"stderr": "",
"data": null
},
{
"type": "case",
"testPath": [
{ "type": "file", "name": "cypress/e2e/1-getting-started/todo.cy.js" },
{ "type": "class", "name": "can delete all completed tasks" },
{
"type": "testcase",
"name": "Window cy.title() - get the title"
"name": "example to-do app with a checked task can delete all completed tasks"
}
],
"duration": 0.088,
"duration": 0.209,
"status": 1,
"stdout": "",
"stderr": "",
Expand Down
14 changes: 14 additions & 0 deletions tests/data/cypress/src/cypress.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const { defineConfig } = require("cypress");

module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {
// implement node event listeners here
},
},
reporter: 'junit',
reporterOptions: {
mochaFile: '../test-result.xml',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use absolute path for mochaFile

Using a relative path ('../test-result.xml') for mochaFile could be fragile as it depends on the working directory when Cypress is executed.

Consider using an absolute path:

-    mochaFile: '../test-result.xml',
+    mochaFile: 'tests/data/cypress/test-result.xml',
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
mochaFile: '../test-result.xml',
mochaFile: 'tests/data/cypress/test-result.xml',

toConsole: true,
},
Comment on lines +9 to +13
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Missing cypress-junit-reporter dependency

The configuration uses the 'junit' reporter, but the required cypress-junit-reporter package is not listed in the dependencies. Add the following to devDependencies:

"cypress-junit-reporter": "^1.0.0"
🔗 Analysis chain

Verify reporter dependencies

The configuration specifies 'junit' reporter, but we need to verify if the required dependencies are installed.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the required reporter package is in package.json
if [ -f "package.json" ]; then
  echo "Checking package.json for cypress junit reporter..."
  grep -A 5 '"dependencies"\|"devDependencies"' package.json
else
  echo "package.json not found in the root directory"
  # Try to find it in the Cypress directory
  fd -t f "package.json" tests/data/cypress
fi

Length of output: 202


Script:

#!/bin/bash
# Check the content of the found package.json
cat tests/data/cypress/src/package.json

Length of output: 242

});
143 changes: 143 additions & 0 deletions tests/data/cypress/src/cypress/e2e/1-getting-started/todo.cy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
/// <reference types="cypress" />

// Welcome to Cypress!
//
// This spec file contains a variety of sample tests
// for a todo list app that are designed to demonstrate
// the power of writing tests in Cypress.
//
// To learn more about how Cypress works and
// what makes it such an awesome testing tool,
// please read our getting started guide:
// https://on.cypress.io/introduction-to-cypress

describe('example to-do app', () => {
beforeEach(() => {
// Cypress starts out with a blank slate for each test
// so we must tell it to visit our website with the `cy.visit()` command.
// Since we want to visit the same URL at the start of all our tests,
// we include it in our beforeEach function so that it runs before each test
cy.visit('https://example.cypress.io/todo')
})
Comment on lines +14 to +21
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Replace hardcoded URL with environment configuration.

Using a hardcoded URL makes the tests environment-dependent and less maintainable. Consider using Cypress environment variables or configuration files to manage the base URL.

- cy.visit('https://example.cypress.io/todo')
+ cy.visit(Cypress.env('BASE_URL') + '/todo')

Also, add the following to your cypress.config.js:

module.exports = {
  env: {
    BASE_URL: process.env.TEST_URL || 'http://localhost:3000'
  }
}


it('displays two todo items by default', () => {
// We use the `cy.get()` command to get all elements that match the selector.
// Then, we use `should` to assert that there are two matched items,
// which are the two default items.
cy.get('.todo-list li').should('have.length', 3)

// We can go even further and check that the default todos each contain
// the correct text. We use the `first` and `last` functions
// to get just the first and last matched elements individually,
// and then perform an assertion with `should`.
cy.get('.todo-list li').first().should('have.text', 'Pay electric bill')
cy.get('.todo-list li').last().should('have.text', 'Walk the dog')
})
Comment on lines +23 to +35
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix inconsistency in test description and assertion.

The test description states "displays two todo items by default" but the assertion checks for 3 items. Update either the test description or the assertion to maintain consistency.

- it('displays two todo items by default', () => {
+ it('displays three todo items by default', () => {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
it('displays two todo items by default', () => {
// We use the `cy.get()` command to get all elements that match the selector.
// Then, we use `should` to assert that there are two matched items,
// which are the two default items.
cy.get('.todo-list li').should('have.length', 3)
// We can go even further and check that the default todos each contain
// the correct text. We use the `first` and `last` functions
// to get just the first and last matched elements individually,
// and then perform an assertion with `should`.
cy.get('.todo-list li').first().should('have.text', 'Pay electric bill')
cy.get('.todo-list li').last().should('have.text', 'Walk the dog')
})
it('displays three todo items by default', () => {
// We use the `cy.get()` command to get all elements that match the selector.
// Then, we use `should` to assert that there are two matched items,
// which are the two default items.
cy.get('.todo-list li').should('have.length', 3)
// We can go even further and check that the default todos each contain
// the correct text. We use the `first` and `last` functions
// to get just the first and last matched elements individually,
// and then perform an assertion with `should`.
cy.get('.todo-list li').first().should('have.text', 'Pay electric bill')
cy.get('.todo-list li').last().should('have.text', 'Walk the dog')
})


it.skip('can add new todo items', () => {
// We'll store our item text in a variable so we can reuse it
const newItem = 'Feed the cat'

// Let's get the input element and use the `type` command to
// input our new list item. After typing the content of our item,
// we need to type the enter key as well in order to submit the input.
// This input has a data-test attribute so we'll use that to select the
// element in accordance with best practices:
// https://on.cypress.io/selecting-elements
cy.get('[data-test=new-todo]').type(`${newItem}{enter}`)

// Now that we've typed our new item, let's check that it actually was added to the list.
// Since it's the newest item, it should exist as the last element in the list.
// In addition, with the two default items, we should have a total of 3 elements in the list.
// Since assertions yield the element that was asserted on,
// we can chain both of these assertions together into a single statement.
cy.get('.todo-list li')
.should('have.length', 3)
.last()
.should('have.text', newItem)
})

it('can check off an item as completed', () => {
// In addition to using the `get` command to get an element by selector,
// we can also use the `contains` command to get an element by its contents.
// However, this will yield the <label>, which is lowest-level element that contains the text.
// In order to check the item, we'll find the <input> element for this <label>
// by traversing up the dom to the parent element. From there, we can `find`
// the child checkbox <input> element and use the `check` command to check it.
cy.contains('Pay electric bill')
.parent()
.find('input[type=checkbox]')
.check()

// Now that we've checked the button, we can go ahead and make sure
// that the list element is now marked as completed.
// Again we'll use `contains` to find the <label> element and then use the `parents` command
// to traverse multiple levels up the dom until we find the corresponding <li> element.
// Once we get that element, we can assert that it has the completed class.
cy.contains('Pay electric bill')
.parents('li')
.should('have.class', 'completed')
})

context('with a checked task', () => {
beforeEach(() => {
// We'll take the command we used above to check off an element
// Since we want to perform multiple tests that start with checking
// one element, we put it in the beforeEach hook
// so that it runs at the start of every test.
cy.contains('Pay electric bill')
.parent()
.find('input[type=checkbox]')
.check()
})
Comment on lines +82 to +92
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Refactor duplicate beforeEach setup into a custom command.

The duplicate beforeEach hook violates DRY principles and was flagged by static analysis. Consider moving the checkbox checking logic into a custom Cypress command.

Add this to your cypress/support/commands.js:

Cypress.Commands.add('checkTodoItem', (text) => {
  cy.contains(text)
    .parent()
    .find('input[type=checkbox]')
    .check()
})

Then update the tests:

- beforeEach(() => {
-   cy.contains('Pay electric bill')
-     .parent()
-     .find('input[type=checkbox]')
-     .check()
- })
+ beforeEach(() => {
+   cy.checkTodoItem('Pay electric bill')
+ })
🧰 Tools
🪛 Biome

[error] 83-92: Disallow duplicate setup and teardown hooks.

Disallow beforeEach duplicacy inside the describe function.

(lint/suspicious/noDuplicateTestHooks)


it('can filter for uncompleted tasks', () => {
// We'll click on the "active" button in order to
// display only incomplete items
cy.contains('Active').click()

// After filtering, we can assert that there is only the one
// incomplete item in the list.
cy.get('.todo-list li')
.should('have.length', 1)
.first()
.should('have.text', 'Walk the dog')

// For good measure, let's also assert that the task we checked off
// does not exist on the page.
cy.contains('Pay electric bill').should('not.exist')
})

it('can filter for completed tasks', () => {
// We can perform similar steps as the test above to ensure
// that only completed tasks are shown
cy.contains('Completed').click()

cy.get('.todo-list li')
.should('have.length', 1)
.first()
.should('have.text', 'Pay electric bill')

cy.contains('Walk the dog').should('not.exist')
})

it('can delete all completed tasks', () => {
// First, let's click the "Clear completed" button
// `contains` is actually serving two purposes here.
// First, it's ensuring that the button exists within the dom.
// This button only appears when at least one task is checked
// so this command is implicitly verifying that it does exist.
// Second, it selects the button so we can click it.
cy.contains('Clear completed').click()

// Then we can make sure that there is only one element
// in the list and our element does not exist
cy.get('.todo-list li')
.should('have.length', 1)
.should('not.have.text', 'Pay electric bill')

// Finally, make sure that the clear button no longer exists.
cy.contains('Clear completed').should('not.exist')
})
})
})
5 changes: 5 additions & 0 deletions tests/data/cypress/src/cypress/fixtures/example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "Using fixtures to represent data",
"email": "hello@cypress.io",
"body": "Fixtures are a great way to mock data for responses to routes"
}
5 changes: 5 additions & 0 deletions tests/data/cypress/src/cypress/fixtures/profile.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"id": 8739,
"name": "Jane",
"email": "jane@example.com"
}
Loading