firmament-docker/ts/test/docker-image-management.test.ts

Typescript classes for performing Docker operations

import 'reflect-metadata';
import kernel from '../inversify.config';
import {expect} from 'chai';
import {DockerOde, DockerImage, ImageOrContainerRemoveResults} from '../interfaces/dockerode';
import {DockerOdeMockImpl} from './docker-ode-mock-impl';
import {DockerImageManagement} from '../interfaces/docker-image-management';
import {ForceError} from 'firmament-yargs';
//import {DockerOdeImpl} from '../implementations/docker-ode-impl';
const path = require('path');
describe('DockerImageManagement', function () {
  let dockerImageManagement: DockerImageManagement;
  beforeEach(()=> {
    kernel.unbind('DockerOde');
    //kernel.bind<DockerOde>('DockerOde').to(DockerOdeImpl);
    kernel.bind<DockerOde>('DockerOde').to(DockerOdeMockImpl);
    dockerImageManagement = kernel.get<DockerImageManagement>('DockerImageManagement');
  });
  //
  //****************************** DockerImageManagement.listImages
  //
  describe('DockerImageManagement.listImages (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.listImages(
        true,
        (err: Error, images: DockerImage[])=> {
          expect(err).to.not.equal(null);
          expect(images).to.equal(null);
          done();
        });
    });
  });
  describe('DockerImageManagement.listImages (all)', function () {
    it('should return array of all (9) Images in callback', function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.listImages(
        true,
        (err: Error, images: DockerImage[])=> {
          expect(err).to.equal(null);
          expect(images).to.have.lengthOf(9);
          done();
        });
    });
  });
  describe('DockerImageManagement.listImages (not-all)', function () {
    it('should return array of all (5) Images in callback', function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.listImages(
        false,
        (err: Error, images: DockerImage[])=> {
          expect(err).to.equal(null);
          expect(images).to.have.lengthOf(5);
          done();
        });
    });
  });
  describe('DockerImageManagement.getImage (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.getImage(
        '3',
        (err: Error, image: DockerImage)=> {
          expect(err).to.not.equal(null);
          expect(image).to.equal(null);
          done();
        });
    });
  });
  describe('DockerImageManagement.getImage (by firmamentId)', function () {
    it(`should return ImageObject with name: 'jstnldrs/caffedata:1.0'`, function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.getImage(
        '7',
        (err: Error, image: DockerImage)=> {
          expect(err).to.equal(null);
          expect(image.constructor.name).to.equal('DockerImageImpl');
          expect(image.Name).to.equal('jstnldrs/caffedata:1.0');
          done();
        });
    });
  });
  describe('DockerImageManagement.getImages (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.getImages(
        ['7', '8'],
        (err: Error, images: DockerImage[])=> {
          expect(err).to.not.equal(null);
          expect(images).to.equal(null);
          done();
        });
    });
  });
  describe('DockerImageManagement.getImages (by firmamentId)', function () {
    let imageNames = ['jstnldrs/caffedata:1.0','mongo:2.6'];
    it(`should return array of ImageObjects (length 2)`, function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.getImages(
        ['7', '8'],
        (err: Error, images: DockerImage[])=> {
          expect(err).to.equal(null);
          expect(images).to.have.lengthOf(2);
          for(let i = 0;i < images.length;++i){
            expect(images[i].constructor.name).to.equal('DockerImageImpl');
            expect(images[i].Name).to.equal(imageNames[i]);
          }
          done();
        });
    });
  });
  describe('DockerImageManagement.pullImage (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      //noinspection JSUnusedLocalSymbols,JSUnusedLocalSymbols,JSUnusedLocalSymbols,JSUnusedLocalSymbols
      dockerImageManagement.pullImage(
        'mysql:5.6',
        (taskId:string,status:string,current:number,total:number)=>{
        },
        (err: Error)=> {
          expect(err).to.not.equal(null);
          expect(err.message).to.equal('force error: pull');
          done();
        });
    });
  });
  describe('DockerImageManagement.pullImage (recoverable errors)', function () {
    it(`should pull an image from hub.docker.com`, function (done) {
      let progressCallbackCalledWithErrorCount = 0;
      let progressCallbackCalledWithDownloadingCount = 0;
      expect(dockerImageManagement).to.not.equal(null);
      //noinspection JSUnusedLocalSymbols,JSUnusedLocalSymbols
      dockerImageManagement.pullImage(
        'mysql:5.6',
        (taskId:string,status:string,current:number,total:number)=>{
          if(status === 'Downloading'){
            ++progressCallbackCalledWithDownloadingCount;
          }
          if(taskId === '**error**'){
            ++progressCallbackCalledWithErrorCount;
          }
        },
        (err: Error)=> {
          expect(err).to.equal(null);
          expect(progressCallbackCalledWithErrorCount).to.equal(4);
          expect(progressCallbackCalledWithDownloadingCount).to.equal(6);
          done();
        });
    });
  });
  describe('DockerImageManagement.buildDockerFile (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      let pathToDockerFile = path.resolve(__dirname, '../../test-data');
      //noinspection JSUnusedLocalSymbols,JSUnusedLocalSymbols,JSUnusedLocalSymbols,JSUnusedLocalSymbols
      dockerImageManagement.buildDockerFile(
        pathToDockerFile,
        'mysql:5.5',
        (taskId:string,status:string,current:number,total:number)=>{
        },
        (err: Error)=> {
          expect(err).to.not.equal(null);
          expect(err.message).to.equal('force error: buildImage');
          done();
        });
    });
  });
  describe('DockerImageManagement.buildDockerFile', function () {
    it('report that image was built from Dockerfile', function (done) {
      let pathToDockerFile = path.resolve(__dirname, '../../test-data');
      let progressCallbackCalledWithDownloadingCount = 0;
      expect(dockerImageManagement).to.not.equal(null);
      //noinspection JSUnusedLocalSymbols,JSUnusedLocalSymbols
      dockerImageManagement.buildDockerFile(
        pathToDockerFile,
        'mysql:5.5',
        (taskId:string,status:string,current:number,total:number)=>{
          if(status === 'Downloading'){
            ++progressCallbackCalledWithDownloadingCount;
          }
        },
        (err: Error)=> {
          expect(err).to.equal(null);
          expect(progressCallbackCalledWithDownloadingCount).to.equal(6);
          done();
        });
    });
  });
  describe('DockerImageManagement.removeImages (force error)', function () {
    it('should return non-null Error instance in callback', function (done) {
      (<ForceError>dockerImageManagement).forceError = true;
      expect(dockerImageManagement).to.not.equal(null);
      //noinspection JSUnusedLocalSymbols
      dockerImageManagement.removeImages(
        ['2','3', '113'],
        (err: Error, imageRemoveResult:ImageOrContainerRemoveResults[])=> {
          expect(err).to.not.equal(null);
          done();
        });
    });
  });
  describe('DockerImageManagement.removeImages (by firmamentId)', function () {
    it('should return non-null Error instance in callback', function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.removeImages(
        ['2','3','5','113'],
        (err: Error, imageRemoveResults:ImageOrContainerRemoveResults[])=> {
          expect(err).to.equal(null);
          expect(imageRemoveResults).to.be.instanceOf(Array);
          expect(imageRemoveResults).to.have.lengthOf(4);
          for(let i = 0;i < imageRemoveResults.length - 1;++i){
            expect(imageRemoveResults[i].msg.substring(0, 8)).to.equal('Removing');
          }
          expect(imageRemoveResults[imageRemoveResults.length - 1].msg.substring(0, 6)).to.equal('Unable');
          done();
        });
    });
  });
  describe('DockerImageManagement.removeImages (by Docker Id)', function () {
    it('should return non-null Error instance in callback', function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.removeImages(
        ['f55','817','248','xxx'],
        (err: Error, imageRemoveResults:ImageOrContainerRemoveResults[])=> {
          expect(err).to.equal(null);
          expect(imageRemoveResults).to.be.instanceOf(Array);
          expect(imageRemoveResults).to.have.lengthOf(4);
          for(let i = 0;i < imageRemoveResults.length - 1;++i){
            expect(imageRemoveResults[i].msg.substring(0, 8)).to.equal('Removing');
          }
          expect(imageRemoveResults[imageRemoveResults.length - 1].msg.substring(0, 6)).to.equal('Unable');
          done();
        });
    });
  });
  describe('DockerImageManagement.removeImages (all)', function () {
    it('should return non-null Error instance in callback', function (done) {
      expect(dockerImageManagement).to.not.equal(null);
      dockerImageManagement.removeImages(
        ['???','all','xxx'],
        (err: Error, imageRemoveResults:ImageOrContainerRemoveResults[])=> {
          expect(err).to.equal(null);
          expect(imageRemoveResults).to.be.instanceOf(Array);
          expect(imageRemoveResults).to.have.lengthOf(9);
          for(let i = 0;i < imageRemoveResults.length;++i){
            expect(imageRemoveResults[i].msg.substring(0, 8)).to.equal('Removing');
          }
          done();
        });
    });
  });
});