@backstage/plugin-scaffolder-backend-module-rails 0.5.6 → 0.5.7-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,26 @@
|
|
|
1
1
|
# @backstage/plugin-scaffolder-backend-module-rails
|
|
2
2
|
|
|
3
|
+
## 0.5.7-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/config@1.3.2
|
|
12
|
+
- @backstage/errors@1.2.7
|
|
13
|
+
- @backstage/integration@1.16.1
|
|
14
|
+
- @backstage/types@1.2.1
|
|
15
|
+
|
|
16
|
+
## 0.5.7-next.0
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- Updated dependencies
|
|
21
|
+
- @backstage/backend-plugin-api@1.2.1-next.0
|
|
22
|
+
- @backstage/plugin-scaffolder-node@0.7.1-next.0
|
|
23
|
+
|
|
3
24
|
## 0.5.6
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../../../../src/actions/fetch/rails/index.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { ContainerRunner } from '@backstage/backend-common';\nimport { JsonObject } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport fs from 'fs-extra';\nimport {\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-node';\n\nimport { resolve as resolvePath } from 'path';\nimport { RailsNewRunner } from './railsNewRunner';\nimport { PassThrough } from 'stream';\nimport { examples } from './index.examples';\nimport { UrlReaderService } from '@backstage/backend-plugin-api';\n\n/**\n * Creates the `fetch:rails` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://guides.rubyonrails.org/rails_application_templates.html} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @param options - Configuration of the templater.\n * @public\n */\nexport function createFetchRailsAction(options: {\n reader: UrlReaderService;\n integrations: ScmIntegrations;\n containerRunner?: ContainerRunner;\n /** A list of image names that are allowed to be passed as imageName input */\n allowedImageNames?: string[];\n}) {\n const { reader, integrations, containerRunner } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n imageName?: string;\n }>({\n id: 'fetch:rails',\n description:\n 'Downloads a template from the given `url` into the workspace, and runs a rails new generator on it.',\n examples,\n schema: {\n input: {\n type: 'object',\n required: ['url'],\n properties: {\n url: {\n title: 'Fetch URL',\n description:\n 'Relative path or absolute URL pointing to the directory tree to fetch',\n type: 'string',\n },\n targetPath: {\n title: 'Target Path',\n description:\n 'Target path within the working directory to download the contents to.',\n type: 'string',\n },\n values: {\n title: 'Template Values',\n description: 'Values to pass on to rails for templating',\n type: 'object',\n properties: {\n railsArguments: {\n title: 'Arguments to pass to new command',\n description:\n 'You can provide some arguments to create a custom app',\n type: 'object',\n properties: {\n minimal: {\n title: 'minimal',\n description: 'Preconfigure a minimal rails app',\n type: 'boolean',\n },\n skipBundle: {\n title: 'skipBundle',\n description: \"Don't run bundle install\",\n type: 'boolean',\n },\n skipWebpackInstall: {\n title: 'skipWebpackInstall',\n description: \"Don't run Webpack install\",\n type: 'boolean',\n },\n skipTest: {\n title: 'skipTest',\n description: 'Skip test files',\n type: 'boolean',\n },\n skipActionCable: {\n title: 'skipActionCable',\n description: 'Skip Action Cable files',\n type: 'boolean',\n },\n skipActionMailer: {\n title: 'skipActionMailer',\n description: 'Skip Action Mailer files',\n type: 'boolean',\n },\n skipActionMailbox: {\n title: 'skipActionMailbox',\n description: 'Skip Action Mailbox gem',\n type: 'boolean',\n },\n skipActiveStorage: {\n title: 'skipActiveStorage',\n description: 'Skip Active Storage files',\n type: 'boolean',\n },\n skipActionText: {\n title: 'skipActionText',\n description: 'Skip Action Text gem',\n type: 'boolean',\n },\n skipActiveRecord: {\n title: 'skipActiveRecord',\n description: 'Skip Active Record files',\n type: 'boolean',\n },\n\n force: {\n title: 'force',\n description: 'Overwrite files that already exist',\n type: 'boolean',\n },\n api: {\n title: 'api',\n description: 'Preconfigure smaller stack for API only apps',\n type: 'boolean',\n },\n template: {\n title: 'template',\n description:\n 'Path to some application template (can be a filesystem path or URL)',\n type: 'string',\n },\n webpacker: {\n title: 'webpacker',\n description:\n 'Preconfigure Webpack with a particular framework (options: react, vue, angular, elm, stimulus)',\n type: 'string',\n enum: ['react', 'vue', 'angular', 'elm', 'stimulus'],\n },\n database: {\n title: 'database',\n description:\n 'Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)',\n type: 'string',\n enum: [\n 'mysql',\n 'postgresql',\n 'sqlite3',\n 'oracle',\n 'sqlserver',\n 'jdbcmysql',\n 'jdbcsqlite3',\n 'jdbcpostgresql',\n 'jdbc',\n ],\n },\n railsVersion: {\n title: 'Rails version in Gemfile',\n description:\n 'Set up the application with Gemfile pointing to a specific version (options: fromImage, dev, edge, master)',\n type: 'string',\n enum: ['dev', 'edge', 'master', 'fromImage'],\n },\n },\n },\n },\n },\n imageName: {\n title: 'Rails Docker image',\n description:\n 'Specify a Docker image to run rails new. Used only when a local rails is not found.',\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using rails');\n\n const workDir = await ctx.createTemporaryDirectory();\n const resultDir = resolvePath(workDir, 'result');\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.templateInfo?.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: workDir,\n });\n\n const templateRunner = new RailsNewRunner({ containerRunner });\n\n const { imageName } = ctx.input;\n if (imageName && !options.allowedImageNames?.includes(imageName)) {\n throw new Error(`Image ${imageName} is not allowed`);\n }\n\n const logStream = new PassThrough();\n logStream.on('data', chunk => {\n ctx.logger.info(chunk.toString());\n });\n\n // Will execute the template in ./template and put the result in ./result\n await templateRunner.run({\n workspacePath: workDir,\n logStream,\n values: { ...ctx.input.values, imageName },\n });\n\n // Finally move the template result into the task workspace\n const targetPath = ctx.input.targetPath ?? './';\n const outputPath = resolvePath(ctx.workspacePath, targetPath);\n if (!outputPath.startsWith(ctx.workspacePath)) {\n throw new InputError(\n `Fetch action targetPath may not specify a path outside the working directory`,\n );\n }\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["createTemplateAction","examples","resolvePath","fetchContents","RailsNewRunner","PassThrough","InputError","fs"],"mappings":";;;;;;;;;;;;;;AA0CO,SAAS,uBAAuB,OAMpC,EAAA;AACD,EAAA,MAAM,EAAE,MAAA,EAAQ,YAAc,EAAA,eAAA,EAAoB,GAAA,OAAA;AAElD,EAAA,OAAOA,yCAKJ,CAAA;AAAA,IACD,EAAI,EAAA,aAAA;AAAA,IACJ,WACE,EAAA,qGAAA;AAAA,cACFC,uBAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,KAAK,CAAA;AAAA,QAChB,UAAY,EAAA;AAAA,UACV,GAAK,EAAA;AAAA,YACH,KAAO,EAAA,WAAA;AAAA,YACP,WACE,EAAA,uEAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WACE,EAAA,uEAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA,2CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,UAAY,EAAA;AAAA,cACV,cAAgB,EAAA;AAAA,gBACd,KAAO,EAAA,kCAAA;AAAA,gBACP,WACE,EAAA,uDAAA;AAAA,gBACF,IAAM,EAAA,QAAA;AAAA,gBACN,UAAY,EAAA;AAAA,kBACV,OAAS,EAAA;AAAA,oBACP,KAAO,EAAA,SAAA;AAAA,oBACP,WAAa,EAAA,kCAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,UAAY,EAAA;AAAA,oBACV,KAAO,EAAA,YAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,kBAAoB,EAAA;AAAA,oBAClB,KAAO,EAAA,oBAAA;AAAA,oBACP,WAAa,EAAA,2BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WAAa,EAAA,iBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,eAAiB,EAAA;AAAA,oBACf,KAAO,EAAA,iBAAA;AAAA,oBACP,WAAa,EAAA,yBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,gBAAkB,EAAA;AAAA,oBAChB,KAAO,EAAA,kBAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,iBAAmB,EAAA;AAAA,oBACjB,KAAO,EAAA,mBAAA;AAAA,oBACP,WAAa,EAAA,yBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,iBAAmB,EAAA;AAAA,oBACjB,KAAO,EAAA,mBAAA;AAAA,oBACP,WAAa,EAAA,2BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,cAAgB,EAAA;AAAA,oBACd,KAAO,EAAA,gBAAA;AAAA,oBACP,WAAa,EAAA,sBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,gBAAkB,EAAA;AAAA,oBAChB,KAAO,EAAA,kBAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBAEA,KAAO,EAAA;AAAA,oBACL,KAAO,EAAA,OAAA;AAAA,oBACP,WAAa,EAAA,oCAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,GAAK,EAAA;AAAA,oBACH,KAAO,EAAA,KAAA;AAAA,oBACP,WAAa,EAAA,8CAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WACE,EAAA,qEAAA;AAAA,oBACF,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,SAAW,EAAA;AAAA,oBACT,KAAO,EAAA,WAAA;AAAA,oBACP,WACE,EAAA,gGAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,MAAM,CAAC,OAAA,EAAS,KAAO,EAAA,SAAA,EAAW,OAAO,UAAU;AAAA,mBACrD;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WACE,EAAA,mIAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,IAAM,EAAA;AAAA,sBACJ,OAAA;AAAA,sBACA,YAAA;AAAA,sBACA,SAAA;AAAA,sBACA,QAAA;AAAA,sBACA,WAAA;AAAA,sBACA,WAAA;AAAA,sBACA,aAAA;AAAA,sBACA,gBAAA;AAAA,sBACA;AAAA;AACF,mBACF;AAAA,kBACA,YAAc,EAAA;AAAA,oBACZ,KAAO,EAAA,0BAAA;AAAA,oBACP,WACE,EAAA,4GAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,IAAM,EAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,UAAU,WAAW;AAAA;AAC7C;AACF;AACF;AACF,WACF;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,oBAAA;AAAA,YACP,WACE,EAAA,qFAAA;AAAA,YACF,IAAM,EAAA;AAAA;AACR;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,0CAA0C,CAAA;AAE1D,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA;AACnD,MAAM,MAAA,SAAA,GAAYC,YAAY,CAAA,OAAA,EAAS,QAAQ,CAAA;AAE/C,MAAA,MAAMC,kCAAc,CAAA;AAAA,QAClB,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,IAAI,KAAM,CAAA,GAAA;AAAA,QACpB,UAAY,EAAA;AAAA,OACb,CAAA;AAED,MAAA,MAAM,cAAiB,GAAA,IAAIC,6BAAe,CAAA,EAAE,iBAAiB,CAAA;AAE7D,MAAM,MAAA,EAAE,SAAU,EAAA,GAAI,GAAI,CAAA,KAAA;AAC1B,MAAA,IAAI,aAAa,CAAC,OAAA,CAAQ,iBAAmB,EAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAChE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAS,MAAA,EAAA,SAAS,CAAiB,eAAA,CAAA,CAAA;AAAA;AAGrD,MAAM,MAAA,SAAA,GAAY,IAAIC,kBAAY,EAAA;AAClC,MAAU,SAAA,CAAA,EAAA,CAAG,QAAQ,CAAS,KAAA,KAAA;AAC5B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,CAAA;AAAA,OACjC,CAAA;AAGD,MAAA,MAAM,eAAe,GAAI,CAAA;AAAA,QACvB,aAAe,EAAA,OAAA;AAAA,QACf,SAAA;AAAA,QACA,QAAQ,EAAE,GAAG,GAAI,CAAA,KAAA,CAAM,QAAQ,SAAU;AAAA,OAC1C,CAAA;AAGD,MAAM,MAAA,UAAA,GAAa,GAAI,CAAA,KAAA,CAAM,UAAc,IAAA,IAAA;AAC3C,MAAA,MAAM,UAAa,GAAAH,YAAA,CAAY,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA;AAC5D,MAAA,IAAI,CAAC,UAAA,CAAW,UAAW,CAAA,GAAA,CAAI,aAAa,CAAG,EAAA;AAC7C,QAAA,MAAM,IAAII,iBAAA;AAAA,UACR,CAAA,4EAAA;AAAA,SACF;AAAA;AAEF,MAAM,MAAAC,mBAAA,CAAG,IAAK,CAAA,SAAA,EAAW,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;"}
|
|
1
|
+
{"version":3,"file":"index.cjs.js","sources":["../../../../src/actions/fetch/rails/index.ts"],"sourcesContent":["/*\n * Copyright 2021 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 { JsonObject } from '@backstage/types';\nimport { InputError } from '@backstage/errors';\nimport { ScmIntegrations } from '@backstage/integration';\nimport fs from 'fs-extra';\nimport {\n createTemplateAction,\n fetchContents,\n} from '@backstage/plugin-scaffolder-node';\n\nimport { resolve as resolvePath } from 'path';\nimport { RailsNewRunner } from './railsNewRunner';\nimport { PassThrough } from 'stream';\nimport { examples } from './index.examples';\nimport { UrlReaderService } from '@backstage/backend-plugin-api';\nimport { ContainerRunner } from './ContainerRunner';\n\nexport { type ContainerRunner };\n\n/**\n * Creates the `fetch:rails` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://guides.rubyonrails.org/rails_application_templates.html} and {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @param options - Configuration of the templater.\n * @public\n */\nexport function createFetchRailsAction(options: {\n reader: UrlReaderService;\n integrations: ScmIntegrations;\n containerRunner?: ContainerRunner;\n /** A list of image names that are allowed to be passed as imageName input */\n allowedImageNames?: string[];\n}) {\n const { reader, integrations, containerRunner } = options;\n\n return createTemplateAction<{\n url: string;\n targetPath?: string;\n values: JsonObject;\n imageName?: string;\n }>({\n id: 'fetch:rails',\n description:\n 'Downloads a template from the given `url` into the workspace, and runs a rails new generator on it.',\n examples,\n schema: {\n input: {\n type: 'object',\n required: ['url'],\n properties: {\n url: {\n title: 'Fetch URL',\n description:\n 'Relative path or absolute URL pointing to the directory tree to fetch',\n type: 'string',\n },\n targetPath: {\n title: 'Target Path',\n description:\n 'Target path within the working directory to download the contents to.',\n type: 'string',\n },\n values: {\n title: 'Template Values',\n description: 'Values to pass on to rails for templating',\n type: 'object',\n properties: {\n railsArguments: {\n title: 'Arguments to pass to new command',\n description:\n 'You can provide some arguments to create a custom app',\n type: 'object',\n properties: {\n minimal: {\n title: 'minimal',\n description: 'Preconfigure a minimal rails app',\n type: 'boolean',\n },\n skipBundle: {\n title: 'skipBundle',\n description: \"Don't run bundle install\",\n type: 'boolean',\n },\n skipWebpackInstall: {\n title: 'skipWebpackInstall',\n description: \"Don't run Webpack install\",\n type: 'boolean',\n },\n skipTest: {\n title: 'skipTest',\n description: 'Skip test files',\n type: 'boolean',\n },\n skipActionCable: {\n title: 'skipActionCable',\n description: 'Skip Action Cable files',\n type: 'boolean',\n },\n skipActionMailer: {\n title: 'skipActionMailer',\n description: 'Skip Action Mailer files',\n type: 'boolean',\n },\n skipActionMailbox: {\n title: 'skipActionMailbox',\n description: 'Skip Action Mailbox gem',\n type: 'boolean',\n },\n skipActiveStorage: {\n title: 'skipActiveStorage',\n description: 'Skip Active Storage files',\n type: 'boolean',\n },\n skipActionText: {\n title: 'skipActionText',\n description: 'Skip Action Text gem',\n type: 'boolean',\n },\n skipActiveRecord: {\n title: 'skipActiveRecord',\n description: 'Skip Active Record files',\n type: 'boolean',\n },\n\n force: {\n title: 'force',\n description: 'Overwrite files that already exist',\n type: 'boolean',\n },\n api: {\n title: 'api',\n description: 'Preconfigure smaller stack for API only apps',\n type: 'boolean',\n },\n template: {\n title: 'template',\n description:\n 'Path to some application template (can be a filesystem path or URL)',\n type: 'string',\n },\n webpacker: {\n title: 'webpacker',\n description:\n 'Preconfigure Webpack with a particular framework (options: react, vue, angular, elm, stimulus)',\n type: 'string',\n enum: ['react', 'vue', 'angular', 'elm', 'stimulus'],\n },\n database: {\n title: 'database',\n description:\n 'Preconfigure for selected database (options: mysql/postgresql/sqlite3/oracle/sqlserver/jdbcmysql/jdbcsqlite3/jdbcpostgresql/jdbc)',\n type: 'string',\n enum: [\n 'mysql',\n 'postgresql',\n 'sqlite3',\n 'oracle',\n 'sqlserver',\n 'jdbcmysql',\n 'jdbcsqlite3',\n 'jdbcpostgresql',\n 'jdbc',\n ],\n },\n railsVersion: {\n title: 'Rails version in Gemfile',\n description:\n 'Set up the application with Gemfile pointing to a specific version (options: fromImage, dev, edge, master)',\n type: 'string',\n enum: ['dev', 'edge', 'master', 'fromImage'],\n },\n },\n },\n },\n },\n imageName: {\n title: 'Rails Docker image',\n description:\n 'Specify a Docker image to run rails new. Used only when a local rails is not found.',\n type: 'string',\n },\n },\n },\n },\n async handler(ctx) {\n ctx.logger.info('Fetching and then templating using rails');\n\n const workDir = await ctx.createTemporaryDirectory();\n const resultDir = resolvePath(workDir, 'result');\n\n await fetchContents({\n reader,\n integrations,\n baseUrl: ctx.templateInfo?.baseUrl,\n fetchUrl: ctx.input.url,\n outputPath: workDir,\n });\n\n const templateRunner = new RailsNewRunner({ containerRunner });\n\n const { imageName } = ctx.input;\n if (imageName && !options.allowedImageNames?.includes(imageName)) {\n throw new Error(`Image ${imageName} is not allowed`);\n }\n\n const logStream = new PassThrough();\n logStream.on('data', chunk => {\n ctx.logger.info(chunk.toString());\n });\n\n // Will execute the template in ./template and put the result in ./result\n await templateRunner.run({\n workspacePath: workDir,\n logStream,\n values: { ...ctx.input.values, imageName },\n });\n\n // Finally move the template result into the task workspace\n const targetPath = ctx.input.targetPath ?? './';\n const outputPath = resolvePath(ctx.workspacePath, targetPath);\n if (!outputPath.startsWith(ctx.workspacePath)) {\n throw new InputError(\n `Fetch action targetPath may not specify a path outside the working directory`,\n );\n }\n await fs.copy(resultDir, outputPath);\n },\n });\n}\n"],"names":["createTemplateAction","examples","resolvePath","fetchContents","RailsNewRunner","PassThrough","InputError","fs"],"mappings":";;;;;;;;;;;;;;AA4CO,SAAS,uBAAuB,OAMpC,EAAA;AACD,EAAA,MAAM,EAAE,MAAA,EAAQ,YAAc,EAAA,eAAA,EAAoB,GAAA,OAAA;AAElD,EAAA,OAAOA,yCAKJ,CAAA;AAAA,IACD,EAAI,EAAA,aAAA;AAAA,IACJ,WACE,EAAA,qGAAA;AAAA,cACFC,uBAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,KAAK,CAAA;AAAA,QAChB,UAAY,EAAA;AAAA,UACV,GAAK,EAAA;AAAA,YACH,KAAO,EAAA,WAAA;AAAA,YACP,WACE,EAAA,uEAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WACE,EAAA,uEAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,iBAAA;AAAA,YACP,WAAa,EAAA,2CAAA;AAAA,YACb,IAAM,EAAA,QAAA;AAAA,YACN,UAAY,EAAA;AAAA,cACV,cAAgB,EAAA;AAAA,gBACd,KAAO,EAAA,kCAAA;AAAA,gBACP,WACE,EAAA,uDAAA;AAAA,gBACF,IAAM,EAAA,QAAA;AAAA,gBACN,UAAY,EAAA;AAAA,kBACV,OAAS,EAAA;AAAA,oBACP,KAAO,EAAA,SAAA;AAAA,oBACP,WAAa,EAAA,kCAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,UAAY,EAAA;AAAA,oBACV,KAAO,EAAA,YAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,kBAAoB,EAAA;AAAA,oBAClB,KAAO,EAAA,oBAAA;AAAA,oBACP,WAAa,EAAA,2BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WAAa,EAAA,iBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,eAAiB,EAAA;AAAA,oBACf,KAAO,EAAA,iBAAA;AAAA,oBACP,WAAa,EAAA,yBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,gBAAkB,EAAA;AAAA,oBAChB,KAAO,EAAA,kBAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,iBAAmB,EAAA;AAAA,oBACjB,KAAO,EAAA,mBAAA;AAAA,oBACP,WAAa,EAAA,yBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,iBAAmB,EAAA;AAAA,oBACjB,KAAO,EAAA,mBAAA;AAAA,oBACP,WAAa,EAAA,2BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,cAAgB,EAAA;AAAA,oBACd,KAAO,EAAA,gBAAA;AAAA,oBACP,WAAa,EAAA,sBAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,gBAAkB,EAAA;AAAA,oBAChB,KAAO,EAAA,kBAAA;AAAA,oBACP,WAAa,EAAA,0BAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBAEA,KAAO,EAAA;AAAA,oBACL,KAAO,EAAA,OAAA;AAAA,oBACP,WAAa,EAAA,oCAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,GAAK,EAAA;AAAA,oBACH,KAAO,EAAA,KAAA;AAAA,oBACP,WAAa,EAAA,8CAAA;AAAA,oBACb,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WACE,EAAA,qEAAA;AAAA,oBACF,IAAM,EAAA;AAAA,mBACR;AAAA,kBACA,SAAW,EAAA;AAAA,oBACT,KAAO,EAAA,WAAA;AAAA,oBACP,WACE,EAAA,gGAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,MAAM,CAAC,OAAA,EAAS,KAAO,EAAA,SAAA,EAAW,OAAO,UAAU;AAAA,mBACrD;AAAA,kBACA,QAAU,EAAA;AAAA,oBACR,KAAO,EAAA,UAAA;AAAA,oBACP,WACE,EAAA,mIAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,IAAM,EAAA;AAAA,sBACJ,OAAA;AAAA,sBACA,YAAA;AAAA,sBACA,SAAA;AAAA,sBACA,QAAA;AAAA,sBACA,WAAA;AAAA,sBACA,WAAA;AAAA,sBACA,aAAA;AAAA,sBACA,gBAAA;AAAA,sBACA;AAAA;AACF,mBACF;AAAA,kBACA,YAAc,EAAA;AAAA,oBACZ,KAAO,EAAA,0BAAA;AAAA,oBACP,WACE,EAAA,4GAAA;AAAA,oBACF,IAAM,EAAA,QAAA;AAAA,oBACN,IAAM,EAAA,CAAC,KAAO,EAAA,MAAA,EAAQ,UAAU,WAAW;AAAA;AAC7C;AACF;AACF;AACF,WACF;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KAAO,EAAA,oBAAA;AAAA,YACP,WACE,EAAA,qFAAA;AAAA,YACF,IAAM,EAAA;AAAA;AACR;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAI,GAAA,CAAA,MAAA,CAAO,KAAK,0CAA0C,CAAA;AAE1D,MAAM,MAAA,OAAA,GAAU,MAAM,GAAA,CAAI,wBAAyB,EAAA;AACnD,MAAM,MAAA,SAAA,GAAYC,YAAY,CAAA,OAAA,EAAS,QAAQ,CAAA;AAE/C,MAAA,MAAMC,kCAAc,CAAA;AAAA,QAClB,MAAA;AAAA,QACA,YAAA;AAAA,QACA,OAAA,EAAS,IAAI,YAAc,EAAA,OAAA;AAAA,QAC3B,QAAA,EAAU,IAAI,KAAM,CAAA,GAAA;AAAA,QACpB,UAAY,EAAA;AAAA,OACb,CAAA;AAED,MAAA,MAAM,cAAiB,GAAA,IAAIC,6BAAe,CAAA,EAAE,iBAAiB,CAAA;AAE7D,MAAM,MAAA,EAAE,SAAU,EAAA,GAAI,GAAI,CAAA,KAAA;AAC1B,MAAA,IAAI,aAAa,CAAC,OAAA,CAAQ,iBAAmB,EAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAChE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAS,MAAA,EAAA,SAAS,CAAiB,eAAA,CAAA,CAAA;AAAA;AAGrD,MAAM,MAAA,SAAA,GAAY,IAAIC,kBAAY,EAAA;AAClC,MAAU,SAAA,CAAA,EAAA,CAAG,QAAQ,CAAS,KAAA,KAAA;AAC5B,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,EAAU,CAAA;AAAA,OACjC,CAAA;AAGD,MAAA,MAAM,eAAe,GAAI,CAAA;AAAA,QACvB,aAAe,EAAA,OAAA;AAAA,QACf,SAAA;AAAA,QACA,QAAQ,EAAE,GAAG,GAAI,CAAA,KAAA,CAAM,QAAQ,SAAU;AAAA,OAC1C,CAAA;AAGD,MAAM,MAAA,UAAA,GAAa,GAAI,CAAA,KAAA,CAAM,UAAc,IAAA,IAAA;AAC3C,MAAA,MAAM,UAAa,GAAAH,YAAA,CAAY,GAAI,CAAA,aAAA,EAAe,UAAU,CAAA;AAC5D,MAAA,IAAI,CAAC,UAAA,CAAW,UAAW,CAAA,GAAA,CAAI,aAAa,CAAG,EAAA;AAC7C,QAAA,MAAM,IAAII,iBAAA;AAAA,UACR,CAAA,4EAAA;AAAA,SACF;AAAA;AAEF,MAAM,MAAAC,mBAAA,CAAG,IAAK,CAAA,SAAA,EAAW,UAAU,CAAA;AAAA;AACrC,GACD,CAAA;AACH;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"railsNewRunner.cjs.js","sources":["../../../../src/actions/fetch/rails/railsNewRunner.ts"],"sourcesContent":["/*\n * Copyright 2021 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
|
|
1
|
+
{"version":3,"file":"railsNewRunner.cjs.js","sources":["../../../../src/actions/fetch/rails/railsNewRunner.ts"],"sourcesContent":["/*\n * Copyright 2021 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 fs from 'fs-extra';\nimport path from 'path';\nimport { executeShellCommand } from '@backstage/plugin-scaffolder-node';\nimport commandExists from 'command-exists';\nimport {\n railsArgumentResolver,\n RailsRunOptions,\n} from './railsArgumentResolver';\nimport { JsonObject } from '@backstage/types';\nimport { Writable } from 'stream';\nimport { ContainerRunner } from './ContainerRunner';\n\nexport class RailsNewRunner {\n private readonly containerRunner?: ContainerRunner;\n\n constructor({ containerRunner }: { containerRunner?: ContainerRunner }) {\n this.containerRunner = containerRunner;\n }\n\n public async run({\n workspacePath,\n values,\n logStream,\n }: {\n workspacePath: string;\n values: JsonObject;\n logStream: Writable;\n }): Promise<void> {\n const intermediateDir = path.join(workspacePath, 'intermediate');\n await fs.ensureDir(intermediateDir);\n const resultDir = path.join(workspacePath, 'result');\n\n const { name, imageName, railsArguments } = values;\n\n // Directories to bind on container\n const mountDirs = {\n [workspacePath]: '/input',\n [intermediateDir]: '/output',\n };\n\n const baseCommand = 'rails';\n const baseArguments = ['new'];\n const commandExistsToRun = await commandExists(baseCommand);\n\n if (commandExistsToRun) {\n const arrayExtraArguments = railsArgumentResolver(\n workspacePath,\n railsArguments as RailsRunOptions,\n );\n\n await executeShellCommand({\n command: baseCommand,\n args: [\n ...baseArguments,\n `${intermediateDir}${path.sep}${name}`,\n ...arrayExtraArguments,\n ],\n logStream,\n });\n } else {\n if (!imageName) {\n throw new Error('No imageName provided');\n }\n if (!this.containerRunner) {\n throw new Error(\n 'Command is not available and no container runner provided',\n );\n }\n const arrayExtraArguments = railsArgumentResolver(\n '/input',\n railsArguments as RailsRunOptions,\n true,\n );\n await this.containerRunner.runContainer({\n imageName: imageName as string,\n command: baseCommand,\n args: [...baseArguments, `/output/${name}`, ...arrayExtraArguments],\n mountDirs,\n workingDir: '/input',\n // Set the home directory inside the container as something that applications can\n // write to, otherwise they will just fail trying to write to /\n envVars: { HOME: '/tmp' },\n logStream,\n });\n }\n\n // if command was successful, intermediateDir should contain\n // exactly one directory.\n const [generated] = await fs.readdir(intermediateDir);\n\n if (generated === undefined) {\n throw new Error(`No data generated by ${baseCommand}`);\n }\n\n await fs.move(path.join(intermediateDir, generated), resultDir);\n }\n}\n"],"names":["path","fs","commandExists","railsArgumentResolver","executeShellCommand"],"mappings":";;;;;;;;;;;;;;AA4BO,MAAM,cAAe,CAAA;AAAA,EACT,eAAA;AAAA,EAEjB,WAAA,CAAY,EAAE,eAAA,EAA0D,EAAA;AACtE,IAAA,IAAA,CAAK,eAAkB,GAAA,eAAA;AAAA;AACzB,EAEA,MAAa,GAAI,CAAA;AAAA,IACf,aAAA;AAAA,IACA,MAAA;AAAA,IACA;AAAA,GAKgB,EAAA;AAChB,IAAA,MAAM,eAAkB,GAAAA,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,cAAc,CAAA;AAC/D,IAAM,MAAAC,mBAAA,CAAG,UAAU,eAAe,CAAA;AAClC,IAAA,MAAM,SAAY,GAAAD,qBAAA,CAAK,IAAK,CAAA,aAAA,EAAe,QAAQ,CAAA;AAEnD,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,cAAA,EAAmB,GAAA,MAAA;AAG5C,IAAA,MAAM,SAAY,GAAA;AAAA,MAChB,CAAC,aAAa,GAAG,QAAA;AAAA,MACjB,CAAC,eAAe,GAAG;AAAA,KACrB;AAEA,IAAA,MAAM,WAAc,GAAA,OAAA;AACpB,IAAM,MAAA,aAAA,GAAgB,CAAC,KAAK,CAAA;AAC5B,IAAM,MAAA,kBAAA,GAAqB,MAAME,8BAAA,CAAc,WAAW,CAAA;AAE1D,IAAA,IAAI,kBAAoB,EAAA;AACtB,MAAA,MAAM,mBAAsB,GAAAC,2CAAA;AAAA,QAC1B,aAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,MAAMC,wCAAoB,CAAA;AAAA,QACxB,OAAS,EAAA,WAAA;AAAA,QACT,IAAM,EAAA;AAAA,UACJ,GAAG,aAAA;AAAA,UACH,GAAG,eAAe,CAAA,EAAGJ,qBAAK,CAAA,GAAG,GAAG,IAAI,CAAA,CAAA;AAAA,UACpC,GAAG;AAAA,SACL;AAAA,QACA;AAAA,OACD,CAAA;AAAA,KACI,MAAA;AACL,MAAA,IAAI,CAAC,SAAW,EAAA;AACd,QAAM,MAAA,IAAI,MAAM,uBAAuB,CAAA;AAAA;AAEzC,MAAI,IAAA,CAAC,KAAK,eAAiB,EAAA;AACzB,QAAA,MAAM,IAAI,KAAA;AAAA,UACR;AAAA,SACF;AAAA;AAEF,MAAA,MAAM,mBAAsB,GAAAG,2CAAA;AAAA,QAC1B,QAAA;AAAA,QACA,cAAA;AAAA,QACA;AAAA,OACF;AACA,MAAM,MAAA,IAAA,CAAK,gBAAgB,YAAa,CAAA;AAAA,QACtC,SAAA;AAAA,QACA,OAAS,EAAA,WAAA;AAAA,QACT,IAAA,EAAM,CAAC,GAAG,aAAA,EAAe,WAAW,IAAI,CAAA,CAAA,EAAI,GAAG,mBAAmB,CAAA;AAAA,QAClE,SAAA;AAAA,QACA,UAAY,EAAA,QAAA;AAAA;AAAA;AAAA,QAGZ,OAAA,EAAS,EAAE,IAAA,EAAM,MAAO,EAAA;AAAA,QACxB;AAAA,OACD,CAAA;AAAA;AAKH,IAAA,MAAM,CAAC,SAAS,CAAA,GAAI,MAAMF,mBAAA,CAAG,QAAQ,eAAe,CAAA;AAEpD,IAAA,IAAI,cAAc,KAAW,CAAA,EAAA;AAC3B,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,WAAW,CAAE,CAAA,CAAA;AAAA;AAGvD,IAAA,MAAMA,oBAAG,IAAK,CAAAD,qBAAA,CAAK,KAAK,eAAiB,EAAA,SAAS,GAAG,SAAS,CAAA;AAAA;AAElE;;;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,43 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
1
2
|
import * as _backstage_plugin_scaffolder_node from '@backstage/plugin-scaffolder-node';
|
|
2
|
-
import { ContainerRunner } from '@backstage/backend-common';
|
|
3
3
|
import { JsonObject } from '@backstage/types';
|
|
4
4
|
import { ScmIntegrations } from '@backstage/integration';
|
|
5
5
|
import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
|
|
6
6
|
import { UrlReaderService } from '@backstage/backend-plugin-api';
|
|
7
|
+
import { Writable } from 'stream';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Handles the running of containers.
|
|
11
|
+
*
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
interface ContainerRunner {
|
|
15
|
+
/**
|
|
16
|
+
* Runs a container image to completion.
|
|
17
|
+
*/
|
|
18
|
+
runContainer(opts: {
|
|
19
|
+
imageName: string;
|
|
20
|
+
command?: string | string[];
|
|
21
|
+
args: string[];
|
|
22
|
+
logStream?: Writable;
|
|
23
|
+
mountDirs?: Record<string, string>;
|
|
24
|
+
workingDir?: string;
|
|
25
|
+
envVars?: Record<string, string>;
|
|
26
|
+
pullImage?: boolean;
|
|
27
|
+
defaultUser?: boolean;
|
|
28
|
+
pullOptions?: {
|
|
29
|
+
authconfig?: {
|
|
30
|
+
username?: string;
|
|
31
|
+
password?: string;
|
|
32
|
+
auth?: string;
|
|
33
|
+
email?: string;
|
|
34
|
+
serveraddress?: string;
|
|
35
|
+
[key: string]: unknown;
|
|
36
|
+
};
|
|
37
|
+
[key: string]: unknown;
|
|
38
|
+
};
|
|
39
|
+
}): Promise<void>;
|
|
40
|
+
}
|
|
7
41
|
|
|
8
42
|
/**
|
|
9
43
|
* Creates the `fetch:rails` Scaffolder action.
|
|
@@ -34,4 +68,4 @@ declare function createFetchRailsAction(options: {
|
|
|
34
68
|
*/
|
|
35
69
|
declare const railsModule: _backstage_backend_plugin_api.BackendFeature;
|
|
36
70
|
|
|
37
|
-
export { createFetchRailsAction, railsModule as default };
|
|
71
|
+
export { type ContainerRunner, createFetchRailsAction, railsModule as default };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-scaffolder-backend-module-rails",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.7-next.1",
|
|
4
4
|
"description": "A module for the scaffolder backend that lets you template projects using Rails",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin-module",
|
|
@@ -51,21 +51,20 @@
|
|
|
51
51
|
"test": "backstage-cli package test"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@backstage/backend-
|
|
55
|
-
"@backstage/
|
|
56
|
-
"@backstage/
|
|
57
|
-
"@backstage/
|
|
58
|
-
"@backstage/
|
|
59
|
-
"@backstage/
|
|
60
|
-
"@backstage/types": "^1.2.1",
|
|
54
|
+
"@backstage/backend-plugin-api": "1.2.1-next.1",
|
|
55
|
+
"@backstage/config": "1.3.2",
|
|
56
|
+
"@backstage/errors": "1.2.7",
|
|
57
|
+
"@backstage/integration": "1.16.1",
|
|
58
|
+
"@backstage/plugin-scaffolder-node": "0.7.1-next.1",
|
|
59
|
+
"@backstage/types": "1.2.1",
|
|
61
60
|
"command-exists": "^1.2.9",
|
|
62
61
|
"fs-extra": "^11.0.0",
|
|
63
62
|
"yaml": "^2.0.0"
|
|
64
63
|
},
|
|
65
64
|
"devDependencies": {
|
|
66
|
-
"@backstage/backend-test-utils": "
|
|
67
|
-
"@backstage/cli": "
|
|
68
|
-
"@backstage/plugin-scaffolder-node-test-utils": "
|
|
65
|
+
"@backstage/backend-test-utils": "1.3.1-next.1",
|
|
66
|
+
"@backstage/cli": "0.30.1-next.0",
|
|
67
|
+
"@backstage/plugin-scaffolder-node-test-utils": "0.1.20-next.1",
|
|
69
68
|
"@types/command-exists": "^1.2.0",
|
|
70
69
|
"@types/fs-extra": "^11.0.0",
|
|
71
70
|
"@types/node": "^20.16.0",
|