diff --git a/cypress.config.js b/cypress.config.js index 43c7d2f2ab..862adbdea1 100644 --- a/cypress.config.js +++ b/cypress.config.js @@ -1,11 +1,26 @@ +const fetch = require('node-fetch'); const { defineConfig } = require('cypress'); +const BASE_URL = 'http://localhost:5678'; + module.exports = defineConfig({ e2e: { - baseUrl: 'http://localhost:5678', + baseUrl: BASE_URL, video: false, screenshotOnRunFailure: true, experimentalSessionAndOrigin: true, experimentalInteractiveRunEvents: true, + + setupNodeEvents(on) { + on('task', { + 'db:reset': () => fetch(BASE_URL + '/e2e/db/reset', { method: 'POST' }), + 'db:setup-owner': (payload) => + fetch(BASE_URL + '/e2e/db/setup-owner', { + method: 'POST', + body: JSON.stringify(payload), + headers: { 'Content-Type': 'application/json' }, + }), + }); + }, }, }); diff --git a/cypress/e2e/0-smoke.cy.ts b/cypress/e2e/0-smoke.cy.ts index 3f394a4182..f686075d47 100644 --- a/cypress/e2e/0-smoke.cy.ts +++ b/cypress/e2e/0-smoke.cy.ts @@ -1,23 +1,28 @@ -import {DEFAULT_USER_EMAIL, DEFAULT_USER_PASSWORD} from "../constants"; -import {randFirstName, randLastName} from "@ngneat/falso"; +import { DEFAULT_USER_EMAIL, DEFAULT_USER_PASSWORD } from '../constants'; +import { randFirstName, randLastName } from '@ngneat/falso'; -const username = DEFAULT_USER_EMAIL; +const email = DEFAULT_USER_EMAIL; const password = DEFAULT_USER_PASSWORD; const firstName = randFirstName(); const lastName = randLastName(); describe('Authentication', () => { + beforeEach(() => { + cy.task('db:reset'); + }); + it('should setup owner', () => { - cy.signup(username, firstName, lastName, password); + cy.signup(email, firstName, lastName, password); }); it('should sign user in', () => { + cy.task('db:setup-owner', { email, password, firstName, lastName }); cy.on('uncaught:exception', (err, runnable) => { expect(err.message).to.include('Not logged in'); return false; - }) + }); - cy.signin(username, password); + cy.signin(email, password); }); }); diff --git a/package.json b/package.json index c6865795ff..0c48a778e5 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "webhook": "./packages/cli/bin/n8n webhook", "worker": "./packages/cli/bin/n8n worker", "cypress:install": "cypress install", - "test:e2e:ui": "cross-env E2E_TESTS=true CYPRESS_BASE_URL=http://localhost:5678 start-server-and-test start http://localhost:5678/favicon.ico 'cypress open'", + "test:e2e:ui": "cross-env E2E_TESTS=true start-server-and-test start http://localhost:5678/favicon.ico 'cypress open'", "test:e2e:dev": "cross-env E2E_TESTS=true CYPRESS_BASE_URL=http://localhost:8080 start-server-and-test dev http://localhost:8080/favicon.ico 'cypress open'", "test:e2e:smoke": "cross-env E2E_TESTS=true start-server-and-test start http://localhost:5678/favicon.ico 'cypress run --headless --spec \"cypress/e2e/0-smoke.cy.ts\"'", "test:e2e:all": "cross-env E2E_TESTS=true start-server-and-test start http://localhost:5678/favicon.ico 'cypress run'" @@ -42,6 +42,7 @@ "@types/node": "^16.11.22", "cross-env": "^7.0.3", "cypress": "^10.0.3", + "node-fetch": "^2.6.7", "jest": "^29.3.1", "jest-environment-jsdom": "^29.3.1", "jest-mock": "^29.3.1", diff --git a/packages/cli/src/Db.ts b/packages/cli/src/Db.ts index 58a0cb3b5b..b18357381d 100644 --- a/packages/cli/src/Db.ts +++ b/packages/cli/src/Db.ts @@ -32,7 +32,7 @@ import { export let isInitialized = false; export const collections = {} as IDatabaseCollections; -let connection: Connection; +export let connection: Connection; export async function transaction(fn: (entityManager: EntityManager) => Promise): Promise { return connection.transaction(fn); diff --git a/packages/cli/src/Server.ts b/packages/cli/src/Server.ts index 2558b9bbd2..250c5e175e 100644 --- a/packages/cli/src/Server.ts +++ b/packages/cli/src/Server.ts @@ -270,6 +270,10 @@ class App { setupErrorMiddleware(this.app); + if (process.env.E2E_TESTS === 'true') { + this.app.use('/e2e', require('./api/e2e.api').e2eController); + } + const urlBaseWebhook = WebhookHelpers.getWebhookBaseUrl(); const telemetrySettings: ITelemetrySettings = { enabled: config.getEnv('diagnostics.enabled'), @@ -431,6 +435,7 @@ class App { 'metrics', 'icons', 'types', + 'e2e', this.endpointWebhook, this.endpointWebhookTest, this.endpointPresetCredentials, diff --git a/packages/cli/src/api/e2e.api.ts b/packages/cli/src/api/e2e.api.ts new file mode 100644 index 0000000000..ff9528d78f --- /dev/null +++ b/packages/cli/src/api/e2e.api.ts @@ -0,0 +1,111 @@ +/* eslint-disable @typescript-eslint/no-unsafe-return */ +/* eslint-disable @typescript-eslint/no-unsafe-call */ +/* eslint-disable @typescript-eslint/no-unsafe-member-access */ +/* eslint-disable @typescript-eslint/no-unsafe-argument */ +/* eslint-disable @typescript-eslint/no-unsafe-assignment */ +/* eslint-disable @typescript-eslint/naming-convention */ +import { Router } from 'express'; +import bodyParser from 'body-parser'; +import { v4 as uuid } from 'uuid'; +import config from '@/config'; +import * as Db from '@/Db'; +import { Role } from '@/databases/entities/Role'; +import { hashPassword } from '@/UserManagement/UserManagementHelper'; + +if (process.env.E2E_TESTS !== 'true') { + console.error('E2E endpoints only allowed during E2E tests'); + process.exit(1); +} + +const tablesToTruncate = [ + 'shared_workflow', + 'shared_credentials', + 'webhook_entity', + 'workflows_tags', + 'credentials_entity', + 'tag_entity', + 'workflow_entity', + 'execution_entity', + 'settings', + 'installed_packages', + 'installed_nodes', + 'user', + 'role', +]; + +const truncateAll = async () => { + const { connection } = Db; + for (const table of tablesToTruncate) { + await connection.query( + `DELETE FROM ${table}; DELETE FROM sqlite_sequence WHERE name=${table};`, + ); + } + config.set('userManagement.isInstanceOwnerSetUp', false); +}; + +const setupUserManagement = async () => { + const { connection } = Db; + await connection.query('INSERT INTO role (name, scope) VALUES ("owner", "global");'); + const instanceOwnerRole = (await connection.query( + 'SELECT last_insert_rowid() as insertId', + )) as Array<{ insertId: number }>; + + const roles: Array<[Role['name'], Role['scope']]> = [ + ['member', 'global'], + ['owner', 'workflow'], + ['owner', 'credential'], + ['user', 'credential'], + ['editor', 'workflow'], + ]; + + await Promise.all( + roles.map(async ([name, scope]) => + connection.query(`INSERT INTO role (name, scope) VALUES ("${name}", "${scope}");`), + ), + ); + await connection.query( + `INSERT INTO user (id, globalRoleId) values ("${uuid()}", ${instanceOwnerRole[0].insertId})`, + ); + await connection.query( + `INSERT INTO "settings" (key, value, loadOnStartup) values ('userManagement.isInstanceOwnerSetUp', 'false', true), ('userManagement.skipInstanceOwnerSetup', 'false', true)`, + ); +}; + +export const e2eController = Router(); + +e2eController.post('/db/reset', async (req, res) => { + await truncateAll(); + await setupUserManagement(); + + res.writeHead(204).end(); +}); + +e2eController.post('/db/setup-owner', bodyParser.json(), async (req, res) => { + if (config.get('userManagement.isInstanceOwnerSetUp')) { + res.writeHead(500).send({ error: 'Owner already setup' }); + return; + } + + const globalRole = await Db.collections.Role.findOneOrFail({ + name: 'owner', + scope: 'global', + }); + + const owner = await Db.collections.User.findOneOrFail({ globalRole }); + + await Db.collections.User.update(owner.id, { + email: req.body.email, + password: await hashPassword(req.body.password), + firstName: req.body.firstName, + lastName: req.body.lastName, + }); + + await Db.collections.Settings.update( + { key: 'userManagement.isInstanceOwnerSetUp' }, + { value: 'true' }, + ); + + config.set('userManagement.isInstanceOwnerSetUp', true); + + res.writeHead(204).end(); +}); diff --git a/packages/cli/src/config/index.ts b/packages/cli/src/config/index.ts index 80f632f0f8..23d70b54cc 100644 --- a/packages/cli/src/config/index.ts +++ b/packages/cli/src/config/index.ts @@ -13,6 +13,7 @@ const inE2ETests = process.env.E2E_TESTS === 'true'; if (inE2ETests) { // Skip loading config from env variables in end-to-end tests process.env = { + E2E_TESTS: 'true', N8N_USER_FOLDER: mkdtempSync(join(tmpdir(), 'n8n-e2e-')), N8N_DIAGNOSTICS_ENABLED: 'false', N8N_PUBLIC_API_DISABLED: 'true', diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 08be489c0c..3d1930dab1 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -29,6 +29,7 @@ importers: jest-environment-jsdom: ^29.3.1 jest-mock: ^29.3.1 n8n: '*' + node-fetch: ^2.6.7 prettier: ^2.3.2 rimraf: ^3.0.2 run-script-os: ^1.0.7 @@ -50,6 +51,7 @@ importers: jest: 29.3.1_@types+node@16.11.65 jest-environment-jsdom: 29.3.1 jest-mock: 29.3.1 + node-fetch: 2.6.7 prettier: 2.7.1 rimraf: 3.0.2 run-script-os: 1.1.6