Skip to content

feat: integration test suite#51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erunion merged 29 commits into from
Sep 14, 2021
Merged

feat: integration test suite #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b2e6e25
feat: initial pass at rewriting the integration testing framework
erunion Sep 10, 2021
02ab8fd
test: docker tweaks
erunion Sep 10, 2021
75daa15
Merge branch 'main' into feat/integration-tests
erunion Sep 10, 2021
a06d992
style: fixing linting problems
erunion Sep 10, 2021
2d0c160
ci: using optional chaining in tests so don't run them on node 12
erunion Sep 10, 2021
51269a1
feat: first pass at containerizing node integrations
erunion Sep 11, 2021
6ff7e4e
feat: making our useObjectBody option the default behavior in node-fetch
erunion Sep 13, 2021
b4bd8a5
fix: removing multipart/form-data headers from node-fetch when we use…
erunion Sep 13, 2021
4a61242
fix: bug where node request wasn't sending cookies properly
erunion Sep 13, 2021
99faa7d
fix: adding useQuerystring to the node request opts to fix query para…
erunion Sep 13, 2021
7b4acc1
fix: send the full url instead of `qs` for node request because of do…
erunion Sep 13, 2021
f117097
fix: issues with node axios not sending encoded and query params right
erunion Sep 13, 2021
2168051
fix: fixes to the integration tests suite
erunion Sep 13, 2021
a29ab1d
fix: promoting the js+fetch useObjectBody option to be the default be…
erunion Sep 13, 2021
18a7b4d
fix: adding the composer autoloader to the top of guzzle snippets
erunion Sep 13, 2021
00a4ce5
fix: catch and assert errors when we might be hitting a PROPFIND method
erunion Sep 13, 2021
cef2c13
docs: updating our differences list in the readme
erunion Sep 13, 2021
d0a43f3
chore: renaming the `http` fixture to `http-insecure`
erunion Sep 13, 2021
48133d2
test: setting up the integration tests to run on node, php, and python
erunion Sep 13, 2021
fd95dee
feat: getting the docker container running node tests
erunion Sep 13, 2021
4dcc967
ci: workflow for running node integrations
erunion Sep 13, 2021
4d93815
ci: moving integration dockerfiles into their own dir
erunion Sep 13, 2021
1fecafc
ci: containerizing php integrations
erunion Sep 14, 2021
e399acf
ci: no composer files exist to copy
erunion Sep 14, 2021
c7f141d
ci: installing npm deps in the php container so we can run tests
erunion Sep 14, 2021
480c1de
fix: changing python requests target to use full urls instead of supp…
erunion Sep 14, 2021
d7b9da2
ci: containerizing python integration tests
erunion Sep 14, 2021
cb14ccd
ci: containerizing the curl test suite
erunion Sep 14, 2021
533274d
ci: adding a github workflow for the shell integration suite
erunion Sep 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
{
"extends": "@readme/eslint-config",
"root": true,
"parserOptions": {
"ecmaVersion": 2020
},
"rules": {
"global-require": "off",
"no-underscore-dangle": "off",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ jobs:

strategy:
matrix:
node-version: [12.x, 14.x]
node-version: [14.x]

steps:
- uses: actions/checkout@v2.3.4
Expand Down
14 changes: 14 additions & 0 deletions .github/workflows/integration-node.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
name: Integrations (Node)
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.4

- name: Run tests
run: docker-compose run integration_node

- name: Cleanup
if: always()
run: docker-compose down
14 changes: 14 additions & 0 deletions .github/workflows/integration-php.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
name: Integrations (PHP)
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.4

- name: Run tests
run: docker-compose run integration_php

- name: Cleanup
if: always()
run: docker-compose down
14 changes: 14 additions & 0 deletions .github/workflows/integration-python.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
name: Integrations (Python)
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.4

- name: Run tests
run: docker-compose run integration_python

- name: Cleanup
if: always()
run: docker-compose down
14 changes: 14 additions & 0 deletions .github/workflows/integration-shell.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
name: Integrations (Shell)
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.4

- name: Run tests
run: docker-compose run integration_shell

- name: Cleanup
if: always()
run: docker-compose down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
*.log
node_modules/
coverage/
vendor/
composer.*
9 changes: 0 additions & 9 deletions Dockerfile
View file
Open in desktop

This file was deleted.

15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,9 +155,20 @@ For detailed information on each target, please review the [wiki](https://github

The main difference between this library and the upstream [httpsnippet](https://github.com/Kong/httpsnippet) library are:

* Does not ship with a CLI component
* Adds a `useObjectBody` option to the `node` and `javascript` targets. This option is a boolean flag that causes the request body to be rendered as an object literal wrapped in `JSON.stringify`. If disabled, it falls back to the original behavior of a stringified object body. This flag defaults to disabled.
* Does not ship with a CLI component.
* The `fetch` target for Node and JS both treat body payloads as an object literal and wrap it within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads.
* Contains a `harIsAlreadyEncoded` option on the core library to disable [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs. Helpful if the HAR being supplied already has them escaped.
* PHP Guzzle snippets come with `require_once('vendor/autoload.php');` at the top of them.
* A full integration suite for testing out snippets the library creates.

### Running the integration suite

```
docker-compose run integration_node
docker-compose run integration_php
docker-compose run integration_python
docker-compose run integration_shell
```

## License

Expand Down
4 changes: 4 additions & 0 deletions __tests__/__fixtures__/available-targets.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@
"title": "Shell",
"extname": ".sh",
"default": "curl",
"cli": "%s",
"clients": [
{
"key": "curl",
Expand All@@ -30,6 +31,7 @@
"title": "Node.js",
"extname": ".js",
"default": "native",
"cli": "node %s",
"clients": [
{
"key": "native",
Expand DownExpand Up@@ -114,6 +116,7 @@
"title": "PHP",
"extname": ".php",
"default": "curl",
"cli": "php %s",
"clients": [
{
"key": "curl",
Expand DownExpand Up@@ -146,6 +149,7 @@
"title": "Python",
"extname": ".py",
"default": "python3",
"cli": "python3 %s",
"clients": [
{
"key": "python3",
Expand Down
25 changes: 0 additions & 25 deletions __tests__/__fixtures__/cli.json
View file
Open in desktop

This file was deleted.

0 ...ts__/__fixtures__/output/c/libcurl/http.c → ...xtures__/output/c/libcurl/http-insecure.c
View file
Open in desktop
File renamed without changes.
0 ...xtures__/output/clojure/clj_http/http.clj → ...output/clojure/clj_http/http-insecure.clj
View file
Open in desktop
File renamed without changes.
0 ...xtures__/output/csharp/httpclient/http.cs → ...output/csharp/httpclient/http-insecure.cs
View file
Open in desktop
File renamed without changes.
0 ...ixtures__/output/csharp/restsharp/http.cs → .../output/csharp/restsharp/http-insecure.cs
View file
Open in desktop
File renamed without changes.
0 ...s__/__fixtures__/output/go/native/http.go → ...tures__/output/go/native/http-insecure.go
View file
Open in desktop
File renamed without changes.
0 __tests__/__fixtures__/output/http/1.1/http → ..._fixtures__/output/http/1.1/http-insecure
View file
Open in desktop
File renamed without changes.
0 ...ixtures__/output/java/asynchttp/http.java → .../output/java/asynchttp/http-insecure.java
View file
Open in desktop
File renamed without changes.
0 ..._fixtures__/output/java/nethttp/http.java → ...__/output/java/nethttp/http-insecure.java
View file
Open in desktop
File renamed without changes.
0 ...__fixtures__/output/java/okhttp/http.java → ...s__/output/java/okhttp/http-insecure.java
View file
Open in desktop
File renamed without changes.
0 ..._fixtures__/output/java/unirest/http.java → ...__/output/java/unirest/http-insecure.java
View file
Open in desktop
File renamed without changes.
0 ...ixtures__/output/javascript/axios/http.js → .../output/javascript/axios/http-insecure.js
View file
Open in desktop
File renamed without changes.
9 changes: 8 additions & 1 deletion __tests__/__fixtures__/output/javascript/fetch/application-json.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'
body: JSON.stringify({
number: 1,
string: 'f"oo',
arr: [1, 2, 3],
nested: {a: 'b'},
arr_mix: [1, 'a', {arr_mix_nested: {}}],
boolean: false
})
};

fetch('https://httpbin.org/anything', options)
Expand Down
0 ...ixtures__/output/javascript/fetch/http.js → .../output/javascript/fetch/http-insecure.js
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion __tests__/__fixtures__/output/javascript/fetch/jsonObj-multiline.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"foo":"bar"}'
body: JSON.stringify({foo: 'bar'})
};

fetch('https://httpbin.org/anything', options)
Expand Down
2 changes: 1 addition & 1 deletion __tests__/__fixtures__/output/javascript/fetch/jsonObj-null-value.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"foo":null}'
body: JSON.stringify({foo: null})
};

fetch('https://httpbin.org/anything', options)
Expand Down
0 ...xtures__/output/javascript/jquery/http.js → ...output/javascript/jquery/http-insecure.js
View file
Open in desktop
File renamed without changes.
0 ..._fixtures__/output/javascript/xhr/http.js → ...__/output/javascript/xhr/http-insecure.js
View file
Open in desktop
File renamed without changes.
0 ...__fixtures__/output/kotlin/okhttp/http.kt → ...s__/output/kotlin/okhttp/http-insecure.kt
View file
Open in desktop
File renamed without changes.
11 changes: 8 additions & 3 deletions __tests__/__fixtures__/output/node/axios/application-form-encoded.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
var axios = require("axios").default;
const axios = require("axios").default;
const { URLSearchParams } = require('url');
const encodedParams = new URLSearchParams();

var options = {
encodedParams.set('foo', 'bar');
encodedParams.set('hello', 'world');

const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'application/x-www-form-urlencoded'},
data: {foo: 'bar', hello: 'world'}
data: encodedParams

@erunionerunionSep 13, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made this change because this data was getting to HTTPBin actually as the following:

{args: {},data: '',files: {},form: {'{"foo":"bar","hello":"world"}': ''},headers: {Accept: 'application/json, text/plain, */*','Content-Length': '29','Content-Type': 'application/x-www-form-urlencoded',Host: 'httpbin.org','User-Agent': 'axios/0.21.4','X-Amzn-Trace-Id': 'Root=1-613fc81c-33b383d80f53e0750840173b'},json: null,method: 'POST',origin: 'REDACTED',url: 'https://httpbin.org/anything'}

With this fix:

{args: {},data: '',files: {},form: {foo: 'bar',hello: 'world'},headers: {Accept: 'application/json, text/plain, */*','Content-Length': '19','Content-Type': 'application/x-www-form-urlencoded',Host: 'httpbin.org','User-Agent': 'axios/0.21.4','X-Amzn-Trace-Id': 'Root=1-613fc852-1b54e94f1b77ddac478d20a4'},json: null,method: 'POST',origin: 'REDACTED',url: 'https://httpbin.org/anything'}

};

axios.request(options).then(function (response) {
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/application-json.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'application/json'},
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/cookies.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'GET',
url: 'https://httpbin.org/cookies',
headers: {cookie: 'foo=bar; bar=baz'}
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/custom-method.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {method: 'PROPFIND', url: 'https://httpbin.org/anything'};
const options = {method: 'PROPFIND', url: 'https://httpbin.org/anything'};

axios.request(options).then(function (response) {
console.log(response.data);
Expand Down
13 changes: 8 additions & 5 deletions __tests__/__fixtures__/output/node/axios/full.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
var axios = require("axios").default;
const axios = require("axios").default;
const { URLSearchParams } = require('url');
const encodedParams = new URLSearchParams();

var options = {
encodedParams.set('foo', 'bar');

const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
params: {foo: ['bar', 'baz'], baz: 'abc', key: 'value'},

@erunionerunionSep 13, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made this change because query params were getting to HTTPBin as the following:

args: {baz: 'abc','foo[]': ['bar','baz'],key: 'value'},

With this fix:

args: {baz: 'abc',foo: ['bar','baz'],key: 'value'},

@DashronDashronSep 14, 2021

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

interesting, so foo[] is an old way people used to identify that multiple identical parameters should be treated as an array. I haven't seen it for quite some time though. In fact it doesn't really even seem to be supported as an OAS style.

I'm going to poke around axios a bit and see why they're still using this pattern by default.

@DashronDashronSep 14, 2021

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you can use URLSearchParams: https://stackoverflow.com/questions/42898009/multiple-fields-with-same-key-in-query-params-axios-request

@erunionerunionSep 14, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To get this working right with URLSearchParams we'll need to run through arrays and add them in separately:

const params = new URLSearchParams();
params.append('foo', 'bar');
params.append('foo', 'baz');
params.append('baz', 'abc');
params.append('key', 'value');

I'm going to leave it with having query params in the URL because it'll be less noisy.

url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value',
headers: {
cookie: 'foo=bar; bar=baz',
accept: 'application/json',
'content-type': 'application/x-www-form-urlencoded'
},
data: {foo: 'bar'}
data: encodedParams
};

axios.request(options).then(function (response) {
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/headers.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'GET',
url: 'https://httpbin.org/headers',
headers: {accept: 'text/json', 'x-foo': 'Bar'}
Expand Down
4 changes: 2 additions & 2 deletions ...__/__fixtures__/output/node/axios/http.js → ...ures__/output/node/axios/http-insecure.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {method: 'GET', url: 'http://httpbin.org/anything'};
const options = {method: 'GET', url: 'http://httpbin.org/anything'};

axios.request(options).then(function (response) {
console.log(response.data);
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/jsonObj-multiline.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'application/json'},
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/jsonObj-null-value.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'application/json'},
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/multipart-data.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/multipart-file.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/multipart-form-data.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'POST',
url: 'https://httpbin.org/anything',
headers: {'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'},
Expand Down
7 changes: 3 additions & 4 deletions __tests__/__fixtures__/output/node/axios/nested.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'GET',
url: 'https://httpbin.org/anything',
params: {'foo[bar]': 'baz,zap', fiz: 'buz', key: 'value'}
url: 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'
};

axios.request(options).then(function (response) {
Expand Down
10 changes: 3 additions & 7 deletions __tests__/__fixtures__/output/node/axios/query-encoded.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'GET',
url: 'https://httpbin.org/anything',
params: {
startTime: '2019-06-13T19%3A08%3A25.455Z',
endTime: '2015-09-15T14%3A00%3A12-04%3A00'
}
url: 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00'
};

axios.request(options).then(function (response) {
Expand Down
7 changes: 3 additions & 4 deletions __tests__/__fixtures__/output/node/axios/query.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {
const options = {
method: 'GET',
url: 'https://httpbin.org/anything',
params: {foo: ['bar', 'baz'], baz: 'abc', key: 'value'}
url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'
};

axios.request(options).then(function (response) {
Expand Down
4 changes: 2 additions & 2 deletions __tests__/__fixtures__/output/node/axios/short.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
var axios = require("axios").default;
const axios = require("axios").default;

var options = {method: 'GET', url: 'https://httpbin.org/anything'};
const options = {method: 'GET', url: 'https://httpbin.org/anything'};

axios.request(options).then(function (response) {
console.log(response.data);
Expand Down
Loading