From 43eab991f1f9bbe8ff0de835ea968b7b1e16b8f8 Mon Sep 17 00:00:00 2001 From: Mitch-Budibase Date: Mon, 10 Oct 2022 15:39:02 +0100 Subject: [PATCH] API: Screens - Add and Delete Screen Screens API tests - This includes adding a basic screen and deleting a screen --- .../internal-api/TestConfiguration/index.ts | 3 ++ .../internal-api/TestConfiguration/screens.ts | 23 ++++++++ .../config/internal-api/fixtures/screens.ts | 34 ++++++++++++ .../internal-api/screens/screens.spec.ts | 52 +++++++++++++++++++ 4 files changed, 112 insertions(+) create mode 100644 qa-core/src/config/internal-api/TestConfiguration/screens.ts create mode 100644 qa-core/src/config/internal-api/fixtures/screens.ts create mode 100644 qa-core/src/tests/internal-api/screens/screens.spec.ts diff --git a/qa-core/src/config/internal-api/TestConfiguration/index.ts b/qa-core/src/config/internal-api/TestConfiguration/index.ts index b433fd98ea..d90c315849 100644 --- a/qa-core/src/config/internal-api/TestConfiguration/index.ts +++ b/qa-core/src/config/internal-api/TestConfiguration/index.ts @@ -1,15 +1,18 @@ import ApplicationApi from "./applications" import AuthApi from "./auth" import InternalAPIClient from "./InternalAPIClient" +import ScreenApi from "./screens" export default class TestConfiguration { applications: ApplicationApi auth: AuthApi + screen: ScreenApi context: T constructor(apiClient: InternalAPIClient) { this.applications = new ApplicationApi(apiClient) this.auth = new AuthApi(apiClient) + this.screen = new ScreenApi(apiClient) this.context = {} } diff --git a/qa-core/src/config/internal-api/TestConfiguration/screens.ts b/qa-core/src/config/internal-api/TestConfiguration/screens.ts new file mode 100644 index 0000000000..1b97d7f6bf --- /dev/null +++ b/qa-core/src/config/internal-api/TestConfiguration/screens.ts @@ -0,0 +1,23 @@ +import { Screen } from "@budibase/types" +import { Response } from "node-fetch" +import InternalAPIClient from "./InternalAPIClient" + + export default class ScreenApi { + api: InternalAPIClient + + constructor(apiClient: InternalAPIClient) { + this.api = apiClient + } + + async createScreen(body: any): Promise<[Response, Screen]> { + const response = await this.api.post(`/screens`, { body }) + const json = await response.json() + return [response, json] + } + + async deleteScreen(screenId: any, rev: any): Promise<[Response, Screen]> { + const response = await this.api.del(`/screens/${screenId}/${rev}`) + const json = await response.json() + return [response, json] + } + } diff --git a/qa-core/src/config/internal-api/fixtures/screens.ts b/qa-core/src/config/internal-api/fixtures/screens.ts new file mode 100644 index 0000000000..afd4faacad --- /dev/null +++ b/qa-core/src/config/internal-api/fixtures/screens.ts @@ -0,0 +1,34 @@ +import generator from "../../generator" + +const randomId = generator.guid() + +const generateScreen = (): any => ({ + showNavigation: true, + width: "Large", + name: randomId, + template: "createFromScratch", + props: { + _id: randomId, + _component: + "@budibase/standard-components/container", + _styles: { + normal: {}, + hover: {}, + active: {}, + selected: {} + }, + _children: [], + _instanceName: "New Screen", + direction: "column", + hAlign: "stretch", + vAlign: "top", + size: "grow", + gap: "M" + }, routing: { + route: "/test", + roleId: "BASIC", + homeScreen: false + }, +}) + +export default generateScreen diff --git a/qa-core/src/tests/internal-api/screens/screens.spec.ts b/qa-core/src/tests/internal-api/screens/screens.spec.ts new file mode 100644 index 0000000000..e43c241f7c --- /dev/null +++ b/qa-core/src/tests/internal-api/screens/screens.spec.ts @@ -0,0 +1,52 @@ +import TestConfiguration from "../../../config/internal-api/TestConfiguration" +import { App } from "@budibase/types" +import InternalAPIClient from "../../../config/internal-api/TestConfiguration/InternalAPIClient" +import generateApp from "../../../config/internal-api/fixtures/applications" +import { Screen } from "@budibase/types" +import generateScreen from "../../../config/internal-api/fixtures/screens" + + +describe("Internal API - /screens endpoints", () => { + const api = new InternalAPIClient() + const config = new TestConfiguration(api) + const appConfig = new TestConfiguration(api) + + beforeAll(async () => { + await config.beforeAll() + }) + + afterAll(async () => { + await config.afterAll() + }) + + it("POST - Create a BASIC screen", async () => { + // Create app + const [appResponse, app] = await appConfig.applications.create(generateApp()) + expect(appResponse).toHaveStatusCode(200) + expect(app._id).toBeDefined() + + // Create Screen + appConfig.applications.api.appId = app.appId + const [response, screen] = await config.screen.createScreen(generateScreen()) + expect(response).toHaveStatusCode(200) + expect(screen.routing.roleId).toEqual("BASIC") + + }) + + it("DELETE - Delete a screen", async () => { + // Create app + const [appResponse, app] = await appConfig.applications.create(generateApp()) + expect(appResponse).toHaveStatusCode(200) + expect(app._id).toBeDefined() + + // Create Screen + appConfig.applications.api.appId = app.appId + const [screenResponse, screen] = await config.screen.createScreen(generateScreen()) + expect(screenResponse).toHaveStatusCode(200) + expect(screen._id).toBeDefined() + + // Delete Screen + const [response] = await config.screen.deleteScreen(screen._id, screen._rev) + expect(response).toHaveStatusCode(200) + }) +})