Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow CA #272

Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
4436b78
Create eslint.yml
MagnusPladsen Jul 27, 2023
972e82a
Create CI
MagnusPladsen Jul 27, 2023
2bb8ab4
Create main.yml
MagnusPladsen Jul 27, 2023
ba3e962
Merge pull request #1 from MagnusPladsen/actions
MagnusPladsen Jul 27, 2023
bc543de
Delete eslint.yml
MagnusPladsen Jul 27, 2023
d6cccb2
Delete CI
MagnusPladsen Jul 27, 2023
ae53f05
Update and rename main.yml to unit-test.yml
MagnusPladsen Jul 27, 2023
a0831e3
Delete unit-test.yml
MagnusPladsen Jul 27, 2023
d7aa4f5
Create unit-test.yml
MagnusPladsen Jul 27, 2023
29bb61f
Create e2e-test.yml
MagnusPladsen Jul 27, 2023
5388585
Merge pull request #3 from MagnusPladsen/unit-test-1
MagnusPladsen Jul 27, 2023
a391f53
Merge pull request #4 from MagnusPladsen/unit-test
MagnusPladsen Jul 27, 2023
3fa47c7
installed prettier and eslint
jkjode Aug 25, 2023
a295195
added scripts for formatting
jkjode Aug 25, 2023
5cd3da1
adds eslint configuration
jkjode Aug 25, 2023
8374eb7
test change
jkjode Aug 25, 2023
a1eea11
added eslint cashe to gitignore and updated script for lint
jkjode Aug 25, 2023
1cac8a4
adds precommit hooks
jkjode Aug 25, 2023
53186db
install jest
jkjode Aug 25, 2023
54100f2
1.0.2
jkjode Aug 25, 2023
0ab9897
1.0.3
jkjode Aug 25, 2023
b985c10
Merge branch 'workflow' into workflow-unit-testing
jkjode Aug 25, 2023
0ff67f2
created and updated readme.md
jkjode Aug 25, 2023
1336368
configured jest and updated readme
jkjode Aug 25, 2023
9798d3d
added es6, es6.test and configured for testing
jkjode Aug 25, 2023
acf0b7f
added unit testing for login/logout and updated readme.md
jkjode Aug 25, 2023
252730d
installed and set up cypress, updated readme.md
jkjode Aug 25, 2023
5946183
update
jkjode Aug 25, 2023
5ef69f1
added E2E testing and updated readme
jkjode Aug 25, 2023
7a23d67
updated patch nr
jkjode Aug 25, 2023
691beb3
Merge branch 'workflow-unit-testing'
jkjode Aug 25, 2023
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
34 changes: 34 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"env": {
"browser": true,
"es2021": true
},
"extends": "eslint:recommended",
"overrides": [
{
"files": ["/*.test.js"],
"env": { "jest": true },
"plugins": ["jest"],
"extends": ["plugin:jest/recommended"],
"rules": { "jest/prefer-expect-assertions": "off" }
},
{
"files": ["/*.cy.js"],
"env": { "cypress/globals": true },
"plugins": ["cypress"],
"extends": ["plugin:cypress/recommended"],
"rules": {
"cypress/no-unnecessary-waiting": "off",
"no-unused-vars": "off",
"cypress/unsafe-to-chain-command": "warn"
}
}
],
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
"rules": {
"no-console": "off"
}
}
17 changes: 17 additions & 0 deletions .github/workflows/e2e-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Automated E2E Testing
on:
- pull_request
- workflow_dispatch

jobs:
run-e2e-tests:
name: Run E2E Tests
runs-on: ubuntu-latest
steps:
- name: Checkout under $GITHUB_WORKSPACE
uses: actions/checkout@main

- name: run cypress tests with electron
uses: cypress-io/github-action@v4
with:
browser: electron
24 changes: 24 additions & 0 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Automated Unit Testing
on:
- pull_request
- workflow_dispatch

jobs:
run-unit-tests:
name: Run Unit Tests
runs-on: ubuntu-latest

steps:
- name: Checkout under $GITHUB_WORKSPACE
uses: actions/checkout@main

- name: Set up NodeJS
uses: actions/setup-node@v1
with:
node-version: 16

- name: Install all dependencies
run: npm install

- name: Run Tests
run: npm run test-unit
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/node_modules
/dist
/dist
.eslintcache
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
30 changes: 30 additions & 0 deletions .husky/_/husky.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#!/bin/sh
if [ -z "$husky_skip_init" ]; then
debug () {
[ "$HUSKY_DEBUG" = "1" ] && echo "husky (debug) - $1"
}

readonly hook_name="$(basename "$0")"
debug "starting $hook_name..."

if [ "$HUSKY" = "0" ]; then
debug "HUSKY env variable is set to 0, skipping hook"
exit 0
fi

if [ -f ~/.huskyrc ]; then
debug "sourcing ~/.huskyrc"
. ~/.huskyrc
fi

export readonly husky_skip_init=1
sh -e "$0" "$@"
exitCode="$?"

if [ $exitCode != 0 ]; then
echo "husky - $hook_name hook exited with code $exitCode (error)"
exit $exitCode
fi

exit 0
fi
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
15 changes: 15 additions & 0 deletions 6
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

added 52 packages, and audited 371 packages in 3s

53 packages are looking for funding
run `npm fund` for details

4 high severity vulnerabilities

To address issues that do not require attention, run:
npm audit fix

To address all issues (including breaking changes), run:
npm audit fix --force

Run `npm audit` for details.
Comment on lines +1 to +15

Choose a reason for hiding this comment

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

Image description CodeRabbit

This hunk seems to be the output of an npm install or similar command. It's generally not a good practice to include such outputs in your codebase, as they can quickly become outdated and may contain system-specific information. Instead, consider adding instructions in your README file about how to handle package installation and addressing potential vulnerabilities.

- 1: 
- 2: added 52 packages, and audited 371 packages in 3s
- 3: 
- 4: 53 packages are looking for funding
- 5:   run `npm fund` for details
- 6: 
- 7: 4 high severity vulnerabilities
- 8: 
- 9: To address issues that do not require attention, run:
- 10:   npm audit fix
- 11: 
- 12: To address all issues (including breaking changes), run:
- 13:   npm audit fix --force
- 14: 
- 15: Run `npm audit` for details.

17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// Readme file for school assignment Workflow

v.1.0.1
- Added a new file called "README.md"
- Initiated own forked repository
- made a new branch called "Workflow"

v.1.0.2
- Installed and configured prettier and eslint
- Set up gitignore file

v.1.0.3
- Installed JEST and set up for testing
- Added a new files called "localStorage.mock.js" + "save.test.js"
- Unit testing for storing token on login with valid credentials and for clearing token when logout is clicked
- Added E2E testing for login, login error and logout
- Updated content of README.md

Choose a reason for hiding this comment

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

Image description CodeRabbit

It's a good practice to always end your files with a newline. This is because some tools like cat, awk, or vi might not process the file correctly if it doesn't end with a newline.

- Updated content of README.md
+ \ No newline at end of file

3 changes: 3 additions & 0 deletions babel.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"presets": [["@babel/preset-env", { "targets": { "node": "current" } }]]
}
9 changes: 9 additions & 0 deletions cypress.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { defineConfig } from "cypress";

export default defineConfig({
e2e: {
setupNodeEvents(on, config) {
// implement node event listeners here
},
},
});
143 changes: 143 additions & 0 deletions 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', () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

You can remove all of the example files that ship with Cypress

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')
})

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', 2)

// 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('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()
})

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')
})
})
})
Loading
Loading