feat: add helper methods that easily allow writing tests for "dockest…

… inside docker" and "dockest on docker host" environments.

examples/aws-code-build-example/.gitignore

@@ -0,0 +1,2 @@
+dockest.tgz
+.artifacts

examples/aws-code-build-example/integration-test/hello-world.spec.ts

@@ -1,11 +1,11 @@
 import http from 'http'
 import fetch from 'node-fetch'
-import isDocker from 'is-docker'
+import { getHostAddress, getServiceAddress } from 'dockest/dist/test-helper'
 
-const TARGET_HOST = isDocker() ? 'website' : 'localhost'
+const TARGET_HOST = getServiceAddress('website', 9000)
 
 // hostname is either our docker container hostname or if not run inside a docker container the docker host
-const HOSTNAME = isDocker() ? process.env.HOSTNAME : 'host.docker.internal'
+const HOSTNAME = getHostAddress()
 const PORT = 8080
 
 let server: http.Server
@@ -38,7 +38,7 @@ test('can send a request to the container and it can send a request to us', asyn
       })
   })
 
-  const res = await fetch(`http://${TARGET_HOST}:9000`, {
+  const res = await fetch(`http://${TARGET_HOST}`, {
     method: 'post',
     body: `http://${HOSTNAME}:${PORT}`,
   }).then(res => res.text())

examples/aws-code-build-example/run_tests.sh

@@ -7,8 +7,10 @@ yarn pack --filename examples/aws-code-build-example/dockest.tgz
 cd examples/aws-code-build-example
 
 # build dockest
-# yarn install
-# yarn test
+yarn cache clean
+yarn install --no-lockfile
+yarn test
 
 # build with dockest inside docker container
+rm -rf node_modules
 ./codebuild_build.sh -i n1ru4l/aws-codebuild-node -a .artifacts

src/onInstantiation/generateComposeFile/__snapshots__/createComposeObjFromRunners.spec.ts.snap

@@ -4,6 +4,7 @@ exports[`createComposeObjFromRunners should create composeObj from all initializ
 Object {
   "services": Object {
     "general": Object {
+      "extra_hosts": Array [],
       "image": "general/image:123",
       "ports": Array [],
     },
@@ -19,6 +20,7 @@ Object {
         "KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR": 1,
         "KAFKA_ZOOKEEPER_CONNECT": "zookeeper:2181",
       },
+      "extra_hosts": Array [],
       "image": "kafka/image:123",
       "ports": Array [
         Object {
@@ -33,6 +35,7 @@ Object {
         "POSTGRES_PASSWORD": "_",
         "POSTGRES_USER": "_",
       },
+      "extra_hosts": Array [],
       "image": "postgres/image:123",
       "ports": Array [
         Object {
@@ -42,6 +45,7 @@ Object {
       ],
     },
     "redis": Object {
+      "extra_hosts": Array [],
       "image": "redis/image:123",
       "ports": Array [
         Object {
@@ -54,6 +58,7 @@ Object {
       "environment": Object {
         "ZOOKEEPER_CLIENT_PORT": 2181,
       },
+      "extra_hosts": Array [],
       "image": "zookeeper/image:123",
       "ports": Array [
         Object {
@@ -76,6 +81,7 @@ Object {
         "POSTGRES_PASSWORD": "_",
         "POSTGRES_USER": "_",
       },
+      "extra_hosts": Array [],
       "image": "postgres/image:123",
       "ports": Array [
         Object {

src/onInstantiation/generateComposeFile/createComposeObjFromRunners.ts

@@ -1,3 +1,4 @@
+import execa from 'execa'
 import { ComposeService, DependsOn, ComposeFile } from '../../runners/@types'
 import { DockestConfig } from '../../index'
 
@@ -18,6 +19,16 @@ export default (config: DockestConfig, dockerComposeFileVersion: string) => {
     services: {},
   }
 
+  const extra_hosts: string[] = []
+
+  if (!config.$.isInsideDockerContainer) {
+    if (process.platform === 'linux') {
+      const command = `ip -4 addr show docker0 | grep -oP '(?<=inet\s)\d+(\.\d+){3}'`
+      const result = execa.sync(command, { reject: false })
+      extra_hosts.push(`host.docker.internal:${result.stdout}`)
+    }
+  }
+
   config.runners.forEach(runner => {
     const {
       runnerConfig: { service, dependsOn },
@@ -29,7 +40,7 @@ export default (config: DockestConfig, dockerComposeFileVersion: string) => {
 
     composeObj.services = {
       ...composeObj.services,
-      [service]: composeService,
+      [service]: { ...composeService, extra_hosts },
       ...depComposeServices,
     }
   })

src/onInstantiation/generateComposeFile/index.ts

@@ -43,6 +43,9 @@ export default (config: DockestConfig, yaml = yamlLib, fs = fsLib) => {
 
   // write final config to fs
   fs.writeFileSync(GENERATED_COMPOSE_FILE_PATH, yaml.safeDump(composeObjFromComposeFile))
+  // set environment variable that can be used with the test-helpers
+  // jest.runCLI will pass this environment variable into the testcase runners
+  process.env.DOCKEST_INTERNAL_CONFIG = JSON.stringify(composeObjFromComposeFile)
 
   return { composeFileConfig: composeObjFromComposeFile }
 }

src/onRun/index.ts

@@ -24,7 +24,7 @@ const onRun = async (config: DockestConfig) => {
 
   if (isInsideDockerContainer) {
     await createBridgeNetwork()
-    await joinBridgeNetwork(hostname)
+    await joinBridgeNetwork(hostname, 'host.dockest-runner.internal')
   }
 
   await waitForRunnersReadiness(config)

src/runners/@types.ts

@@ -38,6 +38,7 @@ export interface ComposeService {
         target: string
       }
     | string
+  extra_hosts?: string[]
 }
 
 export interface ComposeFile {

src/test-helper/index.ts

@@ -0,0 +1,35 @@
+/* eslint-disable import/default */
+import isDocker from 'is-docker'
+import { ComposeFile } from '../runners/@types'
+
+const isInsideDockerContainer = isDocker()
+
+if (!process.env.DOCKEST_INTERNAL_CONFIG) {
+  throw new Error('Not executed inside dockest context.')
+}
+
+const config: ComposeFile = JSON.parse(process.env.DOCKEST_INTERNAL_CONFIG)
+
+export const getHostAddress = () => {
+  if (!isInsideDockerContainer) {
+    return `host.docker.internal`
+  }
+
+  return `host.dockest-runner.internal`
+}
+
+export const getServiceAddress = (serviceName: string, targetPort: number | string) => {
+  const service = config.services[serviceName]
+  if (!service) {
+    throw new Error(`Service "${serviceName}" does not exist.`)
+  }
+  const portBinding = service.ports.find(portBinding => portBinding.target === targetPort)
+  if (!portBinding) {
+    throw new Error(`Service "${serviceName}" has no target port ${portBinding}.`)
+  }
+
+  if (isInsideDockerContainer) {
+    return `${serviceName}:${portBinding.target}`
+  }
+  return `localhost:${portBinding.published}`
+}