Merge pull request #425 from fjogeleit/implement-jsonpath

Use JSONPath for value updates

Author: fjogeleit

README.md

@@ -84,7 +84,7 @@ jobs:
 |Argument  |  Description  |  Default  |
 |----------|---------------|-----------|
 |valueFile | relative path from the Workspace Directory| _required_ Field |
-|propertyPath| PropertyPath for the new value | _required_ Field |
+|propertyPath| PropertyPath for the new value, JSONPath supported | _required_ Field |
 |value  | New value for the related PropertyPath| _required_ Field |
 |repository| The Repository where the YAML file is located and should be updated. You have to checkout this repository too and set the working-directory for this action to the same as the repository. See the example below | ${{github.repository}} |
 |commitChange| Commit the change to __branch__ with the given __message__ | true |

__tests__/action.test.ts

@@ -1,6 +1,6 @@
 import * as process from 'process'
 import * as path from 'path'
-import {runTest} from '../src/action'
+import {runTest, YamlNode} from '../src/action'
 import {EnvOptions} from '../src/options'
 
 test('test success', async () => {
@@ -10,19 +10,21 @@ test('test success', async () => {
   process.env['VALUE'] = 'v1.1.0'
   process.env['BRANCH'] = 'deployment/v1.1.0'
 
-  const {json, yaml} = await runTest<{backend: {version: string}; frontend: boolean}>(new EnvOptions())
+  const {json, yaml} = await runTest<{backend: {version: string}; frontend: YamlNode}>(new EnvOptions())
 
   expect(json.backend.version).toEqual(process.env['VALUE'])
   console.info(yaml)
 })
 
-test('test yaml value path error', async () => {
+test('test add new property', async () => {
   process.env['VALUE_FILE'] = 'fixtures/values.yaml'
   process.env['WORK_DIR'] = '__tests__'
   process.env['VALUE_PATH'] = 'frontend.version'
   process.env['VALUE'] = 'v1.1.0'
 
-  expect(runTest(new EnvOptions())).rejects.toThrowError('invalid property path - frontend is not an object')
+  const {json} = await runTest<{backend: {version: string}; frontend: YamlNode}>(new EnvOptions())
+
+  expect(json.frontend).toEqual({version: 'v1.1.0'})
 })
 
 test('test yaml file path error', async () => {
@@ -44,3 +46,25 @@ test('test yaml file parse error', async () => {
 
   expect(runTest(new EnvOptions())).rejects.toThrowError(`could not parse content as YAML`)
 })
+
+test('test array item change - old syntax', async () => {
+  process.env['VALUE_FILE'] = 'fixtures/values.yaml'
+  process.env['WORK_DIR'] = '__tests__'
+  process.env['VALUE_PATH'] = 'containers.0.image'
+  process.env['VALUE'] = 'nginx:alpine'
+
+  const {json, yaml} = await runTest<{containers: Array<{name: string; image: string}>}>(new EnvOptions())
+
+  expect(json.containers[0].image).toEqual(process.env['VALUE'])
+})
+
+test('test array item change - new syntax', async () => {
+  process.env['VALUE_FILE'] = 'fixtures/values.yaml'
+  process.env['WORK_DIR'] = '__tests__'
+  process.env['VALUE_PATH'] = 'containers[0].image'
+  process.env['VALUE'] = 'nginx:alpine'
+
+  const {json, yaml} = await runTest<{containers: Array<{name: string; image: string}>}>(new EnvOptions())
+
+  expect(json.containers[0].image).toEqual(process.env['VALUE'])
+})

__tests__/fixtures/values.yaml

@@ -1,4 +1,9 @@
 backend:
   version: v1.2.0
-frontent: false
+frontend: {}
+containers:
+  - name: nginx
+    image: nginx:latest
+  - name: node
+    image: node:latest
 config: {}