paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 20 Packages Projects Releases Wiki Activity

+ unit test

Browse Source 
Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
This commit is contained in:
bnechyporenko
2024-02-11 23:14:05 +01:00
parent fb07d87c0d
commit f94cd8bf3e
8 changed files with 131 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-backend/api-report.md
+27 -33
View File
@@ -411,17 +411,15 @@ export class DatabaseTaskStore implements TaskStore {
// (undocumented)
getTaskState({ taskId }: { taskId: string }): Promise<
| {
state: {
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;
@@ -567,17 +565,15 @@ export class TaskManager implements TaskContext {
// (undocumented)
getTaskState?(): Promise<
| {
state: {
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;
@@ -632,17 +628,15 @@ export interface TaskStore {
// (undocumented)
getTaskState?({ taskId }: { taskId: string }): Promise<
| {
state: {
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;
plugins/scaffolder-backend/src/scaffolder/tasks/DatabaseTaskStore.ts
+14 -18
View File
@@ -397,14 +397,12 @@ export class DatabaseTaskStore implements TaskStore {
async getTaskState({ taskId }: { taskId: string }): Promise<
| {
state: {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
}
| undefined
> {
@@ -412,16 +410,14 @@ export class DatabaseTaskStore implements TaskStore {
.where({ id: taskId })
.select('state');
return result.state
? {
state: JSON.parse(result.state) as unknown as {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
},
}
? (JSON.parse(result.state) as unknown as {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
})
: undefined;
}
plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.test.ts
+53 -36
View File
@@ -18,6 +18,7 @@ import { getVoidLogger } from '@backstage/backend-common';
import { NunjucksWorkflowRunner } from './NunjucksWorkflowRunner';
import { TemplateActionRegistry } from '../actions';
import { ScmIntegrations } from '@backstage/integration';
import { JsonValue } from '@backstage/types';
import { ConfigReader } from '@backstage/config';
import { TaskContext } from './types';
import { TaskSpec } from '@backstage/plugin-scaffolder-common';
@@ -137,29 +138,19 @@ describe('NunjucksWorkflowRunner', () => {
id: 'checkpoints-action',
description: 'Mock action with checkpoints',
handler: async ctx => {
let key1 = 0;
let key2 = '';
let i = 0;
const incrementKey1 = async () => {
key1 += 1;
return key1;
};
const appendKey2 = async () => {
key2 += 'k';
return key2;
};
while (i < 3) {
i += 1;
ctx.checkpoint?.('key1', incrementKey1);
}
ctx.checkpoint?.('key2', appendKey2);
const key1 = await ctx.checkpoint?.('key1', async () => {
return 'updated';
});
const key2 = await ctx.checkpoint?.('key2', async () => {
return 'updated';
});
const key3 = await ctx.checkpoint?.('key3', async () => {
return 'updated';
});
ctx.output('key1', key1);
ctx.output('key2', key2);
ctx.output('key3', key3);
},
});
@@ -569,26 +560,52 @@ describe('NunjucksWorkflowRunner', () => {
});
it('should deal with checkpoints', async () => {
const task = createMockTaskWithSpec({
apiVersion: 'scaffolder.backstage.io/v1beta3',
parameters: {},
steps: [
{
id: 'test',
name: 'name',
action: 'checkpoints-action',
input: { foo: 1 },
const task = {
...createMockTaskWithSpec({
apiVersion: 'scaffolder.backstage.io/v1beta3',
parameters: {},
steps: [
{
id: 'test',
name: 'name',
action: 'checkpoints-action',
input: { foo: 1 },
},
],
output: {
key1: '${{steps.test.output.key1}}',
key2: '${{steps.test.output.key2}}',
key3: '${{steps.test.output.key3}}',
},
],
output: {
key1: '${{steps.test.output.key1}}',
key2: '${{steps.test.output.key2}}',
}),
getTaskState: (): Promise<
| {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
}
| undefined
> => {
return Promise.resolve({
['v1.task.checkpoint.key1']: {
status: 'success',
value: 'initial',
},
['v1.task.checkpoint.key2']: {
status: 'failed',
reason: 'fatal error',
},
});
},
});
};
const result = await runner.execute(task);
expect(result.output.key1).toEqual(3);
expect(result.output.key2).toEqual('k');
expect(result.output.key1).toEqual('initial');
expect(result.output.key2).toEqual('updated');
expect(result.output.key3).toEqual('updated');
});
it('should template the output from simple actions', async () => {
plugins/scaffolder-backend/src/scaffolder/tasks/NunjucksWorkflowRunner.ts
+10 -7
View File
@@ -358,18 +358,21 @@ export class NunjucksWorkflowRunner implements WorkflowRunner {
try {
let prevValue: U | undefined;
if (prevTaskState) {
const prevState = prevTaskState.state[key];
if (prevState.status === 'success') {
const prevState = prevTaskState[key];
if (prevState && prevState.status === 'success') {
prevValue = prevState.value as U;
}
}
const value = prevValue ? prevValue : await fn();
task.updateCheckpoint?.({
key,
status: 'success',
value,
});
if (!prevValue) {
task.updateCheckpoint?.({
key,
status: 'success',
value,
});
}
return value;
} catch (err) {
task.updateCheckpoint?.({
plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts
+6 -8
View File
@@ -93,14 +93,12 @@ export class TaskManager implements TaskContext {
async getTaskState?(): Promise<
| {
state: {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
}
| undefined
> {
plugins/scaffolder-backend/src/scaffolder/tasks/types.ts
+6 -8
View File
@@ -196,14 +196,12 @@ export interface TaskStore {
getTaskState?({ taskId }: { taskId: string }): Promise<
| {
state: {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;
plugins/scaffolder-node/api-report.md
+9 -11
View File
@@ -351,17 +351,15 @@ export interface TaskContext {
// (undocumented)
getTaskState?(): Promise<
| {
state: {
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| {
status: 'failed';
reason: string;
}
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;
plugins/scaffolder-node/src/tasks/types.ts
+6 -8
View File
@@ -128,14 +128,12 @@ export interface TaskContext {
getTaskState?(): Promise<
| {
state: {
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
};
[key: string]:
| { status: 'failed'; reason: string }
| {
status: 'success';
value: JsonValue;
};
}
| undefined
>;