test: Add more tests for workflow/credential migrations when enabling UM

cypress.config.js

@@ -1,11 +1,26 @@
+const fetch = require('node-fetch');
 const { defineConfig } = require('cypress');
 
+const baseUrl = 'http://localhost:5678';
+
 module.exports = defineConfig({
 	e2e: {
-		baseUrl: 'http://localhost:5678',
+		baseUrl,
 		video: false,
 		screenshotOnRunFailure: true,
 		experimentalSessionAndOrigin: true,
 		experimentalInteractiveRunEvents: true,
+
+		setupNodeEvents(on) {
+			on('task', {
+				'db:reset': () => fetch(baseUrl + '/e2e/db/reset', { method: 'POST' }),
+				'db:setup-owner': (payload) =>
+					fetch(baseUrl + '/e2e/db/setup-owner', {
+						method: 'POST',
+						body: JSON.stringify(payload),
+						headers: { 'Content-Type': 'application/json' },
+					}),
+			});
+		},
 	},
 });

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

cypress/e2e/3-default-owner.cy.ts

@@ -1,9 +1,115 @@
-describe('Authentication', () => {
-	it('should skip owner setup', () => {
-		cy.skipSetup();
+import { randFirstName, randLastName } from '@ngneat/falso';
+import { DEFAULT_USER_EMAIL, DEFAULT_USER_PASSWORD } from '../constants';
+import { SettingsUsersPage, SignupPage, WorkflowsPage, WorkflowPage, CredentialsPage, CredentialsModal, MessageBox } from '../pages';
+
+import { MainSidebar, SettingsSidebar } from "../pages/sidebar";
+
+const mainSidebar = new MainSidebar();
+const settingsSidebar = new SettingsSidebar();
+
+const workflowsPage = new WorkflowsPage();
+const signupPage = new SignupPage();
+const workflowPage = new WorkflowPage();
+
+const credentialsPage = new CredentialsPage();
+const credentialsModal = new CredentialsModal();
+
+const settingsUsersPage = new SettingsUsersPage();
+
+const messageBox = new MessageBox();
+
+const username = DEFAULT_USER_EMAIL;
+const password = DEFAULT_USER_PASSWORD;
+const firstName = randFirstName();
+const lastName = randLastName();
+
+describe('Default owner', () => {
+	// todo test should redirect to setup if have not skipped
+
+	beforeEach(() => {
+		cy.task('db:reset');
 	});
 
-	// todo test for adding workflow
-	// todo test for setting up UM again through settings
-	// todo test that workflows migrated successfully
+	it('should be able to use n8n without user management and setup UM', () => {
+		describe('should skip owner setup', () => {
+			cy.skipSetup();
+			cy.url().should('include', workflowsPage.url);
+		});
+
+		describe('should be able to create workflows', () => {
+			workflowsPage.getters.newWorkflowButtonCard().should('be.visible');
+			workflowsPage.getters.newWorkflowButtonCard().click();
+
+			cy.createFixtureWorkflow('Test_workflow_1.json', `Test workflow`);
+
+			// reload page, ensure owner still has access
+			cy.reload();
+
+			workflowPage.getters.workflowNameInput().should('contain.value', 'Test workflow');
+		});
+
+		describe('should be able to add new credentials', () => {
+			cy.visit(credentialsPage.url);
+
+			credentialsPage.getters.emptyListCreateCredentialButton().click();
+
+			credentialsModal.getters.newCredentialModal().should('be.visible');
+			credentialsModal.getters.newCredentialTypeSelect().should('be.visible');
+			credentialsModal.getters.newCredentialTypeOption('Notion API').click();
+
+			credentialsModal.getters.newCredentialTypeButton().click();
+
+			credentialsModal.getters.connectionParameter('API Key').type('1234567890');
+
+			credentialsModal.actions.setName('My awesome Notion account');
+			credentialsModal.actions.save();
+
+			credentialsModal.actions.close();
+
+			credentialsModal.getters.newCredentialModal().should('not.exist');
+			credentialsModal.getters.editCredentialModal().should('not.exist');
+
+			credentialsPage.getters.credentialCards().should('have.length', 1);
+		});
+
+		describe('should be able to setup UM from settings', () => {
+			mainSidebar.getters.settings().should('be.visible');
+			mainSidebar.actions.goToSettings();
+			cy.url().should('include', settingsUsersPage.url);
+
+			settingsUsersPage.actions.goToOwnerSetup();
+
+			cy.url().should('include', signupPage.url);
+		});
+
+		describe('should be able to setup instance and migrate workflows and credentials', () => {
+			cy.signup(username, firstName, lastName, password);
+
+			messageBox.getters.content().should('contain.text', '1 existing workflow and 1 credential')
+
+			messageBox.actions.confirm();
+		});
+
+		describe('should be redirected back to users page after setup', () => {
+			cy.url().should('include', settingsUsersPage.url);
+			// todo test users and that owner exist
+		});
+
+		describe('can click back to workflows and have migrated workflow after setup', () => {
+			settingsSidebar.actions.back();
+
+			cy.url().should('include', workflowsPage.url);
+
+			workflowsPage.getters.workflowCards().should('have.length', 1);
+		});
+
+		describe('can click back to main menu and have migrated credential after setup', () => {
+			mainSidebar.actions.goToCredentials();
+
+			cy.url().should('include', workflowsPage.url);
+
+			workflowsPage.getters.workflowCards().should('have.length', 1);
+		});
+	});
 });
+

cypress/pages/index.ts

@@ -3,4 +3,6 @@ export * from './credentials';
 export * from './signin';
 export * from './signup';
 export * from './workflows';
+export * from './workflow';
 export * from './modals';
+export * from './settings-users';

cypress/pages/modals/credentials-modal.ts

@@ -6,13 +6,15 @@ export class CredentialsModal extends BasePage {
 		newCredentialTypeSelect: () => cy.getByTestId('new-credential-type-select'),
 		newCredentialTypeOption: (credentialType: string) => cy.getByTestId('new-credential-type-select-option').contains(credentialType),
 		newCredentialTypeButton: () => cy.getByTestId('new-credential-type-button'),
+		editCredentialModal: () => cy.getByTestId('editCredential-modal', { timeout: 5000 }),
 		connectionParameters: () => cy.getByTestId('credential-connection-parameter'),
 		connectionParameter: (fieldName: string) => this.getters.connectionParameters().contains(fieldName)
 			.parents('[data-test-id="credential-connection-parameter"]')
 			.find('.n8n-input input'),
 		name: () => cy.getByTestId('credential-name'),
 		nameInput: () => cy.getByTestId('credential-name').find('input'),
-		saveButton: () => cy.getByTestId('credential-save-button')
+		saveButton: () => cy.getByTestId('credential-save-button'),
+		closeButton: () => this.getters.editCredentialModal().find('.el-dialog__close'),
 	};
 	actions = {
 		setName: (name: string) => {
@@ -21,6 +23,9 @@ export class CredentialsModal extends BasePage {
 		},
 		save: () => {
 			this.getters.saveButton().click();
-		}
+		},
+		close: () => {
+			this.getters.closeButton().click();
+		},
 	};
 }

cypress/pages/modals/index.ts

@@ -1 +1,2 @@
 export * from './credentials-modal';
+export * from './message-box';

cypress/pages/modals/message-box.ts

@@ -4,6 +4,7 @@ export class MessageBox extends BasePage {
 	getters = {
 		modal: () => cy.get('.el-message-box', { withinSubject: null }),
 		header: () => this.getters.modal().find('.el-message-box__title'),
+		content: () => this.getters.modal().find('.el-message-box__content'),
 		confirm: () => this.getters.modal().find('.btn--confirm'),
 		cancel: () => this.getters.modal().find('.btn--cancel'),
 	};

cypress/pages/settings-users.ts

@@ -0,0 +1,11 @@
+import { BasePage } from "./base";
+
+export class SettingsUsersPage extends BasePage {
+	url = '/settings/users';
+	getters = {
+		setUpOwnerButton: () => cy.getByTestId('action-box').find('button'),
+	}
+	actions = {
+		goToOwnerSetup: () => this.getters.setUpOwnerButton().click(),
+	}
+}

cypress/pages/sidebar/index.ts

@@ -0,0 +1,2 @@
+export * from './main-sidebar';
+export * from './settings-sidebar';

cypress/pages/sidebar/main-sidebar.ts

@@ -0,0 +1,15 @@
+import { BasePage } from "../base";
+
+export class MainSidebar extends BasePage {
+	getters = {
+		settings: () => cy.getByTestId('menuitem-settings', { timeout: 5000 }),
+		templates: () => cy.getByTestId('menuitem-templates'),
+		workflows: () => cy.getByTestId('menuitem-workflows'),
+		credentials: () => cy.getByTestId('menuitem-credentials'),
+		executions: () => cy.getByTestId('menuitem-executions'),
+	};
+	actions = {
+		goToSettings: () => this.getters.settings().click(),
+		goToCredentials: () => this.getters.credentials().click(),
+	};
+}

cypress/pages/sidebar/settings-sidebar.ts

@@ -0,0 +1,14 @@
+import { BasePage } from "../base";
+
+export class SettingsSidebar extends BasePage {
+	getters = {
+		personal: () => cy.getByTestId('menuitem-settings-personal'),
+		users: () => cy.getByTestId('menuitem-settings-users'),
+		api: () => cy.getByTestId('menuitem-settings-api'),
+		communityNodes: () => cy.getByTestId('menuitem-settings-community-nodes'),
+		back: () => cy.getByTestId('settings-back'),
+	};
+	actions = {
+		back: () => this.getters.back().click(),
+	};
+}

cypress/pages/workflow.ts

@@ -3,7 +3,7 @@ import { BasePage } from "./base";
 export class WorkflowPage extends BasePage {
 	url = '/workflow/new';
 	getters = {
-		workflowNameInput: () => cy.getByTestId('workflow-name-input').then($el => cy.wrap($el.find('input'))),
+		workflowNameInput: () => cy.getByTestId('workflow-name-input', { timeout: 5000 }).then($el => cy.wrap($el.find('input'))),
 		workflowImportInput: () => cy.getByTestId('workflow-import-input'),
 		workflowTags: () => cy.getByTestId('workflow-tags'),
 		saveButton: () => cy.getByTestId('save-button'),

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",

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<T>(fn: (entityManager: EntityManager) => Promise<T>): Promise<T> {
 	return connection.transaction(fn);

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,