@readme/httpsnippet 4.0.0 → 4.0.3

package/src/integration.test.ts

@@ -1,270 +0,0 @@
-/* eslint-disable jest/no-conditional-expect */
-import type { Request } from '.';
-import type { TargetId } from './targets/targets';
-import type { Response } from 'har-format';
-
-import shell from 'child_process';
-import { format } from 'util';
-import { readdirSync } from 'fs';
-import path from 'path';
-
-import { availableTargets, extname } from './helpers/utils';
-
-const expectedBasePath = ['src', 'fixtures', 'requests'];
-
-const ENVIRONMENT_CONFIG = {
-  docker: {
-    // Every client + target that we test in an HTTPBin-powered Docker environment.
-    node: ['axios', 'fetch', 'native', 'request'],
-    php: ['curl', 'guzzle'],
-    python: ['requests'],
-    shell: ['curl'],
-  },
-  local: {
-    // When running tests locally, or within a Jest CI environment, we shold limit the targets that
-    // we're testing so as to not require a mess of dependency requirements that would be better
-    // served within a container.
-    node: ['native'],
-    php: ['curl'],
-    python: ['requests'],
-    shell: ['curl'],
-  },
-};
-
-const inputFileNames = readdirSync(path.join(...expectedBasePath), 'utf-8');
-
-const fixtures: [string, Request][] = inputFileNames.map(inputFileName => [
-  inputFileName.replace(path.extname(inputFileName), ''),
-  // eslint-disable-next-line import/no-dynamic-require, global-require
-  require(path.resolve(...expectedBasePath, inputFileName)),
-]);
-
-/** ignore a set of fixtures from being run in tests */
-const fixtureIgnoreFilter: string[] = [
-  // Some targets don't support native file handling without supplying a raw boundary header and
-  // because the HAR for `multipart-file` doesn't include the files contents, just its filename
-  // running one of these generated snippets doesn't send anything for the file because the
-  // FormData API rewrites the incoming full path of `src/fixtures/files/hello.txt` to just
-  // `hello.txt`. Instead of monkeypatching these targets to have the full file path at time ofb
-  // this execution suite we're just ignoring this test case as file uploading is well covered by
-  // the other cases we have.
-  'multipart-file',
-];
-
-const environmentFilter = (): string[] => {
-  if (process.env.HTTPBIN) {
-    return Object.keys(ENVIRONMENT_CONFIG.docker);
-  } else if (process.env.NODE_ENV === 'test') {
-    return Object.keys(ENVIRONMENT_CONFIG.local);
-  }
-
-  throw new Error('Unsupported environment supplied to `environmentFilter`.');
-};
-
-const clientFilter = (target: TargetId): string[] => {
-  if (process.env.HTTPBIN) {
-    // @ts-expect-error fix this type
-    return ENVIRONMENT_CONFIG.docker[target];
-  } else if (process.env.NODE_ENV === 'test') {
-    // @ts-expect-error fix this type
-    return ENVIRONMENT_CONFIG.local[target];
-  }
-
-  throw new Error('Unsupported environment supplied to `clientFilter`.');
-};
-
-const testFilter =
-  <T>(property: keyof T, list: T[keyof T][], ignore = false) =>
-  (item: T) => {
-    if (!list.length) {
-      return true;
-    } else if (ignore) {
-      return list.length > 0 ? !list.includes(item[property]) : true;
-    }
-
-    return list.length > 0 ? list.includes(item[property]) : true;
-  };
-
-/**
- * @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_eval!
- */
-function looseJSONParse(obj: any) {
-  // eslint-disable-next-line no-new-func
-  return new Function(`"use strict";return ${obj}`)();
-}
-
-availableTargets()
-  .filter(target => target.cli)
-  .filter(testFilter('key', environmentFilter()))
-  .forEach(({ key: targetId, cli: targetCLI, title, extname: fixtureExtension, clients }) => {
-    describe(`${title} integration tests`, () => {
-      clients.filter(testFilter('key', clientFilter(targetId))).forEach(({ key: clientId }) => {
-        // If we're in an HTTPBin-powered Docker environment we only want to run tests for the
-        // client that our Docker has been configured for.
-        if (process.env.HTTPBIN && process.env.INTEGRATION_CLIENT !== targetId) {
-          return;
-        }
-
-        // eslint-disable-next-line jest/valid-title
-        describe(clientId, () => {
-          fixtures.filter(testFilter(0, fixtureIgnoreFilter, true)).forEach(([fixture, request]) => {
-            it(`should return the expected response for \`${fixture}\``, () => {
-              const basePath = path.join(
-                'src',
-                'targets',
-                targetId,
-                clientId,
-                'fixtures',
-                `${fixture}${extname(targetId)}`
-              );
-
-              // Clone the fixture we're testing against to another object because for multipart cases
-              // we're deleting the header, and if we don't clone the fixture to another object, that
-              // deleted header will cause other tests to fail because it's missing where other tests
-              // are expecting it.
-              const har = JSON.parse(JSON.stringify(request));
-              const url = har.log.entries[0].request.url;
-              const harResponse = har.log.entries[0].response as Response;
-
-              const command = format(targetCLI, basePath);
-              let stdout;
-              try {
-                stdout = shell.execSync(command);
-              } catch (err) {
-                // If this target throws errors when it can't access a method on the server that
-                // doesn't exist let's make sure that it only did that on the `custom-method` test,
-                // otherwise something went wrong!
-                if (err.message.includes('405 METHOD NOT ALLOWED')) {
-                  expect(fixture).toBe('custom-method');
-                  return;
-                }
-
-                throw err;
-              }
-
-              stdout = stdout.toString().trim();
-
-              // If the endpoint we're testing against returns HTML we should do a string comparison
-              // instead of parsing a non-existent JSON response.
-              if (harResponse.headers.find(header => header.name === 'Content-Type' && header.value === 'text/html')) {
-                // const stdoutTrimmed = stdout.toString().trim();
-
-                try {
-                  expect(stdout).toStrictEqual(harResponse.content.text);
-                } catch (err) {
-                  // Some targets always assume that their response is JSON and for this case
-                  // (`custom-method`) will print out an empty string instead.
-                  expect(stdout).toBe('');
-                }
-
-                return;
-              }
-
-              const expected = JSON.parse(String(harResponse.content.text));
-              let response;
-              try {
-                response = JSON.parse(stdout);
-              } catch (err) {
-                // Some JS targets print out their response with `console.log(json)` which creates
-                // a JSON object that we can't access with `JSON.parse()`.
-                // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval#never_use_eval!
-                if (fixtureExtension !== '.js') {
-                  throw err;
-                }
-
-                response = looseJSONParse(stdout);
-              }
-
-              // If we're testing against the `/cookies` or `/headers` endpoints it returns a
-              // different schema than everything else.
-              if (url === 'https://httpbin.org/cookies') {
-                expect(response.cookies).toStrictEqual(expected.cookies);
-                return;
-              } else if (url === 'https://httpbin.org/headers') {
-                expect(response.headers).toStrictEqual(
-                  expect.objectContaining({
-                    ...expected.headers,
-                  })
-                );
-
-                return;
-              }
-
-              expect(response.args).toStrictEqual(expected.args);
-
-              // Some targets send files that have a new line at the end of them without that new
-              // line so we need to make our assertion universal across all targets.
-              let files = {};
-              if (Object.keys(response.files).length) {
-                files = Object.entries(response.files)
-                  .map(([k, v]) => ({ [k]: String(v).trim() }))
-                  .reduce((prev, next) => Object.assign(prev, next));
-              }
-
-              expect(files).toStrictEqual(expected.files);
-
-              expect(response.form).toStrictEqual(expected.form);
-              expect(response.method).toStrictEqual(expected.method);
-              expect(response.url).toStrictEqual(expected.url);
-
-              // Because some JS targets may be returning their payloads with `console.log()` that
-              // method has a default depth, at which point it turns objects into `[Object]`. When
-              // we then run that through `looseJSONParse` it gets transformed again into
-              // `[ [Function: Object] ]`. Since we don't have access to the original object context
-              // from the target snippet, we rewrite our response a bit so that it can partially
-              // match what we're looking for.
-              //
-              // Of course the side effect to this is is that now these test cases may be subject
-              // to flakiness but without updating the root snippets to not use `console.log()`,
-              // which we don't want to do, this is the way it's got to be.
-              if (fixture === 'application-json' && fixtureExtension === '.js') {
-                const respJSON = response.json;
-                respJSON.arr_mix[2] = { arr_mix_nested: {} };
-
-                expect(respJSON).toStrictEqual(expected.json);
-              } else {
-                expect(response.json).toStrictEqual(expected.json);
-              }
-
-              // If we're dealing with a JSON payload, some snippets add indents and new lines to
-              // the data that is sent to
-              // HTTPBin (that it then returns back us in the same format) -- to make this `data`
-              // check target agnostic we need to parse and re-stringify our expectations so that
-              // this test can universally match them all.
-              if (expected.headers?.['Content-Type']?.includes('application/json')) {
-                expect(JSON.stringify(JSON.parse(response.data))).toStrictEqual(
-                  JSON.stringify(JSON.parse(expected.data))
-                );
-              } else {
-                expect(response.data).toStrictEqual(expected.data);
-              }
-
-              // `multipart/form-data` needs some special tests to assert that boundaries were sent
-              // and received properly.
-              if (expected.headers?.['Content-Type']?.includes('multipart/form-data')) {
-                if (expected.headers['Content-Type'] === response.headers['Content-Type']) {
-                  // If the headers match identically, great! If not we need to make sure that
-                  // there's a boundary set up.
-                } else {
-                  // It doesn't matter that the /right/ boundary is set up because some targets may
-                  // add their own, we just need to make sure that **a** boundary is present.
-                  const contentTypes: string[] = response.headers['Content-Type']
-                    .split(';')
-                    .map((p: string) => p.trim());
-
-                  expect(contentTypes).toHaveLength(2);
-                  expect(contentTypes.map(type => type.includes('boundary=')).filter(Boolean)).toHaveLength(1);
-                }
-              } else {
-                expect(response.headers).toStrictEqual(
-                  expect.objectContaining({
-                    ...expected.headers,
-                  })
-                );
-              }
-            });
-          });
-        });
-      });
-    });
-  });

package/src/targets/c/libcurl/client.ts

@@ -1,50 +0,0 @@
-import type { Client } from '../../targets';
-import { CodeBuilder } from '../../../helpers/code-builder';
-
-export const libcurl: Client = {
-  info: {
-    key: 'libcurl',
-    title: 'Libcurl',
-    link: 'http://curl.haxx.se/libcurl',
-    description: 'Simple REST and HTTP API Client for C',
-  },
-  convert: ({ method, fullUrl, headersObj, allHeaders, postData }) => {
-    const { push, blank, join } = new CodeBuilder();
-
-    push('CURL *hnd = curl_easy_init();');
-    blank();
-    push(`curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "${method.toUpperCase()}");`);
-    push(`curl_easy_setopt(hnd, CURLOPT_URL, "${fullUrl}");`);
-
-    // Add headers, including the cookies
-    const headers = Object.keys(headersObj);
-
-    // construct headers
-    if (headers.length) {
-      blank();
-      push('struct curl_slist *headers = NULL;');
-
-      headers.forEach(header => {
-        push(`headers = curl_slist_append(headers, "${header}: ${headersObj[header]}");`);
-      });
-
-      push('curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);');
-    }
-
-    // construct cookies
-    if (allHeaders.cookie) {
-      blank();
-      push(`curl_easy_setopt(hnd, CURLOPT_COOKIE, "${allHeaders.cookie}");`);
-    }
-
-    if (postData.text) {
-      blank();
-      push(`curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, ${JSON.stringify(postData.text)});`);
-    }
-
-    blank();
-    push('CURLcode ret = curl_easy_perform(hnd);');
-
-    return join();
-  },
-};

package/src/targets/c/libcurl/fixtures/application-form-encoded.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "foo=bar&hello=world");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/application-json.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: application/json");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/cookies.c

@@ -1,8 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/cookies");
-
-curl_easy_setopt(hnd, CURLOPT_COOKIE, "foo=bar; bar=baz");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/custom-method.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PROPFIND");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/full.c

@@ -1,15 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "accept: application/json");
-headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_COOKIE, "foo=bar; bar=baz");
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "foo=bar");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/headers.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/headers");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "accept: application/json");
-headers = curl_slist_append(headers, "x-foo: Bar");
-headers = curl_slist_append(headers, "x-bar: Foo");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/http-insecure.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "http://httpbin.org/anything");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/jsonObj-multiline.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: application/json");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"foo\": \"bar\"\n}");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/jsonObj-null-value.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: application/json");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"foo\":null}");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/multipart-data.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bar\"\r\n\r\nBonjour le monde\r\n-----011000010111000001101001--\r\n");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/multipart-file.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\n\r\n-----011000010111000001101001--\r\n");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/multipart-form-data-no-params.c

@@ -1,10 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "Content-Type: multipart/form-data");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/multipart-form-data.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "Content-Type: multipart/form-data; boundary=---011000010111000001101001");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/nested.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/query-encoded.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/query.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/short.c

@@ -1,6 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/libcurl/fixtures/text-plain.c

@@ -1,12 +0,0 @@
-CURL *hnd = curl_easy_init();
-
-curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
-curl_easy_setopt(hnd, CURLOPT_URL, "https://httpbin.org/anything");
-
-struct curl_slist *headers = NULL;
-headers = curl_slist_append(headers, "content-type: text/plain");
-curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
-
-curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "Hello World");
-
-CURLcode ret = curl_easy_perform(hnd);

package/src/targets/c/target.ts

@@ -1,14 +0,0 @@
-import type { Target } from '../targets';
-import { libcurl } from './libcurl/client';
-
-export const c: Target = {
-  info: {
-    key: 'c',
-    title: 'C',
-    extname: '.c',
-    default: 'libcurl',
-  },
-  clientsById: {
-    libcurl,
-  },
-};