@backstage/plugin-scaffolder-node-test-utils 0.3.2-next.0 → 0.3.2
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,15 @@
|
|
|
1
1
|
# @backstage/plugin-scaffolder-node-test-utils
|
|
2
2
|
|
|
3
|
+
## 0.3.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 812485c: Add step info to scaffolder action context to access the step id and name.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/plugin-scaffolder-node@0.11.0
|
|
10
|
+
- @backstage/backend-test-utils@1.8.0
|
|
11
|
+
- @backstage/backend-plugin-api@1.4.2
|
|
12
|
+
|
|
3
13
|
## 0.3.2-next.0
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
|
@@ -1 +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,
|
|
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,0BAAA,CAAU;AAAA,EAC/C,WAAA,CACmB,iBACjB,IAAA,EACA;AACA,IAAA,KAAA,CAAM,IAAI,CAAA;AAHO,IAAA,IAAA,CAAA,eAAA,GAAA,eAAA;AAAA,EAInB;AAAA,EAEA,GAAA,CAAI,MAAe,QAAA,EAAwB;AACzC,IAAA,IAAI,OAAO,IAAA,KAAS,QAAA,IAAY,IAAA,KAAS,IAAA,EAAM;AAC7C,MAAA,QAAA,EAAS;AACT,MAAA;AAAA,IACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAO,OAAA,EAAS,GAAG,MAAK,GAAI,IAAA;AACpC,IAAA,QAAQ,KAAA;AAAO,MACb,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAA,CAAgB,KAAA,CAAM,MAAA,CAAO,OAAO,GAAG,IAAI,CAAA;AAChD,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAA,CAAgB,IAAA,CAAK,MAAA,CAAO,OAAO,GAAG,IAAI,CAAA;AAC/C,QAAA;AAAA,MACF,KAAK,MAAA;AACH,QAAA,IAAA,CAAK,eAAA,CAAgB,IAAA,CAAK,MAAA,CAAO,OAAO,GAAG,IAAI,CAAA;AAC/C,QAAA;AAAA,MACF,KAAK,OAAA;AACH,QAAA,IAAA,CAAK,eAAA,CAAgB,KAAA,CAAM,MAAA,CAAO,OAAO,GAAG,IAAI,CAAA;AAChD,QAAA;AAAA,MACF;AACE,QAAA,IAAA,CAAK,eAAA,CAAgB,IAAA,CAAK,MAAA,CAAO,OAAO,GAAG,IAAI,CAAA;AAAA;AAEnD,IAAA,QAAA,EAAS;AAAA,EACX;AACF;AAMO,SAAS,qBAAA,CACd,QACA,IAAA,EACe;AACf,EAAA,OAAOC,oBAAA,CAAa;AAAA,IAClB,YAAY,CAAC,IAAI,wBAAA,CAAyB,MAAA,EAAQ,IAAI,CAAC;AAAA,GACxD,CAAA;AACH;;;;"}
|
|
@@ -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 { CheckpointContext } from '@backstage/plugin-scaffolder-node/alpha';\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>(\n opts: CheckpointContext<T>,\n ): Promise<T> {\n return opts.fn();\n },\n getInitiatorCredentials: () => Promise.resolve(credentials),\n task: {\n id: 'mock-task-id',\n },\n step: {\n id: 'mock-step-id',\n name: 'mock step name',\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":";;;;;;AAiCO,SAAS,wBAId,
|
|
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 { CheckpointContext } from '@backstage/plugin-scaffolder-node/alpha';\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>(\n opts: CheckpointContext<T>,\n ): Promise<T> {\n return opts.fn();\n },\n getInitiatorCredentials: () => Promise.resolve(credentials),\n task: {\n id: 'mock-task-id',\n },\n step: {\n id: 'mock-step-id',\n name: 'mock step name',\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":";;;;;;AAiCO,SAAS,wBAId,OAAA,EAC4C;AAC5C,EAAA,MAAM,WAAA,GAAcA,iCAAgB,IAAA,EAAK;AAEzC,EAAA,MAAM,cAAA,GAAiB;AAAA,IACrB,MAAA,EAAQC,2CAAA,CAAsBC,6BAAA,CAAa,MAAA,CAAO,MAAM,CAAA;AAAA,IACxD,SAAA,EAAW,IAAIC,kBAAA,EAAY;AAAA,IAC3B,MAAA,EAAQ,KAAK,EAAA,EAAG;AAAA,IAChB,wBAAA,EAA0B,KAAK,EAAA,EAAG;AAAA,IAClC,OAAO,EAAC;AAAA,IACR,MAAM,WACJ,IAAA,EACY;AACZ,MAAA,OAAO,KAAK,EAAA,EAAG;AAAA,IACjB,CAAA;AAAA,IACA,uBAAA,EAAyB,MAAM,OAAA,CAAQ,OAAA,CAAQ,WAAW,CAAA;AAAA,IAC1D,IAAA,EAAM;AAAA,MACJ,EAAA,EAAI;AAAA,KACN;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,EAAA,EAAI,cAAA;AAAA,MACJ,IAAA,EAAM;AAAA;AACR,GACF;AAEA,EAAA,MAAM,yBAAyB,OAAO;AAAA,IACpC,aAAA,EAAeC,oCAAA,EAAoB,CAAE,OAAA,CAAQ,WAAW;AAAA,GAC1D,CAAA;AAEA,EAAA,IAAI,CAAC,OAAA,EAAS;AACZ,IAAA,OAAO;AAAA,MACL,GAAG,cAAA;AAAA,MACH,GAAG,sBAAA;AAAuB,KAC5B;AAAA,EACF;AAEA,EAAA,MAAM,EAAE,OAAO,MAAA,EAAQ,OAAA,EAAS,cAAc,aAAA,EAAe,IAAA,EAAM,MAAK,GACtE,OAAA;AAEF,EAAA,OAAO;AAAA,IACL,GAAG,cAAA;AAAA,IACH,GAAI,aAAA,GAAgB,EAAE,aAAA,KAAkB,sBAAA,EAAuB;AAAA,IAC/D,GAAI,aAAA,IAAiB;AAAA,MACnB,wBAAA,EAA0B,IAAA,CAAK,EAAA,EAAG,CAAE,kBAAkB,aAAa;AAAA,KACrE;AAAA,IACA,GAAI,MAAA,IAAU,EAAE,MAAA,EAAO;AAAA,IACvB,GAAI,KAAA,IAAS,EAAE,KAAA,EAAM;AAAA,IACrB,GAAI,OAAA,IAAW,EAAE,OAAA,EAAQ;AAAA,IACzB,GAAI,IAAA,IAAQ,EAAE,IAAA,EAAK;AAAA,IACnB,GAAI,IAAA,IAAQ,EAAE,IAAA,EAAK;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.3.2
|
|
3
|
+
"version": "0.3.2",
|
|
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.2
|
|
44
|
-
"@backstage/backend-test-utils": "1.
|
|
45
|
-
"@backstage/plugin-scaffolder-node": "0.11.0
|
|
46
|
-
"@backstage/types": "1.2.1",
|
|
43
|
+
"@backstage/backend-plugin-api": "^1.4.2",
|
|
44
|
+
"@backstage/backend-test-utils": "^1.8.0",
|
|
45
|
+
"@backstage/plugin-scaffolder-node": "^0.11.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.34.0",
|
|
52
52
|
"@types/react": "^18.0.0",
|
|
53
53
|
"react": "^18.0.2",
|
|
54
54
|
"react-dom": "^18.0.2",
|