feat: integration test suite (#51)

* feat: initial pass at rewriting the integration testing framework

* test: docker tweaks

* style: fixing linting problems

* ci: using optional chaining in tests so don't run them on node 12

* feat: first pass at containerizing node integrations

* feat: making our useObjectBody option the default behavior in node-fetch

* fix: removing multipart/form-data headers from node-fetch when we use FormData

* fix: bug where node request wasn't sending cookies properly

* fix: adding useQuerystring to the node request opts to fix query param arrays

* fix: send the full url instead of `qs` for node request because of double encoding issues

* fix: issues with node axios not sending encoded and query params right

* fix: fixes to the integration tests suite

* fix: promoting the js+fetch useObjectBody option to be the default behavior

* fix: adding the composer autoloader to the top of guzzle snippets

* fix: catch and assert errors when we might be hitting a PROPFIND method

* docs: updating our differences list in the readme

* chore: renaming the `http` fixture to `http-insecure`

* test: setting up the integration tests to run on node, php, and python

* feat: getting the docker container running node tests

* ci: workflow for running node integrations

* ci: moving integration dockerfiles into their own dir

* ci: containerizing php integrations

* ci: no composer files exist to copy

* ci: installing npm deps in the php container so we can run tests

* fix: changing python requests target to use full urls instead of supplying query params

* ci: containerizing python integration tests

* ci: containerizing the curl test suite

* ci: adding a github workflow for the shell integration suite

.eslintrc

@@ -1,6 +1,9 @@
 {
   "extends": "@readme/eslint-config",
   "root": true,
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
   "rules": {
     "global-require": "off",
     "no-underscore-dangle": "off",

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x]
+        node-version: [14.x]
 
     steps:
     - uses: actions/checkout@v2.3.4

.github/workflows/integration-node.yml

@@ -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

.github/workflows/integration-php.yml

@@ -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

.github/workflows/integration-python.yml

@@ -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

.github/workflows/integration-shell.yml

@@ -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

.gitignore

@@ -1,3 +1,5 @@
 *.log
 node_modules/
 coverage/
+vendor/
+composer.*

README.md

@@ -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
 

__tests__/__fixtures__/available-targets.json

@@ -4,6 +4,7 @@
     "title": "Shell",
     "extname": ".sh",
     "default": "curl",
+    "cli": "%s",
     "clients": [
       {
         "key": "curl",
@@ -30,6 +31,7 @@
     "title": "Node.js",
     "extname": ".js",
     "default": "native",
+    "cli": "node %s",
     "clients": [
       {
         "key": "native",
@@ -114,6 +116,7 @@
     "title": "PHP",
     "extname": ".php",
     "default": "curl",
+    "cli": "php %s",
     "clients": [
       {
         "key": "curl",
@@ -146,6 +149,7 @@
     "title": "Python",
     "extname": ".py",
     "default": "python3",
+    "cli": "python3 %s",
     "clients": [
       {
         "key": "python3",

__tests__/__fixtures__/output/javascript/fetch/application-json.js

@@ -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)

__tests__/__fixtures__/output/javascript/fetch/jsonObj-multiline.js

@@ -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)

__tests__/__fixtures__/output/javascript/fetch/jsonObj-null-value.js

@@ -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)

__tests__/__fixtures__/output/node/axios/application-form-encoded.js

@@ -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
 };
 
 axios.request(options).then(function (response) {

__tests__/__fixtures__/output/node/axios/application-json.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/cookies.js

@@ -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'}

__tests__/__fixtures__/output/node/axios/custom-method.js

@@ -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);

__tests__/__fixtures__/output/node/axios/full.js

@@ -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'},
+  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) {

__tests__/__fixtures__/output/node/axios/headers.js

@@ -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'}

__tests__/__fixtures__/output/node/axios/http.js → __tests__/__fixtures__/output/node/axios/http-insecure.js

@@ -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);

__tests__/__fixtures__/output/node/axios/jsonObj-multiline.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/jsonObj-null-value.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/multipart-data.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/multipart-file.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/multipart-form-data.js

@@ -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'},

__tests__/__fixtures__/output/node/axios/nested.js

@@ -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) {

__tests__/__fixtures__/output/node/axios/query-encoded.js

@@ -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) {

__tests__/__fixtures__/output/node/axios/query.js

@@ -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) {

__tests__/__fixtures__/output/node/axios/short.js

@@ -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);