Merge remote-tracking branch 'origin/master' into update-alpha

.dependabot/config.yml

@@ -2,7 +2,7 @@ version: 1
 update_configs:
   - package_manager: "javascript"
     directory: "/"
-    update_schedule: "live"
+    update_schedule: "daily"
     ignored_updates:
       - match:
           dependency_name: "@types/node"
@@ -14,7 +14,7 @@ update_configs:
 
   - package_manager: "javascript"
     directory: "/black-box-tests/pre-release"
-    update_schedule: "live"
+    update_schedule: "daily"
     ignored_updates:
       - match:
           dependency_name: "@types/node"
@@ -26,7 +26,7 @@ update_configs:
 
   - package_manager: "docker"
     directory: "/"
-    update_schedule: "live"
+    update_schedule: "daily"
     ignored_updates:
       - match:
           dependency_name: "node"

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:12.16.2-alpine as base
+FROM node:12.18.4-alpine as base
 
 RUN apk add --no-cache bash
 RUN apk add --no-cache curl

black-box-tests/acceptance/__snapshots__/generate.spec.ts.snap

@@ -0,0 +1,16 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ncdc generate can generate multiple configs: toMatchStrippedSnapshot 1`] = `
+"info: JSON schemas have been written to disk
+"
+`;
+
+exports[`ncdc generate can run the generate command with noEmit false and composite true: toMatchStrippedSnapshot 1`] = `
+"info: JSON schemas have been written to disk
+"
+`;
+
+exports[`ncdc generate can run the generate command: toMatchStrippedSnapshot 1`] = `
+"info: JSON schemas have been written to disk
+"
+`;

black-box-tests/acceptance/__snapshots__/test.spec.ts.snap

@@ -0,0 +1,40 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`ncdc test can run the test command: toMatchStrippedSnapshot 1`] = `
+"info: PASSED: Shorts - http://localhost:5000/api/resource
+"
+`;
+
+exports[`ncdc test can test endpoints that return json: toMatchStrippedSnapshot 1`] = `
+"info: PASSED: Hello - http://localhost:5000/api/resource
+"
+`;
+
+exports[`ncdc test does not break when using a rate limit: toMatchStrippedSnapshot 1`] = `
+"info: PASSED: Shorts - http://localhost:5000/api/resource
+"
+`;
+
+exports[`ncdc test gives back a useful error message when a type does not exist on the FS: toMatchStrippedSnapshot 1`] = `
+"Code: 1 | Signal: null | Output:
+
+error: An error occurred while validating a fixture within /test-environment/config.yml:
+ENOENT: no such file or directory, open '/test-environment/json-schemas/Hello.json'
+"
+`;
+
+exports[`ncdc test gives back a useful message when a configured body does not match the real response: toMatchStrippedSnapshot 1`] = `
+"Code: 1 | Signal: null | Output:
+
+error: FAILED: Hello - http://localhost:5000/api/resource
+The response body was not deeply equal to your configured fixture
+Received:
+{ hello: 123 }
+error: Not all tests passed
+"
+`;
+
+exports[`ncdc test passes even if a request or response has additional properties: toMatchStrippedSnapshot 1`] = `
+"info: PASSED: lel - http://localhost:5000/api/resource
+"
+`;

black-box-tests/acceptance/generate.spec.ts

@@ -1,8 +1,8 @@
-import strip from 'strip-ansi'
 import { runGenerateCommand } from '~shared/generate-wrapper'
 import { ConfigWrapper, TEST_ENV, TYPES_FILE } from '~shared/config-wrapper'
 import { ConfigBuilder } from '~shared/config-builder'
 import { writeFileSync } from 'fs'
+import './jest-extensions'
 
 jest.useRealTimers()
 jest.setTimeout(10000)
@@ -23,7 +23,8 @@ describe('ncdc generate', () => {
 
     const output = await runGenerateCommand()
 
-    expect(strip(output)).toContain(`JSON schemas have been written to disk`)
+    expect(output).toContain(`JSON schemas have been written to disk`)
+    expect(output).toMatchStrippedSnapshot()
   })
 
   // TODO: now that multiple configs are a thing, this whole config wrapping thing definitely needs a redo
@@ -54,7 +55,8 @@ describe('ncdc generate', () => {
 
     const output = await runGenerateCommand(config2Path)
 
-    expect(strip(output)).toContain(`JSON schemas have been written to disk`)
+    expect(output).toContain(`JSON schemas have been written to disk`)
+    expect(output).toMatchStrippedSnapshot()
   })
 
   it('handles a case where a type does not exist gracefully', async () => {
@@ -71,7 +73,7 @@ describe('ncdc generate', () => {
 
     const output = await runGenerateCommand()
 
-    expect(strip(output)).toContain('error: Could not find type: RTypeDelta')
+    expect(output).toContain('error: Could not find type: RTypeDelta')
   })
 
   it('can run the generate command with noEmit false and composite true', async () => {
@@ -98,6 +100,7 @@ describe('ncdc generate', () => {
 
     const output = await runGenerateCommand()
 
-    expect(strip(output)).toContain(`JSON schemas have been written to disk`)
+    expect(output).toContain(`JSON schemas have been written to disk`)
+    expect(output).toMatchStrippedSnapshot()
   })
 })

black-box-tests/acceptance/jest-extensions.ts

@@ -0,0 +1,29 @@
+import strip from 'strip-ansi'
+import { toMatchSnapshot } from 'jest-snapshot'
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace jest {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    interface Matchers<R> {
+      toMatchStrippedSnapshot(): R
+    }
+  }
+}
+
+expect.extend({
+  toMatchStrippedSnapshot(received) {
+    const content = strip(received)
+      .split('\n')
+      .map((line) => {
+        const filePathRegex = /\/(?:.*\/)+test-environment/i
+        return line.replace(filePathRegex, '/test-environment')
+      })
+      .join('\n')
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore do not know how to fix this "this" type mismatch
+    return toMatchSnapshot.call(this, content, 'toMatchStrippedSnapshot')
+  },
+})