Merge pull request #37 from dependabot/jurre/extract-updater-image-bu…

…ilding

Extract updater image building for easier testing

__tests__/helpers.ts

@@ -54,3 +54,7 @@ export const eventFixturePath = (fixtureName: string): string => {
     `${fixtureName}.json`
   )
 }
+
+export const integration = process.env.SKIP_INTEGRATION_TESTS
+  ? describe.skip
+  : describe

__tests__/proxy-integration.test.ts

@@ -3,12 +3,12 @@ import {Credential} from '../src/api-client'
 import {ImageService} from '../src/image-service'
 import {PROXY_IMAGE_NAME} from '../src/main'
 import {ProxyBuilder} from '../src/proxy'
-import {removeDanglingUpdaterContainers} from './helpers'
+import {integration, removeDanglingUpdaterContainers} from './helpers'
 import {spawnSync} from 'child_process'
 import fs from 'fs'
 import path from 'path'
 
-describe('ProxyBuilder', () => {
+integration('ProxyBuilder', () => {
   const docker = new Docker()
   const jobId = 1
   const credentials: Credential[] = [
@@ -23,10 +23,6 @@ describe('ProxyBuilder', () => {
   const builder = new ProxyBuilder(docker, PROXY_IMAGE_NAME)
 
   beforeAll(async () => {
-    // Skip the test when we haven't preloaded the updater image
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
     await ImageService.pull(PROXY_IMAGE_NAME)
   })
 
@@ -36,11 +32,6 @@ describe('ProxyBuilder', () => {
 
   jest.setTimeout(20000)
   it('should create a proxy container with the right details', async () => {
-    // Skip the test when we haven't preloaded the updater image
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
-
     const proxy = await builder.run(jobId, credentials)
     await proxy.container.start()
 
@@ -77,10 +68,6 @@ describe('ProxyBuilder', () => {
 
   jest.setTimeout(20000)
   it('copies in a custom root CA if configured', async () => {
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
-
     // make a tmp dir at the repo root unless it already exists
     const tmpDir = path.join(__dirname, '../tmp')
     if (!fs.existsSync(tmpDir)) {

__tests__/updater-builder-integration.test.ts

@@ -0,0 +1,90 @@
+import {PROXY_IMAGE_NAME, UPDATER_IMAGE_NAME} from '../src/main'
+import {ImageService} from '../src/image-service'
+import {removeDanglingUpdaterContainers, integration} from './helpers'
+import Docker from 'dockerode'
+import {Credential, JobDetails} from '../src/api-client'
+import {ProxyBuilder} from '../src/proxy'
+import path from 'path'
+import fs from 'fs'
+import {JobParameters} from '../src/inputs'
+import {UpdaterBuilder} from '../src/updater-builder'
+
+integration('UpdaterBuilder', () => {
+  const docker = new Docker()
+  const credentials: Credential[] = [
+    {
+      type: 'git_source',
+      host: 'github.com',
+      username: 'x-access-token',
+      password: 'ghp_some_token'
+    }
+  ]
+
+  const details: JobDetails = {
+    'allowed-updates': [],
+    id: '1',
+    'package-manager': 'npm_and_yarn'
+  }
+
+  const workingDirectory = path.join(
+    __dirname,
+    '..',
+    'tmp',
+    './integration_working_directory'
+  )
+
+  beforeAll(async () => {
+    await ImageService.pull(PROXY_IMAGE_NAME)
+    await ImageService.pull(UPDATER_IMAGE_NAME)
+
+    fs.mkdirSync(workingDirectory)
+  })
+
+  afterEach(async () => {
+    await removeDanglingUpdaterContainers()
+    fs.rmdirSync(workingDirectory, {recursive: true})
+  })
+
+  it('createUpdaterContainer returns a container only connected to the internal network', async () => {
+    const outputPath = path.join(workingDirectory, 'output')
+    const repoPath = path.join(workingDirectory, 'repo')
+    fs.mkdirSync(outputPath)
+    fs.mkdirSync(repoPath)
+
+    const proxy = await new ProxyBuilder(docker, PROXY_IMAGE_NAME).run(
+      1,
+      credentials
+    )
+    await proxy.container.start()
+    const input = {job: details}
+    const params = new JobParameters(
+      1,
+      'job-token',
+      'cred-token',
+      'https://example.com',
+      '172.17.0.1',
+      workingDirectory
+    )
+    const container = await new UpdaterBuilder(
+      docker,
+      params,
+      input,
+      outputPath,
+      proxy,
+      repoPath,
+      UPDATER_IMAGE_NAME
+    ).run('updater-image-test', 'fetch_files')
+
+    const containerInfo = await container.inspect()
+
+    const networkNames = Object.keys(containerInfo.NetworkSettings.Networks)
+    expect(networkNames).toEqual(['dependabot-job-1-internal-network'])
+
+    const network = docker.getNetwork(networkNames[0])
+    const networkInfo = await network.inspect()
+    expect(networkInfo.Internal).toBe(true)
+
+    await proxy.shutdown()
+    await container.remove()
+  })
+})

__tests__/updater-integration.test.ts

@@ -7,11 +7,15 @@ import {JobParameters} from '../src/inputs'
 import {UPDATER_IMAGE_NAME, PROXY_IMAGE_NAME} from '../src/main'
 import {Updater} from '../src/updater'
 
-import {removeDanglingUpdaterContainers, runFakeDependabotApi} from './helpers'
+import {
+  integration,
+  removeDanglingUpdaterContainers,
+  runFakeDependabotApi
+} from './helpers'
 
 const FAKE_SERVER_PORT = 9000
 
-describe('Updater', () => {
+integration('Updater', () => {
   let server: any
 
   // Used from this action to get job details and credentials
@@ -40,11 +44,6 @@ describe('Updater', () => {
   const apiClient = new ApiClient(client, params)
 
   beforeAll(async () => {
-    // Skip the test when we haven't preloaded the updater image
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
-
     await ImageService.pull(UPDATER_IMAGE_NAME)
     await ImageService.pull(PROXY_IMAGE_NAME)
 
@@ -54,23 +53,13 @@ describe('Updater', () => {
   })
 
   afterEach(async () => {
-    // Skip the test when we haven't preloaded the updater image
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
-
     server && server() // teardown server process
     await removeDanglingUpdaterContainers()
     fs.rmdirSync(workingDirectory, {recursive: true})
   })
 
   jest.setTimeout(120000)
   it('should run the updater and create a pull request', async () => {
-    // Skip the test when we haven't preloaded the updater image
-    if (process.env.SKIP_INTEGRATION_TESTS) {
-      return
-    }
-
     const details = await apiClient.getJobDetails()
     const credentials = await apiClient.getCredentials()