Initial commit

petersamokhin · petersamokhin · commit 0abac69b5705 · 2022-05-15T00:19:57.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+.idea
+*.iml
+.DS_Store
+node_modules
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Night Story Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# Replace environment variabels in files in a GitHub Action
+
+## Inputs
+
+- `input_file`
+    - Path to file with the placeholders to replace.
+- `input_file`
+    - Path to output file.
+    - Optional, defaults to `input_file`
+- `pattern`
+    - Which placeholders to replace.
+    - Options:
+      - `single_dollar_brackets` -> `${VARIABLE}`
+      - `double_dollar_brackets` -> `${{VARIABLE}}`
+      - `double_underscore` -> `__VARIABLE__`
+    - Optional, defaults to `single_dollar_brackets`
+- `fail_on_missing_env`
+    - If true, will fail if a key required in the input file is missing in the environment.
+    - default: `false`
+
+## Example usage
+
+The `input_file`:
+
+```json
+{
+  "foo": "${FOO_BAR_123}"
+}
+```
+
+⚠️ no spaces around the key.
+
+The workflow:
+
+```yaml
+name: whatever
+
+env:
+  FOO_BAR_123: 'literally whatever'
+```
+
+The result:
+
+```json
+{
+  "foo": "literally whatever"
+}
+```
+
+## License
+
+Licensed under MIT license.<br/>
+Please also see [licenses.txt](lib/licenses.txt)
diff --git a/action.yml b/action.yml
@@ -0,0 +1,24 @@
+name: 'replace-env'
+description: 'Replace environment variables in files'
+branding:
+  icon: briefcase
+  color: blue
+inputs:
+  input_file:
+    description: 'Input file path'
+    required: true
+  output_file:
+    description: 'Output file path'
+    default: ''
+    required: false
+  fail_on_missing_env:
+    description: 'Whether to fail if an env var mentioned in the input file does not exist'
+    default: 'false'
+    required: false
+  pattern:
+    description: 'Pattern to replace the variables: single_dollar_brackets, double_dollar_brackets, double_underscore'
+    default: 'single_dollar_brackets'
+    required: false
+runs:
+  using: 'node16'
+  main: 'lib/index.js'
diff --git a/lib/index.js b/lib/index.js
diff --git a/lib/index.js.map b/lib/index.js.map
diff --git a/lib/licenses.txt b/lib/licenses.txt
@@ -0,0 +1,60 @@
+@actions/core
+MIT
+The MIT License (MIT)
+
+Copyright 2019 GitHub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+@actions/http-client
+MIT
+Actions Http Client for Node.js
+
+Copyright (c) GitHub, Inc.
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+tunnel
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2012 Koichi Kobayashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/lib/sourcemap-register.js b/lib/sourcemap-register.js
diff --git a/package.json b/package.json
@@ -0,0 +1,34 @@
+{
+  "name": "replace-env",
+  "description": "Replace environment variables in files",
+  "version": "1.0.0",
+  "keywords": [
+    "github",
+    "actions",
+    "github actions",
+    "replace",
+    "environment variables"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nightstory/replace-env.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nightstory/replace-env/issues"
+  },
+  "homepage": "https://github.com/nightstory/replace-env#readme",
+  "author": "nightstory",
+  "dependencies": {
+    "@actions/core": "^1.8.2"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.17",
+    "@vercel/ncc": "^0.33.3",
+    "typescript": "^4.5.5"
+  },
+  "scripts": {
+    "build": "node_modules/.bin/ncc build --license licenses.txt --source-map -m -q src/main.ts -o lib"
+  }
+}
diff --git a/src/main.ts b/src/main.ts
@@ -0,0 +1,74 @@
+import * as core from '@actions/core'
+import fs from 'fs';
+
+import getOptions, {Options, ReplacementPattern, validateOptions} from './options'
+
+const main = async () => {
+  const options: Options = getOptions()
+
+  if (!validateOptions(options)) {
+    process.exit(1)
+  }
+
+  let pattern = /\${\w+}/gi;
+  let matcher = /\${(?<var>\w+)}/i;
+
+  switch (options.pattern) {
+    case ReplacementPattern.SingleDollarBrackets:
+      pattern = /\${\w+}/gi;
+      matcher = /\${(?<var>\w+)}/i;
+      break;
+    case ReplacementPattern.DoubleDollarBrackets:
+      pattern = /\${{\w+}}/gi;
+      matcher = /\${{(?<var>\w+)}}/i;
+      break;
+    case ReplacementPattern.DoubleUnderscore:
+      pattern = /__\w+__/gi;
+      matcher = /__(?<var>\w+)__/i;
+      break;
+  }
+
+  if (fs.existsSync(options.inputFile)) {
+    const data = fs.readFileSync(options.inputFile, 'utf8');
+    const res = data.replace(pattern, (c) => {
+      const match = c.match(matcher);
+
+      if (match === null) {
+        core.warning(`[replace-env] error happened, invalid match for ${c}: ${match}`)
+        return c;
+      }
+
+      let env = process.env[match[1]];
+
+      if (typeof env === 'undefined') {
+        if (options.failOnMissingEnv) {
+          core.error(`[replace-env] Environment Variable ${match[1]} not found!`);
+          throw new Error('[replace-env] Environment Variable ${match[1]} not found!');
+        } else {
+          core.warning(`[replace-env] Environment Variable ${match[1]} not found!`);
+          env = c;
+        }
+      } else {
+        core.info(`[replace-env] Replacing Environment Variable ${match[1]}.`);
+      }
+
+      return env;
+    });
+
+    let resultFile = options.inputFile;
+    if (options.outputFile !== null) {
+      resultFile = options.outputFile;
+    }
+
+    fs.writeFileSync(resultFile, res);
+    core.info(`[replace-env] File ${resultFile} saved.`);
+  } else {
+    throw new Error('[replace-env] input_file is missing')
+  }
+}
+
+try {
+  main()
+} catch (error) {
+  core.setFailed(`${error}`)
+}
diff --git a/src/options.ts b/src/options.ts
@@ -0,0 +1,77 @@
+import * as core from '@actions/core'
+
+export interface Options {
+  readonly inputFile: string
+  readonly outputFile: string | null
+  readonly failOnMissingEnv: boolean
+  readonly pattern: ReplacementPattern
+}
+
+export enum ReplacementPattern {
+  SingleDollarBrackets, DoubleDollarBrackets, DoubleUnderscore
+}
+
+const patternMap: { [key: string]: ReplacementPattern } = {
+  'single_dollar_brackets': ReplacementPattern.SingleDollarBrackets,
+  'double_dollar_brackets': ReplacementPattern.DoubleDollarBrackets,
+  'double_underscore': ReplacementPattern.DoubleUnderscore,
+}
+
+const defaultPattern = 'single_dollar_brackets'
+
+const findOption: (inputKey: string, envKey: string | null) => (string | null) =
+  (inputKey, envKey) => {
+    const input = core.getInput(inputKey)
+
+    if (input.length === 0) {
+      if (envKey !== null) {
+        return process.env[envKey] ?? null
+      } else {
+        return null
+      }
+    } else {
+      return input
+    }
+  }
+
+const requireOption: (inputKey: string, envKey: string | null) => string =
+  (inputKey, envKey) => {
+    const result = findOption(inputKey, envKey)
+    if (!result) {
+      core.setFailed(`input ${inputKey} (or env ${envKey}) is required but was missing`)
+      process.exit(1)
+    }
+    return result!
+  }
+
+const getFlag: (inputKey: string, envKey: string | null, def: boolean) => boolean =
+  (inputKey, envKey, def) => {
+    const result = findOption(inputKey, envKey)
+    return result ? result === 'true' : def
+  }
+
+const getOptions: () => Options = () => ({
+  inputFile: requireOption('input_file', null),
+  outputFile: findOption('output_file', null),
+  failOnMissingEnv: getFlag('fail_on_missing_env', null, false),
+  pattern: patternMap[findOption('pattern', null) ?? defaultPattern]!,
+})
+
+export const validateOptions: (options: Options) => boolean =
+  (o) => {
+    let result = true
+
+    if ([o.inputFile].some(v => v.length === 0)) {
+      core.setFailed(`input_file must not be empty`)
+      result = false
+    }
+
+    if (o.outputFile !== null && o.outputFile.length === 0) {
+      core.setFailed(`output_file must not be empty`)
+      result = false
+    }
+
+    return result
+  }
+
+export default getOptions
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2015",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.idea
 +*.iml
 +.DS_Store
 +node_modules