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

Simplify calls to createAutomationBuilder.

This commit is contained in:
Sam Rose 2025-02-05 17:39:38 +00:00
parent d2902464c0
commit d62be2629c
No known key found for this signature in database
24 changed files with 109 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
packages/server/src/api/routes/tests/automation.spec.ts
View File

@ -107,10 +107,7 @@ describe("/automations", () => {
})
it("Should ensure you can't have a branch as not a last step", async () => {
const automation = createAutomationBuilder({
name: "String Equality Branching",
appId: config.getAppId(),
})
const automation = createAutomationBuilder(config)
.appAction({ fields: { status: "active" } })
.branch({
activeBranch: {
@ -134,10 +131,7 @@ describe("/automations", () => {
})
it("Should check validation on an automation that has a branch step with no children", async () => {
const automation = createAutomationBuilder({
name: "String Equality Branching",
appId: config.getAppId(),
})
const automation = createAutomationBuilder(config)
.appAction({ fields: { status: "active" } })
.branch({})
.serverLog({ text: "Inactive user" })
@ -153,10 +147,7 @@ describe("/automations", () => {
})
it("Should check validation on a branch step with empty conditions", async () => {
const automation = createAutomationBuilder({
name: "String Equality Branching",
appId: config.getAppId(),
})
const automation = createAutomationBuilder(config)
.appAction({ fields: { status: "active" } })
.branch({
activeBranch: {
@ -177,10 +168,7 @@ describe("/automations", () => {
})
it("Should check validation on an branch that has a condition that is not valid", async () => {
const automation = createAutomationBuilder({
name: "String Equality Branching",
appId: config.getAppId(),
})
const automation = createAutomationBuilder(config)
.appAction({ fields: { status: "active" } })
.branch({
activeBranch: {
@ -252,11 +240,7 @@ describe("/automations", () => {
})
it("should be able to access platformUrl, logoUrl and company in the automation", async () => {
const result = await createAutomationBuilder({
name: "Test Automation",
appId: config.getAppId(),
config,
})
const result = await createAutomationBuilder(config)
.serverLog({
text: "{{ settings.url }}",
})

14
packages/server/src/automations/tests/branching.spec.ts
View File

@ -24,7 +24,7 @@ describe("Branching automations", () => {
const branch2LogId = "33333333-3333-3333-3333-333333333333"
const branch2Id = "44444444-4444-4444-4444-444444444444"
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.serverLog(
{ text: "Starting automation" },
{ stepName: "FirstLog", stepId: firstLogId }
@ -82,7 +82,7 @@ describe("Branching automations", () => {
})
it("should execute correct branch based on string equality", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "active" } })
.branch({
activeBranch: {
@ -107,7 +107,7 @@ describe("Branching automations", () => {
})
it("should handle multiple conditions with AND operator", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "active", role: "admin" } })
.branch({
activeAdminBranch: {
@ -135,7 +135,7 @@ describe("Branching automations", () => {
})
it("should handle multiple conditions with OR operator", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "test", role: "user" } })
.branch({
specialBranch: {
@ -167,7 +167,7 @@ describe("Branching automations", () => {
})
it("should stop the branch automation when no conditions are met", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { status: "test", role: "user" } })
.createRow({ row: { name: "Test", tableId: table._id } })
.branch({
@ -203,7 +203,7 @@ describe("Branching automations", () => {
})
it("evaluate multiple conditions", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { test_trigger: true } })
.serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" })
.branch({
@ -244,7 +244,7 @@ describe("Branching automations", () => {
})
it("evaluate multiple conditions with interpolated text", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { test_trigger: true } })
.serverLog({ text: "Starting automation" }, { stepId: "aN6znRYHG" })
.branch({

22
packages/server/src/automations/tests/scenarios.spec.ts
View File

@ -29,7 +29,7 @@ describe("Automation Scenarios", () => {
it("should trigger an automation which then creates a row", async () => {
const table = await config.api.table.save(basicTable())
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.rowUpdated(
{ tableId: table._id! },
{
@ -65,7 +65,7 @@ describe("Automation Scenarios", () => {
}
await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows({
tableId: table._id!,
})
@ -83,7 +83,7 @@ describe("Automation Scenarios", () => {
}
await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows({
tableId: table._id!,
})
@ -124,7 +124,7 @@ describe("Automation Scenarios", () => {
},
})
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.createRow(
{
row: {
@ -192,7 +192,7 @@ describe("Automation Scenarios", () => {
}
await config.api.row.save(table._id!, row)
await config.api.row.save(table._id!, row)
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -241,7 +241,7 @@ describe("Automation Scenarios", () => {
})
it("should stop an automation if the condition is not met", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.createRow({
row: {
name: "Equal Test",
@ -266,7 +266,7 @@ describe("Automation Scenarios", () => {
})
it("should continue the automation if the condition is met", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.createRow({
row: {
name: "Not Equal Test",
@ -332,7 +332,7 @@ describe("Automation Scenarios", () => {
it.each(testCases)(
"should pass the filter when condition is $condition",
async ({ condition, value, rowValue, expectPass }) => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.createRow({
row: {
name: `${condition} Test`,
@ -366,7 +366,7 @@ describe("Automation Scenarios", () => {
it("Check user is passed through from row trigger", async () => {
const table = await config.api.table.save(basicTable())
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.rowUpdated(
{ tableId: table._id! },
{
@ -381,7 +381,7 @@ describe("Automation Scenarios", () => {
})
it("Check user is passed through from app trigger", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.serverLog({ text: "{{ [user].[email] }}" })
.run()
@ -452,7 +452,7 @@ if (descriptions.length) {
queryVerb: "read",
})
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({
fields: {},
})

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

@ -24,7 +24,7 @@ describe("Execute Bash Automations", () => {
})
it("should use trigger data in bash command and pass output to subsequent steps", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { command: "hello world" } })
.bash(
{ code: "echo '{{ trigger.fields.command }}'" },
@ -43,7 +43,7 @@ describe("Execute Bash Automations", () => {
})
it("should chain multiple bash commands using previous outputs", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { filename: "testfile.txt" } })
.bash(
{ code: "echo 'initial content' > {{ trigger.fields.filename }}" },
@ -64,7 +64,7 @@ describe("Execute Bash Automations", () => {
})
it("should integrate bash output with row operations", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -93,7 +93,7 @@ describe("Execute Bash Automations", () => {
})
it("should handle bash output in conditional logic", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { threshold: "5" } })
.bash(
{ code: "echo $(( {{ trigger.fields.threshold }} + 5 ))" },
@ -120,7 +120,7 @@ describe("Execute Bash Automations", () => {
})
it("should handle null values gracefully", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.bash(
// @ts-expect-error - testing null input
{ code: null },

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

@ -40,7 +40,7 @@ describe("test the create row action", () => {
})
it("should be able to run the action", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "new" } })
.serverLog({ text: "Starting create row flow" }, { stepName: "StartLog" })
.createRow({ row }, { stepName: "CreateRow" })
@ -66,7 +66,7 @@ describe("test the create row action", () => {
})
it("should return an error (not throw) when bad info provided", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "error" } })
.serverLog({ text: "Starting error test flow" }, { stepName: "StartLog" })
.createRow(
@ -84,7 +84,7 @@ describe("test the create row action", () => {
})
it("should check invalid inputs return an error", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { status: "invalid" } })
.serverLog({ text: "Testing invalid input" }, { stepName: "StartLog" })
.createRow({ row: {} }, { stepName: "CreateRow" })
@ -122,7 +122,7 @@ describe("test the create row action", () => {
]
attachmentRow.file_attachment = attachmentObject
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "attachment" } })
.serverLog(
{ text: "Processing attachment upload" },
@ -173,7 +173,7 @@ describe("test the create row action", () => {
}
attachmentRow.single_file_attachment = attachmentObject
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "single-attachment" } })
.serverLog(
{ text: "Processing single attachment" },
@ -244,7 +244,7 @@ describe("test the create row action", () => {
}
attachmentRow.single_file_attachment = attachmentObject
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.appAction({ fields: { type: "invalid-attachment" } })
.serverLog(
{ text: "Testing invalid attachment keys" },

2
packages/server/src/automations/tests/steps/cron-automations.spec.ts
View File

@ -27,7 +27,7 @@ describe("cron automations", () => {
})
it("should initialise the automation timestamp", async () => {
await createAutomationBuilder({ config }).cron({ cron: "* * * * *" }).save()
await createAutomationBuilder(config).cron({ cron: "* * * * *" }).save()
tk.travel(Date.now() + oneMinuteInMs)
await config.publish()

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

@ -16,7 +16,7 @@ describe("test the delay logic", () => {
const time = 100
const before = performance.now()
await createAutomationBuilder({ config }).delay({ time }).run()
await createAutomationBuilder(config).delay({ time }).run()
const now = performance.now()

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

@ -20,7 +20,7 @@ describe("test the delete row action", () => {
})
it("should be able to run the delete row action", async () => {
await createAutomationBuilder({ config })
await createAutomationBuilder(config)
.deleteRow({
tableId: table._id!,
id: row._id!,
@ -34,7 +34,7 @@ describe("test the delete row action", () => {
})
it("should check invalid inputs return an error", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.deleteRow({ tableId: "", id: "", revision: "" })
.run()
@ -42,7 +42,7 @@ describe("test the delete row action", () => {
})
it("should return an error when table doesn't exist", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.deleteRow({
tableId: "invalid",
id: "invalid",

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

@ -19,7 +19,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.discord({
url: "http://www.example.com",
username: "joe_bloggs",

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

@ -20,7 +20,7 @@ describe("Execute Script Automations", () => {
})
it("should execute a basic script and return the result", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.executeScript({ code: "return 2 + 2" })
.run()
@ -28,7 +28,7 @@ describe("Execute Script Automations", () => {
})
it("should access bindings from previous steps", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { data: [1, 2, 3] } })
.executeScript(
{
@ -42,7 +42,7 @@ describe("Execute Script Automations", () => {
})
it("should handle script execution errors gracefully", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.executeScript({ code: "return nonexistentVariable.map(x => x)" })
.run()
@ -53,7 +53,7 @@ describe("Execute Script Automations", () => {
})
it("should handle conditional logic in scripts", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: { value: 10 } })
.executeScript({
code: `
@ -70,7 +70,8 @@ describe("Execute Script Automations", () => {
})
it("should use multiple steps and validate script execution", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.appAction({ fields: {} })
.serverLog(
{ text: "Starting multi-step automation" },
{ stepId: "start-log-step" }

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

@ -42,7 +42,7 @@ describe("test the filter logic", () => {
[new Date().toISOString(), ">", new Date(-10000).toISOString()],
]
it.each(pass)("should pass %p %p %p", async (field, condition, value) => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.filter({ field, condition: stringToFilterCondition(condition), value })
.run()
@ -59,7 +59,7 @@ describe("test the filter logic", () => {
[{}, "==", {}],
]
it.each(fail)("should fail %p %p %p", async (field, condition, value) => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.filter({ field, condition: stringToFilterCondition(condition), value })
.run()

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

@ -72,7 +72,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should run an automation with a trigger, loop, and create row step", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.rowSaved(
{ tableId: table._id! },
{
@ -115,7 +115,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should run an automation where a loop step is between two normal steps to ensure context correctness", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.rowSaved(
{ tableId: table._id! },
{
@ -151,7 +151,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("if an incorrect type is passed to the loop it should return an error", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop({
option: LoopStepType.ARRAY,
binding: "1, 2, 3",
@ -166,7 +166,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("ensure the loop stops if the failure condition is reached", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop({
option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"],
@ -184,7 +184,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("ensure the loop stops if the max iterations are reached", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop({
option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"],
@ -198,7 +198,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should run an automation with loop and max iterations to ensure context correctness further down the tree", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop({
option: LoopStepType.ARRAY,
binding: ["test", "test2", "test3"],
@ -212,7 +212,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should run an automation where a loop is successfully run twice", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.rowSaved(
{ tableId: table._id! },
{
@ -274,7 +274,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should run an automation where a loop is used twice to ensure context correctness further down the tree", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop({
option: LoopStepType.ARRAY,
binding: [1, 2, 3],
@ -295,7 +295,7 @@ describe("Attempt to run a basic loop automation", () => {
})
it("should use automation names to loop with", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.loop(
{
option: LoopStepType.ARRAY,
@ -346,7 +346,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows({
tableId: table._id!,
})
@ -425,7 +425,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -507,7 +507,7 @@ describe("Attempt to run a basic loop automation", () => {
await config.api.row.bulkImport(table._id!, { rows })
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.queryRows({
tableId: table._id!,
})

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

@ -19,7 +19,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.make({
url: "http://www.example.com",
body: null,
@ -45,7 +45,7 @@ describe("test the outgoing webhook action", () => {
.post("/", payload)
.reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.make({
body: { value: JSON.stringify(payload) },
url: "http://www.example.com",
@ -57,7 +57,7 @@ describe("test the outgoing webhook action", () => {
})
it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.make({
body: { value: "{ invalid json }" },
url: "http://www.example.com",

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

@ -20,7 +20,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action and default to 'get'", async () => {
nock("http://www.example.com/").get("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.n8n({
url: "http://www.example.com",
body: { test: "IGNORE_ME" },
@ -38,7 +38,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { name: "Adam", age: 9 })
.reply(200)
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.n8n({
url: "http://www.example.com",
body: { value: JSON.stringify({ name: "Adam", age: 9 }) },
@ -51,7 +51,7 @@ describe("test the outgoing webhook action", () => {
})
it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.n8n({
url: "http://www.example.com",
body: { value: "{ value1 1 }" },
@ -70,7 +70,7 @@ describe("test the outgoing webhook action", () => {
.head("/", body => body === "")
.reply(200)
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.n8n({
url: "http://www.example.com",
method: HttpMethod.HEAD,

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

@ -57,7 +57,7 @@ describe("test the openai action", () => {
// means it goes through the "legacy" path which requires you to set your
// own API key. We don't count this against your quota.
const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config })
createAutomationBuilder(config)
.openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI })
.run()
)
@ -68,7 +68,7 @@ describe("test the openai action", () => {
it("should present the correct error message when a prompt is not provided", async () => {
const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config })
createAutomationBuilder(config)
.openai({ prompt: "", model: Model.GPT_4O_MINI })
.run()
)
@ -83,7 +83,7 @@ describe("test the openai action", () => {
mockChatGPTError()
const result = await expectAIUsage(0, () =>
createAutomationBuilder({ config })
createAutomationBuilder(config)
.openai({ prompt: "Hello, world", model: Model.GPT_4O_MINI })
.run()
)
@ -105,7 +105,7 @@ describe("test the openai action", () => {
// calculation we use to approximate cost. This uses Budibase's OpenAI API
// key, so we charge users for it.
const result = await expectAIUsage(14, () =>
createAutomationBuilder({ config })
createAutomationBuilder(config)
.openai({ model: Model.GPT_4O_MINI, prompt: "Hello, world" })
.run()
)

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

@ -23,7 +23,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { a: 1 })
.reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.outgoingWebhook({
requestMethod: RequestType.POST,
url: "http://www.example.com",
@ -38,7 +38,7 @@ describe("test the outgoing webhook action", () => {
})
it("should return an error if something goes wrong in fetch", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.outgoingWebhook({
requestMethod: RequestType.GET,
url: "www.invalid.com",

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

@ -28,10 +28,7 @@ describe("Test a query step automation", () => {
})
it("should be able to run the query step", async () => {
const result = await createAutomationBuilder({
name: "Basic Query Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -55,10 +52,7 @@ describe("Test a query step automation", () => {
})
it("Returns all rows when onEmptyFilter has no value and no filters are passed", async () => {
const result = await createAutomationBuilder({
name: "Empty Filter Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -78,10 +72,7 @@ describe("Test a query step automation", () => {
})
it("Returns no rows when onEmptyFilter is RETURN_NONE and theres no filters", async () => {
const result = await createAutomationBuilder({
name: "Return None Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -102,10 +93,7 @@ describe("Test a query step automation", () => {
})
it("Returns no rows when onEmptyFilters RETURN_NONE and a filter is passed with a null value", async () => {
const result = await createAutomationBuilder({
name: "Null Filter Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -130,10 +118,7 @@ describe("Test a query step automation", () => {
})
it("Returns rows when onEmptyFilter is RETURN_ALL and no filter is passed", async () => {
const result = await createAutomationBuilder({
name: "Return All Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: table._id!,
@ -160,10 +145,7 @@ describe("Test a query step automation", () => {
await config.api.row.save(tableWithSpaces._id!, {
name: NAME,
})
const result = await createAutomationBuilder({
name: "Return All Test",
config,
})
const result = await createAutomationBuilder(config)
.queryRows(
{
tableId: tableWithSpaces._id!,

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

@ -13,7 +13,7 @@ describe("test the server log action", () => {
})
it("should be able to log the text", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.serverLog({ text: "Hello World" })
.run()
expect(result.steps[0].outputs.message).toEqual(

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

@ -17,11 +17,11 @@ describe("Test triggering an automation from another automation", () => {
})
it("should trigger an other server log automation", async () => {
const automation = await createAutomationBuilder({ config })
const automation = await createAutomationBuilder(config)
.serverLog({ text: "Hello World" })
.save()
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.triggerAutomationRun({
automation: {
automationId: automation._id!,
@ -34,7 +34,7 @@ describe("Test triggering an automation from another automation", () => {
})
it("should fail gracefully if the automation id is incorrect", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.triggerAutomationRun({
automation: {
// @ts-expect-error - incorrect on purpose

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

@ -30,7 +30,7 @@ describe("test the update row action", () => {
})
it("should be able to run the update row action", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.updateRow({
rowId: row._id!,
row: {
@ -52,7 +52,7 @@ describe("test the update row action", () => {
})
it("should check invalid inputs return an error", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.updateRow({ meta: {}, row: {}, rowId: "" })
.run()
@ -60,7 +60,7 @@ describe("test the update row action", () => {
})
it("should return an error when table doesn't exist", async () => {
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.updateRow({
row: { _id: "invalid" },
rowId: "invalid",
@ -103,7 +103,7 @@ describe("test the update row action", () => {
user2: [{ _id: user2._id }],
})
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.updateRow({
rowId: row._id!,
row: {
@ -156,7 +156,7 @@ describe("test the update row action", () => {
user2: [{ _id: user2._id }],
})
const results = await createAutomationBuilder({ config })
const results = await createAutomationBuilder(config)
.updateRow({
rowId: row._id!,
row: {

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

@ -20,7 +20,7 @@ describe("test the outgoing webhook action", () => {
it("should be able to run the action", async () => {
nock("http://www.example.com/").post("/").reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.zapier({ url: "http://www.example.com", body: null })
.run()
@ -43,7 +43,7 @@ describe("test the outgoing webhook action", () => {
.post("/", { ...payload, platform: "budibase" })
.reply(200, { foo: "bar" })
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.zapier({
url: "http://www.example.com",
body: { value: JSON.stringify(payload) },
@ -55,7 +55,7 @@ describe("test the outgoing webhook action", () => {
})
it("should return a 400 if the JSON payload string is malformed", async () => {
const result = await createAutomationBuilder({ config })
const result = await createAutomationBuilder(config)
.zapier({
url: "http://www.example.com",
body: { value: "{ invalid json }" },

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

@ -24,7 +24,7 @@ describe("cron trigger", () => {
})
})
await createAutomationBuilder({ config })
await createAutomationBuilder(config)
.cron({ cron: "* * * * *" })
.serverLog({
text: "Hello, world!",
@ -44,7 +44,7 @@ describe("cron trigger", () => {
})
it("should fail if the cron expression is invalid", async () => {
await createAutomationBuilder({ config })
await createAutomationBuilder(config)
.cron({ cron: "* * * * * *" })
.serverLog({
text: "Hello, world!",

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

@ -11,7 +11,7 @@ describe("Branching automations", () => {
let webhook: Webhook
async function createWebhookAutomation() {
const automation = await createAutomationBuilder({ config })
const automation = await createAutomationBuilder(config)
.webhook({ fields: { parameter: "string" } })
.createRow({
row: { tableId: table._id!, name: "{{ trigger.parameter }}" },

31
packages/server/src/automations/tests/utilities/AutomationTestBuilder.ts
View File

@ -135,14 +135,12 @@ class AutomationBuilder extends BaseStepBuilder {
private triggerOutputs: TriggerOutputs
private triggerSet = false
constructor(
options: { name?: string; appId?: string; config?: TestConfiguration } = {}
) {
constructor(config?: TestConfiguration) {
super()
this.config = options.config || setup.getConfig()
this.config = config || setup.getConfig()
this.triggerOutputs = { fields: {} }
this.automationConfig = {
name: options.name || `Test Automation ${uuidv4()}`,
name: `Test Automation ${uuidv4()}`,
definition: {
steps: [],
trigger: {
@ -154,10 +152,15 @@ class AutomationBuilder extends BaseStepBuilder {
stepNames: {},
},
type: "automation",
appId: options.appId ?? this.config.getAppId(),
appId: this.config.getAppId(),
}
}
name(n: string): this {
this.automationConfig.name = n
return this
}
protected triggerInputOutput<
TStep extends AutomationTriggerStepId,
TInput = AutomationTriggerInputs<TStep>,
@ -195,10 +198,13 @@ class AutomationBuilder extends BaseStepBuilder {
}
}
// The input and output for appAction is identical, and we only ever seem to
// set the output, so we're ignoring the input for now.
appAction = this.triggerOutputOnly(AutomationTriggerStepId.APP)
rowSaved = this.triggerInputOutput(AutomationTriggerStepId.ROW_SAVED)
rowUpdated = this.triggerInputOutput(AutomationTriggerStepId.ROW_UPDATED)
rowDeleted = this.triggerInputOutput(AutomationTriggerStepId.ROW_DELETED)
appAction = this.triggerOutputOnly(AutomationTriggerStepId.APP)
webhook = this.triggerInputOutput(AutomationTriggerStepId.WEBHOOK)
cron = this.triggerInputOutput(AutomationTriggerStepId.CRON)
@ -214,9 +220,6 @@ class AutomationBuilder extends BaseStepBuilder {
}
async save() {
if (!Object.keys(this.automationConfig.definition.trigger).length) {
throw new Error("Please add a trigger to this automation test")
}
this.automationConfig.definition.steps = this.steps
const { automation } = await this.config.api.automation.post(this.build())
return automation
@ -241,10 +244,6 @@ class AutomationBuilder extends BaseStepBuilder {
}
}
export function createAutomationBuilder(options?: {
name?: string
appId?: string
config?: TestConfiguration
}) {
return new AutomationBuilder(options)
export function createAutomationBuilder(config?: TestConfiguration) {
return new AutomationBuilder(config)
}