MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into demock-application-tests

This commit is contained in:
Sam Rose 2025-03-03 21:22:29 +00:00 committed by GitHub
parent 210e7e0c37 d9ce8e3838
commit 85e0b2f478
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
36 changed files with 209 additions and 279 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/server/src/api/controllers/integration.ts
View File

@ -9,6 +9,7 @@ import {
const DISABLED_EXTERNAL_INTEGRATIONS = [
SourceName.AIRTABLE,
SourceName.BUDIBASE,
SourceName.ARANGODB,
]
export async function fetch(ctx: UserCtx<void, FetchIntegrationsResponse>) {

239
packages/server/src/api/routes/tests/environmentVariables.spec.ts
View File

@ -1,153 +1,106 @@
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 { structures } from "./utilities"
import { mocks } from "@budibase/backend-core/tests"
import { env, events } from "@budibase/backend-core"
import { QueryPreview } from "@budibase/types"
import { setEnv } from "@budibase/backend-core"
import { Datasource } from "@budibase/types"
import TestConfiguration from "../../../tests/utilities/TestConfiguration"
import {
DatabaseName,
datasourceDescribe,
} from "../../../integrations/tests/utils"
const structures = setup.structures
const describes = datasourceDescribe({ only: [DatabaseName.POSTGRES] })
env._set("ENCRYPTION_KEY", "budibase")
mocks.licenses.useEnvironmentVariables()
if (describes.length > 0) {
describe.each(describes)("/api/env/variables", ({ dsProvider }) => {
const config = new TestConfiguration()
describe("/api/env/variables", () => {
let request = setup.getRequest()
let config = setup.getConfig()
let rawDatasource: Datasource
let restoreEnv: () => void
afterAll(setup.afterAll)
beforeAll(async () => {
await config.init()
restoreEnv = setEnv({ ENCRYPTION_KEY: "budibase" })
mocks.licenses.useEnvironmentVariables()
beforeAll(async () => {
await config.init()
})
const ds = await dsProvider()
rawDatasource = ds.rawDatasource!
})
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)
afterAll(() => {
restoreEnv()
})
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 queryPreview: QueryPreview = {
datasourceId: response.body.datasource._id,
parameters: [],
fields: {},
queryVerb: "read",
name: response.body.datasource.name,
transformer: null,
schema: {},
readable: true,
}
const res = await request
.post(`/api/queries/preview`)
.send(queryPreview)
.set(config.defaultHeaders())
.expect("Content-Type", /json/)
.expect(200)
expect(res.body.rows.length).toEqual(0)
expect(events.query.previewed).toHaveBeenCalledTimes(1)
// API doesn't include config in response
delete response.body.datasource.config
expect(events.query.previewed).toHaveBeenCalledWith(
response.body.datasource,
{
...queryPreview,
nullDefaultSupport: true,
beforeEach(async () => {
const { variables } = await config.api.environment.fetch()
for (const variable of variables) {
await config.api.environment.destroy(variable)
}
)
expect(pg.Client).toHaveBeenCalledWith({ password: "test", ssl: undefined })
await config.api.environment.create({
name: "test",
production: rawDatasource.config!.password,
development: rawDatasource.config!.password,
})
})
it("should be able check the status of env var API", async () => {
const { encryptionKeyAvailable } = await config.api.environment.status()
expect(encryptionKeyAvailable).toEqual(true)
})
it("should be able to fetch the 'test' variable name", async () => {
const { variables } = await config.api.environment.fetch()
expect(variables.length).toEqual(1)
expect(variables[0]).toEqual("test")
})
it("should be able to update the environment variable 'test'", async () => {
await config.api.environment.update("test", {
production: "test1",
development: "test1",
})
})
it("should be able to delete the environment variable 'test'", async () => {
await config.api.environment.destroy("test")
})
it("should create a datasource (using the environment variable) and query", async () => {
const datasource = await config.api.datasource.create({
...structures.basicDatasource().datasource,
config: {
...rawDatasource.config,
password: "{{ env.test }}",
},
})
const query = await config.api.query.save({
...structures.basicQuery(datasource._id!),
fields: { sql: "SELECT 1" },
})
expect(query._id).toBeDefined()
})
it("should run a query preview and check the mocked results", async () => {
const datasource = await config.api.datasource.create({
...structures.basicDatasource().datasource,
config: {
...rawDatasource.config,
password: "{{ env.test }}",
},
})
const query = await config.api.query.save({
...structures.basicQuery(datasource._id!),
fields: { sql: "SELECT 1 as id" },
})
const { rows } = await config.api.query.preview({
...query,
queryId: query._id!,
})
expect(rows).toEqual([{ id: 1 }])
})
})
})
}

23
packages/server/src/api/routes/tests/search.spec.ts
View File

@ -6,6 +6,7 @@ import {
docIds,
MAX_VALID_DATE,
MIN_VALID_DATE,
setEnv,
SQLITE_DESIGN_DOC_ID,
utils,
withEnv as withCoreEnv,
@ -43,19 +44,7 @@ import { generator, structures, mocks } from "@budibase/backend-core/tests"
import { DEFAULT_EMPLOYEE_TABLE_SCHEMA } from "../../../db/defaultData/datasource_bb_default"
import { generateRowIdField } from "../../../integrations/utils"
import { cloneDeep } from "lodash/fp"
jest.mock("@budibase/pro", () => ({
...jest.requireActual("@budibase/pro"),
ai: {
LargeLanguageModel: {
forCurrentTenant: async () => ({
llm: {},
run: jest.fn(() => `Mock LLM Response`),
buildPromptFromAIOperation: jest.fn(),
}),
},
},
}))
import { mockChatGPTResponse } from "../../../tests/utilities/mocks/openai"
const descriptions = datasourceDescribe({ plus: true })
@ -1896,11 +1885,15 @@ if (descriptions.length) {
!isInMemory &&
describe("AI Column", () => {
const UNEXISTING_AI_COLUMN = "Real LLM Response"
let envCleanup: () => void
beforeAll(async () => {
mocks.licenses.useBudibaseAI()
mocks.licenses.useAICustomConfigs()
envCleanup = setEnv({ OPENAI_API_KEY: "mock" })
mockChatGPTResponse("Mock LLM Response")
tableOrViewId = await createTableOrView({
product: { name: "product", type: FieldType.STRING },
ai: {
@ -1917,6 +1910,10 @@ if (descriptions.length) {
])
})
afterAll(() => {
envCleanup()
})
describe("equal", () => {
it("successfully finds rows based on AI column", async () => {
await expectQuery({

1
packages/server/src/automations/tests/steps/bash.spec.ts
View File

@ -16,6 +16,7 @@ describe("Execute Bash Automations", () => {
name: "test row",
description: "test description",
})
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/createRow.spec.ts
View File

@ -33,6 +33,7 @@ describe("test the create row action", () => {
name: "test",
description: "test",
}
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/delay.spec.ts
View File

@ -6,6 +6,7 @@ describe("test the delay logic", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/deleteRow.spec.ts
View File

@ -13,6 +13,7 @@ describe("test the delete row action", () => {
await config.init()
table = await config.api.table.save(basicTable())
row = await config.api.row.save(table._id!, {})
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/discord.spec.ts
View File

@ -7,6 +7,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/executeQuery.spec.ts
View File

@ -26,6 +26,7 @@ if (descriptions.length) {
const ds = await dsProvider()
datasource = ds.datasource!
client = ds.client!
await config.api.automation.deleteAll()
})
beforeEach(async () => {

1
packages/server/src/automations/tests/steps/executeScript.spec.ts
View File

@ -13,6 +13,7 @@ describe("Execute Script Automations", () => {
await config.init()
table = await config.api.table.save(basicTable())
await config.api.row.save(table._id!, {})
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/filter.spec.ts
View File

@ -26,6 +26,7 @@ describe("test the filter logic", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

5
packages/server/src/automations/tests/steps/loop.spec.ts
View File

@ -22,10 +22,7 @@ describe("Attempt to run a basic loop automation", () => {
})
beforeEach(async () => {
const { automations } = await config.api.automation.fetch()
for (const automation of automations) {
await config.api.automation.delete(automation)
}
await config.api.automation.deleteAll()
table = await config.api.table.save(basicTable())
await config.api.row.save(table._id!, {})

1
packages/server/src/automations/tests/steps/make.spec.ts
View File

@ -7,6 +7,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/n8n.spec.ts
View File

@ -8,6 +8,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/openai.spec.ts
View File

@ -16,6 +16,7 @@ describe("test the openai action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
beforeEach(() => {

1
packages/server/src/automations/tests/steps/outgoingWebhook.spec.ts
View File

@ -8,6 +8,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/queryRows.spec.ts
View File

@ -21,6 +21,7 @@ describe("Test a query step automation", () => {
}
await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row)
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/sendSmtpEmail.spec.ts
View File

@ -28,6 +28,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/serverLog.spec.ts
View File

@ -6,6 +6,7 @@ describe("test the server log action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/triggerAutomationRun.spec.ts
View File

@ -9,6 +9,7 @@ describe("Test triggering an automation from another automation", () => {
beforeAll(async () => {
await automation.init()
await config.init()
await config.api.automation.deleteAll()
})
afterAll(async () => {

1
packages/server/src/automations/tests/steps/updateRow.spec.ts
View File

@ -23,6 +23,7 @@ describe("test the update row action", () => {
await config.init()
table = await config.createTable()
row = await config.createRow()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/steps/zapier.spec.ts
View File

@ -7,6 +7,7 @@ describe("test the outgoing webhook action", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

2
packages/server/src/automations/tests/triggers/appAction.spec.ts
View File

@ -9,6 +9,8 @@ describe("app action trigger", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
automation = await createAutomationBuilder(config)
.onAppAction()
.serverLog({

1
packages/server/src/automations/tests/triggers/cron.spec.ts
View File

@ -16,6 +16,7 @@ describe("cron trigger", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
})
afterAll(() => {

1
packages/server/src/automations/tests/triggers/rowDeleted.spec.ts
View File

@ -11,6 +11,7 @@ describe("row deleted trigger", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
table = await config.api.table.save(basicTable())
automation = await createAutomationBuilder(config)
.onRowDeleted({ tableId: table._id! })

1
packages/server/src/automations/tests/triggers/rowSaved.spec.ts
View File

@ -11,6 +11,7 @@ describe("row saved trigger", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
table = await config.api.table.save(basicTable())
automation = await createAutomationBuilder(config)
.onRowSaved({ tableId: table._id! })

1
packages/server/src/automations/tests/triggers/rowUpdated.spec.ts
View File

@ -11,6 +11,7 @@ describe("row updated trigger", () => {
beforeAll(async () => {
await config.init()
await config.api.automation.deleteAll()
table = await config.api.table.save(basicTable())
automation = await createAutomationBuilder(config)
.onRowUpdated({ tableId: table._id! })

1
packages/server/src/automations/tests/triggers/webhook.spec.ts
View File

@ -37,6 +37,7 @@ describe("Webhook trigger test", () => {
beforeEach(async () => {
await config.init()
await config.api.automation.deleteAll()
table = await config.createTable()
})

5
packages/server/src/integrations/arangodb.ts
View File

@ -9,6 +9,11 @@ import {
import { Database, aql } from "arangojs"
/**
* @deprecated 3rd March 2025
* datasource disabled - this datasource is marked for deprecation and removal
*/
interface ArangodbConfig {
url: string
username: string

12
packages/server/src/integrations/index.ts
View File

@ -33,15 +33,17 @@ const DEFINITIONS: Record<SourceName, Integration | undefined> = {
[SourceName.COUCHDB]: couchdb.schema,
[SourceName.SQL_SERVER]: sqlServer.schema,
[SourceName.S3]: s3.schema,
[SourceName.AIRTABLE]: airtable.schema,
[SourceName.MYSQL]: mysql.schema,
[SourceName.ARANGODB]: arangodb.schema,
[SourceName.REST]: rest.schema,
[SourceName.FIRESTORE]: firebase.schema,
[SourceName.GOOGLE_SHEETS]: googlesheets.schema,
[SourceName.REDIS]: redis.schema,
[SourceName.SNOWFLAKE]: snowflake.schema,
[SourceName.ORACLE]: oracle.schema,
/* deprecated - not available through UI */
[SourceName.ARANGODB]: arangodb.schema,
[SourceName.AIRTABLE]: airtable.schema,
/* un-used */
[SourceName.BUDIBASE]: undefined,
}
@ -56,15 +58,17 @@ const INTEGRATIONS: Record<SourceName, IntegrationBaseConstructor | undefined> =
[SourceName.COUCHDB]: couchdb.integration,
[SourceName.SQL_SERVER]: sqlServer.integration,
[SourceName.S3]: s3.integration,
[SourceName.AIRTABLE]: airtable.integration,
[SourceName.MYSQL]: mysql.integration,
[SourceName.ARANGODB]: arangodb.integration,
[SourceName.REST]: rest.integration,
[SourceName.FIRESTORE]: firebase.integration,
[SourceName.GOOGLE_SHEETS]: googlesheets.integration,
[SourceName.REDIS]: redis.integration,
[SourceName.SNOWFLAKE]: snowflake.integration,
[SourceName.ORACLE]: oracle.integration,
/* deprecated - not available through UI */
[SourceName.ARANGODB]: arangodb.integration,
[SourceName.AIRTABLE]: airtable.integration,
/* un-used */
[SourceName.BUDIBASE]: undefined,
}

76
packages/server/src/integrations/tests/airtable.spec.ts
View File

@ -1,76 +0,0 @@
import { default as AirtableIntegration } from "../airtable"
jest.mock("airtable")
class TestConfiguration {
integration: any
client: any
constructor(config: any = {}) {
this.integration = new AirtableIntegration.integration(config)
this.client = {
create: jest.fn(),
select: jest.fn(() => ({
firstPage: jest.fn(() => []),
})),
update: jest.fn(),
destroy: jest.fn(),
}
this.integration.client = () => this.client
}
}
describe("Airtable Integration", () => {
let config: any
beforeEach(() => {
config = new TestConfiguration()
})
it("calls the create method with the correct params", async () => {
await config.integration.create({
table: "test",
json: {},
})
expect(config.client.create).toHaveBeenCalledWith([
{
fields: {},
},
])
})
it("calls the read method with the correct params", async () => {
await config.integration.read({
table: "test",
view: "Grid view",
})
expect(config.client.select).toHaveBeenCalledWith({
maxRecords: 10,
view: "Grid view",
})
})
it("calls the update method with the correct params", async () => {
await config.integration.update({
table: "table",
id: "123",
json: {
name: "test",
},
})
expect(config.client.update).toHaveBeenCalledWith([
{
id: "123",
fields: { name: "test" },
},
])
})
it("calls the delete method with the correct params", async () => {
const ids = [1, 2, 3, 4]
await config.integration.delete({
ids,
})
expect(config.client.destroy).toHaveBeenCalledWith(ids)
})
})

38
packages/server/src/integrations/tests/arangodb.spec.ts
View File

@ -1,38 +0,0 @@
import { default as ArangoDBIntegration } from "../arangodb"
jest.mock("arangojs")
class TestConfiguration {
integration: any
constructor(config: any = {}) {
this.integration = new ArangoDBIntegration.integration(config)
}
}
describe("ArangoDB Integration", () => {
let config: any
beforeEach(() => {
config = new TestConfiguration()
})
it("calls the create method with the correct params", async () => {
const body = {
json: "Hello",
}
await config.integration.create(body)
expect(config.integration.client.query).toHaveBeenCalledWith(
`INSERT Hello INTO collection RETURN NEW`
)
})
it("calls the read method with the correct params", async () => {
const query = {
sql: `test`,
}
await config.integration.read(query)
expect(config.integration.client.query).toHaveBeenCalledWith(query.sql)
})
})

7
packages/server/src/tests/utilities/api/automation.ts
View File

@ -133,4 +133,11 @@ export class AutomationAPI extends TestAPI {
}
)
}
deleteAll = async (expectations?: Expectations): Promise<void> => {
const { automations } = await this.fetch()
await Promise.all(
automations.map(automation => this.delete(automation, expectations))
)
}
}

51
packages/server/src/tests/utilities/api/environment.ts Normal file
View File

@ -0,0 +1,51 @@
import { Expectations, TestAPI } from "./base"
import {
CreateEnvironmentVariableRequest,
CreateEnvironmentVariableResponse,
GetEnvironmentVariablesResponse,
StatusEnvironmentVariableResponse,
UpdateEnvironmentVariableRequest,
} from "@budibase/types"
export class EnvironmentAPI extends TestAPI {
create = async (
body: CreateEnvironmentVariableRequest,
expectations?: Expectations
) => {
return await this._post<CreateEnvironmentVariableResponse>(
`/api/env/variables`,
{ body, expectations }
)
}
status = async (expectations?: Expectations) => {
return await this._get<StatusEnvironmentVariableResponse>(
`/api/env/variables/status`,
{ expectations }
)
}
fetch = async (expectations?: Expectations) => {
return await this._get<GetEnvironmentVariablesResponse>(
`/api/env/variables`,
{ expectations }
)
}
update = async (
varName: string,
body: UpdateEnvironmentVariableRequest,
expectations?: Expectations
) => {
return await this._patch<void>(`/api/env/variables/${varName}`, {
body,
expectations,
})
}
destroy = async (varName: string, expectations?: Expectations) => {
return await this._delete<void>(`/api/env/variables/${varName}`, {
expectations,
})
}
}

3
packages/server/src/tests/utilities/api/index.ts
View File

@ -17,6 +17,7 @@ import { RowActionAPI } from "./rowAction"
import { AutomationAPI } from "./automation"
import { PluginAPI } from "./plugin"
import { WebhookAPI } from "./webhook"
import { EnvironmentAPI } from "./environment"
import { UserPublicAPI } from "./public/user"
export default class API {
@ -25,6 +26,7 @@ export default class API {
automation: AutomationAPI
backup: BackupAPI
datasource: DatasourceAPI
environment: EnvironmentAPI
legacyView: LegacyViewAPI
permission: PermissionAPI
plugin: PluginAPI
@ -49,6 +51,7 @@ export default class API {
this.automation = new AutomationAPI(config)
this.backup = new BackupAPI(config)
this.datasource = new DatasourceAPI(config)
this.environment = new EnvironmentAPI(config)
this.legacyView = new LegacyViewAPI(config)
this.permission = new PermissionAPI(config)
this.plugin = new PluginAPI(config)

3
packages/server/src/tests/utilities/structures.ts
View File

@ -37,6 +37,7 @@ import {
DeepPartial,
FilterCondition,
AutomationTriggerResult,
CreateEnvironmentVariableRequest,
} from "@budibase/types"
import { LoopInput } from "../../definitions/automations"
import { merge } from "lodash"
@ -574,7 +575,7 @@ export function basicEnvironmentVariable(
name: string,
prod: string,
dev?: string
) {
): CreateEnvironmentVariableRequest {
return {
name,
production: prod,