@budibase/server 2.3.17 → 2.3.18-alpha.0

package/src/api/routes/public/tests/utils.ts

@@ -1,13 +1,27 @@
+import * as setup from "../../tests/utilities"
 import { checkSlashesInUrl } from "../../../../utilities"
+import supertest from "supertest"
 
-export function generateMakeRequest(apiKey: string, setup: any) {
-  const request = setup.getRequest()
-  const config = setup.getConfig()
+export type HttpMethod = "post" | "get" | "put" | "delete" | "patch"
+
+export type MakeRequestResponse = (
+  method: HttpMethod,
+  endpoint: string,
+  body?: any,
+  intAppId?: string
+) => Promise<supertest.Response>
+
+export function generateMakeRequest(
+  apiKey: string,
+  isInternal = false
+): MakeRequestResponse {
+  const request = setup.getRequest()!
+  const config = setup.getConfig()!
   return async (
-    method: string,
+    method: HttpMethod,
     endpoint: string,
     body?: any,
-    intAppId: string = config.getAppId()
+    intAppId: string | null = config.getAppId()
   ) => {
     const extraHeaders: any = {
       "x-budibase-api-key": apiKey,
@@ -15,9 +29,12 @@ export function generateMakeRequest(apiKey: string, setup: any) {
     if (intAppId) {
       extraHeaders["x-budibase-app-id"] = intAppId
     }
-    const req = request[method](
-      checkSlashesInUrl(`/api/public/v1/${endpoint}`)
-    ).set(config.defaultHeaders(extraHeaders))
+
+    const url = isInternal
+      ? endpoint
+      : checkSlashesInUrl(`/api/public/v1/${endpoint}`)
+
+    const req = request[method](url).set(config.defaultHeaders(extraHeaders))
     if (body) {
       req.send(body)
     }

package/src/api/routes/tests/__snapshots__/datasource.spec.ts.snap

@@ -7,7 +7,7 @@ Array [
     "entities": Array [
       Object {
         "_id": "ta_users",
-        "_rev": "1-6f4013e796887f1771bf7837598d87e7",
+        "_rev": "1-2375e1bc58aeec664dc1b1f04ad43e44",
         "createdAt": "2020-01-01T00:00:00.000Z",
         "name": "Users",
         "primaryDisplay": "email",

package/src/api/routes/tests/analytics.spec.js

@@ -10,8 +10,11 @@ describe("/static", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     app = await config.init()
+  })
+  
+  beforeEach(()=>{
     jest.clearAllMocks()
   })
 

package/src/api/routes/tests/apikeys.spec.js

@@ -7,7 +7,7 @@ describe("/api/keys", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 

package/src/api/routes/tests/application.spec.ts

@@ -14,18 +14,22 @@ jest.mock("../../../utilities/redis", () => ({
 import { clearAllApps, checkBuilderEndpoint } from "./utilities/TestFunctions"
 import * as setup from "./utilities"
 import { AppStatus } from "../../../db/utils"
-import { events } from "@budibase/backend-core"
+import { events, utils } from "@budibase/backend-core"
 import env from "../../../environment"
 
+jest.setTimeout(15000)
+
 describe("/applications", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
-    await clearAllApps()
+  beforeAll(async () => {
     await config.init()
+  })
+
+  beforeEach(async () => {
     jest.clearAllMocks()
   })
 
@@ -33,7 +37,7 @@ describe("/applications", () => {
     it("creates empty app", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
@@ -44,7 +48,7 @@ describe("/applications", () => {
     it("creates app from template", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .field("useTemplate", "true")
         .field("templateKey", "test")
         .field("templateString", "{}") // override the file download
@@ -59,7 +63,7 @@ describe("/applications", () => {
     it("creates app from file", async () => {
       const res = await request
         .post("/api/applications")
-        .field("name", "My App")
+        .field("name", utils.newid())
         .field("useTemplate", "true")
         .set(config.defaultHeaders())
         .attach("templateFile", "src/api/routes/tests/data/export.txt")
@@ -106,6 +110,11 @@ describe("/applications", () => {
   })
 
   describe("fetch", () => {
+    beforeEach(async () => {
+      // Clean all apps but the onde from config
+      await clearAllApps(config.getTenantId(), [config.getAppId()!])
+    })
+
     it("lists all applications", async () => {
       await config.createApp("app1")
       await config.createApp("app2")
@@ -266,6 +275,11 @@ describe("/applications", () => {
   })
 
   describe("unpublish", () => {
+    beforeEach(async () => {
+      // We want to republish as the unpublish will delete the prod app
+      await config.publish()
+    })
+
     it("should unpublish app with dev app ID", async () => {
       const appId = config.getAppId()
       await request

package/src/api/routes/tests/auth.spec.js

@@ -7,7 +7,7 @@ describe("/authenticate", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 
@@ -18,7 +18,7 @@ describe("/authenticate", () => {
         .set(config.defaultHeaders())
         .expect("Content-Type", /json/)
         .expect(200)
-      expect(res.body._id).toEqual(generateUserMetadataID("us_uuid1"))
+      expect(res.body._id).toEqual(generateUserMetadataID(config.user._id))
     })
   })
 })

package/src/api/routes/tests/automation.spec.js

@@ -10,12 +10,16 @@ const MAX_RETRIES = 4
 const { TRIGGER_DEFINITIONS, ACTION_DEFINITIONS } = require("../../../automations")
 const { events } = require("@budibase/backend-core")
 
+
+jest.setTimeout(30000)
+
 describe("/automations", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
+  // For some reason this cannot be a beforeAll or the test "tests the automation successfully" fail
   beforeEach(async () => {
     await config.init()
   })
@@ -145,7 +149,7 @@ describe("/automations", () => {
         let elements = await getAllTableRows(config)
         // don't test it unless there are values to test
         if (elements.length > 1) {
-          expect(elements.length).toEqual(5)
+          expect(elements.length).toBeGreaterThanOrEqual(MAX_RETRIES)
           expect(elements[0].name).toEqual("Test")
           expect(elements[0].description).toEqual("TEST")
           return
@@ -305,7 +309,7 @@ describe("/automations", () => {
         .expect('Content-Type', /json/)
         .expect(200)
 
-        expect(res.body[0]).toEqual(expect.objectContaining(autoConfig))
+      expect(res.body[0]).toEqual(expect.objectContaining(autoConfig))
     })
 
     it("should apply authorization to endpoint", async () => {

package/src/api/routes/tests/backup.spec.ts

@@ -1,17 +1,8 @@
-jest.mock("@budibase/backend-core", () => {
-  const core = jest.requireActual("@budibase/backend-core")
-  return {
-    ...core,
-    objectStore: {
-      budibaseTempDir: core.objectStore.budibaseTempDir,
-    },
-  }
-})
-
 import * as setup from "./utilities"
 import { events } from "@budibase/backend-core"
 import sdk from "../../../sdk"
 import { checkBuilderEndpoint } from "./utilities/TestFunctions"
+
 describe("/backups", () => {
   let request = setup.getRequest()
   let config = setup.getConfig()
@@ -28,7 +19,6 @@ describe("/backups", () => {
         .get(`/api/backups/export?appId=${config.getAppId()}&appname=test`)
         .set(config.defaultHeaders())
         .expect(200)
-      expect(res.text).toBeDefined()
       expect(res.headers["content-type"]).toEqual("application/gzip")
       expect(events.app.exported).toBeCalledTimes(1)
     })
@@ -44,9 +34,9 @@ describe("/backups", () => {
 
   describe("calculateBackupStats", () => {
     it("should be able to calculate the backup statistics", async () => {
-      config.createAutomation()
-      config.createScreen()
-      let res = await sdk.backups.calculateBackupStats(config.getAppId())
+      await config.createAutomation()
+      await config.createScreen()
+      let res = await sdk.backups.calculateBackupStats(config.getAppId()!)
       expect(res.automations).toEqual(1)
       expect(res.datasources).toEqual(1)
       expect(res.screens).toEqual(1)

package/src/api/routes/tests/{cloud.spec.ts → cloud.seq.spec.ts}

@@ -1,14 +1,22 @@
-import { db as dbCore } from "@budibase/backend-core"
+jest.setTimeout(30000)
+
 import { AppStatus } from "../../../db/utils"
 
 import * as setup from "./utilities"
 
+import { wipeDb } from "./utilities/TestFunctions"
+
 describe("/cloud", () => {
-  let request = setup.getRequest()
+  let request = setup.getRequest()!
   let config = setup.getConfig()
 
   afterAll(setup.afterAll)
 
+  beforeAll(() => {
+    // Importing is only allowed in self hosted environments
+    config.modeSelf()
+  })
+
   beforeEach(async () => {
     await config.init()
   })
@@ -22,19 +30,7 @@ describe("/cloud", () => {
     it("should be able to import apps", async () => {
       // first we need to delete any existing apps on the system so it looks clean otherwise the
       // import will not run
-      await request
-        .post(
-          `/api/applications/${dbCore.getProdAppID(
-            config.getAppId()
-          )}/unpublish`
-        )
-        .set(config.defaultHeaders())
-        .expect(204)
-      await request
-        .delete(`/api/applications/${config.getAppId()}`)
-        .set(config.defaultHeaders())
-        .expect("Content-Type", /json/)
-        .expect(200)
+      await wipeDb()
 
       // get a count of apps before the import
       const preImportApps = await request

package/src/api/routes/tests/component.spec.js

@@ -7,7 +7,7 @@ describe("/component", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 

package/src/api/routes/tests/datasource.spec.ts

@@ -5,6 +5,10 @@ import { checkCacheForDynamicVariable } from "../../../threads/utils"
 import { context, events } from "@budibase/backend-core"
 import sdk from "../../../sdk"
 
+import tk from "timekeeper"
+import { mocks } from "@budibase/backend-core/tests"
+tk.freeze(mocks.date.MOCK_DATE)
+
 let { basicDatasource } = setup.structures
 const pg = require("pg")
 
@@ -15,11 +19,13 @@ describe("/datasources", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  async function setupTest() {
     await config.init()
     datasource = await config.createDatasource()
     jest.clearAllMocks()
-  })
+  }
+
+  beforeAll(setupTest)
 
   describe("create", () => {
     it("should create a new datasource", async () => {
@@ -56,7 +62,14 @@ describe("/datasources", () => {
         datasource: any,
         fields: { path: string; queryString: string }
       ) {
-        return config.previewQuery(request, config, datasource, fields)
+        return config.previewQuery(
+          request,
+          config,
+          datasource,
+          fields,
+          undefined,
+          ""
+        )
       }
 
       it("should invalidate changed or removed variables", async () => {
@@ -91,6 +104,8 @@ describe("/datasources", () => {
   })
 
   describe("fetch", () => {
+    beforeAll(setupTest)
+
     it("returns all the datasources from the server", async () => {
       const res = await request
         .get(`/api/datasources`)
@@ -159,6 +174,8 @@ describe("/datasources", () => {
   })
 
   describe("destroy", () => {
+    beforeAll(setupTest)
+
     it("deletes queries for the datasource after deletion and returns a success message", async () => {
       await config.createQuery()
 

package/src/api/routes/tests/dev.spec.js

@@ -8,7 +8,7 @@ describe("/dev", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
     jest.clearAllMocks()
   })

package/src/api/routes/tests/environmentVariables.spec.ts

@@ -0,0 +1,144 @@
+const pg = require("pg")
+jest.mock("pg", () => {
+  return {
+    Client: jest.fn().mockImplementation(() => ({
+      connect: jest.fn(),
+      query: jest.fn().mockImplementation(() => ({ rows: [] })),
+      end: jest.fn().mockImplementation((fn: any) => fn()),
+    })),
+    queryMock: jest.fn().mockImplementation(() => {}),
+    on: jest.fn(),
+  }
+})
+import * as setup from "./utilities"
+import { mocks } from "@budibase/backend-core/tests"
+import { env, events } from "@budibase/backend-core"
+const structures = setup.structures
+
+env._set("ENCRYPTION_KEY", "budibase")
+mocks.licenses.useEnvironmentVariables()
+
+describe("/api/env/variables", () => {
+  let request = setup.getRequest()
+  let config = setup.getConfig()
+
+  afterAll(setup.afterAll)
+
+  beforeAll(async () => {
+    await config.init()
+  })
+
+  it("should be able check the status of env var API", async () => {
+    const res = await request
+      .get(`/api/env/variables/status`)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+
+    expect(res.body.encryptionKeyAvailable).toEqual(true)
+  })
+
+  it("should be able to create an environment variable", async () => {
+    await request
+      .post(`/api/env/variables`)
+      .send(structures.basicEnvironmentVariable("test", "test"))
+      .set(config.defaultHeaders())
+      .expect(200)
+  })
+
+  it("should be able to fetch the 'test' variable name", async () => {
+    const res = await request
+      .get(`/api/env/variables`)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+    expect(res.body.variables.length).toEqual(1)
+    expect(res.body.variables[0]).toEqual("test")
+  })
+
+  it("should be able to update the environment variable 'test'", async () => {
+    const varName = "test"
+    await request
+      .patch(`/api/env/variables/${varName}`)
+      .send(structures.basicEnvironmentVariable("test", "test1"))
+      .set(config.defaultHeaders())
+      .expect(200)
+  })
+
+  it("should be able to delete the environment variable 'test'", async () => {
+    const varName = "test"
+    await request
+      .delete(`/api/env/variables/${varName}`)
+      .set(config.defaultHeaders())
+      .expect(200)
+  })
+
+  it("should create a datasource (using the environment variable) and query", async () => {
+    const datasourceBase = structures.basicDatasource()
+    await request
+      .post(`/api/env/variables`)
+      .send(structures.basicEnvironmentVariable("test", "test"))
+      .set(config.defaultHeaders())
+
+    datasourceBase.datasource.config = {
+      password: "{{ env.test }}",
+    }
+    const response = await request
+      .post(`/api/datasources`)
+      .send(datasourceBase)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+    expect(response.body.datasource._id).toBeDefined()
+
+    const response2 = await request
+      .post(`/api/queries`)
+      .send(structures.basicQuery(response.body.datasource._id))
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+    expect(response2.body._id).toBeDefined()
+  })
+
+  it("should run a query preview and check the mocked results", async () => {
+    const datasourceBase = structures.basicDatasource()
+    await request
+      .post(`/api/env/variables`)
+      .send(structures.basicEnvironmentVariable("test", "test"))
+      .set(config.defaultHeaders())
+
+    datasourceBase.datasource.config = {
+      password: "{{ env.test }}",
+    }
+    const response = await request
+      .post(`/api/datasources`)
+      .send(datasourceBase)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+    expect(response.body.datasource._id).toBeDefined()
+
+    const query = {
+      datasourceId: response.body.datasource._id,
+      parameters: {},
+      fields: {},
+      queryVerb: "read",
+      name: response.body.datasource.name,
+    }
+    const res = await request
+      .post(`/api/queries/preview`)
+      .send(query)
+      .set(config.defaultHeaders())
+      .expect("Content-Type", /json/)
+      .expect(200)
+    expect(res.body.rows.length).toEqual(0)
+    expect(events.query.previewed).toBeCalledTimes(1)
+    // API doesn't include config in response
+    delete response.body.datasource.config
+    expect(events.query.previewed).toBeCalledWith(
+      response.body.datasource,
+      query
+    )
+    expect(pg.Client).toHaveBeenCalledWith({ password: "test", ssl: undefined })
+  })
+})

package/src/api/routes/tests/integration.spec.js

@@ -7,7 +7,7 @@ describe("/integrations", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 

package/src/api/routes/tests/layout.spec.js

@@ -10,7 +10,7 @@ describe("/layouts", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
     layout = await config.createLayout()
     jest.clearAllMocks()

package/src/api/routes/tests/metadata.spec.js

@@ -9,7 +9,7 @@ describe("/metadata", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
     automation = await config.createAutomation()
   })

package/src/api/routes/tests/misc.spec.js

@@ -7,7 +7,7 @@ describe("run misc tests", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 

package/src/api/routes/tests/permissions.spec.js

@@ -15,8 +15,11 @@ describe("/permission", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
+  })
+  
+  beforeEach(async () => {
     table = await config.createTable()
     row = await config.createRow()
     perms = await config.addPermission(STD_ROLE_ID, table._id)

package/src/api/routes/tests/{query.spec.js → query.seq.spec.js}

@@ -1,3 +1,6 @@
+const tk = require( "timekeeper")
+tk.freeze(Date.now())
+
 // Mock out postgres for this
 jest.mock("pg")
 jest.mock("node-fetch")
@@ -27,10 +30,15 @@ describe("/queries", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  const setupTest = async()=>{
+
     await config.init()
     datasource = await config.createDatasource()
     query = await config.createQuery()
+  }
+
+  beforeAll(async () => {
+    await setupTest()
   })
 
   async function createInvalidIntegration() {
@@ -101,6 +109,10 @@ describe("/queries", () => {
   })
 
   describe("fetch", () => {
+    beforeEach(async() => {
+      await setupTest()
+    })
+
     it("returns all the queries from the server", async () => {
       const res = await request
         .get(`/api/queries`)
@@ -178,6 +190,10 @@ describe("/queries", () => {
   })
 
   describe("destroy", () => {
+    beforeEach(async() => {
+      await setupTest()
+    })
+
     it("deletes a query and returns a success message", async () => {
       await request
         .delete(`/api/queries/${query._id}/${query._rev}`)
@@ -226,6 +242,7 @@ describe("/queries", () => {
       })
       expect(res.body.rows.length).toEqual(1)
       expect(events.query.previewed).toBeCalledTimes(1)
+      delete datasource.config
       expect(events.query.previewed).toBeCalledWith(datasource, query)
     })
 
@@ -239,6 +256,10 @@ describe("/queries", () => {
   })
 
   describe("execute", () => {
+    beforeEach(async() => {
+      await setupTest()
+    })
+
     it("should be able to execute the query", async () => {
       const res = await request
         .post(`/api/queries/${query._id}`)

package/src/api/routes/tests/role.spec.js

@@ -10,7 +10,7 @@ describe("/roles", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
   })
 
@@ -60,6 +60,11 @@ describe("/roles", () => {
   })
 
   describe("fetch", () => {
+    beforeAll(async () => {
+      // Recreate the app
+      await config.init()
+    })
+
     it("should list custom roles, plus 2 default roles", async () => {
       const customRole = await config.createRole()
 

package/src/api/routes/tests/routing.spec.js

@@ -16,7 +16,7 @@ describe("/routing", () => {
 
   afterAll(setup.afterAll)
 
-  beforeEach(async () => {
+  beforeAll(async () => {
     await config.init()
     screen = basicScreen()
     screen.routing.route = route