From a620b147dd97c967432ecca3c248fe36162cf749 Mon Sep 17 00:00:00 2001 From: Mitch-Budibase Date: Mon, 10 Oct 2022 15:39:02 +0100 Subject: [PATCH 1/4] 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) + }) +}) From 44c9ef15685d4ded7021d22a6b362bfa6873718b Mon Sep 17 00:00:00 2001 From: Mitch-Budibase Date: Mon, 10 Oct 2022 17:27:55 +0100 Subject: [PATCH 2/4] API Screens - Fetch screens test Additional test to fetch screens. - To confirm the screen was created i am checking `routes` - It will then confirm the route with the screen exists - in this case the route is `/test` (as determined when the screen is created) --- .../TestConfiguration/applications.ts | 6 ++++++ .../tests/internal-api/screens/screens.spec.ts | 16 ++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/qa-core/src/config/internal-api/TestConfiguration/applications.ts b/qa-core/src/config/internal-api/TestConfiguration/applications.ts index 0c51487122..d457e0c1b6 100644 --- a/qa-core/src/config/internal-api/TestConfiguration/applications.ts +++ b/qa-core/src/config/internal-api/TestConfiguration/applications.ts @@ -46,4 +46,10 @@ export default class AppApi { const json = await response.json() return [response, json.data] } + + async getRoutes(): Promise<[Response, any]> { + const response = await this.api.get(`/routing`) + const json = await response.json() + return [response, json] + } } diff --git a/qa-core/src/tests/internal-api/screens/screens.spec.ts b/qa-core/src/tests/internal-api/screens/screens.spec.ts index e43c241f7c..8774d48007 100644 --- a/qa-core/src/tests/internal-api/screens/screens.spec.ts +++ b/qa-core/src/tests/internal-api/screens/screens.spec.ts @@ -30,7 +30,23 @@ describe("Internal API - /screens endpoints", () => { const [response, screen] = await config.screen.createScreen(generateScreen()) expect(response).toHaveStatusCode(200) expect(screen.routing.roleId).toEqual("BASIC") + }) + it("GET - Fetch screens", 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) + + // Check screen exists + const [routesResponse, routes] = await appConfig.applications.getRoutes() + expect(routesResponse).toHaveStatusCode(200) + expect(routes.routes["/test"]).toBeTruthy() }) it("DELETE - Delete a screen", async () => { From 013d29475f4201f224ae860a15a94932ee913714 Mon Sep 17 00:00:00 2001 From: Mitch-Budibase Date: Mon, 10 Oct 2022 17:44:19 +0100 Subject: [PATCH 3/4] API Screens - Updating create screen test The create screen tests will now create a screen with each available role type - The types are: BASIC, POWER, ADMIN, PUBLIC --- .../src/config/internal-api/fixtures/screens.ts | 4 ++-- .../tests/internal-api/screens/screens.spec.ts | 15 +++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/qa-core/src/config/internal-api/fixtures/screens.ts b/qa-core/src/config/internal-api/fixtures/screens.ts index afd4faacad..1ebc1eb5c8 100644 --- a/qa-core/src/config/internal-api/fixtures/screens.ts +++ b/qa-core/src/config/internal-api/fixtures/screens.ts @@ -2,7 +2,7 @@ import generator from "../../generator" const randomId = generator.guid() -const generateScreen = (): any => ({ +const generateScreen = (roleId: string): any => ({ showNavigation: true, width: "Large", name: randomId, @@ -26,7 +26,7 @@ const generateScreen = (): any => ({ gap: "M" }, routing: { route: "/test", - roleId: "BASIC", + roleId: roleId, homeScreen: false }, }) diff --git a/qa-core/src/tests/internal-api/screens/screens.spec.ts b/qa-core/src/tests/internal-api/screens/screens.spec.ts index 8774d48007..4d2c17177f 100644 --- a/qa-core/src/tests/internal-api/screens/screens.spec.ts +++ b/qa-core/src/tests/internal-api/screens/screens.spec.ts @@ -19,17 +19,20 @@ describe("Internal API - /screens endpoints", () => { await config.afterAll() }) - it("POST - Create a BASIC screen", async () => { + it("POST - Create a screen with each role type", async () => { // Create app const [appResponse, app] = await appConfig.applications.create(generateApp()) expect(appResponse).toHaveStatusCode(200) expect(app._id).toBeDefined() // Create Screen + const roleArray = ["BASIC", "POWER", "ADMIN", "PUBLIC"] appConfig.applications.api.appId = app.appId - const [response, screen] = await config.screen.createScreen(generateScreen()) - expect(response).toHaveStatusCode(200) - expect(screen.routing.roleId).toEqual("BASIC") + for (let i = 0; i < 4; i++) { + const [response, screen] = await config.screen.createScreen(generateScreen(roleArray[i])) + expect(response).toHaveStatusCode(200) + expect(screen.routing.roleId).toEqual(roleArray[i]) + } }) it("GET - Fetch screens", async () => { @@ -40,7 +43,7 @@ describe("Internal API - /screens endpoints", () => { // Create Screen appConfig.applications.api.appId = app.appId - const [response, screen] = await config.screen.createScreen(generateScreen()) + const [response, screen] = await config.screen.createScreen(generateScreen("BASIC")) expect(response).toHaveStatusCode(200) // Check screen exists @@ -57,7 +60,7 @@ describe("Internal API - /screens endpoints", () => { // Create Screen appConfig.applications.api.appId = app.appId - const [screenResponse, screen] = await config.screen.createScreen(generateScreen()) + const [screenResponse, screen] = await config.screen.createScreen(generateScreen("BASIC")) expect(screenResponse).toHaveStatusCode(200) expect(screen._id).toBeDefined() From 25f9a2043b4bc00ef205cca4d04e4ccf0ad7402e Mon Sep 17 00:00:00 2001 From: Mitch-Budibase Date: Wed, 12 Oct 2022 17:48:33 +0100 Subject: [PATCH 4/4] Small changes based on PR feedback As per some of the comments on the PR: - Renaming createScreen & deleteScreen to create & delete as they are on the screens namespace - Updating a test within create.spec.js (applications) for when a screen is generated - Improvements to the current screens tests (removing unnecessary `expect` lines & updating the for loop for the create screens test) --- .../internal-api/TestConfiguration/screens.ts | 4 ++-- .../internal-api/applications/create.spec.ts | 2 +- .../internal-api/screens/screens.spec.ts | 21 ++++++------------- 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/qa-core/src/config/internal-api/TestConfiguration/screens.ts b/qa-core/src/config/internal-api/TestConfiguration/screens.ts index 1b97d7f6bf..30c688022a 100644 --- a/qa-core/src/config/internal-api/TestConfiguration/screens.ts +++ b/qa-core/src/config/internal-api/TestConfiguration/screens.ts @@ -9,13 +9,13 @@ import InternalAPIClient from "./InternalAPIClient" this.api = apiClient } - async createScreen(body: any): Promise<[Response, Screen]> { + async create(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]> { + async delete(screenId: string, rev: string): 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/tests/internal-api/applications/create.spec.ts b/qa-core/src/tests/internal-api/applications/create.spec.ts index c09af632de..aa71724cac 100644 --- a/qa-core/src/tests/internal-api/applications/create.spec.ts +++ b/qa-core/src/tests/internal-api/applications/create.spec.ts @@ -164,7 +164,7 @@ describe("Internal API - /applications endpoints", () => { // Change/add component to the app const [screenResponse, screen] = await config.applications.addScreentoApp( - generateScreen() + generateScreen("BASIC") ) expect(screenResponse).toHaveStatusCode(200) expect(screen._id).toBeDefined() diff --git a/qa-core/src/tests/internal-api/screens/screens.spec.ts b/qa-core/src/tests/internal-api/screens/screens.spec.ts index 4d2c17177f..68e1022cb4 100644 --- a/qa-core/src/tests/internal-api/screens/screens.spec.ts +++ b/qa-core/src/tests/internal-api/screens/screens.spec.ts @@ -22,29 +22,24 @@ describe("Internal API - /screens endpoints", () => { it("POST - Create a screen with each role type", async () => { // Create app const [appResponse, app] = await appConfig.applications.create(generateApp()) - expect(appResponse).toHaveStatusCode(200) - expect(app._id).toBeDefined() // Create Screen const roleArray = ["BASIC", "POWER", "ADMIN", "PUBLIC"] appConfig.applications.api.appId = app.appId - for (let i = 0; i < 4; i++) { - const [response, screen] = await config.screen.createScreen(generateScreen(roleArray[i])) + for (let role in roleArray) { + const [response, screen] = await config.screen.create(generateScreen(roleArray[role])) expect(response).toHaveStatusCode(200) - expect(screen.routing.roleId).toEqual(roleArray[i]) + expect(screen.routing.roleId).toEqual(roleArray[role]) } }) it("GET - Fetch screens", 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("BASIC")) - expect(response).toHaveStatusCode(200) + const [response, screen] = await config.screen.create(generateScreen("BASIC")) // Check screen exists const [routesResponse, routes] = await appConfig.applications.getRoutes() @@ -55,17 +50,13 @@ describe("Internal API - /screens endpoints", () => { 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("BASIC")) - expect(screenResponse).toHaveStatusCode(200) - expect(screen._id).toBeDefined() + const [screenResponse, screen] = await config.screen.create(generateScreen("BASIC")) // Delete Screen - const [response] = await config.screen.deleteScreen(screen._id, screen._rev) + const [response] = await config.screen.delete(screen._id!, screen._rev!) expect(response).toHaveStatusCode(200) }) })