@stencila/dockter/tests/DockerParser.test.ts

import DockerParser from '../src/DockerParser'
import { Person, SoftwareEnvironment } from '@stencila/schema'
import { fixture } from './test-functions'
import MockUrlFetcher from './MockUrlFetcher'

const urlFetcher = new MockUrlFetcher()

/**
 * When passed Dockerfile strings, parse should extract LABEL
 * and MAINTAINER instructions.
 */
test('parse:strings', async () => {
  const parser = new DockerParser(urlFetcher, '')
  let environ

  environ = await parser.parse('FROM ubuntu') as SoftwareEnvironment
  expect(environ.authors).toEqual([])

  // Single label
  environ = await parser.parse('LABEL maintainer="Joe Bloggs <joe@bloggs.com> (https://bloggs.com/joe)"') as SoftwareEnvironment
  expect(environ.authors && environ.authors[0].name).toEqual('Joe Bloggs')
  const author = environ.authors && environ.authors[0] as Person
  expect(author).toBeDefined()
  expect(author && author.givenNames).toEqual(['Joe'])
  expect(author && author.familyNames).toEqual(['Bloggs'])
  expect(author && author.emails).toEqual(['joe@bloggs.com'])
  expect(author && author.urls).toEqual(['https://bloggs.com/joe'])

  // Mutiple labels
  environ = await parser.parse('LABEL maintainer="Joe Bloggs" description="My image"') as SoftwareEnvironment
  expect(environ.description).toEqual('My image')
  expect(environ.authors && environ.authors[0].name).toEqual('Joe Bloggs')

  // Mutiple labels using same key - last wins
  environ = await parser.parse('LABEL maintainer="Joe Bloggs" maintainer="Peter Pan"') as SoftwareEnvironment
  expect(environ.authors && environ.authors[0].name).toEqual('Peter Pan')

  // Muti-label with back slashes for spaces and line continuations
  environ = await parser.parse('LABEL maintainer=Joe\\ Bloggs \\\ndescription="My image"') as SoftwareEnvironment
  expect(environ.description).toEqual('My image')
  expect(environ.authors && environ.authors[0].name).toEqual('Joe Bloggs')

  // Prefixed labels
  for (let prefix of ['org.opencontainers.image', 'org.label-schema']) {
    environ = await parser.parse(`LABEL ${prefix}.description="My image"`) as SoftwareEnvironment
    expect(environ.description).toEqual('My image')
  }

  // Deprecated MAINTAINER instruction
  environ = await parser.parse('MAINTAINER Peter Pan') as SoftwareEnvironment
  expect(environ.authors && environ.authors[0].name).toEqual('Peter Pan')

  // Using multiple MAINTAINERS does result in multiple authors
  environ = await parser.parse('LABEL maintainer="Joe Bloggs"\n MAINTAINER Peter Pan\n MAINTAINER Capt Hook')  as SoftwareEnvironment
  expect(environ.authors && environ.authors.length).toEqual(3)
  expect(environ.authors && environ.authors[0].name).toEqual('Joe Bloggs')
  expect(environ.authors && environ.authors[1].name).toEqual('Peter Pan')
  expect(environ.authors && environ.authors[2].name).toEqual('Capt Hook')
})

/**
 * When applied to an empty folder, parse should return null.
 */
test('parse:empty', async () => {
  const parser = new DockerParser(urlFetcher, fixture('empty'))
  expect(await parser.parse()).toBeNull()
})

/**
 * When applied to a folder without a Dockerfile, parse should return null.
 */
test('parse:r-date', async () => {
  const parser = new DockerParser(urlFetcher, fixture('r-date'))
  expect(await parser.parse()).toBeNull()
})

/**
 * When applied to a folder with a Dockerfile, parse should return a
 * `SoftwareEnvironment` based upon it.
 */
test('parse:dockerfile-date', async () => {
  const parser = new DockerParser(urlFetcher, fixture('dockerfile-date'))
  const environ = await parser.parse() as SoftwareEnvironment
  expect(environ.description && environ.description.substring(0, 23)).toEqual('Prints the current date')
  expect(environ.authors && environ.authors[0].name).toEqual('Nokome Bentley')
})