mirror of
https://github.com/fjogeleit/http-request-action.git
synced 2026-02-05 00:55:52 +08:00
Compare commits
54 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e3313c1a5f | ||
|
|
d4c0bee13c | ||
|
|
435fe1dbc8 | ||
|
|
35336be18d | ||
|
|
f986377e36 | ||
|
|
046e838b3a | ||
|
|
31fad16908 | ||
|
|
5c4179dc69 | ||
|
|
d45f6649f6 | ||
|
|
f683177370 | ||
|
|
a6980b2ca5 | ||
|
|
70ee000b97 | ||
|
|
5e30e204fc | ||
|
|
82d22dd60f | ||
|
|
1ea54adf35 | ||
|
|
8e939c608a | ||
|
|
7c5a3f2e70 | ||
|
|
78bba76cbe | ||
|
|
3e3e6b3eec | ||
|
|
0929a0c636 | ||
|
|
bd043fe286 | ||
|
|
7626a13e42 | ||
|
|
48dc3972df | ||
|
|
84e61f1a56 | ||
|
|
42677b964e | ||
|
|
b6bb4fa030 | ||
|
|
de202bb090 | ||
|
|
eff73a48f7 | ||
|
|
f91c5933c4 | ||
|
|
3a9531bb34 | ||
|
|
0cc64a5579 | ||
|
|
81e44c2059 | ||
|
|
cc4fc855b5 | ||
|
|
c7cadd574f | ||
|
|
3634ea0063 | ||
|
|
b63e908234 | ||
|
|
60ab747148 | ||
|
|
2ac119cf97 | ||
|
|
ff8539eb83 | ||
|
|
f90afba39a | ||
|
|
82c8e38c69 | ||
|
|
4e4ff2b320 | ||
|
|
348745cc31 | ||
|
|
d3ea5fce44 | ||
|
|
5d7e3ef283 | ||
|
|
089a11111a | ||
|
|
f7cd714b2c | ||
|
|
acd894b2e1 | ||
|
|
8ed097ea3f | ||
|
|
b9373e0ef3 | ||
|
|
65d4ab42a4 | ||
|
|
193a7dd98c | ||
|
|
3b9f5efa1c | ||
|
|
cfc342658b |
70
.github/workflows/test.yml
vendored
Normal file
70
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
name: Test
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
request:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
ref: ${{ github.ref }}
|
||||||
|
|
||||||
|
- name: Request Postman Echo GET
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
url: 'https://postman-echo.com/get'
|
||||||
|
method: 'GET'
|
||||||
|
|
||||||
|
- name: Request Postman Echo POST
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
url: 'https://postman-echo.com/post'
|
||||||
|
method: 'POST'
|
||||||
|
data: '{ "key": "value" }'
|
||||||
|
|
||||||
|
- name: Request Postman 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 Postman Echo BasicAuth
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
url: 'https://postman-echo.com/basic-auth'
|
||||||
|
method: 'GET'
|
||||||
|
username: 'postman'
|
||||||
|
password: 'password'
|
||||||
|
|
||||||
|
- name: Request Postman 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
|
||||||
|
run: |
|
||||||
|
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 }}/testfile.txt" }'
|
||||||
|
|
||||||
|
- name: Request Postman Echo POST single file
|
||||||
|
uses: ./
|
||||||
|
with:
|
||||||
|
url: 'https://postman-echo.com/post'
|
||||||
|
method: 'POST'
|
||||||
|
file: "${{ github.workspace }}/testfile.txt"
|
||||||
68
README.md
68
README.md
@@ -1,34 +1,72 @@
|
|||||||
# HTTP Request Action
|
# 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.
|
||||||
|
|
||||||
Exmaple Usage:
|
### Example
|
||||||
```
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
deployment
|
deployment:
|
||||||
- name: Deploy Stage
|
runs-on: ubuntu-latest
|
||||||
uses: fjogeleit/http-request-action@master
|
steps:
|
||||||
with:
|
- name: Deploy Stage
|
||||||
url: 'https://ansible.io/api/v2/job_templates/84/launch/'
|
uses: fjogeleit/http-request-action@v1
|
||||||
method: 'POST'
|
with:
|
||||||
username: ${{ secrets.AWX_USER }}
|
url: 'https://ansible.io/api/v2/job_templates/84/launch/'
|
||||||
password: ${{ secrets.AWX_PASSWORD }}
|
method: 'POST'
|
||||||
|
username: ${{ secrets.AWX_USER }}
|
||||||
|
password: ${{ secrets.AWX_PASSWORD }}
|
||||||
|
customHeaders: '{"Content-Type": "application/json"}'
|
||||||
|
data: '{"key_1": "value_1", "key_2": "value_2"}'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Input Arguments
|
### Versioning
|
||||||
|
|
||||||
|
`master` branch is deprecated. Please use `main` or `v1` to get the latest version of this action. It is recommended to use a fixed version.
|
||||||
|
|
||||||
|
### Request Configuration
|
||||||
|
|
||||||
|Argument| Description | Default |
|
|Argument| Description | Default |
|
||||||
|--------|---------------|-----------|
|
|--------|---------------|-----------|
|
||||||
|url | Request URL | _required_ Field |
|
|url | Request URL | _required_ Field |
|
||||||
|method | Request Method| POST |
|
|method | Request Method| POST |
|
||||||
|contentType | Request ContentType| application/json |
|
|contentType | Request ContentType| application/json |
|
||||||
|data | Request Body Content as JSON String, only for POST / PUT / PATCH Requests | '{}' |
|
|data | Request Body Content:<br>- text content like JSON or XML<br>- key=value pairs separated by '&' and contentType: application/x-www-form-urlencoded<br><br>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** | '{}' |
|
||||||
|
|file | Single absolute file path send as `application/octet-stream` request to the API, if set the contentType is set to `application/octet-stream`. This input will be ignored if either `data` or `files` input is present. **Example provided in the _test_ Workflow of this Action** ||
|
||||||
|timeout| Request Timeout in ms | 5000 (5s) |
|
|timeout| Request Timeout in ms | 5000 (5s) |
|
||||||
|username| Username for Basic Auth ||
|
|username| Username for Basic Auth ||
|
||||||
|password| Password for Basic Auth ||
|
|password| Password for Basic Auth ||
|
||||||
|bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
|
|bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
|
||||||
|customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
|
|customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
|
||||||
|
|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`. You can also access specific field from the response data using [fromJson()](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) expression.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name: Make Request
|
||||||
|
id: myRequest
|
||||||
|
uses: fjogeleit/http-request-action@v1
|
||||||
|
with:
|
||||||
|
url: "http://yoursite.com/api"
|
||||||
|
- name: Show Response
|
||||||
|
run: |
|
||||||
|
echo ${{ steps.myRequest.outputs.response }}
|
||||||
|
echo ${{ fromJson(steps.myRequest.outputs.response).field_you_want_to_access }}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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`
|
||||||
|
|||||||
22
action.yml
22
action.yml
@@ -11,11 +11,17 @@ inputs:
|
|||||||
contentType:
|
contentType:
|
||||||
description: 'Content Type'
|
description: 'Content Type'
|
||||||
required: false
|
required: false
|
||||||
default: 'application/json'
|
|
||||||
data:
|
data:
|
||||||
description: 'Request Body as JSON String'
|
description: 'Request Body as JSON String'
|
||||||
required: false
|
required: false
|
||||||
default: '{}'
|
default: '{}'
|
||||||
|
files:
|
||||||
|
description: 'Map of absolute file paths as JSON String'
|
||||||
|
required: false
|
||||||
|
default: '{}'
|
||||||
|
file:
|
||||||
|
description: 'A single absolute file path'
|
||||||
|
required: false
|
||||||
username:
|
username:
|
||||||
description: 'Auth Username'
|
description: 'Auth Username'
|
||||||
required: false
|
required: false
|
||||||
@@ -29,9 +35,21 @@ inputs:
|
|||||||
bearerToken:
|
bearerToken:
|
||||||
description: 'Bearer Authentication Token'
|
description: 'Bearer Authentication Token'
|
||||||
required: false
|
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
|
||||||
|
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
|
||||||
outputs:
|
outputs:
|
||||||
response:
|
response:
|
||||||
description: 'HTTP Response Content'
|
description: 'HTTP Response Content'
|
||||||
runs:
|
runs:
|
||||||
using: 'node12'
|
using: 'node16'
|
||||||
main: 'dist/index.js'
|
main: 'dist/index.js'
|
||||||
|
|||||||
6690
dist/index.js
vendored
6690
dist/index.js
vendored
File diff suppressed because one or more lines are too long
229
package-lock.json
generated
229
package-lock.json
generated
@@ -1,48 +1,225 @@
|
|||||||
{
|
{
|
||||||
"name": "http-request-action",
|
"name": "http-request-action",
|
||||||
"version": "1.0.0",
|
"version": "1.9.0",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"name": "http-request-action",
|
||||||
|
"version": "1.9.0",
|
||||||
|
"license": "MIT",
|
||||||
|
"dependencies": {
|
||||||
|
"@zeit/ncc": "^0.22",
|
||||||
|
"axios": "^0.21.4",
|
||||||
|
"form-data": "^4.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@actions/core": "^1.2.6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/core": {
|
||||||
|
"version": "1.6.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/core/-/core-1.6.0.tgz",
|
||||||
|
"integrity": "sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@actions/http-client": "^1.0.11"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@actions/http-client": {
|
||||||
|
"version": "1.0.11",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
|
||||||
|
"integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"tunnel": "0.0.6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"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.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.4.tgz",
|
||||||
|
"integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==",
|
||||||
|
"dependencies": {
|
||||||
|
"follow-redirects": "^1.14.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.14.9",
|
||||||
|
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.9.tgz",
|
||||||
|
"integrity": "sha512-MQDfihBQYMcyy5dhRDJUHcw7lb2Pv/TuE6xP1vyraLukNDHKbDxDNaOE3NbCAdKQApno+GPRyo1YAp89yCjK4w==",
|
||||||
|
"funding": [
|
||||||
|
{
|
||||||
|
"type": "individual",
|
||||||
|
"url": "https://github.com/sponsors/RubenVerborgh"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4.0"
|
||||||
|
},
|
||||||
|
"peerDependenciesMeta": {
|
||||||
|
"debug": {
|
||||||
|
"optional": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/form-data": {
|
||||||
|
"version": "4.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
|
||||||
|
"integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
|
||||||
|
"dependencies": {
|
||||||
|
"asynckit": "^0.4.0",
|
||||||
|
"combined-stream": "^1.0.8",
|
||||||
|
"mime-types": "^2.1.12"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/mime-db": {
|
||||||
|
"version": "1.51.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.51.0.tgz",
|
||||||
|
"integrity": "sha512-5y8A56jg7XVQx2mbv1lu49NR4dokRnhZYTtL+KGfaa27uq4pSTXkwQkFJl4pkRMyNFz/EtYDSkiiEHx3F7UN6g==",
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 0.6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/mime-types": {
|
||||||
|
"version": "2.1.34",
|
||||||
|
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.34.tgz",
|
||||||
|
"integrity": "sha512-6cP692WwGIs9XXdOO4++N+7qjqv0rqxxVvJ3VHPh/Sc9mVZcQP+ZGhkKiTvWMQRr2tbHkJP/Yn7Y0npb3ZBs4A==",
|
||||||
|
"dependencies": {
|
||||||
|
"mime-db": "1.51.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 0.6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/tunnel": {
|
||||||
|
"version": "0.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
|
||||||
|
"integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.6.11 <=0.7.0 || >=0.7.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": {
|
"@actions/core": {
|
||||||
"version": "1.2.2",
|
"version": "1.6.0",
|
||||||
"resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.2.tgz",
|
"resolved": "https://registry.npmjs.org/@actions/core/-/core-1.6.0.tgz",
|
||||||
"integrity": "sha512-IbCx7oefq+Gi6FWbSs2Fnw8VkEI6Y4gvjrYprY3RV//ksq/KPMlClOerJ4jRosyal6zkUIc8R9fS/cpRMlGClg==",
|
"integrity": "sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==",
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"@actions/http-client": "^1.0.11"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"@actions/http-client": {
|
||||||
|
"version": "1.0.11",
|
||||||
|
"resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-1.0.11.tgz",
|
||||||
|
"integrity": "sha512-VRYHGQV1rqnROJqdMvGUbY/Kn8vriQe/F9HR2AlYHzmKuM/p3kjNuXhmdBfcVgsvRWTz5C5XW5xvndZrVBuAYg==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"tunnel": "0.0.6"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"@zeit/ncc": {
|
"@zeit/ncc": {
|
||||||
"version": "0.21.1",
|
"version": "0.22.3",
|
||||||
"resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.21.1.tgz",
|
"resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.3.tgz",
|
||||||
"integrity": "sha512-M9WzgquSOt2nsjRkYM9LRylBLmmlwNCwYbm3Up3PDEshfvdmIfqpFNSK8EJvR18NwZjGHE5z2avlDtYQx2JQnw=="
|
"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": {
|
"axios": {
|
||||||
"version": "0.19.2",
|
"version": "0.21.4",
|
||||||
"resolved": "https://registry.npmjs.org/axios/-/axios-0.19.2.tgz",
|
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.4.tgz",
|
||||||
"integrity": "sha512-fjgm5MvRHLhx+osE2xoekY70AhARk3a6hkN+3Io1jc00jtquGvxYlKlsFUhmUET0V5te6CcZI7lcv2Ym61mjHA==",
|
"integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==",
|
||||||
"requires": {
|
"requires": {
|
||||||
"follow-redirects": "1.5.10"
|
"follow-redirects": "^1.14.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"debug": {
|
"combined-stream": {
|
||||||
"version": "3.1.0",
|
"version": "1.0.8",
|
||||||
"resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
|
||||||
"integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
|
"integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
|
||||||
"requires": {
|
"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": {
|
"follow-redirects": {
|
||||||
"version": "1.5.10",
|
"version": "1.14.9",
|
||||||
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.10.tgz",
|
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.9.tgz",
|
||||||
"integrity": "sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==",
|
"integrity": "sha512-MQDfihBQYMcyy5dhRDJUHcw7lb2Pv/TuE6xP1vyraLukNDHKbDxDNaOE3NbCAdKQApno+GPRyo1YAp89yCjK4w=="
|
||||||
|
},
|
||||||
|
"form-data": {
|
||||||
|
"version": "4.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz",
|
||||||
|
"integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==",
|
||||||
"requires": {
|
"requires": {
|
||||||
"debug": "=3.1.0"
|
"asynckit": "^0.4.0",
|
||||||
|
"combined-stream": "^1.0.8",
|
||||||
|
"mime-types": "^2.1.12"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"ms": {
|
"mime-db": {
|
||||||
"version": "2.0.0",
|
"version": "1.51.0",
|
||||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.51.0.tgz",
|
||||||
"integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
|
"integrity": "sha512-5y8A56jg7XVQx2mbv1lu49NR4dokRnhZYTtL+KGfaa27uq4pSTXkwQkFJl4pkRMyNFz/EtYDSkiiEHx3F7UN6g=="
|
||||||
|
},
|
||||||
|
"mime-types": {
|
||||||
|
"version": "2.1.34",
|
||||||
|
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.34.tgz",
|
||||||
|
"integrity": "sha512-6cP692WwGIs9XXdOO4++N+7qjqv0rqxxVvJ3VHPh/Sc9mVZcQP+ZGhkKiTvWMQRr2tbHkJP/Yn7Y0npb3ZBs4A==",
|
||||||
|
"requires": {
|
||||||
|
"mime-db": "1.51.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tunnel": {
|
||||||
|
"version": "0.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
|
||||||
|
"integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
|
||||||
|
"dev": true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
11
package.json
11
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "http-request-action",
|
"name": "http-request-action",
|
||||||
"version": "1.0.0",
|
"version": "1.9.0",
|
||||||
"description": "",
|
"description": "",
|
||||||
"main": "src/index.js",
|
"main": "src/index.js",
|
||||||
"private": false,
|
"private": false,
|
||||||
@@ -13,16 +13,17 @@
|
|||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
"license": "ISC",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/fjogeleit/http-request-action/issues"
|
"url": "https://github.com/fjogeleit/http-request-action/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/fjogeleit/http-request-action#readme",
|
"homepage": "https://github.com/fjogeleit/http-request-action#readme",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@actions/core": "^1.2.2"
|
"@actions/core": "^1.2.6"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@zeit/ncc": "^0.21.1",
|
"@zeit/ncc": "^0.22",
|
||||||
"axios": "^0.19.2"
|
"axios": "^0.21.4",
|
||||||
|
"form-data": "^4.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
39
src/githubActions.js
Normal file
39
src/githubActions.js
Normal file
@@ -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 }
|
||||||
198
src/httpClient.js
Normal file
198
src/httpClient.js
Normal file
@@ -0,0 +1,198 @@
|
|||||||
|
const axios = require("axios");
|
||||||
|
const FormData = require('form-data')
|
||||||
|
const fs = require('fs')
|
||||||
|
|
||||||
|
const METHOD_GET = 'GET'
|
||||||
|
const METHOD_POST = 'POST'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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 {string} param0.file Single request file (absolute path)
|
||||||
|
* @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, file, auth, actions, ignoredCodes, preventFailureOnNoResponse, escapeData }) => {
|
||||||
|
try {
|
||||||
|
if (escapeData) {
|
||||||
|
data = data.replace(/"[^"]*"/g, (match) => {
|
||||||
|
return match.replace(/[\n\r]\s*/g, "\\n");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (method === METHOD_GET) {
|
||||||
|
data = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (files && files !== '{}') {
|
||||||
|
let filesJson = convertToJSON(files)
|
||||||
|
let 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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only consider file if neither data nor files provided
|
||||||
|
if ((!data || data === '{}') && (!files || files === '{}') && file) {
|
||||||
|
data = fs.createReadStream(file)
|
||||||
|
updateConfigForFile(instanceConfig, file, actions)
|
||||||
|
}
|
||||||
|
|
||||||
|
const requestData = {
|
||||||
|
auth,
|
||||||
|
method,
|
||||||
|
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)
|
||||||
|
|
||||||
|
actions.setOutput('response', JSON.stringify(response.data))
|
||||||
|
} catch (error) {
|
||||||
|
if ((typeof error === 'object') && (error.isAxiosError === true)) {
|
||||||
|
const { name, message, code, response } = error
|
||||||
|
actions.setOutput('requestError', JSON.stringify({ name, message, code, status: response && response.status ? response.status : null }));
|
||||||
|
}
|
||||||
|
|
||||||
|
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) {
|
||||||
|
actions.warning(JSON.stringify(error));
|
||||||
|
} else {
|
||||||
|
actions.setFailed(JSON.stringify({ message: error.message, data }));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @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 instanceConfig
|
||||||
|
* @param filePath
|
||||||
|
* @param {*} actions
|
||||||
|
*
|
||||||
|
* @returns {{ baseURL: string; timeout: number; headers: { [name: string]: string } }}
|
||||||
|
*/
|
||||||
|
const updateConfigForFile = (instanceConfig, filePath, actions) => {
|
||||||
|
try {
|
||||||
|
const { size } = fs.statSync(filePath)
|
||||||
|
|
||||||
|
return {
|
||||||
|
...instanceConfig,
|
||||||
|
headers: {
|
||||||
|
...instanceConfig.headers,
|
||||||
|
'Content-Length': size,
|
||||||
|
'Content-Type': 'application/octet-stream'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} 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,
|
||||||
|
METHOD_GET,
|
||||||
|
}
|
||||||
35
src/index.js
35
src/index.js
@@ -1,5 +1,6 @@
|
|||||||
const core = require("@actions/core");
|
const core = require("@actions/core");
|
||||||
const axios = require("axios");
|
const { request, METHOD_POST } = require('./httpClient');
|
||||||
|
const { GithubActions } = require('./githubActions');
|
||||||
|
|
||||||
let auth = undefined
|
let auth = undefined
|
||||||
let customHeaders = {}
|
let customHeaders = {}
|
||||||
@@ -24,7 +25,7 @@ if (!!core.getInput('username') || !!core.getInput('password')) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (!!core.getInput('bearerToken')) {
|
if (!!core.getInput('bearerToken')) {
|
||||||
headers['Authentication'] = `Bearer ${core.getInput('bearerToken')}`;
|
headers['Authorization'] = `Bearer ${core.getInput('bearerToken')}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
const instanceConfig = {
|
const instanceConfig = {
|
||||||
@@ -33,24 +34,18 @@ const instanceConfig = {
|
|||||||
headers: { ...headers, ...customHeaders }
|
headers: { ...headers, ...customHeaders }
|
||||||
}
|
}
|
||||||
|
|
||||||
core.debug(JSON.stringify(instanceConfig))
|
const data = core.getInput('data') || '{}';
|
||||||
|
const files = core.getInput('files') || '{}';
|
||||||
|
const file = core.getInput('file')
|
||||||
|
const method = core.getInput('method') || METHOD_POST;
|
||||||
|
const preventFailureOnNoResponse = core.getInput('preventFailureOnNoResponse') === 'true';
|
||||||
|
const escapeData = core.getInput('escapeData') === 'true';
|
||||||
|
|
||||||
const instance = axios.create(instanceConfig);
|
const ignoreStatusCodes = core.getInput('ignoreStatusCodes')
|
||||||
|
let ignoredCodes = []
|
||||||
|
|
||||||
(async() => {
|
if (typeof ignoreStatusCodes === 'string' && ignoreStatusCodes.length > 0) {
|
||||||
try {
|
ignoredCodes = ignoreStatusCodes.split(',').map(statusCode => parseInt(statusCode.trim()))
|
||||||
const requestData = {
|
}
|
||||||
auth,
|
|
||||||
method: core.getInput('method') || 'POST',
|
|
||||||
data: JSON.parse(core.getInput('data') || '{}')
|
|
||||||
}
|
|
||||||
|
|
||||||
core.debug(JSON.stringify(requestData))
|
request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, files, file, ignoredCodes, actions: new GithubActions() })
|
||||||
|
|
||||||
const response = await instance.request(requestData)
|
|
||||||
|
|
||||||
core.setOutput('response', JSON.stringify(response.data))
|
|
||||||
} catch (error) {
|
|
||||||
core.setFailed(JSON.stringify({ code: error.response.code, message: error.response.data }))
|
|
||||||
}
|
|
||||||
})()
|
|
||||||
|
|||||||
Reference in New Issue
Block a user