Merge branch 'beta' of github.com:SoftwareBrothers/admin-bro into beta

SoftwareBrothers · Oct 31, 2020 · f73bd88 · f73bd88
2 parents f108eaa + e5f32db
commit f73bd88
Show file tree

Hide file tree

Showing 21 changed files with 155 additions and 60 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -81,7 +81,10 @@ module.exports = {
       },
     },
     {
-      files: ['**/*/cypress/integration/**/*.spec.js'],
+      files: [
+        '**/*/cypress/integration/**/*.spec.js',
+        './cy/**/*.js',
+      ],
       rules: {
         'mocha/no-mocha-arrows': 'off',
         'spaced-comment': 'off',

diff --git a/cy/commands/ab-get-property.js b/cy/commands/ab-get-property.js
@@ -0,0 +1,14 @@
+/// <reference types="cypress" />
+
+/**
+ * @method abGetProperty
+ * @param {string} propertyPath
+ * @param {string} [selector=null]
+ */
+Cypress.Commands.add('abGetProperty', (propertyPath, selector = null) => {
+  let propertySelector = `[data-testid$="-${propertyPath}"]`
+  if (selector) {
+    propertySelector = [propertySelector, selector].join(' ')
+  }
+  return cy.get(propertySelector)
+})
diff --git a/cy/commands/ab-keep-logged-in.js b/cy/commands/ab-keep-logged-in.js
@@ -0,0 +1,19 @@
+/// <reference types="cypress" />
+
+/**
+ * @method abKeepLoggedIn
+ * @param {object} [options]
+ * @param {object} [options.cookie]   session cookie name: default to Cypress.env('AB_COOKIE_NAME')
+ * @example
+ * before(() => {
+ *   cy.abLogin()
+ * })
+ *
+ * beforeAll(() => {
+ *   cy.abKeepLoggedIn({ cookie: 'my-session-cookie' })
+ *   cy.visit('your/path')
+ * })
+ */
+Cypress.Commands.add('abKeepLoggedIn', ({ cookie }) => {
+  Cypress.Cookies.preserveOnce(cookie || Cypress.env('AB_COOKIE_NAME'))
+})
diff --git a/cy/commands/ab-login-api.js b/cy/commands/ab-login-api.js
@@ -0,0 +1,15 @@
+/// <reference types="cypress" />
+
+/**
+ * @method abLogin
+ * @param {object} [options]
+ * @param {object} [options.email]          login email: default to Cypress.env('AB_EMAIL')
+ * @param {object} [options.password]       login password: default to Cypress.env('AB_PASSWORD')
+ * @param {object} [options.loginPath]      default to '/login'
+ */
+Cypress.Commands.add('abLoginAPI', ({ email, password, loginPath } = {}) => (
+  cy.request('POST', loginPath || '/login', {
+    email: email || Cypress.env('AB_EMAIL'),
+    password: password || Cypress.env('AB_PASSWORD'),
+  })
+))
diff --git a/cy/commands/ab-login.js b/cy/commands/ab-login.js
@@ -0,0 +1,15 @@
+/// <reference types="cypress" />
+
+/**
+ * @method abLogin
+ * @param {object} [options]
+ * @param {object} [options.email]          login email: default to Cypress.env('AB_EMAIL')
+ * @param {object} [options.password]       login password: default to Cypress.env('AB_PASSWORD')
+ * @param {object} [options.loginPath]      default to '/login'
+ */
+Cypress.Commands.add('abLogin', ({ email, password, loginPath } = {}) => {
+  cy.visit(loginPath || '/login')
+  cy.get('[name=email]').type(email || Cypress.env('AB_EMAIL'))
+  cy.get('[name=password]').type(password || Cypress.env('AB_PASSWORD'))
+  cy.get('button').click()
+})
diff --git a/cy/index.d.ts b/cy/index.d.ts
@@ -0,0 +1,20 @@
+/// <reference types="cypress" />
+
+declare namespace Cypress {
+  type AbLoginParams = {
+    email?: string;
+    password?: string;
+    loginPath?: string;
+  }
+
+  type AbKeepLoggedInParams = {
+    cookie?: string;
+  }
+
+  interface Chainable<Subject> {
+    abLogin(params?: AbLoginParams): Chainable<any>;
+    abLoginAPI(params?: AbLoginParams): Chainable<any>;
+    abGetProperty(propertyPath: string, selector?: string): Chainable<any>;
+    abKeepLoggedIn(params?: AbKeepLoggedInParams): Chainable<any>;
+  }
+}
diff --git a/cy/index.js b/cy/index.js
@@ -0,0 +1,4 @@
+require('./commands/ab-login')
+require('./commands/ab-login-api')
+require('./commands/ab-keep-logged-in')
+require('./commands/ab-get-property')
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "admin-bro",
-  "version": "3.3.0-beta.35",
+  "version": "3.3.0-beta.36",
   "description": "Admin panel for apps written in node.js",
   "main": "index.js",
   "types": "index.d.ts",
@@ -9,7 +9,7 @@
     "types": "tsc",
     "clean": "rm -rf lib && mkdir lib && rm -fr types && mkdir types",
     "build": "babel src --out-dir lib --copy-files --extensions '.ts,.js,.jsx,.tsx'",
-    "lint": "eslint './spec/**/*' './src/**/*' './*'",
+    "lint": "eslint './spec/**/*' './src/**/*' './cy/**/*' './*'",
     "cover": "NODE_ENV=test nyc --reporter=lcov --reporter=text-lcov npm test",
     "codecov": "NODE_ENV=test nyc --reporter=text-lcov npm test | codecov --pipe",
     "bundle": "node bin/watch-dev.js",

diff --git a/packages/admin-bro-e2e/cypress/integration/companies/create-company.spec.js b/packages/admin-bro-e2e/cypress/integration/companies/create-company.spec.js
@@ -1,58 +1,60 @@
 /// <reference types="cypress" />
+/// <reference types="admin-bro/cy" />
 /// <reference types="../../support" />
 
 context('resources/Company/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Company/actions/new')
   })
 
   it('shows password property', () => {
     const typedPassword = 'password'
 
-    cy.get('[data-testid="property-edit-password"] input[type="password"]').type(typedPassword)
-    cy.get('[data-testid="property-edit-password"] button').click()
+    cy.abGetProperty('password', 'input[type="password"]')
+      .type(typedPassword)
+    cy.abGetProperty('password', 'button')
+      .click()
 
-    cy.get('[data-testid="property-edit-password"] input[type="input"]').should('have.value', typedPassword)
+    cy.abGetProperty('password', 'input[type="input"]')
+      .should('have.value', typedPassword)
   })
 
   it('shows disabled checkBox', () => {
-    cy.get('[data-testid="property-edit-isAdmin"] input[type="checkbox"]')
+    cy.abGetProperty('isAdmin', 'input[type="checkbox"]')
       .should('be.disabled')
       .should('not.be.checked')
 
-    cy.get('[data-testid="property-edit-isAdmin"] label')
+    cy.abGetProperty('isAdmin', 'label')
       .click()
       .should('not.be.checked')
   })
 
   it('show translated select labels and button', () => {
-    cy.get('[data-testid="property-edit-companySize"] input').click()
-    cy.get('[data-testid="property-edit-companySize"] [class$="option"]')
-      .then((options) => {
-        expect(
-          options.map((k, option) => cy.$$(option).text()).toArray(),
-        ).to.have.members(['superBig', 's', 't'])
-      })
-    cy.get('[data-testid="property-edit-tags"] button').should('have.text', 'Add new Tag')
+    cy.abGetProperty('companySize', 'input')
+      .click()
+      .get('[class$="option"]').then(options => options
+        .map((k, option) => cy.$$(option).text()).toArray())
+      .should('have.members', ['superBig', 's', 't'])
+
+    cy.abGetProperty('tags', 'button').should('have.text', 'Add new Tag')
   })
 
   it('preserve regular checkbox value when validation fails', () => {
-    cy.get('[data-testid="property-edit-isBig"] input[type="checkbox"]')
+    cy.abGetProperty('isBig', 'input[type="checkbox"]')
       .should('not.be.disabled')
       .should('not.be.checked')
 
     // clicking checkbox twice
-    cy.get('[data-testid="property-edit-isBig"] label')
-      .click().click()
+    cy.abGetProperty('isBig', 'label').click().click()
 
     cy.get('form button[data-testid="button-save"]').click()
 
-    cy.get('[data-testid="property-edit-isBig"] input[type="checkbox"]')
+    cy.abGetProperty('isBig', 'input[type="checkbox"]')
       .should('not.be.checked')
   })
 
@@ -64,19 +66,27 @@ context('resources/Company/actions/new', () => {
       companySize: 'superBig',
     }
 
-    cy.get('#email').type(data.email)
-    cy.get('#companyName').type(data.companyName)
-    cy.get('#address').type(data.address)
-    cy.get('#password').type('somePassword')
-
-    cy.get('[data-testid="property-edit-companySize"] input').click()
-    cy.get('[data-testid="property-edit-companySize"] [class$="option"]').first().click()
-
-    cy.get('[data-testid="property-edit-isBig"] label').click()
+    cy.abGetProperty('email', 'input')
+      .type(data.email)
+    cy.abGetProperty('companyName', 'input')
+      .type(data.companyName)
+    cy.abGetProperty('address', 'input')
+      .type(data.address)
+    cy.abGetProperty('password', 'input')
+      .type('somePassword')
+    cy.abGetProperty('companySize', 'input')
+      .click()
+      .get('[class$="option"]')
+      .first()
+      .click()
+    cy.abGetProperty('isBig', 'label')
+      .click()
 
-    cy.get('button[type="submit"]').click()
+    cy.get('button[type="submit"]')
+      .click()
 
-    cy.location('pathname').should('eq', '/admin/resources/Company')
+    cy.location('pathname')
+      .should('eq', '/admin/resources/Company')
 
     cy.get('td[data-property-name="email"]')
       .contains(data.email)

diff --git a/packages/admin-bro-e2e/cypress/integration/companies/list-companies.spec.js b/packages/admin-bro-e2e/cypress/integration/companies/list-companies.spec.js
@@ -3,7 +3,7 @@
 
 context('resources/Company', () => {
   beforeEach(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
     cy.visit('resources/Company')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/employees/create-employee.spec.js b/packages/admin-bro-e2e/cypress/integration/employees/create-employee.spec.js
@@ -9,11 +9,11 @@ const select = (selector, value) => {
 
 context('resources/Employee/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Employee/actions/new')
   })
 

diff --git a/...ges/admin-bro-e2e/cypress/integration/external-employees/create-external-employee.spec.js b/...ges/admin-bro-e2e/cypress/integration/external-employees/create-external-employee.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/ExternalEmployees/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/ExternalEmployees/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/nested/create-nested.spec.js b/packages/admin-bro-e2e/cypress/integration/nested/create-nested.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Nested/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Nested/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/pages/create-page.spec.js b/packages/admin-bro-e2e/cypress/integration/pages/create-page.spec.js
@@ -6,11 +6,11 @@ const dateTimeRegex = /^[\d]{4}-[\d]{2}-[\d]{2} [\d]{2}:[\d]{2}$/
 
 context('resources/Profession/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Page/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/professions/create-profession.spec.js b/packages/admin-bro-e2e/cypress/integration/professions/create-profession.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Profession/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Profession/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/sign-in/sign-in.spec.js b/packages/admin-bro-e2e/cypress/integration/sign-in/sign-in.spec.js
@@ -3,10 +3,10 @@
 
 context('SignIn page', () => {
   beforeEach(() => {
-    cy.login()
+    cy.abLogin({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   it('logs in to the application', () => {
     cy.location('pathname').should('not.include', 'admin/login')
   })
-})
+})
diff --git a/packages/admin-bro-e2e/cypress/integration/taggables/edit-taggable.spec.js b/packages/admin-bro-e2e/cypress/integration/taggables/edit-taggable.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Taggables/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Taggables/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/tools/create-tool.spec.js b/packages/admin-bro-e2e/cypress/integration/tools/create-tool.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Tool/actions/new', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Tool/actions/new')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/tools/edit-tool.spec.js b/packages/admin-bro-e2e/cypress/integration/tools/edit-tool.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Tool/actions/edit', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Tool')
   })
 

diff --git a/packages/admin-bro-e2e/cypress/integration/tools/list-tools.spec.js b/packages/admin-bro-e2e/cypress/integration/tools/list-tools.spec.js
@@ -3,11 +3,11 @@
 
 context('resources/Tool', () => {
   before(() => {
-    cy.login()
+    cy.abLoginAPI({ password: Cypress.env('ADMIN_PASSWORD'), email: Cypress.env('ADMIN_EMAIL') })
   })
 
   beforeEach(() => {
-    Cypress.Cookies.preserveOnce(Cypress.env('COOKIE_NAME'))
+    cy.abKeepLoggedIn({ cookie: Cypress.env('COOKIE_NAME') })
     cy.visit('resources/Tool')
     cy.get('.admin-bro_PaginationLink')
     cy.get('.admin-bro_H2 .admin-bro_Badge').invoke('text').as('total')