File upload (#20)

* Add Support for FileUpload

.github/workflows/test.yml

@@ -23,6 +23,18 @@ jobs:
           method: 'POST'
           data: '{ "key": "value" }'
       
+      - name: Request Postment Echo POST with Unescaped Newline
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/post'
+          method: 'POST'
+          escapeData: 'true'
+          data: >-
+            {
+              "key":"multi line\ntest
+              text"
+            }
+      
       - name: Request Postment Echo BasicAuth
         uses: ./
         with:
@@ -30,3 +42,16 @@ jobs:
           method: 'GET'
           username: 'postman'
           password: 'password'
+      
+      - 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" }'

README.md

@@ -5,14 +5,16 @@ Create any kind of HTTP Requests in your GitHub actions to trigger Tools like An
 Example Usage:
 ```
 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
@@ -23,11 +25,14 @@ 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 ||
 
 ### Output
 

action.yml

@@ -16,6 +16,10 @@ inputs:
         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
@@ -29,6 +33,15 @@ inputs:
     bearerToken:
         description: 'Bearer Authentication Token'
         required: false
+    customHeaders:
+        description: 'Custom HTTP Headers'
+        required: false
+    preventFailureOnNoResponse:
+        description: 'Prevent this Action to fail if the request respond without an response'
+        required: false
+    escapeData:
+        description: 'Escape newlines in data string content'
+        required: false
 outputs:
     response:
         description: 'HTTP Response Content'

package-lock.json

@@ -1,48 +1,73 @@
 {
   "name": "http-request-action",
-  "version": "1.0.0",
+  "version": "1.7.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
     "@actions/core": {
-      "version": "1.2.2",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.2.tgz",
-      "integrity": "sha512-IbCx7oefq+Gi6FWbSs2Fnw8VkEI6Y4gvjrYprY3RV//ksq/KPMlClOerJ4jRosyal6zkUIc8R9fS/cpRMlGClg==",
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
+      "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==",
       "dev": true
     },
     "@zeit/ncc": {
-      "version": "0.21.1",
-      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.1.tgz",
-      "integrity": "sha512-M9WzgquSOt2nsjRkYM9LRylBLmmlwNCwYbm3Up3PDEshfvdmIfqpFNSK8EJvR18NwZjGHE5z2avlDtYQx2JQnw=="
+      "version": "0.22.3",
+      "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.19.2",
-      "resolved": "https://registry.npmjs.org/axios/-/axios-0.19.2.tgz",
-      "integrity": "sha512-fjgm5MvRHLhx+osE2xoekY70AhARk3a6hkN+3Io1jc00jtquGvxYlKlsFUhmUET0V5te6CcZI7lcv2Ym61mjHA==",
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
       "requires": {
-        "follow-redirects": "1.5.10"
+        "follow-redirects": "^1.10.0"
       }
     },
-    "debug": {
-      "version": "3.1.0",
-      "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
-      "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+    "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": {
-        "ms": "2.0.0"
+        "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.5.10",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.10.tgz",
-      "integrity": "sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==",
+      "version": "1.13.1",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
+      "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
+    },
+    "form-data": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz",
+      "integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==",
       "requires": {
-        "debug": "=3.1.0"
+        "asynckit": "^0.4.0",
+        "combined-stream": "^1.0.8",
+        "mime-types": "^2.1.12"
       }
     },
-    "ms": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
-      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+    "mime-db": {
+      "version": "1.45.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.45.0.tgz",
+      "integrity": "sha512-CkqLUxUk15hofLoLyljJSrukZi8mAtgd+yE5uO4tqRZsdsAJKv0O+rFMhVDRJgozy+yG6md5KwuXhD4ocIoP+w=="
+    },
+    "mime-types": {
+      "version": "2.1.28",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.28.tgz",
+      "integrity": "sha512-0TO2yJ5YHYr7M2zzT7gDU1tbwHxEUWBCLt0lscSNpcdAfFyJOVEpRYNS7EXVcTLNj/25QO8gulHC5JtTzSE2UQ==",
+      "requires": {
+        "mime-db": "1.45.0"
+      }
     }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-action",
-  "version": "1.3.2",
+  "version": "1.7.0",
   "description": "",
   "main": "src/index.js",
   "private": false,
@@ -19,10 +19,11 @@
   },
   "homepage": "https://github.com/fjogeleit/http-request-action#readme",
   "devDependencies": {
-    "@actions/core": "^1.2.2"
+    "@actions/core": "^1.2.6"
   },
   "dependencies": {
-    "@zeit/ncc": "^0.21.1",
-    "axios": "^0.19.2"
+    "@zeit/ncc": "^0.22",
+    "axios": "^0.21.1",
+    "form-data": "^3.0.0"
   }
 }

src/githubActions.js

@@ -0,0 +1,39 @@
+const core = require("@actions/core");
+
+class GithubActions {
+  debug(message) {
+    core.debug(message)
+  }
+
+  warning(message) {
+    core.warning(message)
+  }
+
+  setOutput(name, output) {
+    core.setOutput(name, output)
+  }
+
+  setFailed(message) {
+    core.setFailed(message)
+  }
+}
+
+class LogActions {
+  debug(message) {
+    console.info(message)
+  }
+
+  warning(message) {
+    console.warn(message)
+  }
+
+  setOutput(name, output) {
+    console.log(name, output)
+  }
+
+  setFailed(message) {
+    console.error(message)
+  }
+}
+
+module.exports = { GithubActions, LogActions }

src/httpClient.js

@@ -0,0 +1,117 @@
+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, files, auth, actions, preventFailureOnNoResponse, escapeData }) => {
+  try {
+    const instance = axios.create(instanceConfig);
+
+    if (escapeData) {
+      data = data.replace(/"[^"]*"/g, (match) => { 
+          return match.replace(/[\n\r]\s*/g, "\\n");
+      }); 
+    }
+
+    if (method === METHOD_GET) {
+      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
+    }
+
+    actions.debug('Request Data: ' + JSON.stringify(requestData))
+
+    const response = await instance.request(requestData)
+
+    actions.setOutput('response', JSON.stringify(response.data))
+  } catch (error) {
+    if (error.toJSON) {
+      actions.setOutput(JSON.stringify(error.toJSON()));
+    }
+
+    if (error.response) {
+      actions.setFailed(JSON.stringify({ code: error.response.code, message: error.response.data }))
+    } else if (error.request && !preventFailureOnNoResponse) {
+      actions.setFailed(JSON.stringify({ error: "no response received" }));
+    } else if (error.request && preventFailureOnNoResponse) {
+      actions.warning(JSON.stringify(error));
+    } else {
+      actions.setFailed(JSON.stringify({ message: error.message, data }));
+    }
+  }
+}
+
+const convertToJSON = (value) => {
+  try {
+    return JSON.parse(value)
+  } catch(e) {
+    return {}
+  }
+}
+
+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
+}
+
+const updateConfig = async (instanceConfig, formData, actions) => {
+  try {
+    return { 
+      ...instanceConfig, 
+      headers: { 
+        ...instanceConfig.headers, 
+        ...formData.getHeaders(), 
+        'Content-Length': await contentLength(formData) 
+      }
+    }
+  } catch(error) {
+    actions.setFailed({ message: `Unable to read Content-Length: ${error.message}`, data, files })
+  }
+}
+
+const contentLength = (formData) => new Promise((resolve, reject) => {
+  formData.getLength((err, length) => {
+    if (err) {
+      reject (err)
+      return
+    }
+
+    resolve(length)
+  })
+})
+
+module.exports = {
+  request,
+  METHOD_POST,
+  METHOD_GET,
+}

src/index.js

@@ -1,8 +1,6 @@
 const core = require("@actions/core");
-const axios = require("axios");
-
-const METHOD_GET = 'GET'
-const METHOD_POST = 'POST'
+const { request, METHOD_POST } = require('./httpClient');
+const { GithubActions } = require('./githubActions');
 
 let auth = undefined
 let customHeaders = {}
@@ -38,35 +36,10 @@ const instanceConfig = {
 
 core.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))
 
-const instance = axios.create(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';
 
-(async() => {
-  try {
-    const method = core.getInput('method') || METHOD_POST;
-    const data = method === METHOD_GET ? undefined : JSON.parse(core.getInput('data') || '{}')
-
-    const requestData = {
-      auth,
-      method,
-      data
-    }
-
-    core.debug('Request Data: ' + JSON.stringify(requestData))
-
-    const response = await instance.request(requestData)
-
-    core.setOutput('response', JSON.stringify(response.data))
-  } catch (error) {
-    if (error.toJSON) {
-      core.setOutput(JSON.stringify(error.toJSON()));
-    }
-
-    if (error.response) {
-      core.setFailed(JSON.stringify({ code: error.response.code, message: error.response.data }))
-    } else if (error.request) {
-      core.setFailed(JSON.stringify({ error: "no response received" }));
-    } else {
-      core.setFailed(error.message);
-    }
-  }
-})()
+request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, files, actions: new GithubActions() })