refactoring to promises

This commit is contained in:
alecmerdler 2017-03-08 11:43:53 -08:00
parent 390e389027
commit 85441c8459
9 changed files with 191 additions and 28 deletions

View file

@ -24,6 +24,9 @@ module.exports = function(config) {
'node_modules/raven-js/dist/raven.js', 'node_modules/raven-js/dist/raven.js',
'node_modules/cal-heatmap/cal-heatmap.js', 'node_modules/cal-heatmap/cal-heatmap.js',
// Polyfills
'node_modules/core-js/index.js',
// static/lib resources // static/lib resources
'static/lib/**/*.js', 'static/lib/**/*.js',
@ -37,6 +40,7 @@ module.exports = function(config) {
preprocessors: { preprocessors: {
'static/lib/ngReact/react.ngReact.min.js': ['webpack'], 'static/lib/ngReact/react.ngReact.min.js': ['webpack'],
'static/lib/angular-moment.min.js': ['webpack'], 'static/lib/angular-moment.min.js': ['webpack'],
'node_modules/core-js/index.js': ['webpack'],
'static/js/**/*.spec.ts*': ['webpack'], 'static/js/**/*.spec.ts*': ['webpack'],
}, },
webpack: webpackConfig, webpack: webpackConfig,

View file

@ -24,6 +24,7 @@
"bootstrap": "^3.3.2", "bootstrap": "^3.3.2",
"bootstrap-datepicker": "^1.6.4", "bootstrap-datepicker": "^1.6.4",
"cal-heatmap": "^3.3.10", "cal-heatmap": "^3.3.10",
"core-js": "^2.4.1",
"d3": "^3.3.3", "d3": "^3.3.3",
"eonasdan-bootstrap-datetimepicker": "^4.17.43", "eonasdan-bootstrap-datetimepicker": "^4.17.43",
"jquery": "1.12.4", "jquery": "1.12.4",

View file

@ -39,25 +39,48 @@ angular.module('quay').directive('dockerfileBuildForm', function () {
$scope.state = 'checking'; $scope.state = 'checking';
$scope.selectedFiles = files; $scope.selectedFiles = files;
DockerfileService.getDockerfile(files[0], function(df) { // FIXME: Remove this
var baseImage = df.getRegistryBaseImage(); // DockerfileService.getDockerfile(files[0], function(df) {
if (baseImage) { // var baseImage = df.getRegistryBaseImage();
checkPrivateImage(baseImage); // if (baseImage) {
} else { // checkPrivateImage(baseImage);
$scope.state = 'ready'; // } else {
} // $scope.state = 'ready';
// }
//
// $scope.$apply(function() {
// opt_callback && opt_callback(true, 'Dockerfile found and valid')
// });
// }, function(msg) {
// $scope.state = 'empty';
// $scope.privateBaseRepository = null;
//
// $scope.$apply(function() {
// opt_callback && opt_callback(false, msg || 'Could not find valid Dockerfile');
// });
// });
$scope.$apply(function() { DockerfileService.extractDockerfile(files[0])
opt_callback && opt_callback(true, 'Dockerfile found and valid') .then(function(dockerfileInfo) {
}); var baseImage = dockerfileInfo.getRegistryBaseImage();
}, function(msg) { if (baseImage) {
$scope.state = 'empty'; checkPrivateImage(baseImage);
$scope.privateBaseRepository = null; } else {
$scope.state = 'ready';
}
$scope.$apply(function() { $scope.$apply(function() {
opt_callback && opt_callback(false, msg || 'Could not find valid Dockerfile'); opt_callback && opt_callback(true, 'Dockerfile found and valid')
});
})
.catch(function(error) {
$scope.state = 'empty';
$scope.privateBaseRepository = null;
$scope.$apply(function() {
opt_callback && opt_callback(false, error || 'Could not find valid Dockerfile');
});
}); });
});
}; };
$scope.handleFilesCleared = function() { $scope.handleFilesCleared = function() {

View file

@ -1,4 +1,5 @@
import * as angular from "angular"; import * as angular from "angular";
import 'core-js';
import { ViewArrayImpl } from "./services/view-array/view-array.impl"; import { ViewArrayImpl } from "./services/view-array/view-array.impl";
import { NAME_PATTERNS } from "./constants/name-patterns.constant"; import { NAME_PATTERNS } from "./constants/name-patterns.constant";
import { INJECTED_CONFIG, INJECTED_FEATURES, INJECTED_ENDPOINTS } from "./constants/injected-values.constant"; import { INJECTED_CONFIG, INJECTED_FEATURES, INJECTED_ENDPOINTS } from "./constants/injected-values.constant";

View file

@ -170,7 +170,77 @@ describe("DockerfileServiceImpl", () => {
}); });
describe("extractDockerfile", () => { describe("extractDockerfile", () => {
// TODO: TDD promise-based method with same functionality as getDockerfile var file: any;
var invalidArchiveFile: any[];
var validArchiveFile: any[];
var readAsFileBufferSpy: Spy;
var forDataSpy: Spy;
beforeEach(() => {
dataFileServiceMock.readDataArrayAsPossibleArchive.and.callFake((buf, success, failure) => {
failure([]);
});
dataFileServiceMock.arrayToString.and.callFake((buf, callback) => {
var contents: string = "";
callback(contents);
});
dataFileServiceMock.blobToString.and.callFake((blob, callback) => {
callback(blob.toString());
});
forDataSpy = spyOn(DockerfileInfoImpl, "forData").and.returnValue(new DockerfileInfoImpl(file, configMock));
readAsFileBufferSpy = spyOn(fileReaderMock, "readAsArrayBuffer").and.callFake(() => {
var event: any = {target: {result: file}};
fileReaderMock.onload(event);
});
file = "FROM quay.io/coreos/nginx:latest";
validArchiveFile = [{name: 'Dockerfile', toBlob: jasmine.createSpy('toBlobSpy').and.returnValue(file)}];
invalidArchiveFile = [{name: 'main.exe', toBlob: jasmine.createSpy('toBlobSpy').and.returnValue("")}];
});
it("calls datafile service to read given file as possible archive file", (done) => {
dockerfileServiceImpl.extractDockerfile(file)
.then((dockerfile: DockerfileInfoImpl) => {
expect(readAsFileBufferSpy.calls.argsFor(0)[0]).toEqual(file);
expect(dataFileServiceMock.readDataArrayAsPossibleArchive).toHaveBeenCalled();
done();
})
.catch((error: string) => {
fail('Promise should be resolved');
done();
});
});
it("calls datafile service to convert file to string if given file is not an archive", (done) => {
done();
});
it("returns rejected promise if given non-archive file that is not a valid Dockerfile", (done) => {
done();
});
it("returns resolved promise with new DockerfileInfoImpl instance if given valid Dockerfile", (done) => {
done();
});
it("returns rejected promise if given archive file with no Dockerfile present in root directory", (done) => {
done();
});
it("calls datafile service to convert blob to string if given file is an archive", (done) => {
done();
});
it("returns rejected promise if given archive file with invalid Dockerfile", (done) => {
done();
});
it("returns resolved promise of new DockerfileInfoImpl instance if given archive with valid Dockerfile", (done) => {
done();
});
}); });
}); });
@ -201,9 +271,13 @@ describe("DockerfileInfoImpl", () => {
describe("getRegistryBaseImage", () => { describe("getRegistryBaseImage", () => {
var domain: string; var domain: string;
var baseImage: string;
beforeEach(() => { beforeEach(() => {
domain = "quay.io"; domain = "quay.io";
baseImage = "coreos/nginx";
configMock.getDomain.and.returnValue(domain);
}); });
it("returns null if instance's contents do not contain a 'FROM' command", () => { it("returns null if instance's contents do not contain a 'FROM' command", () => {
@ -222,7 +296,9 @@ describe("DockerfileInfoImpl", () => {
}); });
it("returns the registry base image", () => { it("returns the registry base image", () => {
spyOn(dockerfileInfoImpl, "getBaseImage").and.returnValue(null); spyOn(dockerfileInfoImpl, "getBaseImage").and.returnValue(`${domain}/${baseImage}`);
expect(dockerfileInfoImpl.getRegistryBaseImage()).toEqual(baseImage);
}); });
}); });

View file

@ -11,7 +11,20 @@ export class DockerfileServiceImpl implements DockerfileService {
public extractDockerfile(file: any): Promise<DockerfileInfoImpl | string> { public extractDockerfile(file: any): Promise<DockerfileInfoImpl | string> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
// TODO: Replace callbacks with promises var reader: FileReader = this.FileReaderFactory();
reader.onload = (event: any) => {
this.DataFileService.readDataArrayAsPossibleArchive(event.target.result,
(files: any[]) => {
this.processFiles1(files);
},
() => {
// Not an archive. Read directly as a single file.
this.processFile1(event.target.result);
});
};
reader.onerror = (event: any) => reject(event);
reader.readAsArrayBuffer(file);
}); });
} }
@ -48,6 +61,20 @@ export class DockerfileServiceImpl implements DockerfileService {
}); });
} }
private processFile1(dataArray: any): Promise<DockerfileInfoImpl | string> {
return new Promise((resolve, reject) => {
this.DataFileService.arrayToString(dataArray, (contents: string) => {
var result: DockerfileInfoImpl | null = DockerfileInfoImpl.forData(contents, this.Config);
if (result == null) {
reject('File chosen is not a valid Dockerfile');
}
else {
resolve(result);
}
});
});
}
private processFiles(files: any[], private processFiles(files: any[],
success: (dockerfile: DockerfileInfoImpl) => void, success: (dockerfile: DockerfileInfoImpl) => void,
failure: (error: ErrorEvent | string) => void): void { failure: (error: ErrorEvent | string) => void): void {
@ -71,6 +98,30 @@ export class DockerfileServiceImpl implements DockerfileService {
failure('No Dockerfile found in root of archive'); failure('No Dockerfile found in root of archive');
} }
} }
private processFiles1(files: any[]): Promise<DockerfileInfoImpl | string> {
return new Promise((resolve, reject) => {
var found: boolean = false;
files.forEach((file) => {
if (file['name'] == 'Dockerfile') {
this.DataFileService.blobToString(file.toBlob(), (contents: string) => {
var result: DockerfileInfoImpl | null = DockerfileInfoImpl.forData(contents, this.Config);
if (result == null) {
reject('Dockerfile inside archive is not a valid Dockerfile');
}
else {
resolve(result);
}
});
found = true;
}
});
if (!found) {
reject('No Dockerfile found in root of archive');
}
});
}
} }

View file

@ -5,8 +5,8 @@
export abstract class DockerfileService { export abstract class DockerfileService {
/** /**
* Retrieve Dockerfile from given archive file. * Retrieve Dockerfile from given file.
* @param file File containing Dockerfile. * @param file Dockerfile or archive file containing Dockerfile.
* @param success Success callback with retrieved Dockerfile as parameter. * @param success Success callback with retrieved Dockerfile as parameter.
* @param failure Failure callback with failure message as parameter. * @param failure Failure callback with failure message as parameter.
*/ */
@ -14,6 +14,11 @@ export abstract class DockerfileService {
success: (dockerfile: DockerfileInfo) => void, success: (dockerfile: DockerfileInfo) => void,
failure: (error: ErrorEvent | string) => void): void; failure: (error: ErrorEvent | string) => void): void;
/**
* Retrieve Dockerfile from given file.
* @param file Dockerfile or archive file containing Dockerfile.
* @return promise Promise resolving to new DockerfileInfo instance or rejecting to error message.
*/
public abstract extractDockerfile(file: any): Promise<DockerfileInfo | string>; public abstract extractDockerfile(file: any): Promise<DockerfileInfo | string>;
} }

View file

@ -21,7 +21,9 @@ var config = {
rules: [ rules: [
{ {
test: /\.tsx?$/, test: /\.tsx?$/,
loader: "ts-loader", use: [
"ts-loader",
],
exclude: /node_modules/ exclude: /node_modules/
}, },
{ {

View file

@ -796,7 +796,7 @@ core-js@^1.0.0:
version "1.2.7" version "1.2.7"
resolved "https://registry.yarnpkg.com/core-js/-/core-js-1.2.7.tgz#652294c14651db28fa93bd2d5ff2983a4f08c636" resolved "https://registry.yarnpkg.com/core-js/-/core-js-1.2.7.tgz#652294c14651db28fa93bd2d5ff2983a4f08c636"
core-js@^2.1.0: core-js@^2.1.0, core-js@^2.4.1:
version "2.4.1" version "2.4.1"
resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.4.1.tgz#4de911e667b0eae9124e34254b53aea6fc618d3e" resolved "https://registry.yarnpkg.com/core-js/-/core-js-2.4.1.tgz#4de911e667b0eae9124e34254b53aea6fc618d3e"
@ -3514,14 +3514,14 @@ semver-diff@^2.0.0:
dependencies: dependencies:
semver "^5.0.3" semver "^5.0.3"
"semver@2 || 3 || 4 || 5", "semver@2.x || 3.x || 4 || 5", semver@~4.3.3: "semver@2 || 3 || 4 || 5", "semver@2.x || 3.x || 4 || 5", semver@^5.0.1, semver@^5.0.3, semver@^5.1.0, semver@~5.3.0:
version "4.3.6"
resolved "https://registry.yarnpkg.com/semver/-/semver-4.3.6.tgz#300bc6e0e86374f7ba61068b5b1ecd57fc6532da"
semver@^5.0.1, semver@^5.0.3, semver@^5.1.0, semver@~5.3.0:
version "5.3.0" version "5.3.0"
resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f" resolved "https://registry.yarnpkg.com/semver/-/semver-5.3.0.tgz#9b2ce5d3de02d17c6012ad326aa6b4d0cf54f94f"
semver@~4.3.3:
version "4.3.6"
resolved "https://registry.yarnpkg.com/semver/-/semver-4.3.6.tgz#300bc6e0e86374f7ba61068b5b1ecd57fc6532da"
semver@~5.0.1: semver@~5.0.1:
version "5.0.3" version "5.0.3"
resolved "https://registry.yarnpkg.com/semver/-/semver-5.0.3.tgz#77466de589cd5d3c95f138aa78bc569a3cb5d27a" resolved "https://registry.yarnpkg.com/semver/-/semver-5.0.3.tgz#77466de589cd5d3c95f138aa78bc569a3cb5d27a"