Merge pull request #93 from aquality-automation/feature/public_api_tests

Feature/public api tests

Author: VladislavKostyukevich

e2e/api/base.api.ts

@@ -0,0 +1,25 @@
+import { Project } from '../../src/app/shared/models/project';
+import { ATError } from '../../src/app/shared/models/error';
+import { ApiAssertMessages } from '../specs/api/api.constants';
+
+export class BaseAPI {
+    project: Project;
+    token: string;
+
+    constructor(project: Project, token: string) {
+        this.project = project;
+        this.token = token;
+    }
+
+    public async assertNegativeresponse(promise: Promise<object>, expectedError: string): Promise<void> {
+        let atError: ATError;
+        try {
+            await promise;
+        } catch (error) {
+            atError = error;
+        }
+
+        expect(atError).toBeDefined(ApiAssertMessages.errorNotRaised);
+        expect(atError.message).toBe(expectedError, ApiAssertMessages.errorIsWrong);
+    }
+}

e2e/api/editor.api.ts

@@ -5,7 +5,7 @@ import { TestRun } from '../../src/app/shared/models/testRun';
 import { Milestone } from '../../src/app/shared/models/milestone';
 import { sendPost, sendGet, sendDelete } from '../utils/aqualityTrackingAPI.util';
 import { TestResult } from '../../src/app/shared/models/test-result';
-import { Project } from '../../src/app/shared/models/project';
+import { BaseAPI } from './base.api';
 
 enum Endpoints {
     suite = '/suite',
@@ -18,14 +18,7 @@ enum Endpoints {
     testToSuite = '/testToSuite'
 }
 
-export class EditorAPI {
-    project: Project;
-    token: string;
-
-    constructor(project: Project, token: string) {
-        this.project = project;
-        this.token = token;
-    }
+export class EditorAPI extends BaseAPI {
 
     public async createSuite(suite: TestSuite): Promise<TestSuite> {
         suite.project_id = this.project.id;

e2e/api/importer.api.ts

@@ -3,6 +3,7 @@ import { logger } from '../utils/log.util';
 import { Project } from '../../src/app/shared/models/project';
 import { EditorAPI } from './editor.api';
 import { TestRun } from '../../src/app/shared/models/testRun';
+import { BaseAPI } from './base.api';
 
 export class ImportParams {
     projectId?: number;
@@ -20,14 +21,11 @@ export enum ImportFormats {
 
 const CHECK_IMPORTED_DELAY = 2000;
 
-export class Importer {
-    project: Project;
-    token: string;
+export class Importer extends BaseAPI {
     editorAPI: EditorAPI;
 
     constructor(project: Project, token: string) {
-        this.project = project;
-        this.token = token;
+        super(project, token);
         this.editorAPI = new EditorAPI(this.project, this.token);
     }
 

e2e/api/public.api.ts

@@ -0,0 +1,43 @@
+import { TestSuite } from '../../src/app/shared/models/testSuite';
+import { Test } from '../../src/app/shared/models/test';
+import { TestRun } from '../../src/app/shared/models/testRun';
+import { sendPost, sendGet } from '../utils/aqualityTrackingAPI.util';
+import { TestResult } from '../../src/app/shared/models/test-result';
+import { Project } from '../../src/app/shared/models/project';
+import { BaseAPI } from './base.api';
+
+enum Endpoints {
+    suite_create_or_update = '/public/suite/create-or-update',
+    testrun_start = '/public/testrun/start',
+    testrun_finish = '/public/testrun/finish',
+    test_result_start = '/public/test/result/start',
+    test_result_finish = '/public/test/result/finish',
+    test_create_or_update = '/public/test/create-or-update'
+}
+
+export class PublicAPI extends BaseAPI {
+
+    public createOrUpdateSuite(suite: TestSuite): Promise<TestSuite> {
+        return sendPost(Endpoints.suite_create_or_update, undefined, suite, this.token, this.project.id);
+    }
+
+    public createOrUpdateTest(test: Test): Promise<Test> {
+        return sendPost(Endpoints.test_create_or_update, undefined, test, this.token, this.project.id);
+    }
+
+    public startTestrun(testrun: TestRun): Promise<TestRun> {
+        return sendPost(Endpoints.testrun_start, undefined, testrun, this.token, this.project.id);
+    }
+
+    public finishTestRun(project_id: number, id: number) {
+        return sendGet(Endpoints.testrun_finish, { project_id, id }, this.token, this.project.id);
+    }
+
+    public testResultStart(test_id: number, test_run_id: number, project_id: number) {
+        return sendGet(Endpoints.test_result_start, { test_id, test_run_id, project_id }, this.token, this.project.id);
+    }
+
+    public testResultFinish(testResult: TestResult): Promise<TestResult> {
+        return sendPost(Endpoints.test_result_finish, undefined, testResult, this.token, this.project.id);
+    }
+}

e2e/helpers/project.helper.ts

@@ -12,6 +12,7 @@ import { Importer } from '../api/importer.api';
 import { EditorAPI } from '../api/editor.api';
 import projects from '../data/projects.json';
 import usersTestData from '../data/users.json';
+import { PublicAPI } from '../api/public.api';
 
 
 export enum PermissionType {
@@ -28,6 +29,7 @@ export class ProjectHelper {
     public project: Project = projects.customerOnly;
     public importer: Importer;
     public editorAPI: EditorAPI;
+    public publicAPI: PublicAPI;
     private admin = usersTestData.admin;
 
     constructor(name?: string) {
@@ -52,6 +54,7 @@ export class ProjectHelper {
 
             this.importer = new Importer(this.project, token);
             this.editorAPI = new EditorAPI(this.project, token);
+            this.publicAPI = new PublicAPI(this.project, token);
             return projectView.menuBar.clickLogOut();
         } catch (err) {
             logger.error(err.message);

e2e/specs/api/api.constants.ts

@@ -0,0 +1,42 @@
+export enum ApiAssertMessages {
+    errorNotRaised = 'Error was not raised!',
+    errorIsWrong = 'Error message is wrong!',
+    idMissed = 'id is missed!',
+    nameWrong = 'name is wrong!',
+    projecIdWrong = 'project_id is wrong!',
+    suiteMissed = 'suite is missed!',
+    idWrong = 'id is wrong!',
+    startTimeMissed = 'start_time is missed!',
+    startTimeWrong = 'start_time is wrong!',
+    finishTimeWrong = 'finish_time is wrong!',
+    startDateMissed = 'start_date is missed!',
+    finalResultIdWrong = 'final_result_id is wrong!',
+    testIdWrong = 'test_id is wrong!',
+}
+
+class ApiResponseErrors {
+    public missedId = `You should specify 'id'!`;
+    public missedIdOrName = `You should specify 'id' or/and 'name' suite parameters!`;
+    public missedProjectId = `You should specify 'project_id'!`;
+    public missedBuildName = `You should specify 'build_name'!`;
+    public missedSuiteId = `You should specify 'test_suite_id'`;
+    public missedTestId = `You should specify 'test_id'`;
+    public missedTestRunId = `You should specify 'test_run_id'`;
+    public missedFinalResultId = `You should specify 'final_result_id' - Failed: 1, Passed: 2, Not Executed: 3, Pending: 5.`;
+    // tslint:disable-next-line: quotemark
+    public missedSuites = "You should specify 'suites' array with single suite like `[{id: test_suite_id}]`";
+    public anonymousNotAllowedToViewTestSuites = this.anonymousNotAllowedToView('Test Suites');
+    public anonymousNotAllowedToViewTests = this.anonymousNotAllowedToView('Tests');
+    public anonymousNotAllowedToViewTestResults = this.anonymousNotAllowedToView('Test Results');
+    public anonymousNotAllowedToCreateTestRun = this.anonymousNotAllowedToCreate('Test Run');
+    public entityWithIdDoesNotExist = (id: number) => `Entity with specified '${id}' id does not exist!`;
+
+    private anonymousNotAllowedToView(entity: string) {
+        return `[Permissions anonymous]: Account is not allowed to view ${entity}`;
+    }
+
+    private anonymousNotAllowedToCreate(entity: string) {
+        return `[Permissions anonymous]: Account is not allowed to create ${entity}`;
+    }
+}
+export const apiResponseErrors = new ApiResponseErrors();

e2e/specs/api/publicApi.spec.ts renamed to e2e/specs/api/application.api.spec.ts

@@ -6,7 +6,7 @@ import { TestRun } from '../../../src/app/shared/models/testRun';
 import { Test } from '../../../src/app/shared/models/test';
 import { TestResult } from '../../../src/app/shared/models/test-result';
 
-describe('Public API tests', () => {
+describe('Application API:', () => {
   const projectHelper: ProjectHelper = new ProjectHelper();
   const builds = { build_1: 'Build_1' };
   let suite: TestSuite = suites.suiteCreation;