Merge pull request #4 from caseycs/allow-emty-map

allow empty map #3

Author: caseycs

.github/workflows/ci.yml

@@ -53,14 +53,26 @@ jobs:
         id: checkout
         uses: actions/checkout@v4
 
-      - name: Test Local Action
-        id: test-action
+      - name: Test Local Action 1
+        id: test-action-1
         uses: ./
         with:
           key: staging-5
           map: |
             staging-\d+: staging
 
-      - name: Print Output
-        id: output
-        run: echo "${{ steps.test-action.outputs.value }}"
+      - name: Test Local Action 1 - print output
+        run: set -e; [ "${{ steps.test-action-1.outputs.value }}" == "staging" ]
+
+      - name: Test Local Action 2
+        id: test-action-2
+        uses: ./
+        with:
+          key: staging-5
+          allow_empty_map: true
+          mode: fallback-to-original
+          map: ''
+
+      - name: Test Local Action 2 - print output
+        run:
+          set -e; [ "${{ steps.test-action-2.outputs.value }}" == "staging-5" ]

README.md

@@ -93,3 +93,21 @@ Also showcasing different output options
     echo ${{ steps.mapper.outputs.value }}
   # playground
 ```
+
+## Edge case - map can be empty
+
+Mode `strict` is not supported in this case
+
+```yaml
+- uses: caseycs/single-variable-mapper@master
+  id: mapper
+  with:
+    key: staging-5
+    map: ''
+    mode: fallback-to-original
+    allow_empty_map: true
+- name: Print mapped value
+  run: |
+    echo ${{ steps.mapper.outputs.value }}
+  # staging-5
+```

__tests__/main.test.ts

@@ -190,6 +190,107 @@ describe('correct input values, edge cases', () => {
   })
 })
 
+describe('allowed empty map', () => {
+  beforeEach(() => {
+    jest.clearAllMocks()
+
+    errorMock = jest.spyOn(core, 'error').mockImplementation()
+    getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
+    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
+    setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
+    exportVariableMock = jest.spyOn(core, 'exportVariable').mockImplementation()
+  })
+
+  it('map not empty, fallback-to-default', () => {
+    const input: { [name: string]: string } = {
+      key: 'k1',
+      map: 'k1:v2',
+      separator: ':',
+      export_to: 'output',
+      mode: 'fallback-to-default',
+      allow_empty_map: '1'
+    }
+    getInputMock.mockImplementation(name => input[name])
+
+    main.run()
+    expect(runMock).toHaveReturned()
+
+    expect(errorMock).not.toHaveBeenCalled()
+    expect(exportVariableMock).not.toHaveBeenCalled()
+    expect(setFailedMock).not.toHaveBeenCalled()
+
+    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'value', 'v2')
+  })
+
+  it('map not empty, strict', () => {
+    const input: { [name: string]: string } = {
+      key: 'k1',
+      map: 'k1:v2',
+      separator: ':',
+      export_to: 'output',
+      mode: 'strict',
+      allow_empty_map: '1'
+    }
+    getInputMock.mockImplementation(name => input[name])
+
+    main.run()
+    expect(runMock).toHaveReturned()
+
+    expect(errorMock).not.toHaveBeenCalled()
+    expect(exportVariableMock).not.toHaveBeenCalled()
+    expect(setOutputMock).not.toHaveBeenCalled()
+
+    expect(setFailedMock).toHaveBeenNthCalledWith(
+      1,
+      'Strict mode is not possible when empty map is allowed'
+    )
+  })
+
+  it('map empty, fallback-to-default', () => {
+    const input: { [name: string]: string } = {
+      key: 'k1',
+      map: '',
+      separator: ':',
+      export_to: 'output',
+      mode: 'fallback-to-default',
+      default: 'v2',
+      allow_empty_map: '1'
+    }
+    getInputMock.mockImplementation(name => input[name])
+
+    main.run()
+    expect(runMock).toHaveReturned()
+
+    expect(errorMock).not.toHaveBeenCalled()
+    expect(exportVariableMock).not.toHaveBeenCalled()
+    expect(setFailedMock).not.toHaveBeenCalled()
+
+    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'value', 'v2')
+  })
+
+  it('map empty, fallback-to-original', () => {
+    const input: { [name: string]: string } = {
+      key: 'k1',
+      map: '',
+      separator: ':',
+      export_to: 'output',
+      mode: 'fallback-to-original',
+      default: 'v2',
+      allow_empty_map: '1'
+    }
+    getInputMock.mockImplementation(name => input[name])
+
+    main.run()
+    expect(runMock).toHaveReturned()
+
+    expect(errorMock).not.toHaveBeenCalled()
+    expect(exportVariableMock).not.toHaveBeenCalled()
+    expect(setFailedMock).not.toHaveBeenCalled()
+
+    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'value', 'k1')
+  })
+})
+
 describe('input validation', () => {
   beforeEach(() => {
     jest.clearAllMocks()
@@ -204,7 +305,10 @@ describe('input validation', () => {
   it('empty key', () => {
     const input: { [name: string]: string } = {
       key: '',
-      map: 'k1:v1'
+      map: 'k1:v1',
+      separator: ':',
+      mode: 'strict',
+      export_to: 'output'
     }
     getInputMock.mockImplementation(name => input[name])
 
@@ -221,7 +325,9 @@ describe('input validation', () => {
   it('empty map', () => {
     const input: { [name: string]: string } = {
       key: 'k1',
-      map: ''
+      map: '',
+      mode: 'strict',
+      export_to: 'output'
     }
     getInputMock.mockImplementation(name => input[name])
 
@@ -239,7 +345,9 @@ describe('input validation', () => {
     const input: { [name: string]: string } = {
       key: 'k1',
       map: 'k1:v1',
-      separator: ''
+      mode: 'strict',
+      separator: '',
+      export_to: 'output'
     }
     getInputMock.mockImplementation(name => input[name])
 
@@ -253,10 +361,34 @@ describe('input validation', () => {
     expect(setFailedMock).toHaveBeenNthCalledWith(1, 'Separator is empty')
   })
 
+  it('incorrect mode', () => {
+    const input: { [name: string]: string } = {
+      key: 'k1',
+      map: 'k1:v1',
+      mode: 'invalid',
+      separator: ':',
+      export_to: 'env'
+    }
+    getInputMock.mockImplementation(name => input[name])
+
+    main.run()
+    expect(runMock).toHaveReturned()
+
+    expect(errorMock).not.toHaveBeenCalled()
+    expect(exportVariableMock).not.toHaveBeenCalled()
+    expect(setOutputMock).not.toHaveBeenCalled()
+
+    expect(setFailedMock).toHaveBeenNthCalledWith(
+      1,
+      expect.stringMatching('Invalid mode')
+    )
+  })
+
   it('incorrect export_to - empty', () => {
     const input: { [name: string]: string } = {
       key: 'k1',
       map: 'k1:v1',
+      mode: 'strict',
       separator: ':',
       export_to: ''
     }
@@ -271,14 +403,15 @@ describe('input validation', () => {
 
     expect(setFailedMock).toHaveBeenNthCalledWith(
       1,
-      expect.stringMatching('Invalid mode')
+      expect.stringMatching('Invalid export_to')
     )
   })
 
   it('incorrect export_to - invalid', () => {
     const input: { [name: string]: string } = {
       key: 'k1',
       map: 'k1:v1',
+      mode: 'strict',
       separator: ':',
       export_to: 'env,invalid'
     }
@@ -293,7 +426,7 @@ describe('input validation', () => {
 
     expect(setFailedMock).toHaveBeenNthCalledWith(
       1,
-      expect.stringMatching('Invalid mode')
+      expect.stringMatching('Invalid export_to')
     )
   })
 

action.yml

@@ -18,9 +18,9 @@ inputs:
     required: true
   export_to:
     description:
-      'Comma-separated list of targets to export variables to. log, env and
-      output are valid values.'
-    default: 'output,log'
+      'Comma-separated list of targets to export variables to. Possible optoins:
+      env, output'
+    default: 'output'
   export_to_env_name:
     description: 'Environment variable name when export_to contains env'
     default: ''
@@ -37,6 +37,11 @@ inputs:
       'Default value, used when mode is fallback-to-default and not match was
       found'
     default: ''
+  allow_empty_map:
+    description:
+      'Do not throw error when empty map was provided, requires mode to be other
+      than strict'
+    default: ''
 
 # Define your outputs here.
 outputs: