Add ignore ssl error (#145)

* add ignore ssl
* build and update docs
* keep the upstream formatting/indentation

.github/workflows/ci.yml

@@ -123,31 +123,21 @@ jobs:
       
       - name: Create Test File
         run: |
-          echo "test" > testfile1.txt
-          echo "test" > testfile2.txt
-
+          echo "test" > testfile.txt
       - name: Request Postman Echo POST Multipart
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
           data: '{ "key": "value" }'
-          files: '{ "file": "${{ github.workspace }}/testfile1.txt" }'
-
-      - name: Request Postman Echo POST Multipart File Array
-        uses: ./
-        with:
-          url: 'https://postman-echo.com/post'
-          method: 'POST'
-          data: '{ "key": "value" }'
-          files: '{ "file": ["${{ github.workspace }}/testfile1.txt", "${{ github.workspace }}/testfile2.txt"] }'
+          files: '{ "file": "${{ github.workspace }}/testfile.txt" }'
 
       - name: Request Postman Echo POST and persist response
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
-          file: "${{ github.workspace }}/testfile1.txt"
+          file: "${{ github.workspace }}/testfile.txt"
           responseFile: "${{ github.workspace }}/response.json"
       - name: Output responseFile
         run: |
@@ -158,14 +148,14 @@ jobs:
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
-          files: '{ "file": "${{ github.workspace }}/testfile1.txt" }'
+          files: '{ "file": "${{ github.workspace }}/testfile.txt" }'
 
       - name: Request Postman Echo POST single file
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
-          file: "${{ github.workspace }}/testfile1.txt"
+          file: "${{ github.workspace }}/testfile.txt"
 
       - name: Request Postman Echo POST URLEncoded string data
         uses: ./

README.md

@@ -45,8 +45,10 @@ jobs:
 |httpsCert| Client Certificate as string ||
 |httpsKey| Client Certificate Key as string ||
 |responseFile| Persist the response data to the specified file path ||
+|maskResponse| If set to true, the response will be masked in the logs of the action |'false'|
 |retry| optional amount of retries if the request is failing, does not retry if the status code is ignored ||
 |retryWait| time between each retry in millseconds | 3000 |
+|ignoreSsl| ignore ssl verify (rejectUnauthorized: false) | false |
 
 ### Response
 
@@ -99,4 +101,4 @@ Optionen:
       --bearerToken    bearer token without Bearer prefix, added as
                        Authorization header                            [string]
       --timeout        request timeout                                 [number] [default: 5000]
-```
+```

action.yml

@@ -29,7 +29,7 @@ inputs:
         description: 'Auth Password'
         required: false
     timeout:
-        description: 'Request Timeout in Sec'
+        description: 'Request Timeout in milliseconds'
         required: false
         default: '5000'
     bearerToken:
@@ -59,17 +59,24 @@ inputs:
     responseFile:
         description: 'Persist the response data to the specified file path'
         required: false
+    maskResponse:
+        description: 'Allows to mark your response as secret and hide the output in the action logs'
+        required: false
+        default: 'false'
     retry:
         description: 'optional amount of retries if the request fails'
         required: false
     retryWait:
         description: 'wait time between retries in milliseconds'
         required: false
+    ignoreSsl:
+        description: 'ignore ssl verify (rejectUnauthorized: false)'
+        default: 'false'
 outputs:
     response:
         description: 'HTTP Response Content'
     headers:
         description: 'HTTP Response Headers'
 runs:
-    using: 'node16'
+    using: 'node20'
     main: 'dist/index.js'

package.json

@@ -25,9 +25,7 @@
     "yargs": "^17.7.2"
   },
   "dependencies": {
-    "@actions/core": "^1.10.1",
-    "install": "^0.13.0",
-    "npm": "^10.2.4"
+    "@actions/core": "^1.10.1"
   },
   "engines": {
     "node": ">=16.0.0"

src/githubActions.js

@@ -19,6 +19,10 @@ class GithubActions {
     core.setOutput(name, output)
   }
 
+  setSecret(value) {
+    core.setSecret(value)
+  }
+
   setFailed(message) {
     core.setFailed(message)
   }

src/handler/mask.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const axios = require('axios');
+const { GithubActions } = require('../githubActions');
+
+/**
+ * @param {GithubActions} actions
+ * 
+ * @returns {(response: axios.AxiosResponse) => void}
+ */
+const createMaskHandler = (actions) => (response) => {
+    actions.setSecret(JSON.stringify(response.data))
+}
+
+module.exports = { createMaskHandler }

src/handler/output.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const axios = require('axios');
+const { GithubActions } = require('../githubActions');
+
+/**
+ * @param {GithubActions} actions
+ * 
+ * @returns {(response: axios.AxiosResponse) => void}
+ */
+const createOutputHandler  = (actions) => (response) => {
+    actions.setOutput('response', JSON.stringify(response.data))
+    actions.setOutput('headers', response.headers)
+}
+
+module.exports = { createOutputHandler }

src/helper.js

@@ -24,7 +24,7 @@ const convertToJSON = (value) => {
  *
  * @returns {FormData}
  */
-const convertToFormData = async (data, files, convertPaths) => {
+const convertToFormData = (data, files, convertPaths) => {
   const formData = new FormData();
 
   for (const [key, value] of Object.entries(data)) {
@@ -32,11 +32,7 @@ const convertToFormData = async (data, files, convertPaths) => {
   }
 
   for (const [key, value] of Object.entries(files)) {
-    if (Array.isArray(value)) {
-      value.forEach(v => formData.append(key, fs.createReadStream(v)))
-    } else {
-      formData.append(key, fs.createReadStream(value));
-    }
+    formData.append(key, fs.createReadStream(value));
   }
 
   return formData;
@@ -59,7 +55,7 @@ const retry = async (callback, options) => {
       lastErr = err;
     }
 
-    if (i < options.retries) {
+    if (i < options.retry) {
       options.actions.warning(`#${i + 1} request failed: ${err}`);
       await sleep(options.sleep);
     }

src/httpClient.js

@@ -94,10 +94,10 @@ const request = async({ method, instanceConfig, data, files, file, actions, opti
       } catch(error) {
         if (error.response && options.ignoredCodes.includes(error.response.status)) {
           actions.warning(`ignored status code: ${JSON.stringify({ code: error.response.status, message: error.response.data })}`)
-          
-          return null
+
+          return error.response
         }
-        
+
         if (!error.response && error.request && options.preventFailureOnNoResponse) {
           actions.warning(`no response received: ${JSON.stringify(error)}`);
 
@@ -119,9 +119,6 @@ const request = async({ method, instanceConfig, data, files, file, actions, opti
       return null
     }
 
-    actions.setOutput('response', JSON.stringify(response.data))
-    actions.setOutput('headers', response.headers)
-
     return response
   } catch (error) {
     if ((typeof error === 'object') && (error.isAxiosError === true)) {

src/index.js

@@ -5,7 +5,10 @@ const axios = require('axios');
 const https = require('https');
 const { request, METHOD_POST } = require('./httpClient');
 const { GithubActions } = require('./githubActions');
+
 const { createPersistHandler } = require('./handler/persist');
+const { createOutputHandler } = require('./handler/output');
+const { createMaskHandler } = require('./handler/mask');
 
 let customHeaders = {}
 
@@ -26,6 +29,9 @@ if (!!core.getInput('bearerToken')) {
 
 /** @type {axios.AxiosRequestConfig} */
 const instanceConfig = {
+  httpsAgent: new https.Agent({
+    rejectUnauthorized: core.getInput('ignoreSsl') !== 'true',
+  }),
   baseURL: core.getInput('url', { required: true }),
   timeout: parseInt(core.getInput('timeout') || 5000, 10),
   headers: { ...headers, ...customHeaders }
@@ -55,7 +61,7 @@ if (!!core.getInput('retry')) {
 
 let retryWait = 3000
 if (!!core.getInput('retryWait')) {
-  retry = parseInt(core.getInput('retryWait'))
+  retryWait = parseInt(core.getInput('retryWait'))
 }
 
 const data = core.getInput('data') || '{}';
@@ -73,9 +79,16 @@ if (typeof ignoreStatusCodes === 'string' && ignoreStatusCodes.length > 0) {
   ignoredCodes = ignoreStatusCodes.split(',').map(statusCode => parseInt(statusCode.trim()))
 }
 
-const handler = [];
 const actions = new GithubActions();
 
+const handler = [];
+
+if (core.getBooleanInput('maskResponse')) {
+  handler.push(createMaskHandler(actions))
+}
+
+handler.push(createOutputHandler(actions))
+
 if (!!responseFile) {
   handler.push(createPersistHandler(responseFile, actions))
 }
@@ -89,7 +102,7 @@ const options = {
 }
 
 request({ data, method, instanceConfig, files, file, actions, options }).then(response => {
-  if (typeof response == 'object') {
+  if (response && typeof response == 'object') {
     handler.forEach(h => h(response))
   }
-})
+})