@backstage/plugin-scaffolder-node-test-utils 0.1.20-next.0 → 0.1.20-next.1
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,16 @@
|
|
|
1
1
|
# @backstage/plugin-scaffolder-node-test-utils
|
|
2
2
|
|
|
3
|
+
## 0.1.20-next.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 09cf038: Got rid of most `@backstage/backend-common` usages
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/plugin-scaffolder-node@0.7.1-next.1
|
|
10
|
+
- @backstage/backend-plugin-api@1.2.1-next.1
|
|
11
|
+
- @backstage/backend-test-utils@1.3.1-next.1
|
|
12
|
+
- @backstage/types@1.2.1
|
|
13
|
+
|
|
3
14
|
## 0.1.20-next.0
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var winston = require('winston');
|
|
4
|
+
var Transport = require('winston-transport');
|
|
5
|
+
|
|
6
|
+
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
7
|
+
|
|
8
|
+
var Transport__default = /*#__PURE__*/_interopDefaultCompat(Transport);
|
|
9
|
+
|
|
10
|
+
class BackstageLoggerTransport extends Transport__default.default {
|
|
11
|
+
constructor(backstageLogger, opts) {
|
|
12
|
+
super(opts);
|
|
13
|
+
this.backstageLogger = backstageLogger;
|
|
14
|
+
}
|
|
15
|
+
log(info, callback) {
|
|
16
|
+
if (typeof info !== "object" || info === null) {
|
|
17
|
+
callback();
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
const { level, message, ...meta } = info;
|
|
21
|
+
switch (level) {
|
|
22
|
+
case "error":
|
|
23
|
+
this.backstageLogger.error(String(message), meta);
|
|
24
|
+
break;
|
|
25
|
+
case "warn":
|
|
26
|
+
this.backstageLogger.warn(String(message), meta);
|
|
27
|
+
break;
|
|
28
|
+
case "info":
|
|
29
|
+
this.backstageLogger.info(String(message), meta);
|
|
30
|
+
break;
|
|
31
|
+
case "debug":
|
|
32
|
+
this.backstageLogger.debug(String(message), meta);
|
|
33
|
+
break;
|
|
34
|
+
default:
|
|
35
|
+
this.backstageLogger.info(String(message), meta);
|
|
36
|
+
}
|
|
37
|
+
callback();
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
function loggerToWinstonLogger(logger, opts) {
|
|
41
|
+
return winston.createLogger({
|
|
42
|
+
transports: [new BackstageLoggerTransport(logger, opts)]
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
exports.loggerToWinstonLogger = loggerToWinstonLogger;
|
|
47
|
+
//# sourceMappingURL=loggerToWinstonLogger.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loggerToWinstonLogger.cjs.js","sources":["../../src/actions/loggerToWinstonLogger.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { LoggerService } from '@backstage/backend-plugin-api';\nimport { JsonObject } from '@backstage/types';\nimport { Logger as WinstonLogger, createLogger } from 'winston';\nimport Transport, { TransportStreamOptions } from 'winston-transport';\n\nclass BackstageLoggerTransport extends Transport {\n constructor(\n private readonly backstageLogger: LoggerService,\n opts?: TransportStreamOptions,\n ) {\n super(opts);\n }\n\n log(info: unknown, callback: VoidFunction) {\n if (typeof info !== 'object' || info === null) {\n callback();\n return;\n }\n const { level, message, ...meta } = info as JsonObject;\n switch (level) {\n case 'error':\n this.backstageLogger.error(String(message), meta);\n break;\n case 'warn':\n this.backstageLogger.warn(String(message), meta);\n break;\n case 'info':\n this.backstageLogger.info(String(message), meta);\n break;\n case 'debug':\n this.backstageLogger.debug(String(message), meta);\n break;\n default:\n this.backstageLogger.info(String(message), meta);\n }\n callback();\n }\n}\n\n/**\n * A helper function to convert a Backstage LoggerService to a Winston Logger.\n * @internal\n */\nexport function loggerToWinstonLogger(\n logger: LoggerService,\n opts?: TransportStreamOptions,\n): WinstonLogger {\n return createLogger({\n transports: [new BackstageLoggerTransport(logger, opts)],\n });\n}\n"],"names":["Transport","createLogger"],"mappings":";;;;;;;;;AAqBA,MAAM,iCAAiCA,0BAAU,CAAA;AAAA,EAC/C,WAAA,CACmB,iBACjB,IACA,EAAA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA;AAAA;AAInB,EAEA,GAAA,CAAI,MAAe,QAAwB,EAAA;AACzC,IAAA,IAAI,OAAO,IAAA,KAAS,QAAY,IAAA,IAAA,KAAS,IAAM,EAAA;AAC7C,MAAS,QAAA,EAAA;AACT,MAAA;AAAA;AAEF,IAAA,MAAM,EAAE,KAAA,EAAO,OAAS,EAAA,GAAG,MAAS,GAAA,IAAA;AACpC,IAAA,QAAQ,KAAO;AAAA,MACb,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA;AAChD,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA;AAC/C,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA;AAC/C,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAgB,CAAA,KAAA,CAAM,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA;AAChD,QAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,eAAgB,CAAA,IAAA,CAAK,MAAO,CAAA,OAAO,GAAG,IAAI,CAAA;AAAA;AAEnD,IAAS,QAAA,EAAA;AAAA;AAEb;AAMgB,SAAA,qBAAA,CACd,QACA,IACe,EAAA;AACf,EAAA,OAAOC,oBAAa,CAAA;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAyB,CAAA,MAAA,EAAQ,IAAI,CAAC;AAAA,GACxD,CAAA;AACH;;;;"}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
3
|
var stream = require('stream');
|
|
4
|
-
var backendCommon = require('@backstage/backend-common');
|
|
5
4
|
var backendTestUtils = require('@backstage/backend-test-utils');
|
|
5
|
+
var loggerToWinstonLogger = require('./loggerToWinstonLogger.cjs.js');
|
|
6
6
|
|
|
7
7
|
const createMockActionContext = (options) => {
|
|
8
8
|
const credentials = backendTestUtils.mockCredentials.user();
|
|
9
9
|
const defaultContext = {
|
|
10
|
-
logger:
|
|
10
|
+
logger: loggerToWinstonLogger.loggerToWinstonLogger(backendTestUtils.mockServices.logger.mock()),
|
|
11
11
|
logStream: new stream.PassThrough(),
|
|
12
12
|
output: jest.fn(),
|
|
13
13
|
createTemporaryDirectory: jest.fn(),
|
|
@@ -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 {
|
|
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 const createMockActionContext = <\n TActionInput extends JsonObject = JsonObject,\n TActionOutput extends JsonObject = JsonObject,\n>(\n options?: Partial<ActionContext<TActionInput, TActionOutput>>,\n): ActionContext<TActionInput, TActionOutput> => {\n const credentials = mockCredentials.user();\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 {\n input,\n logger,\n logStream,\n secrets,\n templateInfo,\n workspacePath,\n task,\n } = options;\n\n return {\n ...defaultContext,\n ...(workspacePath ? { workspacePath } : createDefaultWorkspace()),\n ...(workspacePath && {\n createTemporaryDirectory: jest.fn().mockResolvedValue(workspacePath),\n }),\n ...(logger && { logger }),\n ...(logStream && { logStream }),\n ...(input && { input }),\n ...(secrets && { secrets }),\n ...(task && { task }),\n templateInfo,\n };\n};\n"],"names":["mockCredentials","loggerToWinstonLogger","mockServices","PassThrough","createMockDirectory"],"mappings":";;;;;;AAgCa,MAAA,uBAAA,GAA0B,CAIrC,OAC+C,KAAA;AAC/C,EAAM,MAAA,WAAA,GAAcA,iCAAgB,IAAK,EAAA;AACzC,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;AAAA,IACJ,KAAA;AAAA,IACA,MAAA;AAAA,IACA,SAAA;AAAA,IACA,OAAA;AAAA,IACA,YAAA;AAAA,IACA,aAAA;AAAA,IACA;AAAA,GACE,GAAA,OAAA;AAEJ,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,SAAa,IAAA,EAAE,SAAU,EAAA;AAAA,IAC7B,GAAI,KAAS,IAAA,EAAE,KAAM,EAAA;AAAA,IACrB,GAAI,OAAW,IAAA,EAAE,OAAQ,EAAA;AAAA,IACzB,GAAI,IAAQ,IAAA,EAAE,IAAK,EAAA;AAAA,IACnB;AAAA,GACF;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-node-test-utils",
|
|
3
|
-
"version": "0.1.20-next.
|
|
3
|
+
"version": "0.1.20-next.1",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "node-library",
|
|
6
6
|
"pluginId": "scaffolder",
|
|
@@ -40,13 +40,15 @@
|
|
|
40
40
|
"test": "backstage-cli package test"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@backstage/backend-
|
|
44
|
-
"@backstage/backend-test-utils": "1.3.1-next.
|
|
45
|
-
"@backstage/plugin-scaffolder-node": "0.7.1-next.
|
|
46
|
-
"@backstage/types": "1.2.1"
|
|
43
|
+
"@backstage/backend-plugin-api": "1.2.1-next.1",
|
|
44
|
+
"@backstage/backend-test-utils": "1.3.1-next.1",
|
|
45
|
+
"@backstage/plugin-scaffolder-node": "0.7.1-next.1",
|
|
46
|
+
"@backstage/types": "1.2.1",
|
|
47
|
+
"winston": "^3.2.1",
|
|
48
|
+
"winston-transport": "^4.7.0"
|
|
47
49
|
},
|
|
48
50
|
"devDependencies": {
|
|
49
|
-
"@backstage/cli": "0.30.0",
|
|
51
|
+
"@backstage/cli": "0.30.1-next.0",
|
|
50
52
|
"@types/react": "^18.0.0",
|
|
51
53
|
"react": "^18.0.2",
|
|
52
54
|
"react-dom": "^18.0.2",
|