import type { User } from '@n8n/db'; import { ProjectRepository } from '@n8n/db'; import { TestRunRepository } from '@n8n/db'; import { Container } from '@n8n/di'; import { mockInstance } from 'n8n-core/test/utils'; import type { IWorkflowBase } from 'n8n-workflow'; import { TestRunnerService } from '@/evaluation.ee/test-runner/test-runner.service.ee'; import { createUserShell } from '@test-integration/db/users'; import { createWorkflow } from '@test-integration/db/workflows'; import * as testDb from '@test-integration/test-db'; import type { SuperAgentTest } from '@test-integration/types'; import * as utils from '@test-integration/utils'; let authOwnerAgent: SuperAgentTest; let workflowUnderTest: IWorkflowBase; let otherWorkflow: IWorkflowBase; let ownerShell: User; const testRunner = mockInstance(TestRunnerService); const testServer = utils.setupTestServer({ endpointGroups: ['workflows', 'evaluation'], enabledFeatures: ['feat:sharing', 'feat:multipleMainInstances'], }); beforeAll(async () => { ownerShell = await createUserShell('global:owner'); authOwnerAgent = testServer.authAgentFor(ownerShell); }); beforeEach(async () => { await testDb.truncate(['TestRun', 'WorkflowEntity', 'SharedWorkflow']); workflowUnderTest = await createWorkflow({ name: 'workflow-under-test' }, ownerShell); otherWorkflow = await createWorkflow({ name: 'other-workflow' }); }); describe('GET /workflows/:workflowId/test-runs', () => { test('should retrieve empty list of test runs', async () => { const resp = await authOwnerAgent.get(`/workflows/${workflowUnderTest.id}/test-runs`); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual([]); }); // TODO: replace with non existent workflow // test('should return 404 if test definition does not exist', async () => { // const resp = await authOwnerAgent.get('/evaluation/test-definitions/123/runs'); // // expect(resp.statusCode).toBe(404); // }); // TODO: replace with workflow that is not accessible to the user // test('should return 404 if user does not have access to test definition', async () => { // const resp = await authOwnerAgent.get( // `/evaluation/test-definitions/${otherTestDefinition.id}/runs`, // ); // // expect(resp.statusCode).toBe(404); // }); test('should retrieve list of runs for a workflow', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(workflowUnderTest.id); const resp = await authOwnerAgent.get(`/workflows/${workflowUnderTest.id}/test-runs`); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual([ expect.objectContaining({ id: testRun.id, status: 'new', runAt: null, completedAt: null, }), ]); }); test('should retrieve list of test runs for a workflow with pagination', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun1 = await testRunRepository.createTestRun(workflowUnderTest.id); // Mark as running just to make a slight delay between the runs await testRunRepository.markAsRunning(testRun1.id); const testRun2 = await testRunRepository.createTestRun(workflowUnderTest.id); // Fetch the first page const resp = await authOwnerAgent.get(`/workflows/${workflowUnderTest.id}/test-runs?take=1`); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual([ expect.objectContaining({ id: testRun2.id, status: 'new', runAt: null, completedAt: null, }), ]); // Fetch the second page const resp2 = await authOwnerAgent.get( `/workflows/${workflowUnderTest.id}/test-runs?take=1&skip=1`, ); expect(resp2.statusCode).toBe(200); expect(resp2.body.data).toEqual([ expect.objectContaining({ id: testRun1.id, status: 'running', runAt: expect.any(String), completedAt: null, }), ]); }); }); describe('GET /workflows/:workflowId/test-runs/:id', () => { test('should retrieve specific test run for a workflow', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(workflowUnderTest.id); const resp = await authOwnerAgent.get( `/workflows/${workflowUnderTest.id}/test-runs/${testRun.id}`, ); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual( expect.objectContaining({ id: testRun.id, status: 'new', runAt: null, completedAt: null, }), ); }); test('should return 404 if test run does not exist', async () => { const resp = await authOwnerAgent.get(`/workflows/${workflowUnderTest.id}/test-runs/123`); expect(resp.statusCode).toBe(404); }); test('should return 404 if user does not have access to the workflow', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(otherWorkflow.id); const resp = await authOwnerAgent.get(`/workflows/${otherWorkflow.id}/test-runs/${testRun.id}`); expect(resp.statusCode).toBe(404); }); test('should retrieve test run of a shared workflow', async () => { const memberShell = await createUserShell('global:member'); const memberAgent = testServer.authAgentFor(memberShell); const memberPersonalProject = await Container.get( ProjectRepository, ).getPersonalProjectForUserOrFail(memberShell.id); // Share workflow with a member const sharingResponse = await authOwnerAgent .put(`/workflows/${workflowUnderTest.id}/share`) .send({ shareWithIds: [memberPersonalProject.id] }); expect(sharingResponse.statusCode).toBe(200); // Create a test run for the shared workflow const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(workflowUnderTest.id); // Check if member can retrieve the test run of a shared workflow const resp = await memberAgent.get( `/workflows/${workflowUnderTest.id}/test-runs/${testRun.id}`, ); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual( expect.objectContaining({ id: testRun.id, }), ); }); }); describe('DELETE /evaluation/test-definitions/:testDefinitionId/runs/:id', () => { test('should delete test run for a test definition', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(workflowUnderTest.id); const resp = await authOwnerAgent.delete( `/workflows/${workflowUnderTest.id}/test-runs/${testRun.id}`, ); expect(resp.statusCode).toBe(200); expect(resp.body.data).toEqual({ success: true }); const testRunAfterDelete = await testRunRepository.findOne({ where: { id: testRun.id } }); expect(testRunAfterDelete).toBeNull(); }); test('should return 404 if test run does not exist', async () => { const resp = await authOwnerAgent.delete(`/workflows/${workflowUnderTest.id}/test-runs/123`); expect(resp.statusCode).toBe(404); }); test('should return 404 if user does not have access to test definition', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(otherWorkflow.id); const resp = await authOwnerAgent.delete( `/workflows/${otherWorkflow.id}/test-runs/${testRun.id}`, ); expect(resp.statusCode).toBe(404); }); }); describe('POST /evaluation/test-definitions/:testDefinitionId/runs/:id/cancel', () => { test('should cancel test run', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(workflowUnderTest.id); jest.spyOn(testRunRepository, 'markAsCancelled'); const resp = await authOwnerAgent.post( `/workflows/${workflowUnderTest.id}/test-runs/${testRun.id}/cancel`, ); expect(resp.statusCode).toBe(202); expect(resp.body).toEqual({ success: true }); expect(testRunner.cancelTestRun).toHaveBeenCalledWith(testRun.id); }); test('should return 404 if test run does not exist', async () => { const resp = await authOwnerAgent.post( `/workflows/${workflowUnderTest.id}/test-runs/123/cancel`, ); expect(resp.statusCode).toBe(404); }); test('should return 404 if workflow does not exist', async () => { const resp = await authOwnerAgent.post('/workflows/123/test-runs/123/cancel'); expect(resp.statusCode).toBe(404); }); test('should return 404 if user does not have access to the workflow', async () => { const testRunRepository = Container.get(TestRunRepository); const testRun = await testRunRepository.createTestRun(otherWorkflow.id); const resp = await authOwnerAgent.post( `/workflows/${otherWorkflow.id}/test-runs/${testRun.id}/cancel`, ); expect(resp.statusCode).toBe(404); }); });