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.

Sign up for GitHub

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

193 Mock Test Auth & 2 tests from 192 #197

Merged
merged 16 commits into from
Feb 16, 2023
Merged

193 Mock Test Auth & 2 tests from 192 #197

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b2b31de
mock auth
summer-cook Feb 9, 2023
0f63749
fix request test and test session env
summer-cook Feb 10, 2023
eff04f8
update readme, use dotenv for environment variables so we can hide co…
summer-cook Feb 10, 2023
e4a5d25
fix merge conflicts
summer-cook Feb 10, 2023
bfc8de8
add a line of space in readmne
summer-cook Feb 10, 2023
6c82419
fix comment
summer-cook Feb 10, 2023
8502bfa
Update cypress.config.js
summer-cook Feb 14, 2023
44a1e5e
remove semicolons
summer-cook Feb 14, 2023
7f80cd9
Merge branch '193-mock-auth-tests' of github.com:scientist-softserv/w…
summer-cook Feb 14, 2023
b74deea
updates test to reflect new requirements in epic
summer-cook Feb 15, 2023
fe85471
update browsing test for new requirements in ticket
summer-cook Feb 15, 2023
e5e2bb2
update requests and browsing tests and move non secret env variables
summer-cook Feb 15, 2023
42adb27
Update cypress/support/commands.js
summer-cook Feb 15, 2023
a7f0fce
update readme
summer-cook Feb 15, 2023
b44a746
check for a request instead of the title of the whole list
summer-cook Feb 15, 2023
c29c212
Update README.md
summer-cook Feb 16, 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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,22 @@ There are 2 types of Cypress tests, e2e & component.

If you are creating an e2e test, it will live in the `cypress/e2e` directory. Component tests will need to be created in a directory called `cypress/component `

#### Setup your Cypress env variables
- the Cypress suite requires environment variables that should be stored in your `.env.local` and not committed to git.
- (these two are not secrets)
- [email protected]
- TEST_SCIENTIST_PW=!test1234
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
- (this one is a secret)
summer-cook marked this conversation as resolved.
Show resolved Hide resolved
- TEST_SESSION_COOKIE=
- to get the value for this variable, open your browser to your running app at `localhost:3000`.
- inspect the page
- click the "Application" tab
- click "Cookies"
- find the value for `next-auth.session-token`
- copy that value and paste it in the `TEST_SESSION_COOKIE` variable in your .env.local
- do not ever commit this value
- this value will need to be updated whenever the cookie expires, approximately once per month

## Cutting a New Release
A git tag should exist for every release. We use `release-it` to automate the coordination of package.json and git tag.

Expand Down
12 changes: 10 additions & 2 deletions cypress.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
const { defineConfig } = require("cypress");
require('dotenv').config({ path: `.env.local`, override: true })

const { defineConfig } = require("cypress")

module.exports = defineConfig({
component: {
Expand All @@ -9,8 +11,14 @@ module.exports = defineConfig({
},

e2e: {
baseUrl: 'http://localhost:3000',
chromeWebSecurity: false,
setupNodeEvents(on, config) {
// implement node event listeners here
config.env = {
...process.env,
...config.env
}
return config
},
},
});
9 changes: 6 additions & 3 deletions cypress/e2e/index.cy.js → cypress/e2e/browsing.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
describe('The home page', () => {
it('should be able to reach the browse page', () => {
describe('Browsing', () => {
it('a user can search from the home page and be directed to "/browse" with a blank query', () => {
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
// Start from the home/index page
cy.visit('http://localhost:3000/')
cy.visit('/')

// Find the search button and perform an empty search, which should lead to the browse page
cy.get('button.search-button').click()

// The new url should include "/browse"
cy.url().should('include', '/browse')

alishaevn marked this conversation as resolved.
Show resolved Hide resolved
// The search bar on the browse page should remain blank
cy.get('input.search-bar').should('have.value', '')
})
})
22 changes: 22 additions & 0 deletions cypress/e2e/requests.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
describe("Requests Page", () => {
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
it("A logged out user should not able to see the requests list.", () => {
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
// Visit a protected route in order to allow cypress to set the cookie and mock the login
cy.visit("/requests")

cy.get('div.alert-heading').contains('Unauthorized').then(() => {
cy.log("A logged out user is not able to view requests.");
});
})

it("A logged in user should be able to see the requests list.", () => {
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
// Call the custom cypress command to log in
cy.login(Cypress.env('TEST_SCIENTIST_USER'), Cypress.env('TEST_SCIENTIST_PW'))

// Visit a protected route in order to allow cypress to set the cookie and mock the login
cy.visit("/requests")

cy.get('h1').contains('My Requests').then(() => {
alishaevn marked this conversation as resolved.
Show resolved Hide resolved
cy.log("Successfully logged in and viewing requests page");
});
})
});
Copy link
Member

Choose a reason for hiding this comment

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

now that the wcl has been updated to display text when we have no requests, can that test be added too?

Copy link
Contributor Author

@summer-cook summer-cook Feb 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

i was going to do that in a separate PR because i needed to figure out how and it was going to take a while. Since the e2e tests look at the db itself and use the real backend, and I already have requests, i also will not be able to check if a test like that is working.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

nvm, went ahead and included a check for this, but this is just checking that either of these elements exist when the user is signed in vs. saying that it needs to know whether or not a user has requests on their request list or not.

i think if we wanted to do the latter we would need to test the data itself, which isn't done with cypress out of the box but theres an add on called cypress-react-selector where we could potentially be able to do something like this.
heres an example of how it could be used: https://glebbahmutov.com/blog/react-state-from-e2e-tests/

but this is more in depth and should probably be a separate ticket

Copy link
Member

Choose a reason for hiding this comment

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

is mock data not an option?

the current implementation is ok for now, but it should be expanded in the future. although the tests says it's checking for the existence of requests or a "no requests" message....it isn't. since we don't have a use case where tests exist, the "no requests" route is the only one that will ever return true.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

there is a way with cypress fixtures - if we did that and only wanted to use mock data, we would need to mock every single api call- this is an example of that: https://blog.bitsrc.io/mocking-http-calls-in-cypress-end-to-end-tests-fa2e6b7caaf7

it can be done but it isn't really in the scope of this ticket

9 changes: 9 additions & 0 deletions cypress/fixtures/session.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"user": {
"name": "Spongebob Squarepants",
"email": "[email protected]",
"image": "/path/to/mock/user.jpg"
},
"expires": "3000-01-01T00:00:00.000Z",
"accessToken": "abcdefghijklmnopqrst"
}
5 changes: 5 additions & 0 deletions cypress/plugins/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const dotenvPlugin = require('cypress-dotenv');
module.exports = (on, config) => {
config = dotenvPlugin(config)
return config
}
16 changes: 15 additions & 1 deletion cypress/support/commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,18 @@
//
//
// -- This will overwrite an existing command --
// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })


// add a command to login that uses a session, so the user will remain logged in throughout the test vs. needing to log in before each example.
summer-cook marked this conversation as resolved.
Show resolved Hide resolved
// source: https://github.com/nextauthjs/next-auth/discussions/2053#discussioncomment-1191016
Cypress.Commands.add('login', (username, password) => {
cy.session([username, password], () => {
cy.intercept("/api/auth/session", { fixture: "session.json" }).as("session");

// Set the cookie for cypress.
// It has to be a valid cookie so next-auth can decrypt it and confirm its validity.
// This cookie also may need to be refreshed intermittently if it expires
cy.setCookie("next-auth.session-token", Cypress.env('TEST_SESSION_COOKIE'));
})
})
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
"@testing-library/jest-dom": "^5.16.5",
"@testing-library/react": "^13.4.0",
"cypress": "^12.1.0",
"cypress-dotenv": "^2.0.0",
"dotenv": "^16.0.3",
"eslint": "8.25.0",
"eslint-config-next": "12.3.1",
"jest": "^29.3.1",
Expand Down
39 changes: 38 additions & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2452,6 +2452,15 @@ csstype@^3.0.2:
resolved "https://registry.yarnpkg.com/csstype/-/csstype-3.1.1.tgz#841b532c45c758ee546a11d5bd7b7b473c8c30b9"
integrity sha512-DJR/VvkAvSZW9bTouZue2sSxDwdTN92uHjqeKVm+0dAqdfNykRzQ95tay8aXMBAAPpUiq4Qcug2L7neoRh2Egw==

cypress-dotenv@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/cypress-dotenv/-/cypress-dotenv-2.0.0.tgz#ed77f232de7473c0c29f997fa8ff8b00faa5be2f"
integrity sha512-MHCkWuTU51n/Q6LT2FgjNVZx/OmnrP3Jve7TUGZvSbjgGOpBOVZTbm3tomjvn+2S6HhloRXSAOmT5fY9pvWkpQ==
dependencies:
camelcase "^6.2.0"
dotenv-parse-variables "^2.0.0"
lodash.clonedeep "^4.5.0"

cypress@^12.1.0:
version "12.3.0"
resolved "https://registry.yarnpkg.com/cypress/-/cypress-12.3.0.tgz#ae3fb0540aef4b5eab1ef2bcd0760caf2992b8bf"
Expand Down Expand Up @@ -2536,7 +2545,7 @@ dayjs@^1.10.4:
resolved "https://registry.yarnpkg.com/dayjs/-/dayjs-1.11.7.tgz#4b296922642f70999544d1144a2c25730fce63e2"
integrity sha512-+Yw9U6YO5TQohxLcIkrXBeY73WP3ejHWVvx8XCk3gxvQDCTEmS48ZrSZCKciI7Bhl/uCMyxYtE9UqRILmFphkQ==

debug@4, debug@^4.1.0, debug@^4.1.1, debug@^4.3.2, debug@^4.3.4:
debug@4, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4:
version "4.3.4"
resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865"
integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==
Expand Down Expand Up @@ -2721,6 +2730,18 @@ domexception@^4.0.0:
dependencies:
webidl-conversions "^7.0.0"

dotenv-parse-variables@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/dotenv-parse-variables/-/dotenv-parse-variables-2.0.0.tgz#8bfd83842acdc9013c12d46b340df27ac6046a26"
integrity sha512-/Tezlx6xpDqR6zKg1V4vLCeQtHWiELhWoBz5A/E0+A1lXN9iIkNbbfc4THSymS0LQUo8F1PMiIwVG8ai/HrnSA==
dependencies:
debug "^4.3.1"
is-string-and-not-blank "^0.0.2"

dotenv@^16.0.3:
version "16.0.3"
resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.0.3.tgz#115aec42bac5053db3c456db30cc243a5a836a07"
integrity sha512-7GO6HghkA5fYG9TYnNxi14/7K9f5occMlp3zXAuSxn7CKCxt9xbNWG7yF8hTCSUchlfWSe3uLmlPfigevRItzQ==
dot-prop@^6.0.1:
version "6.0.1"
resolved "https://registry.yarnpkg.com/dot-prop/-/dot-prop-6.0.1.tgz#fc26b3cf142b9e59b74dbd39ed66ce620c681083"
Expand Down Expand Up @@ -4201,6 +4222,17 @@ is-stream@^2.0.0:
resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077"
integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==

is-string-and-not-blank@^0.0.2:
version "0.0.2"
resolved "https://registry.yarnpkg.com/is-string-and-not-blank/-/is-string-and-not-blank-0.0.2.tgz#cd19eded2ca4a514f79ca528915f1fb28e5dd38a"
integrity sha512-FyPGAbNVyZpTeDCTXnzuwbu9/WpNXbCfbHXLpCRpN4GANhS00eEIP5Ef+k5HYSNIzIhdN9zRDoBj6unscECvtQ==
dependencies:
is-string-blank "^1.0.1"

is-string-blank@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/is-string-blank/-/is-string-blank-1.0.1.tgz#866dca066d41d2894ebdfd2d8fe93e586e583a03"
integrity sha512-9H+ZBCVs3L9OYqv8nuUAzpcT9OTgMD1yAWrG7ihlnibdkbtB850heAmYWxHuXc4CHy4lKeK69tN+ny1K7gBIrw==
is-stream@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-3.0.0.tgz#e6bfd7aa6bef69f4f472ce9bb681e3e57b4319ac"
Expand Down Expand Up @@ -5002,6 +5034,11 @@ lodash-es@^4.17.15, lodash-es@^4.17.21:
resolved "https://registry.yarnpkg.com/lodash-es/-/lodash-es-4.17.21.tgz#43e626c46e6591b7750beb2b50117390c609e3ee"
integrity sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==

lodash.clonedeep@^4.5.0:
version "4.5.0"
resolved "https://registry.yarnpkg.com/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz#e23f3f9c4f8fbdde872529c1071857a086e5ccef"
integrity sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==

lodash.merge@^4.6.2:
version "4.6.2"
resolved "https://registry.yarnpkg.com/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a"
Expand Down