@budibase/worker 2.2.26 → 2.2.27-alpha.1

package/src/api/routes/global/tests/auth.spec.ts

@@ -1,7 +1,8 @@
 jest.mock("nodemailer")
 import { TestConfiguration, mocks } from "../../../../tests"
 const sendMailMock = mocks.email.mock()
-import { events } from "@budibase/backend-core"
+import { events, tenancy } from "@budibase/backend-core"
+import { structures } from "@budibase/backend-core/tests"
 
 const expectSetAuthCookie = (res: any) => {
   expect(
@@ -40,36 +41,43 @@ describe("/api/global/auth", () => {
 
     describe("POST /api/global/auth/:tenantId/reset", () => {
       it("should generate password reset email", async () => {
-        const { res, code } = await config.api.auth.requestPasswordReset(
-          sendMailMock
-        )
-        const user = await config.getUser("test@test.com")
+        await tenancy.doInTenant(config.tenant1User!.tenantId, async () => {
+          const userEmail = structures.email()
+          const { res, code } = await config.api.auth.requestPasswordReset(
+            sendMailMock,
+            userEmail
+          )
+          const user = await config.getUser(userEmail)
 
-        expect(res.body).toEqual({
-          message: "Please check your email for a reset link.",
-        })
-        expect(sendMailMock).toHaveBeenCalled()
+          expect(res.body).toEqual({
+            message: "Please check your email for a reset link.",
+          })
+          expect(sendMailMock).toHaveBeenCalled()
 
-        expect(code).toBeDefined()
-        expect(events.user.passwordResetRequested).toBeCalledTimes(1)
-        expect(events.user.passwordResetRequested).toBeCalledWith(user)
+          expect(code).toBeDefined()
+          expect(events.user.passwordResetRequested).toBeCalledTimes(1)
+          expect(events.user.passwordResetRequested).toBeCalledWith(user)
+        })
       })
     })
 
     describe("POST /api/global/auth/:tenantId/reset/update", () => {
       it("should reset password", async () => {
-        const { code } = await config.api.auth.requestPasswordReset(
-          sendMailMock
-        )
-        const user = await config.getUser("test@test.com")
-        delete user.password
-
-        const res = await config.api.auth.updatePassword(code)
+        await tenancy.doInTenant(config.tenant1User!.tenantId, async () => {
+          const userEmail = structures.email()
+          const { code } = await config.api.auth.requestPasswordReset(
+            sendMailMock,
+            userEmail
+          )
+          const user = await config.getUser(userEmail)
+          delete user.password
 
-        expect(res.body).toEqual({ message: "password reset successfully." })
-        expect(events.user.passwordReset).toBeCalledTimes(1)
-        expect(events.user.passwordReset).toBeCalledWith(user)
+          const res = await config.api.auth.updatePassword(code)
 
+          expect(res.body).toEqual({ message: "password reset successfully." })
+          expect(events.user.passwordReset).toBeCalledTimes(1)
+          expect(events.user.passwordReset).toBeCalledWith(user)
+        })
         // TODO: Login using new password
       })
     })

package/src/api/routes/global/tests/configs.spec.ts

@@ -2,12 +2,12 @@
 jest.mock("nodemailer")
 import { TestConfiguration, structures, mocks } from "../../../../tests"
 mocks.email.mock()
-import { Config, events } from "@budibase/backend-core"
+import { Config, context, events } from "@budibase/backend-core"
 
 describe("configs", () => {
   const config = new TestConfiguration()
 
-  beforeAll(async () => {
+  beforeEach(async () => {
     await config.beforeAll()
   })
 
@@ -113,56 +113,64 @@ describe("configs", () => {
 
       describe("create", () => {
         it("should create activated OIDC config", async () => {
-          await saveOIDCConfig()
-          expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
-          expect(events.auth.SSODeactivated).not.toBeCalled()
-          expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
-          await config.deleteConfig(Config.OIDC)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            await saveOIDCConfig()
+            expect(events.auth.SSOCreated).toBeCalledTimes(1)
+            expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
+            expect(events.auth.SSODeactivated).not.toBeCalled()
+            expect(events.auth.SSOActivated).toBeCalledTimes(1)
+            expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
+            await config.deleteConfig(Config.OIDC)
+          })
         })
 
         it("should create deactivated OIDC config", async () => {
-          await saveOIDCConfig({ activated: false })
-          expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
-          expect(events.auth.SSOActivated).not.toBeCalled()
-          expect(events.auth.SSODeactivated).not.toBeCalled()
-          await config.deleteConfig(Config.OIDC)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            await saveOIDCConfig({ activated: false })
+            expect(events.auth.SSOCreated).toBeCalledTimes(1)
+            expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
+            expect(events.auth.SSOActivated).not.toBeCalled()
+            expect(events.auth.SSODeactivated).not.toBeCalled()
+            await config.deleteConfig(Config.OIDC)
+          })
         })
       })
 
       describe("update", () => {
         it("should update OIDC config to deactivated", async () => {
-          const oidcConf = await saveOIDCConfig()
-          jest.clearAllMocks()
-          await saveOIDCConfig(
-            { ...oidcConf.config.configs[0], activated: false },
-            oidcConf._id,
-            oidcConf._rev
-          )
-          expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
-          expect(events.auth.SSOActivated).not.toBeCalled()
-          expect(events.auth.SSODeactivated).toBeCalledTimes(1)
-          expect(events.auth.SSODeactivated).toBeCalledWith(Config.OIDC)
-          await config.deleteConfig(Config.OIDC)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            const oidcConf = await saveOIDCConfig()
+            jest.clearAllMocks()
+            await saveOIDCConfig(
+              { ...oidcConf.config.configs[0], activated: false },
+              oidcConf._id,
+              oidcConf._rev
+            )
+            expect(events.auth.SSOUpdated).toBeCalledTimes(1)
+            expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
+            expect(events.auth.SSOActivated).not.toBeCalled()
+            expect(events.auth.SSODeactivated).toBeCalledTimes(1)
+            expect(events.auth.SSODeactivated).toBeCalledWith(Config.OIDC)
+            await config.deleteConfig(Config.OIDC)
+          })
         })
 
         it("should update OIDC config to activated", async () => {
-          const oidcConf = await saveOIDCConfig({ activated: false })
-          jest.clearAllMocks()
-          await saveOIDCConfig(
-            { ...oidcConf.config.configs[0], activated: true },
-            oidcConf._id,
-            oidcConf._rev
-          )
-          expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
-          expect(events.auth.SSODeactivated).not.toBeCalled()
-          expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
-          await config.deleteConfig(Config.OIDC)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            const oidcConf = await saveOIDCConfig({ activated: false })
+            jest.clearAllMocks()
+            await saveOIDCConfig(
+              { ...oidcConf.config.configs[0], activated: true },
+              oidcConf._id,
+              oidcConf._rev
+            )
+            expect(events.auth.SSOUpdated).toBeCalledTimes(1)
+            expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
+            expect(events.auth.SSODeactivated).not.toBeCalled()
+            expect(events.auth.SSOActivated).toBeCalledTimes(1)
+            expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
+            await config.deleteConfig(Config.OIDC)
+          })
         })
       })
     })
@@ -179,22 +187,26 @@ describe("configs", () => {
 
       describe("create", () => {
         it("should create SMTP config", async () => {
-          await config.deleteConfig(Config.SMTP)
-          await saveSMTPConfig()
-          expect(events.email.SMTPUpdated).not.toBeCalled()
-          expect(events.email.SMTPCreated).toBeCalledTimes(1)
-          await config.deleteConfig(Config.SMTP)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            await config.deleteConfig(Config.SMTP)
+            await saveSMTPConfig()
+            expect(events.email.SMTPUpdated).not.toBeCalled()
+            expect(events.email.SMTPCreated).toBeCalledTimes(1)
+            await config.deleteConfig(Config.SMTP)
+          })
         })
       })
 
       describe("update", () => {
         it("should update SMTP config", async () => {
-          const smtpConf = await saveSMTPConfig()
-          jest.clearAllMocks()
-          await saveSMTPConfig(smtpConf.config, smtpConf._id, smtpConf._rev)
-          expect(events.email.SMTPCreated).not.toBeCalled()
-          expect(events.email.SMTPUpdated).toBeCalledTimes(1)
-          await config.deleteConfig(Config.SMTP)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            const smtpConf = await saveSMTPConfig()
+            jest.clearAllMocks()
+            await saveSMTPConfig(smtpConf.config, smtpConf._id, smtpConf._rev)
+            expect(events.email.SMTPCreated).not.toBeCalled()
+            expect(events.email.SMTPUpdated).toBeCalledTimes(1)
+            await config.deleteConfig(Config.SMTP)
+          })
         })
       })
     })
@@ -211,65 +223,73 @@ describe("configs", () => {
 
       describe("create", () => {
         it("should create settings config with default settings", async () => {
-          await config.deleteConfig(Config.SETTINGS)
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            await config.deleteConfig(Config.SETTINGS)
 
-          await saveSettingsConfig()
+            await saveSettingsConfig()
 
-          expect(events.org.nameUpdated).not.toBeCalled()
-          expect(events.org.logoUpdated).not.toBeCalled()
-          expect(events.org.platformURLUpdated).not.toBeCalled()
+            expect(events.org.nameUpdated).not.toBeCalled()
+            expect(events.org.logoUpdated).not.toBeCalled()
+            expect(events.org.platformURLUpdated).not.toBeCalled()
+          })
         })
 
         it("should create settings config with non-default settings", async () => {
-          config.modeSelf()
-          await config.deleteConfig(Config.SETTINGS)
-          const conf = {
-            company: "acme",
-            logoUrl: "http://example.com",
-            platformUrl: "http://example.com",
-          }
-
-          await saveSettingsConfig(conf)
-
-          expect(events.org.nameUpdated).toBeCalledTimes(1)
-          expect(events.org.logoUpdated).toBeCalledTimes(1)
-          expect(events.org.platformURLUpdated).toBeCalledTimes(1)
-          config.modeCloud()
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            config.modeSelf()
+            await config.deleteConfig(Config.SETTINGS)
+            const conf = {
+              company: "acme",
+              logoUrl: "http://example.com",
+              platformUrl: "http://example.com",
+            }
+
+            await saveSettingsConfig(conf)
+
+            expect(events.org.nameUpdated).toBeCalledTimes(1)
+            expect(events.org.logoUpdated).toBeCalledTimes(1)
+            expect(events.org.platformURLUpdated).toBeCalledTimes(1)
+            config.modeCloud()
+          })
         })
       })
 
       describe("update", () => {
         it("should update settings config", async () => {
-          config.modeSelf()
-          await config.deleteConfig(Config.SETTINGS)
-          const settingsConfig = await saveSettingsConfig()
-          settingsConfig.config.company = "acme"
-          settingsConfig.config.logoUrl = "http://example.com"
-          settingsConfig.config.platformUrl = "http://example.com"
-
-          await saveSettingsConfig(
-            settingsConfig.config,
-            settingsConfig._id,
-            settingsConfig._rev
-          )
-
-          expect(events.org.nameUpdated).toBeCalledTimes(1)
-          expect(events.org.logoUpdated).toBeCalledTimes(1)
-          expect(events.org.platformURLUpdated).toBeCalledTimes(1)
-          config.modeCloud()
+          await context.doInTenant(config.tenant1User!.tenantId, async () => {
+            config.modeSelf()
+            await config.deleteConfig(Config.SETTINGS)
+            const settingsConfig = await saveSettingsConfig()
+            settingsConfig.config.company = "acme"
+            settingsConfig.config.logoUrl = "http://example.com"
+            settingsConfig.config.platformUrl = "http://example.com"
+
+            await saveSettingsConfig(
+              settingsConfig.config,
+              settingsConfig._id,
+              settingsConfig._rev
+            )
+
+            expect(events.org.nameUpdated).toBeCalledTimes(1)
+            expect(events.org.logoUpdated).toBeCalledTimes(1)
+            expect(events.org.platformURLUpdated).toBeCalledTimes(1)
+            config.modeCloud()
+          })
         })
       })
     })
   })
 
   it("should return the correct checklist status based on the state of the budibase installation", async () => {
-    await config.saveSmtpConfig()
+    await context.doInTenant(config.tenant1User!.tenantId, async () => {
+      await config.saveSmtpConfig()
 
-    const res = await config.api.configs.getConfigChecklist()
-    const checklist = res.body
+      const res = await config.api.configs.getConfigChecklist()
+      const checklist = res.body
 
-    expect(checklist.apps.checked).toBeFalsy()
-    expect(checklist.smtp.checked).toBeTruthy()
-    expect(checklist.adminUser.checked).toBeTruthy()
+      expect(checklist.apps.checked).toBeFalsy()
+      expect(checklist.smtp.checked).toBeTruthy()
+      expect(checklist.adminUser.checked).toBeTruthy()
+    })
   })
 })

package/src/api/routes/global/tests/groups.spec.ts

@@ -0,0 +1,58 @@
+import { events } from "@budibase/backend-core"
+import { structures, TestConfiguration, mocks } from "../../../../tests"
+
+describe("/api/global/groups", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  beforeEach(async () => {
+    mocks.licenses.useGroups()
+  })
+
+  describe("create", () => {
+    it("should be able to create a new group", async () => {
+      const group = structures.groups.UserGroup()
+      await config.api.groups.saveGroup(group)
+      expect(events.group.created).toBeCalledTimes(1)
+      expect(events.group.updated).not.toBeCalled()
+      expect(events.group.permissionsEdited).not.toBeCalled()
+    })
+  })
+
+  describe("update", () => {
+    it("should be able to update a basic group", async () => {
+      const group = structures.groups.UserGroup()
+      let oldGroup = await config.api.groups.saveGroup(group)
+
+      let updatedGroup = {
+        ...oldGroup.body,
+        ...group,
+        name: "New Name",
+      }
+      await config.api.groups.saveGroup(updatedGroup)
+
+      expect(events.group.updated).toBeCalledTimes(1)
+      expect(events.group.permissionsEdited).not.toBeCalled()
+    })
+
+    describe("destroy", () => {
+      it("should be able to delete a basic group", async () => {
+        const group = structures.groups.UserGroup()
+        let oldGroup = await config.api.groups.saveGroup(group)
+        await config.api.groups.deleteGroup(
+          oldGroup.body._id,
+          oldGroup.body._rev
+        )
+
+        expect(events.group.deleted).toBeCalledTimes(1)
+      })
+    })
+  })
+})

package/src/api/routes/global/tests/license.spec.ts

@@ -1,7 +1,5 @@
 import { TestConfiguration } from "../../../../tests"
 
-// TODO
-
 describe("/api/global/license", () => {
   const config = new TestConfiguration()
 

package/src/api/routes/global/tests/roles.spec.ts

@@ -1,14 +1,57 @@
-import { TestConfiguration } from "../../../../tests"
+import { structures, TestConfiguration } from "../../../../tests"
+import { context, db, permissions, roles } from "@budibase/backend-core"
+import { Mock } from "jest-mock"
+import { Database } from "@budibase/types"
 
-// TODO
+jest.mock("@budibase/backend-core", () => {
+  const core = jest.requireActual("@budibase/backend-core")
+  return {
+    ...core,
+    db: {
+      ...core.db,
+    },
+    context: {
+      ...core.context,
+      getAppDB: jest.fn(),
+    },
+  }
+})
+
+let appId: string
+let appDb: Database
+
+async function addAppMetadata() {
+  await appDb.put({
+    _id: "app_metadata",
+    appId: appId,
+    name: "New App",
+    version: "version",
+    url: "url",
+  })
+}
 
 describe("/api/global/roles", () => {
   const config = new TestConfiguration()
+  const role = new roles.Role(
+    db.generateRoleID("newRole"),
+    roles.BUILTIN_ROLE_IDS.BASIC,
+    permissions.BuiltinPermissionID.READ_ONLY
+  )
 
   beforeAll(async () => {
     await config.beforeAll()
   })
 
+  beforeEach(async () => {
+    appId = db.generateAppID()
+    appDb = db.getDB(appId)
+    const mockAppDB = context.getAppDB as Mock
+    mockAppDB.mockReturnValue(appDb)
+
+    await addAppMetadata()
+    appDb.put(role)
+  })
+
   afterAll(async () => {
     await config.afterAll()
   })
@@ -18,10 +61,33 @@ describe("/api/global/roles", () => {
   })
 
   describe("GET /api/global/roles", () => {
-    it("retrieves roles", () => {})
+    it("retrieves roles", async () => {
+      const res = await config.api.roles.get()
+      expect(res.body).toBeDefined()
+      expect(res.body[appId].roles.length).toEqual(5)
+      expect(res.body[appId].roles.map((r: any) => r._id)).toContain(role._id)
+    })
   })
 
-  describe("GET /api/global/roles/:appId", () => {})
+  describe("GET api/global/roles/:appId", () => {
+    it("finds a role by appId", async () => {
+      const res = await config.api.roles.find(appId)
+      expect(res.body).toBeDefined()
+      expect(res.body.name).toEqual("New App")
+    })
+  })
 
-  describe("DELETE /api/global/roles/:appId", () => {})
+  describe("DELETE /api/global/roles/:appId", () => {
+    it("removes an app role", async () => {
+      let user = structures.users.user()
+      user.roles = {
+        app_test: "role1",
+      }
+      const userResponse = await config.createUser(user)
+      const res = await config.api.roles.remove(appId)
+      const updatedUser = await config.api.users.getUser(userResponse._id!)
+      expect(updatedUser.body.roles).not.toHaveProperty(appId)
+      expect(res.body.message).toEqual("App role removed from all users")
+    })
+  })
 })

package/src/api/routes/global/tests/templates.spec.ts

@@ -1,3 +1,8 @@
+import {
+  EmailTemplatePurpose,
+  TemplateMetadata,
+  TemplateType,
+} from "../../../../constants"
 import { TestConfiguration } from "../../../../tests"
 
 // TODO
@@ -18,18 +23,85 @@ describe("/api/global/template", () => {
   })
 
   describe("GET /api/global/template/definitions", () => {
-    it("retrieves definitions", () => {})
-  })
-
-  describe("POST /api/global/template", () => {})
+    describe("retrieves definitions", () => {
+      it("checks description definitions", async () => {
+        let result = await config.api.templates.definitions()
 
-  describe("GET /api/global/template", () => {})
+        expect(result.body.info[EmailTemplatePurpose.BASE].description).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][0].description
+        )
+        expect(
+          result.body.info[EmailTemplatePurpose.PASSWORD_RECOVERY].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][1].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.WELCOME].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][2].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.INVITATION].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][3].description)
+        expect(
+          result.body.info[EmailTemplatePurpose.CUSTOM].description
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][4].description)
+      })
 
-  describe("GET /api/global/template/:type", () => {})
+      it("checks description bindings", async () => {
+        let result = await config.api.templates.definitions()
 
-  describe("GET /api/global/template/:ownerId", () => {})
+        expect(result.body.bindings[EmailTemplatePurpose.BASE]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][0].bindings
+        )
+        expect(
+          result.body.bindings[EmailTemplatePurpose.PASSWORD_RECOVERY]
+        ).toEqual(TemplateMetadata[TemplateType.EMAIL][1].bindings)
+        expect(result.body.bindings[EmailTemplatePurpose.WELCOME]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][2].bindings
+        )
+        expect(result.body.bindings[EmailTemplatePurpose.INVITATION]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][3].bindings
+        )
+        expect(result.body.bindings[EmailTemplatePurpose.CUSTOM]).toEqual(
+          TemplateMetadata[TemplateType.EMAIL][4].bindings
+        )
+      })
+    })
+  })
 
-  describe("GET /api/global/template/:id", () => {})
+  describe("POST /api/global/template", () => {
+    it("adds a new template", async () => {
+      let purpose = "base"
+      let contents = "Test contents"
+      let updatedTemplate = {
+        contents: contents,
+        purpose: purpose,
+        type: "email",
+      }
+      await config.api.templates.saveTemplate(updatedTemplate)
+      let res = await config.api.templates.getTemplate()
+      let newTemplate = res.body.find((t: any) => (t.purpose = purpose))
+      expect(newTemplate.contents).toEqual(contents)
+    })
+  })
 
-  describe("DELETE /api/global/template/:id/:rev", () => {})
+  describe("GET /api/global/template", () => {
+    it("fetches templates", async () => {
+      let res = await config.api.templates.getTemplate()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.BASE)
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.CUSTOM)
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.INVITATION)
+      ).toBeDefined()
+      expect(
+        res.body.find(
+          (t: any) => t.purpose === EmailTemplatePurpose.PASSWORD_RECOVERY
+        )
+      ).toBeDefined()
+      expect(
+        res.body.find((t: any) => t.purpose === EmailTemplatePurpose.WELCOME)
+      ).toBeDefined()
+    })
+  })
 })