@backstage/plugin-scaffolder-node-test-utils 0.1.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @backstage/plugin-scaffolder-node-test-utils
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- f44589d: Introduced `createMockActionContext` to unify the way of creating scaffolder mock context.
+
+  It will help to maintain tests in a long run during structural changes of action context.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-test-utils@0.3.3-next.0
+  - @backstage/backend-common@0.21.3-next.0
+  - @backstage/plugin-scaffolder-node@0.3.3-next.0
+  - @backstage/types@1.1.1
+  - @backstage/plugin-scaffolder-common@1.5.1-next.0

package/README.md

@@ -0,0 +1,12 @@
+# @backstage/plugin-scaffolder-node-test-utils
+
+Contains utilities that can be used when testing scaffolder features.
+
+## Installation
+
+Install the package via Yarn into your own packages:
+
+```sh
+cd <package-dir> # if within a monorepo
+yarn add --dev @backstage/plugin-scaffolder-node-test-utils
+```

package/dist/index.cjs.js

@@ -0,0 +1,42 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var stream = require('stream');
+var backendCommon = require('@backstage/backend-common');
+var backendTestUtils = require('@backstage/backend-test-utils');
+
+const createMockActionContext = (options) => {
+  const defaultContext = {
+    logger: backendCommon.getVoidLogger(),
+    logStream: new stream.PassThrough(),
+    output: jest.fn(),
+    createTemporaryDirectory: jest.fn(),
+    input: {}
+  };
+  const createDefaultWorkspace = () => ({
+    workspacePath: backendTestUtils.createMockDirectory().resolve("workspace")
+  });
+  if (!options) {
+    return {
+      ...defaultContext,
+      ...createDefaultWorkspace()
+    };
+  }
+  const { input, logger, logStream, secrets, templateInfo, workspacePath } = options;
+  return {
+    ...defaultContext,
+    ...workspacePath ? { workspacePath } : createDefaultWorkspace(),
+    ...workspacePath && {
+      createTemporaryDirectory: jest.fn().mockResolvedValue(workspacePath)
+    },
+    ...logger && { logger },
+    ...logStream && { logStream },
+    ...input && { input },
+    ...secrets && { secrets },
+    templateInfo
+  };
+};
+
+exports.createMockActionContext = createMockActionContext;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/mockActionConext.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 { getVoidLogger } from '@backstage/backend-common';\nimport { createMockDirectory } from '@backstage/backend-test-utils';\nimport { JsonObject } from '@backstage/types';\nimport { ActionContext } from '@backstage/plugin-scaffolder-node';\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 defaultContext = {\n    logger: getVoidLogger(),\n    logStream: new PassThrough(),\n    output: jest.fn(),\n    createTemporaryDirectory: jest.fn(),\n    input: {} as TActionInput,\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, logStream, secrets, templateInfo, workspacePath } =\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    templateInfo,\n  };\n};\n"],"names":["getVoidLogger","PassThrough","createMockDirectory"],"mappings":";;;;;;;;AA4Ba,MAAA,uBAAA,GAA0B,CAIrC,OAC+C,KAAA;AAC/C,EAAA,MAAM,cAAiB,GAAA;AAAA,IACrB,QAAQA,2BAAc,EAAA;AAAA,IACtB,SAAA,EAAW,IAAIC,kBAAY,EAAA;AAAA,IAC3B,MAAA,EAAQ,KAAK,EAAG,EAAA;AAAA,IAChB,wBAAA,EAA0B,KAAK,EAAG,EAAA;AAAA,IAClC,OAAO,EAAC;AAAA,GACV,CAAA;AAEA,EAAA,MAAM,yBAAyB,OAAO;AAAA,IACpC,aAAe,EAAAC,oCAAA,EAAsB,CAAA,OAAA,CAAQ,WAAW,CAAA;AAAA,GAC1D,CAAA,CAAA;AAEA,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAO,OAAA;AAAA,MACL,GAAG,cAAA;AAAA,MACH,GAAG,sBAAuB,EAAA;AAAA,KAC5B,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,KAAO,EAAA,MAAA,EAAQ,WAAW,OAAS,EAAA,YAAA,EAAc,eACvD,GAAA,OAAA,CAAA;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,CAAA;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,YAAA;AAAA,GACF,CAAA;AACF;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { JsonObject } from '@backstage/types';
+import { ActionContext } from '@backstage/plugin-scaffolder-node';
+
+/**
+ * A utility method to create a mock action context for scaffolder actions.
+ *
+ * @public
+ * @param options - optional parameters to override default mock context
+ */
+declare const createMockActionContext: <TActionInput extends JsonObject = JsonObject, TActionOutput extends JsonObject = JsonObject>(options?: Partial<ActionContext<TActionInput, TActionOutput>> | undefined) => ActionContext<TActionInput, TActionOutput>;
+
+export { createMockActionContext };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@backstage/plugin-scaffolder-node-test-utils",
+  "version": "0.1.0-next.0",
+  "backstage": {
+    "role": "node-library"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/scaffolder-node-test-utils"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.21.3-next.0",
+    "@backstage/backend-test-utils": "^0.3.3-next.0",
+    "@backstage/plugin-scaffolder-common": "^1.5.1-next.0",
+    "@backstage/plugin-scaffolder-node": "^0.3.3-next.0",
+    "@backstage/types": "^1.1.1",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.25.3-next.0",
+    "@testing-library/jest-dom": "^6.0.0",
+    "@types/react": "*"
+  }
+}