@backstage/plugin-scaffolder-node-test-utils 0.2.3-next.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,41 @@
|
|
|
1
1
|
# @backstage/plugin-scaffolder-node-test-utils
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 3cea7ee: **BREAKING CHANGES**
|
|
8
|
+
|
|
9
|
+
Because of the removal of the `logStream` property to the `ActionsContext` this has been removed from the `createMockActionContext` method.
|
|
10
|
+
|
|
11
|
+
You can remove this as it's no longer supported in the scaffolder actions.
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies
|
|
16
|
+
- @backstage/plugin-scaffolder-node@0.9.0
|
|
17
|
+
- @backstage/backend-test-utils@1.6.0
|
|
18
|
+
- @backstage/backend-plugin-api@1.4.0
|
|
19
|
+
- @backstage/types@1.2.1
|
|
20
|
+
|
|
21
|
+
## 0.3.0-next.2
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- 3cea7ee: **BREAKING CHANGES**
|
|
26
|
+
|
|
27
|
+
Because of the removal of the `logStream` property to the `ActionsContext` this has been removed from the `createMockActionContext` method.
|
|
28
|
+
|
|
29
|
+
You can remove this as it's no longer supported in the scaffolder actions.
|
|
30
|
+
|
|
31
|
+
### Patch Changes
|
|
32
|
+
|
|
33
|
+
- Updated dependencies
|
|
34
|
+
- @backstage/plugin-scaffolder-node@0.9.0-next.2
|
|
35
|
+
- @backstage/backend-test-utils@1.6.0-next.2
|
|
36
|
+
- @backstage/backend-plugin-api@1.4.0-next.1
|
|
37
|
+
- @backstage/types@1.2.1
|
|
38
|
+
|
|
3
39
|
## 0.2.3-next.1
|
|
4
40
|
|
|
5
41
|
### Patch Changes
|
|
@@ -4,7 +4,7 @@ var stream = require('stream');
|
|
|
4
4
|
var backendTestUtils = require('@backstage/backend-test-utils');
|
|
5
5
|
var loggerToWinstonLogger = require('./loggerToWinstonLogger.cjs.js');
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
function createMockActionContext(options) {
|
|
8
8
|
const credentials = backendTestUtils.mockCredentials.user();
|
|
9
9
|
const defaultContext = {
|
|
10
10
|
logger: loggerToWinstonLogger.loggerToWinstonLogger(backendTestUtils.mockServices.logger.mock()),
|
|
@@ -29,16 +29,7 @@ const createMockActionContext = (options) => {
|
|
|
29
29
|
...createDefaultWorkspace()
|
|
30
30
|
};
|
|
31
31
|
}
|
|
32
|
-
const {
|
|
33
|
-
input,
|
|
34
|
-
logger,
|
|
35
|
-
logStream,
|
|
36
|
-
secrets,
|
|
37
|
-
templateInfo,
|
|
38
|
-
workspacePath,
|
|
39
|
-
task,
|
|
40
|
-
user
|
|
41
|
-
} = options;
|
|
32
|
+
const { input, logger, secrets, templateInfo, workspacePath, task, user } = options;
|
|
42
33
|
return {
|
|
43
34
|
...defaultContext,
|
|
44
35
|
...workspacePath ? { workspacePath } : createDefaultWorkspace(),
|
|
@@ -46,14 +37,13 @@ const createMockActionContext = (options) => {
|
|
|
46
37
|
createTemporaryDirectory: jest.fn().mockResolvedValue(workspacePath)
|
|
47
38
|
},
|
|
48
39
|
...logger && { logger },
|
|
49
|
-
...logStream && { logStream },
|
|
50
40
|
...input && { input },
|
|
51
41
|
...secrets && { secrets },
|
|
52
42
|
...task && { task },
|
|
53
43
|
...user && { user },
|
|
54
44
|
templateInfo
|
|
55
45
|
};
|
|
56
|
-
}
|
|
46
|
+
}
|
|
57
47
|
|
|
58
48
|
exports.createMockActionContext = createMockActionContext;
|
|
59
49
|
//# sourceMappingURL=mockActionContext.cjs.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mockActionContext.cjs.js","sources":["../../src/actions/mockActionContext.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PassThrough } from 'stream';\nimport {\n createMockDirectory,\n mockCredentials,\n mockServices,\n} from '@backstage/backend-test-utils';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { ActionContext } from '@backstage/plugin-scaffolder-node';\nimport { loggerToWinstonLogger } from './loggerToWinstonLogger';\n\n/**\n * A utility method to create a mock action context for scaffolder actions.\n *\n * @public\n * @param options - optional parameters to override default mock context\n */\nexport
|
|
1
|
+
{"version":3,"file":"mockActionContext.cjs.js","sources":["../../src/actions/mockActionContext.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PassThrough } from 'stream';\nimport {\n createMockDirectory,\n mockCredentials,\n mockServices,\n} from '@backstage/backend-test-utils';\nimport { JsonObject, JsonValue } from '@backstage/types';\nimport { ActionContext } from '@backstage/plugin-scaffolder-node';\nimport { loggerToWinstonLogger } from './loggerToWinstonLogger';\n\n/**\n * A utility method to create a mock action context for scaffolder actions.\n *\n * @public\n * @param options - optional parameters to override default mock context\n */\nexport function createMockActionContext<\n TActionInput extends JsonObject = JsonObject,\n TActionOutput extends JsonObject = any,\n>(\n options?: Partial<ActionContext<TActionInput, TActionOutput>>,\n): ActionContext<TActionInput, TActionOutput> {\n const credentials = mockCredentials.user();\n\n const defaultContext = {\n logger: loggerToWinstonLogger(mockServices.logger.mock()),\n logStream: new PassThrough(),\n output: jest.fn(),\n createTemporaryDirectory: jest.fn(),\n input: {} as TActionInput,\n async checkpoint<T extends JsonValue | void>(opts: {\n key: string;\n fn: () => Promise<T> | T;\n }): Promise<T> {\n return opts.fn();\n },\n getInitiatorCredentials: () => Promise.resolve(credentials),\n task: {\n id: 'mock-task-id',\n },\n };\n\n const createDefaultWorkspace = () => ({\n workspacePath: createMockDirectory().resolve('workspace'),\n });\n\n if (!options) {\n return {\n ...defaultContext,\n ...createDefaultWorkspace(),\n };\n }\n\n const { input, logger, secrets, templateInfo, workspacePath, task, user } =\n options;\n\n return {\n ...defaultContext,\n ...(workspacePath ? { workspacePath } : createDefaultWorkspace()),\n ...(workspacePath && {\n createTemporaryDirectory: jest.fn().mockResolvedValue(workspacePath),\n }),\n ...(logger && { logger }),\n ...(input && { input }),\n ...(secrets && { secrets }),\n ...(task && { task }),\n ...(user && { user }),\n templateInfo,\n };\n}\n"],"names":["mockCredentials","loggerToWinstonLogger","mockServices","PassThrough","createMockDirectory"],"mappings":";;;;;;AAgCO,SAAS,wBAId,OAC4C,EAAA;AAC5C,EAAM,MAAA,WAAA,GAAcA,iCAAgB,IAAK,EAAA;AAEzC,EAAA,MAAM,cAAiB,GAAA;AAAA,IACrB,MAAQ,EAAAC,2CAAA,CAAsBC,6BAAa,CAAA,MAAA,CAAO,MAAM,CAAA;AAAA,IACxD,SAAA,EAAW,IAAIC,kBAAY,EAAA;AAAA,IAC3B,MAAA,EAAQ,KAAK,EAAG,EAAA;AAAA,IAChB,wBAAA,EAA0B,KAAK,EAAG,EAAA;AAAA,IAClC,OAAO,EAAC;AAAA,IACR,MAAM,WAAuC,IAG9B,EAAA;AACb,MAAA,OAAO,KAAK,EAAG,EAAA;AAAA,KACjB;AAAA,IACA,uBAAyB,EAAA,MAAM,OAAQ,CAAA,OAAA,CAAQ,WAAW,CAAA;AAAA,IAC1D,IAAM,EAAA;AAAA,MACJ,EAAI,EAAA;AAAA;AACN,GACF;AAEA,EAAA,MAAM,yBAAyB,OAAO;AAAA,IACpC,aAAe,EAAAC,oCAAA,EAAsB,CAAA,OAAA,CAAQ,WAAW;AAAA,GAC1D,CAAA;AAEA,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA;AAAA,MACL,GAAG,cAAA;AAAA,MACH,GAAG,sBAAuB;AAAA,KAC5B;AAAA;AAGF,EAAM,MAAA,EAAE,OAAO,MAAQ,EAAA,OAAA,EAAS,cAAc,aAAe,EAAA,IAAA,EAAM,MACjE,GAAA,OAAA;AAEF,EAAO,OAAA;AAAA,IACL,GAAG,cAAA;AAAA,IACH,GAAI,aAAA,GAAgB,EAAE,aAAA,KAAkB,sBAAuB,EAAA;AAAA,IAC/D,GAAI,aAAiB,IAAA;AAAA,MACnB,wBAA0B,EAAA,IAAA,CAAK,EAAG,EAAA,CAAE,kBAAkB,aAAa;AAAA,KACrE;AAAA,IACA,GAAI,MAAU,IAAA,EAAE,MAAO,EAAA;AAAA,IACvB,GAAI,KAAS,IAAA,EAAE,KAAM,EAAA;AAAA,IACrB,GAAI,OAAW,IAAA,EAAE,OAAQ,EAAA;AAAA,IACzB,GAAI,IAAQ,IAAA,EAAE,IAAK,EAAA;AAAA,IACnB,GAAI,IAAQ,IAAA,EAAE,IAAK,EAAA;AAAA,IACnB;AAAA,GACF;AACF;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -7,6 +7,6 @@ import { ActionContext } from '@backstage/plugin-scaffolder-node';
|
|
|
7
7
|
* @public
|
|
8
8
|
* @param options - optional parameters to override default mock context
|
|
9
9
|
*/
|
|
10
|
-
declare
|
|
10
|
+
declare function createMockActionContext<TActionInput extends JsonObject = JsonObject, TActionOutput extends JsonObject = any>(options?: Partial<ActionContext<TActionInput, TActionOutput>>): ActionContext<TActionInput, TActionOutput>;
|
|
11
11
|
|
|
12
12
|
export { createMockActionContext };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-node-test-utils",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "node-library",
|
|
6
6
|
"pluginId": "scaffolder",
|
|
@@ -40,15 +40,15 @@
|
|
|
40
40
|
"test": "backstage-cli package test"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@backstage/backend-plugin-api": "1.4.0
|
|
44
|
-
"@backstage/backend-test-utils": "1.6.0
|
|
45
|
-
"@backstage/plugin-scaffolder-node": "0.
|
|
46
|
-
"@backstage/types": "1.2.1",
|
|
43
|
+
"@backstage/backend-plugin-api": "^1.4.0",
|
|
44
|
+
"@backstage/backend-test-utils": "^1.6.0",
|
|
45
|
+
"@backstage/plugin-scaffolder-node": "^0.9.0",
|
|
46
|
+
"@backstage/types": "^1.2.1",
|
|
47
47
|
"winston": "^3.2.1",
|
|
48
48
|
"winston-transport": "^4.7.0"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@backstage/cli": "0.
|
|
51
|
+
"@backstage/cli": "^0.33.0",
|
|
52
52
|
"@types/react": "^18.0.0",
|
|
53
53
|
"react": "^18.0.2",
|
|
54
54
|
"react-dom": "^18.0.2",
|