Ignored status codes (#26 )

* Implement StatusCode ignore list
Build new version
2026-02-04 16:45:52 +08:00 · 2021-03-19 17:28:53 +01:00 · 2021-02-19 12:51:47 +01:00 · 2021-02-19 11:36:10 +01:00 · 2021-01-26 17:49:24 +01:00 · 2021-01-24 14:09:17 +01:00
8 changed files with 2059 additions and 74 deletions
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -42,3 +42,23 @@ jobs:
          method: 'GET'
          username: 'postman'
          password: 'password'
+      
+      - name: Request Postment Echo with 404 Response and ignore failure code
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/status/404'
+          method: 'GET'
+          ignoreStatusCodes: '404'
+      
+      - name: Create Test File
+        id: image
+        run: |
+          echo "test" > testfile.txt
+
+      - name: Request Postment Echo POST Multipart
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/post'
+          method: 'POST'
+          data: '{ "key": "value" }'
+          files: '{ "file": "${{ github.workspace }}/testfile.txt" }'
--- a/README.md
+++ b/README.md
@@ -1,21 +1,23 @@
 # HTTP Request Action

-Create any kind of HTTP Requests in your GitHub actions to trigger Tools like Ansible AWX
+**Create HTTP Requests from GitHub Actions.** This action allows GitHub events to engage with tools like Ansible AWX that use HTTP APIs.

-Example Usage:
-```
+### Example
+```yaml
 jobs:
-    deployment
-        - name: Deploy Stage
-            uses: fjogeleit/http-request-action@master
-            with:
-                url: 'https://ansible.io/api/v2/job_templates/84/launch/'
-                method: 'POST'
-                username: ${{ secrets.AWX_USER }}
-                password: ${{ secrets.AWX_PASSWORD }}
+  deployment:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Deploy Stage
+      uses: fjogeleit/http-request-action@master
+      with:
+        url: 'https://ansible.io/api/v2/job_templates/84/launch/'
+        method: 'POST'
+        username: ${{ secrets.AWX_USER }}
+        password: ${{ secrets.AWX_PASSWORD }}
 ```

-### Input Arguments
+### Request Configuration

 |Argument|  Description  |  Default  |
 |--------|---------------|-----------|
@@ -23,22 +25,39 @@ jobs:
 |method  | Request Method| POST |
 |contentType  | Request ContentType| application/json |
 |data    | Request Body Content as JSON String, only for POST / PUT / PATCH Requests | '{}' |
+|files    | Map of key / absolute file paths send as multipart/form-data request to the API, if set the contentType is set to multipart/form-data, values provided by data will be added as additional FormData values, nested objects are not supported. **Example provided in the _test_ Workflow of this Action** | '{}' |
 |timeout| Request Timeout in ms | 5000 (5s) |
 |username| Username for Basic Auth ||
 |password| Password for Basic Auth ||
 |bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
 |customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
-|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
 |escapeData| Escape newlines in data string content. Use 'true' (string) as value to enable it ||
+|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
+|ignoreStatusCodes| Prevent this Action to fail if the request respond with one of the configured Status Codes. Example: '404,401' ||

-### Output
+### Response

- `response` Request Response as JSON String
+| Variable |  Description  |
+|---|---|
+`response` | Response as JSON String

+To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs`

-### Debug Informations
+```yaml
+steps:
+  - name: Make Request
+    id: myRequest
+    uses: fjogeleit/http-request-action@master
+    with:
+      url: "http://yoursite.com/api"
+  - name: Show Response
+    run: echo ${{ steps.myRequest.outputs.response }}
+```

-Enable Debug mode to get informations about
+### Additional Information

+Additional information is available if debug logging is enabled:
 - Instance Configuration (Url / Timeout / Headers)
 - Request Data (Body / Auth / Method)
+
+To [enable debug logging in GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) create a secret `ACTIONS_RUNNER_DEBUG` with a value of `true`
--- a/action.yml
+++ b/action.yml
@@ -11,11 +11,14 @@ inputs:
    contentType:
        description: 'Content Type'
        required: false
-        default: 'application/json'
    data:
        description: 'Request Body as JSON String'
        required: false
        default: '{}'
+    files:
+        description: 'Map of absolute file paths as JSON String'
+        required: false
+        default: '{}'
    username:
        description: 'Auth Username'
        required: false
@@ -35,6 +38,9 @@ inputs:
    preventFailureOnNoResponse:
        description: 'Prevent this Action to fail if the request respond without an response'
        required: false
+    ignoreStatusCodes:
+        description: 'Prevent this Action to fail if the request respond with one of the configured StatusCodes'
+        required: false
    escapeData:
        description: 'Escape newlines in data string content'
        required: false
--- a/dist/index.js
+++ b/dist/index.js
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,8 +1,120 @@
 {
  "name": "http-request-action",
-  "version": "1.6.1",
-  "lockfileVersion": 1,
+  "version": "1.8.0",
+  "lockfileVersion": 2,
  "requires": true,
+  "packages": {
+    "": {
+      "version": "1.8.0",
+      "license": "MIT",
+      "dependencies": {
+        "@zeit/ncc": "^0.22",
+        "axios": "^0.21.1",
+        "form-data": "^3.0.1"
+      },
+      "devDependencies": {
+        "@actions/core": "^1.2.6"
+      }
+    },
+    "node_modules/@actions/core": {
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
+      "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==",
+      "dev": true
+    },
+    "node_modules/@zeit/ncc": {
+      "version": "0.22.3",
+      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.3.tgz",
+      "integrity": "sha512-jnCLpLXWuw/PAiJiVbLjA8WBC0IJQbFeUwF4I9M+23MvIxTxk5pD4Q8byQBSPmHQjz5aBoA7AKAElQxMpjrCLQ==",
+      "deprecated": "@zeit/ncc is no longer maintained. Please use @vercel/ncc instead.",
+      "bin": {
+        "ncc": "dist/ncc/cli.js"
+      }
+    },
+    "node_modules/asynckit": {
+      "version": "0.4.0",
+      "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+      "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
+    },
+    "node_modules/axios": {
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
+      "dependencies": {
+        "follow-redirects": "^1.10.0"
+      }
+    },
+    "node_modules/combined-stream": {
+      "version": "1.0.8",
+      "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+      "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+      "dependencies": {
+        "delayed-stream": "~1.0.0"
+      },
+      "engines": {
+        "node": ">= 0.8"
+      }
+    },
+    "node_modules/delayed-stream": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+      "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=",
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    },
+    "node_modules/follow-redirects": {
+      "version": "1.13.3",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.3.tgz",
+      "integrity": "sha512-DUgl6+HDzB0iEptNQEXLx/KhTmDb8tZUHSeLqpnjpknR70H0nC2t9N73BK6fN4hOvJ84pKlIQVQ4k5FFlBedKA==",
+      "funding": [
+        {
+          "type": "individual",
+          "url": "https://github.com/sponsors/RubenVerborgh"
+        }
+      ],
+      "engines": {
+        "node": ">=4.0"
+      },
+      "peerDependenciesMeta": {
+        "debug": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/form-data": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
+      "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
+      "dependencies": {
+        "asynckit": "^0.4.0",
+        "combined-stream": "^1.0.8",
+        "mime-types": "^2.1.12"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
+    "node_modules/mime-db": {
+      "version": "1.46.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
+      "integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ==",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/mime-types": {
+      "version": "2.1.29",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
+      "integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
+      "dependencies": {
+        "mime-db": "1.46.0"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    }
+  },
  "dependencies": {
    "@actions/core": {
      "version": "1.2.6",
@@ -15,6 +127,11 @@
      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.3.tgz",
      "integrity": "sha512-jnCLpLXWuw/PAiJiVbLjA8WBC0IJQbFeUwF4I9M+23MvIxTxk5pD4Q8byQBSPmHQjz5aBoA7AKAElQxMpjrCLQ=="
    },
+    "asynckit": {
+      "version": "0.4.0",
+      "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+      "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
+    },
    "axios": {
      "version": "0.21.1",
      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
@@ -23,10 +140,46 @@
        "follow-redirects": "^1.10.0"
      }
    },
+    "combined-stream": {
+      "version": "1.0.8",
+      "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+      "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+      "requires": {
+        "delayed-stream": "~1.0.0"
+      }
+    },
+    "delayed-stream": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+      "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk="
+    },
    "follow-redirects": {
-      "version": "1.13.1",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
-      "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
+      "version": "1.13.3",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.3.tgz",
+      "integrity": "sha512-DUgl6+HDzB0iEptNQEXLx/KhTmDb8tZUHSeLqpnjpknR70H0nC2t9N73BK6fN4hOvJ84pKlIQVQ4k5FFlBedKA=="
+    },
+    "form-data": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
+      "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
+      "requires": {
+        "asynckit": "^0.4.0",
+        "combined-stream": "^1.0.8",
+        "mime-types": "^2.1.12"
+      }
+    },
+    "mime-db": {
+      "version": "1.46.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
+      "integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ=="
+    },
+    "mime-types": {
+      "version": "2.1.29",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
+      "integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
+      "requires": {
+        "mime-db": "1.46.0"
+      }
    }
  }
 }
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "http-request-action",
-  "version": "1.6.1",
+  "version": "1.8.0",
  "description": "",
  "main": "src/index.js",
  "private": false,
@@ -13,7 +13,7 @@
  },
  "keywords": [],
  "author": "",
-  "license": "ISC",
+  "license": "MIT",
  "bugs": {
    "url": "https://github.com/fjogeleit/http-request-action/issues"
  },
@@ -23,6 +23,7 @@
  },
  "dependencies": {
    "@zeit/ncc": "^0.22",
-    "axios": "^0.21.1"
+    "axios": "^0.21.1",
+    "form-data": "^3.0.1"
  }
 }
--- a/src/httpClient.js
+++ b/src/httpClient.js
@@ -1,15 +1,29 @@
 const axios = require("axios");
+const FormData = require('form-data')
+const fs = require('fs')

 const METHOD_GET = 'GET'
 const METHOD_POST = 'POST'

-const request = async({ method, instanceConfig, data, auth, actions, preventFailureOnNoResponse, escapeData }) => {
+/**
+ * @param {Object} param0
+ * @param {string} param0.method HTTP Method
+ * @param {{ baseURL: string; timeout: number; headers: { [name: string]: string } }} param0.instanceConfig
+ * @param {string} param0.data Request Body as string, default {}
+ * @param {string} param0.files Map of Request Files (name: absolute path) as JSON String, default: {}
+ * @param {{ username: string; password: string }|undefined} param0.auth Optional HTTP Basic Auth
+ * @param {*} param0.actions 
+ * @param {number[]} param0.ignoredCodes Prevent Action to fail if the API response with one of this StatusCodes
+ * @param {boolean} param0.preventFailureOnNoResponse Prevent Action to fail if the API respond without Response
+ * @param {boolean} param0.escapeData Escape unescaped JSON content in data
+ *
+ * @returns {void}
+ */
+const request = async({ method, instanceConfig, data, files, auth, actions, ignoredCodes, preventFailureOnNoResponse, escapeData }) => {
  try {
-    const instance = axios.create(instanceConfig);
-
    if (escapeData) {
      data = data.replace(/"[^"]*"/g, (match) => { 
-          return match.replace(/[\n\r]\s*/g, "\\n");
+        return match.replace(/[\n\r]\s*/g, "\\n");
      }); 
    }

@@ -17,12 +31,33 @@ const request = async({ method, instanceConfig, data, auth, actions, preventFail
      data = undefined;
    }

+    if (files && files !== '{}') {
+      filesJson = convertToJSON(files)
+      dataJson = convertToJSON(data)
+
+      if (Object.keys(filesJson).length > 0) {
+        try {
+          data = convertToFormData(dataJson, filesJson)
+          instanceConfig = await updateConfig(instanceConfig, data, actions)
+        } catch(error) {
+          actions.setFailed({ message: `Unable to convert Data and Files into FormData: ${error.message}`, data: dataJson, files: filesJson })
+          return
+        }
+      }
+    }
+
    const requestData = {
      auth,
      method,
-      data
+      data,
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity
    }

+    actions.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))
+    
+    const instance = axios.create(instanceConfig);
+
    actions.debug('Request Data: ' + JSON.stringify(requestData))

    const response = await instance.request(requestData)
@@ -30,11 +65,13 @@ const request = async({ method, instanceConfig, data, auth, actions, preventFail
    actions.setOutput('response', JSON.stringify(response.data))
  } catch (error) {
    if (error.toJSON) {
-      actions.setOutput(JSON.stringify(error.toJSON()));
+      actions.setOutput('requestError', JSON.stringify(error.toJSON()));
    }

-    if (error.response) {
-      actions.setFailed(JSON.stringify({ code: error.response.code, message: error.response.data }))
+    if (error.response && ignoredCodes.includes(error.response.status)) {
+      actions.warning(JSON.stringify({ code: error.response.status, message: error.response.data }))
+    } else if (error.response) {
+      actions.setFailed(JSON.stringify({ code: error.response.status, message: error.response.data }))
    } else if (error.request && !preventFailureOnNoResponse) {
      actions.setFailed(JSON.stringify({ error: "no response received" }));
    } else if (error.request && preventFailureOnNoResponse) {
@@ -45,6 +82,83 @@ const request = async({ method, instanceConfig, data, auth, actions, preventFail
  }
 }

+/**
+ * @param {string} value
+ *
+ * @returns {Object}
+ */
+const convertToJSON = (value) => {
+  try {
+    return JSON.parse(value)
+  } catch(e) {
+    return {}
+  }
+}
+
+/**
+ * @param {Object} data
+ * @param {Object} files
+ *
+ * @returns {FormData}
+ */
+const convertToFormData = (data, files) => {
+  formData = new FormData()
+
+  for (const [key, value] of Object.entries(data)) {
+    formData.append(key, value)
+  }
+
+  for (const [key, value] of Object.entries(files)) {
+    formData.append(key, fs.createReadStream(value))
+  }
+
+  return formData
+}
+
+/**
+ * @param {{ baseURL: string; timeout: number; headers: { [name: string]: string } }} instanceConfig
+ * @param {FormData} formData
+ * @param {*} actions
+ *
+ * @returns {{ baseURL: string; timeout: number; headers: { [name: string]: string } }}
+ */
+const updateConfig = async (instanceConfig, formData, actions) => {
+  try {
+    const formHeaders = formData.getHeaders()
+    const contentType = formHeaders['content-type']
+
+    delete formHeaders['content-type']
+
+    return { 
+      ...instanceConfig, 
+      headers: { 
+        ...instanceConfig.headers, 
+        ...formHeaders,
+        'Content-Length': await contentLength(formData),
+        'Content-Type': contentType
+      }
+    }
+  } catch(error) {
+    actions.setFailed({ message: `Unable to read Content-Length: ${error.message}`, data, files })
+  }
+}
+
+/**
+ * @param {FormData} formData
+ *
+ * @returns {Promise<number>}
+ */
+const contentLength = (formData) => new Promise((resolve, reject) => {
+  formData.getLength((err, length) => {
+    if (err) {
+      reject (err)
+      return
+    }
+
+    resolve(length)
+  })
+})
+
 module.exports = {
  request,
  METHOD_POST,
--- a/src/index.js
+++ b/src/index.js
@@ -34,11 +34,17 @@ const instanceConfig = {
  headers: { ...headers, ...customHeaders }
 }

-core.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))
-
 const data = core.getInput('data') || '{}';
+const files = core.getInput('files') || '{}';
 const method = core.getInput('method') || METHOD_POST;
 const preventFailureOnNoResponse = core.getInput('preventFailureOnNoResponse') === 'true';
 const escapeData = core.getInput('escapeData') === 'true';

-request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, actions: new GithubActions() })
+const ignoreStatusCodes = core.getInput('ignoreStatusCodes')
+let ignoredCodes = []
+
+if (typeof ignoreStatusCodes === 'string' && ignoreStatusCodes.length > 0) {
+  ignoredCodes = ignoreStatusCodes.split(',').map(statusCode => parseInt(statusCode.trim()))
+}
+
+request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, files, ignoredCodes, actions: new GithubActions() })
Author	SHA1	Message	Date
Frank Jogeleit	0929a0c636	Ignored status codes (#26 ) * Implement StatusCode ignore list	2021-03-19 17:28:53 +01:00
Frank Jogeleit	bd043fe286	Build new version	2021-02-19 12:51:47 +01:00
Frank Jogeleit	7626a13e42	Disable MaxContentLength and MaxBodyLength check (#23 ) * Disable MaxContentLength and MaxBodyLength check	2021-02-19 11:36:10 +01:00
Scott W Harden	48dc3972df	more documentation with code sample (#21 ) * improve debug logging documentation * document how to log response content * add syntax highlighting * improve description This action can be used to do more than just interact with Ansible AWS. I rephrased the description to emphasize its general utility.	2021-01-26 17:49:24 +01:00
Frank Jogeleit	84e61f1a56	Update version	2021-01-24 14:09:17 +01:00
Frank Jogeleit	42677b964e	Update FileUpload ContentType	2021-01-24 13:52:05 +01:00
Frank Jogeleit	b6bb4fa030	File upload (#20 ) * Add Support for FileUpload	2021-01-24 13:14:13 +01:00
Frank Jogeleit	de202bb090	Merge pull request #18 from Hoopless/master Changes to basic Example	2021-01-20 10:44:46 +01:00
Jasper	eff73a48f7	Update README.md	2021-01-20 00:21:04 +01:00