test(e2e): add more typings for cypress helpers

ory · Oct 19, 2021 · 60bd63f · 60bd63f
1 parent 2625d16
commit 60bd63f
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 15 deletions.
diff --git a/test/e2e/cypress/support/commands.ts b/test/e2e/cypress/support/commands.ts
@@ -287,8 +287,8 @@ Cypress.Commands.add('browserReturnUrlOry', ({} = {}) => {
   })
 })
 
-Cypress.Commands.add('loginOidc', ({expectSession = true}) => {
-  cy.visit(APP_URL + '/auth/login')
+Cypress.Commands.add('loginOidc', ({expectSession = true, url=APP_URL + '/login'}) => {
+  cy.visit(url)
   cy.get('button[value="hydra"]').click()
   if (expectSession) {
     cy.getSession()
@@ -297,15 +297,15 @@ Cypress.Commands.add('loginOidc', ({expectSession = true}) => {
   }
 })
 
-Cypress.Commands.add('login', ({email, password, expectSession = true}) => {
+Cypress.Commands.add('login', ({email, password, expectSession = true, cookieUrl = APP_URL}) => {
   if (expectSession) {
     console.log('Singing in user: ', {email, password})
   } else {
     console.log('Attempting user sign in: ', {email, password})
   }
 
   // see https://github.com/cypress-io/cypress/issues/408
-  cy.visit(APP_URL)
+  cy.visit(cookieUrl)
   cy.clearCookies()
 
   cy.longPrivilegedSessionTime()
@@ -369,7 +369,7 @@ Cypress.Commands.add(
      expect: {email},
      type: {email: temail, password: tpassword} = {email: undefined, password: undefined}
    }) => {
-    cy.url().should('include', '/auth/login')
+    cy.url().should('include', '/login')
     cy.get('input[name="password_identifier"]').should('have.value', email)
     if (temail) {
       cy.get('input[name="password_identifier"]').clear().type(temail)
@@ -406,7 +406,7 @@ Cypress.Commands.add('deleteMail', ({atLeast = 0} = {}) => {
 })
 
 Cypress.Commands.add(
-  'session',
+  'getSession',
   ({expectAal = 'aal1', expectMethods = []} = {}) =>
     cy.request('GET', `${KRATOS_PUBLIC}/sessions/whoami`).then((response) => {
       expect(response.body.id).to.not.be.empty

diff --git a/test/e2e/cypress/support/index.d.ts b/test/e2e/cypress/support/index.d.ts
@@ -1,11 +1,10 @@
 import {Session} from "@ory/kratos-client";
-import {gen} from "../helpers";
 
 export interface MailMessage {
   fromAddress: string
   toAddresses: Array<string>
-  body:string
-  subject:string
+  body: string
+  subject: string
 }
 
 declare global {
@@ -26,17 +25,36 @@ declare global {
        * @param opts
        */
       getSession(opts?:
-        {
-          expectAal: 'aal2' |'aal1',
-          expectMethods: Array<'password' | 'webauthn'>,
-        }
+                   {
+                     expectAal: 'aal2' | 'aal1',
+                     expectMethods: Array<'password' | 'webauthn'>,
+                   }
       ): Chainable<Session>
 
       /**
        * Expect that the browser has no valid Ory Kratos Cookie Session.
        */
       noSession(): Chainable<Response<any>>
 
+      /**
+       * Log a user in
+       *
+       * @param opts
+       */
+      login(opts: { email: string, password: string, expectSession?: boolean, cookieUrl?: string }): Chainable<Response<Session | undefined>>
+
+      /**
+       * Sign up a user
+       *
+       * @param opts
+       */
+      register(opts: {
+        email: string,
+        password: string,
+        query?: { [key: string]: string },
+        fields?: { [key: string]: any }
+      }): Chainable<Response<void>>
+
       /**
        * Set the "privileged session lifespan" to a large value.
        */
@@ -49,7 +67,7 @@ declare global {
        */
       getMail(opts?: { removeMail: boolean }): Chainable<MailMessage>
 
-      performEmailVerification(opts?: {expect?: {email?: string, redirectTo?: string}}): Chainable<void>
+      performEmailVerification(opts?: { expect?: { email?: string, redirectTo?: string } }): Chainable<void>
 
       /**
        * Sets the Ory Kratos configuration profile.
@@ -65,7 +83,7 @@ declare global {
        *
        * @param opts
        */
-      registerApi(opts?: {email:string, password:string, fields: { [key: string]: string  }}): Chainable<Session>
+      registerApi(opts?: { email: string, password: string, fields: { [key: string]: string } }): Chainable<Session>
 
       /**
        * Changes the config so that the login flow lifespan is very short.
@@ -80,6 +98,7 @@ declare global {
        * Changes the config so that the login flow lifespan is very long.
        *
        * Useful when testing expiry of login flows.
+       *
        * @see shortLoginLifespan()
        */
       longLoginLifespan(): Chainable<void>
@@ -88,6 +107,43 @@ declare global {
        * Change the config so that `https://www.ory.sh/` is a allowed return to URL.
        */
       browserReturnUrlOry(): Chainable<void>
+
+      /**
+       * Changes the config so that the registration flow lifespan is very short.
+       *
+       * Useful when testing expiry of registration flows.
+       *
+       * @see longRegisterLifespan()
+       */
+      shortRegisterLifespan(): Chainable<void>
+
+      /**
+       * Changes the config so that the registration flow lifespan is very long.
+       *
+       * Useful when testing expiry of registration flows.
+       *
+       * @see shortRegisterLifespan()
+       */
+      longRegisterLifespan(): Chainable<void>
+
+      /**
+       * Changes the config so that the settings privileged lifespan is very long.
+       *
+       * Useful when testing privileged settings flows.
+       *
+       * @see longPrivilegedSessionTime()
+       */
+      shortPrivilegedSessionTime(): Chainable<void>
+
+      /**
+       * Re-authenticates a user.
+       *
+       * @param opts
+       */
+      reauth(opts: {
+        expect: { email },
+        type: { email?: string, password?: string }
+      }): Chainable<void>
     }
   }
 }