karma-docker-launcher
Version:
A Karma plugin. Launcher for headless browsers in Docker containers.
144 lines (143 loc) • 7.33 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var node_docker_api_1 = require("node-docker-api");
var container_service_1 = require("./services/container-service");
var image_service_1 = require("./services/image-service");
var KARMA_URL_CONST = '$KARMA_URL';
function injectUrlInCreateOptions(url, createOptions) {
return JSON.parse(JSON.stringify(createOptions).replace(KARMA_URL_CONST, url));
}
var DockerLauncher = /** @class */ (function () {
function DockerLauncher(id, logger, args) {
this.id = id;
this.logger = logger;
this.args = args;
this.name = 'DockerLauncher';
this.browserProcessFailure = null;
this.done = null;
this.captured = false;
this.container = null;
this.validateArgs();
this.log = logger.create(this.name);
this.docker = new node_docker_api_1.Docker(this.args.modemOptions);
this.imageService = new image_service_1.ImageService(this.log, this.docker);
this.containerService = new container_service_1.ContainerService(this.log, this.docker);
this.log.debug('DockerLauncher constructed');
}
DockerLauncher.prototype.start = function (url) {
return __awaiter(this, void 0, void 0, function () {
var createOptions, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
this.log.debug('Received: start');
createOptions = injectUrlInCreateOptions(url + "?id=" + this.id, this.args.createOptions);
return [4 /*yield*/, this.imageService.getImage(createOptions.Image)];
case 1:
_b.sent();
_a = this;
return [4 /*yield*/, this.containerService.startContainer(createOptions)];
case 2:
_a.container = _b.sent();
return [2 /*return*/];
}
});
});
};
DockerLauncher.prototype.forceKill = function () {
return __awaiter(this, void 0, void 0, function () {
var container;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
this.log.debug('Received: force kill');
container = this.container;
this.container = null;
return [4 /*yield*/, this.containerService.stopContainer(container)];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
DockerLauncher.prototype.on = function (callbackType, callbackFunction) {
switch (callbackType) {
case 'browser_process_failure':
this.browserProcessFailure = callbackFunction;
break;
case 'done':
this.done = callbackFunction;
break;
default:
this.log.warn("Unknown callback function registered: " + callbackType);
return;
}
this.log.debug("Registered callback function for '" + callbackType + "'");
};
DockerLauncher.prototype.markCaptured = function () {
var _a, _b;
var imageId = ((_b = (_a = this.container) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.Config.Image) || 'unknown image';
this.log.info("The browser of '" + imageId + "' in is successfully captured");
this.captured = true;
};
DockerLauncher.prototype.isCaptured = function () {
this.log.debug("Captured: " + this.captured);
return this.captured;
};
DockerLauncher.prototype.validateArgs = function () {
if (this.args.modemOptions === undefined) {
this.args.modemOptions = {};
}
if (this.args.createOptions === undefined) {
throw Error("Argument 'createOptions' is missing.\n" +
"You cannot run 'Docker' as browser without extra arguments in customLaunchers in karma.conf." +
"Please refer to README.md for instructions and examples. \n" +
"Check the documentation of the Docker Engine Api for '/containers/create' to " +
"see the available create options.");
}
if (this.args.createOptions.Image === undefined) {
throw Error("Argument 'createOptions.Image' is missing. " +
"Check the documentation of the Docker Engine Api for '/containers/create' to " +
"see the available create options.");
}
};
return DockerLauncher;
}());
exports.DockerLauncher = DockerLauncher;