B2B-866: Implement iterative configuration generation (#9)

Author: levonet

.github/workflows/test.yml

@@ -51,3 +51,24 @@ jobs:
     - run: echo '${{ steps.plain.outputs.result }}'
     - if: ${{ toJSON(steps.plain.outputs.result) != '"root\ntestA\ntestB\n"' }}
       run: 'false'
+
+    - uses: ./
+      id: loop
+      with:
+        output_properties: 'true'
+        patterns: |
+          - test/assets/conf1.yml
+          - test/assets/{{ item }}/conf1.yml
+        loop: |
+          a
+          a/c
+          b
+    - run: echo '${{ steps.loop.outputs.result }}'
+    - if: ${{ steps.loop.outputs.result != '{"a":{"test":"a1"},"a/c":{"test":"c1"},"b":{"test":"b1"}}' }}
+      run: 'false'
+    - if: ${{ steps.loop.outputs.a != '{"test":"a1"}' }}
+      run: 'false'
+    - if: ${{ steps.loop.outputs.a_c != '{"test":"c1"}' }}
+      run: 'false'
+    - if: ${{ steps.loop.outputs.b != '{"test":"b1"}' }}
+      run: 'false'

README.md

@@ -125,6 +125,34 @@ Output each property of the object as JSON.
 
 Default: `false`.
 
+### `loop`
+
+If `loop` is defined, then the action is repeated as many times as the number of rows in the variable's content.
+All found mentions of `{{ item }}` in the pattern are replaced with a row from the `loop` variable.
+The iterative execution of the action returns the object as JSON, where the key contains a row,
+and the value is the result of the execution of the action according to the pattern.
+Also it has output for each row as a serialized key with value in JSON if `output_properties` is enabled.
+
+Example:
+
+```yml
+- uses: blablacar/action-config-levels@master
+  id: config
+  with:
+    patterns: |
+      - {{ item }}/common.yml
+      - {{ item }}/${{ env.ENV }}.yml
+    loop: |
+      dir1
+      dir2/subdir
+
+- run: echo '${{ steps.config.outputs.result }}'
+
+- run: echo '${{ steps.config.outputs.dir1 }}'
+
+- run: echo '${{ steps.config.outputs.dir2_subdir }}'
+```
+
 ## Outputs
 
 ###  `result`

action.yml

@@ -31,6 +31,13 @@ inputs:
       Output each property of the object as JSON.
       Default: 'false'.
     default: 'false'
+  loop:
+    description: |
+      If `loop` is defined, then the action is repeated as many times as the number of rows in the variable's content.
+      All found mentions of `{{ item }}` in the pattern are replaced with a row from the `loop` variable.
+      The iterative execution of the action returns the object as JSON, where the key contains a row,
+      and the value is the result of the execution of the action according to the pattern.
+      Also it has output for each row as a serialized key with value in JSON if `output_properties` is enabled.
 outputs:
   result:
     description: Merged configuration as JSON or plain text.

dist/index.js

@@ -10,6 +10,31 @@ The above copyright notice and this permission notice shall be included in all c
 
 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.
+
+
 @vercel/ncc
 MIT
 Copyright 2018 ZEIT, Inc.
@@ -316,6 +341,44 @@ 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.
+
+
+uuid
+MIT
+The MIT License (MIT)
+
+Copyright (c) 2010-2020 Robert Kieffer and other contributors
+
+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.
+
+
 wrappy
 ISC
 The ISC License

dist/licenses.txt

@@ -1,6 +1,7 @@
 const logWrapper = require('./log')
 const { getFiles, getLevels } = require('./levels')
 const { getType, mergeLevels } = require('./merge')
+const { modifyPattern } = require('./parser')
 
 function configLevels(patterns, options, log = console) {
     const files = getFiles(patterns)
@@ -9,8 +10,12 @@ function configLevels(patterns, options, log = console) {
     return mergeLevels(levels, options, log)
 }
 
+function safeKey(key) {
+    return key.replace(/[^\w_-]+/gu, '_')
+}
+
 function setOutputAndPrint(core, key, value) {
-    const outputKey = key.replace(/[^\w_-]+/gu, '_')
+    const outputKey = safeKey(key)
     if (outputKey.match(/^[a-zA-Z_]/u) === null) {
         core.warning(`Can't set output key "${outputKey}". Name of output key must start with a letter or _.`)
         return
@@ -28,7 +33,8 @@ function setOutputAndPrint(core, key, value) {
 function run(core) {
     const log = logWrapper(core)
     const patterns = core.getInput('patterns', {required: true})
-    const outputProperties = core.getInput('output_properties')
+    const outputProperties = core.getBooleanInput('output_properties')
+    const loop = core.getMultilineInput('loop')
     const options = {
         mergeObject: core.getInput('merge_object'),
         mergeArray: core.getInput('merge_array'),
@@ -48,17 +54,44 @@ function run(core) {
         return
     }
 
-    core.info('patterns:')
-    core.info(patterns)
+    let result
 
-    const result = configLevels(patterns, options, log)
+    /* TODO: Loop it using external action (action-loop) based on
+     * - https://github.com/nektos/act/blob/master/pkg/runner/step_action_remote.go
+     * - https://github.com/cardinalby/github-action-ts-run-api
+     */
+    if (loop.length) {
+        result = {}
+
+        for (const item of loop) {
+            core.startGroup(`Pattern processing with '${item}' item`)
+            const modifiedPattern = modifyPattern(patterns, item)
+            const resultValue = processingLevels(core, modifiedPattern, options, log)
+            if (resultValue === null) {
+                core.endGroup()
+                continue
+            }
+
+            result[item] = resultValue
+
+            if (outputProperties) {
+                setOutputAndPrint(core, item, resultValue)
+            }
+            core.endGroup()
+        }
+
+        setOutputAndPrint(core, 'result', result)
+
+        return
+    }
+
+    result = processingLevels(core, patterns, options, log)
     if (result === null) {
-        core.info('Nothing to output.')
         return
     }
 
     const resultType = getType([result])
-    if (outputProperties === 'true' && resultType === 'object') {
+    if (outputProperties && resultType === 'object') {
         for (const [key, value] of Object.entries(result)) {
             setOutputAndPrint(core, key, value)
         }
@@ -67,6 +100,18 @@ function run(core) {
     setOutputAndPrint(core, 'result', result)
 }
 
+function processingLevels(core, patterns, options, log) {
+    core.info('patterns:')
+    core.info(patterns)
+
+    const result = configLevels(patterns, options, log)
+    if (result === null) {
+        core.info('Nothing to output.')
+    }
+
+    return result
+}
+
 module.exports = {
     configLevels,
     run

lib/action.js

@@ -0,0 +1,20 @@
+
+function modifyPattern(patterns, item) {
+    const reItem = /\{\{(.*?)\}\}/
+    const patternContent = patterns.split('\n')
+    const options = {item: item}
+
+    for (let i = 0; i < patternContent.length; i++) {
+        for (let match = patternContent[i].match(reItem), result; match;) {
+            result = options[match[1].trim()]
+            patternContent[i] = patternContent[i].replace(match[0], result ? result : '')
+            match = patternContent[i].match(reItem)
+        }
+    }
+
+    return patternContent.join('\n')
+}
+
+module.exports = {
+    modifyPattern
+}

lib/parser.js

@@ -0,0 +1,14 @@
+const parser = require('../lib/parser')
+
+describe('test modifyPattern()', () => {
+    test('expect modifed pattern in several rows', () => {
+        expect(parser.modifyPattern('- test/{{ item }}/**/foo.yml\n- test/{{ item }}/**/boo.yml', 'a'))
+            .toEqual('- test/a/**/foo.yml\n- test/a/**/boo.yml')
+    })
+    test('expect several modification in one row', () => {
+        expect(parser.modifyPattern('- test/{{item}}/**/{{item}}/foo.yml', 'a')).toEqual('- test/a/**/a/foo.yml')
+    })
+    test('expect brackets to be removed if the variable does not exist', () => {
+        expect(parser.modifyPattern('- test/{{ boo }}/**/foo.yml', 'a')).toEqual('- test//**/foo.yml')
+    })
+})

test/parser.test.js

@@ -3,9 +3,9 @@
 
 
 "@actions/core@^1.9.1":
-  version "1.9.1"
-  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.9.1.tgz#97c0201b1f9856df4f7c3a375cdcdb0c2a2f750b"
-  integrity sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==
+  version "1.10.0"
+  resolved "https://registry.yarnpkg.com/@actions/core/-/core-1.10.0.tgz#44551c3c71163949a2f06e94d9ca2157a0cfac4f"
+  integrity sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==
   dependencies:
     "@actions/http-client" "^2.0.1"
     uuid "^8.3.2"