@touca/node
Version:
Touca SDK for JavaScript
677 lines • 28.8 kB
JavaScript
// Copyright 2023 Touca, Inc. Subject to Apache-2.0 License.
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
}
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
if (ar || !(i in from)) {
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
ar[i] = from[i];
}
}
return to.concat(ar || Array.prototype.slice.call(from));
};
var __values = (this && this.__values) || function(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
};
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import util from 'node:util';
import ini from 'ini';
import yargs from 'yargs';
import { hideBin } from 'yargs/helpers';
import { Transport } from './transport.js';
import { VERSION } from './version.js';
var ToucaError = /** @class */ (function (_super) {
__extends(ToucaError, _super);
function ToucaError(code) {
var args = [];
for (var _i = 1; _i < arguments.length; _i++) {
args[_i - 1] = arguments[_i];
}
return _super.call(this, util.format.apply(util, __spreadArray([ToucaError.codes[code]], __read(args), false))) || this;
}
ToucaError.codes = {
auth_invalid_key: 'Authentication failed: API Key Invalid.',
auth_invalid_response: 'Authentication failed: Invalid Response.',
auth_server_down: 'Touca server appears to be down',
config_file_missing: 'Configuration file "%s" does not exist',
config_file_invalid: 'Configuration file "%s" has an unexpected format.',
config_option_invalid: 'Configuration option "%s" has unexpected type.',
config_option_missing: 'Configuration option "%s" is missing.',
config_option_fetch: 'Failed to fetch options from the remote server.',
capture_not_configured: 'Client not configured to perform this operation.',
capture_forget: 'Test case "%s" was never declared.',
capture_type_mismatch: 'Specified key "%s" has a different type.',
transport_http: 'HTTP request failed: %s',
transport_post: 'Failed to submit test results.%s',
transport_seal: 'Failed to seal this version.'
};
return ToucaError;
}(Error));
export { ToucaError };
export function assignOptions(target, source) {
var _a;
var targetKeys = (_a = {
api_key: 'api_key',
api_url: 'api_url',
team: 'team',
suite: 'suite',
version: 'version',
offline: 'offline',
save_binary: 'save_binary',
save_json: 'save_json',
output_directory: 'output_directory',
overwrite_results: 'overwrite_results',
testcases: 'testcases',
workflow_filter: 'workflow_filter',
colored_output: 'colored_output',
config_file: 'config_file',
submit_async: 'submit_async'
},
_a['api-key'] = 'api_key',
_a['api-url'] = 'api_url',
_a['revision'] = 'version',
_a['save-as-binary'] = 'save_binary',
_a['save-as-json'] = 'save_json',
_a['output-directory'] = 'output_directory',
_a['overwrite'] = 'overwrite_results',
_a['filter'] = 'workflow_filter',
_a['colored-output'] = 'colored_output',
_a['config-file'] = 'config_file',
_a);
Object.entries(source)
.filter(function (_a) {
var _b = __read(_a, 2), k = _b[0], v = _b[1];
return v !== undefined && k in targetKeys;
})
.forEach(function (_a) {
var _b = __read(_a, 2), k = _b[0], v = _b[1];
return (target[targetKeys[k]] = v);
});
}
export function findHomeDirectory() {
var cwd = path.join(process.cwd(), '.touca');
return fs.existsSync(cwd) ? cwd : path.join(os.homedir(), '.touca');
}
function throwIfMissing(options, keys) {
var e_1, _a;
try {
for (var keys_1 = __values(keys), keys_1_1 = keys_1.next(); !keys_1_1.done; keys_1_1 = keys_1.next()) {
var key = keys_1_1.value;
if (options[key] === undefined) {
throw new ToucaError('config_option_missing', key);
}
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (keys_1_1 && !keys_1_1.done && (_a = keys_1.return)) _a.call(keys_1);
}
finally { if (e_1) throw e_1.error; }
}
}
function validateOptionsType(options, type, keys) {
var e_2, _a;
try {
for (var keys_2 = __values(keys), keys_2_1 = keys_2.next(); !keys_2_1.done; keys_2_1 = keys_2.next()) {
var key = keys_2_1.value;
if (key in options && typeof options[key] !== type) {
throw new ToucaError('config_option_invalid', key);
}
}
}
catch (e_2_1) { e_2 = { error: e_2_1 }; }
finally {
try {
if (keys_2_1 && !keys_2_1.done && (_a = keys_2.return)) _a.call(keys_2);
}
finally { if (e_2) throw e_2.error; }
}
}
function applyCliArguments(options) {
return __awaiter(this, void 0, void 0, function () {
var y, argv, initial;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
y = yargs(hideBin(process.argv));
return [4 /*yield*/, y
.help('help')
.version(VERSION)
.showHelpOnFail(false, 'Specify --help for available options')
.epilog('See https://touca.io/docs for more information.')
.wrap(y.terminalWidth())
.options({
'api-key': {
type: 'string',
desc: 'API Key issued by the Touca Server',
group: 'Common Options'
},
'api-url': {
type: 'string',
desc: 'API URL issued by the Touca Server',
group: 'Common Options'
},
team: {
type: 'string',
desc: 'Slug of team to which test results belong',
group: 'Common Options'
},
suite: {
type: 'string',
desc: 'Slug of suite to which test results belong',
group: 'Common Options'
},
revision: {
type: 'string',
desc: 'Version of the code under test',
group: 'Common Options'
},
offline: {
type: 'boolean',
desc: 'Disables all communications with the Touca server',
boolean: true,
default: false,
group: 'Common Options'
},
'save-as-binary': {
type: 'boolean',
desc: 'Save a copy of test results on local filesystem in binary format',
boolean: true,
default: false,
group: 'Runner Options'
},
'save-as-json': {
type: 'boolean',
desc: 'Save a copy of test results on local filesystem in JSON format',
boolean: true,
default: false,
group: 'Runner Options'
},
'output-directory': {
type: 'string',
desc: 'Path to a local directory to store result files',
group: 'Runner Options'
},
overwrite: {
type: 'boolean',
desc: 'Overwrite result directory for testcase if it already exists',
group: 'Runner Options',
boolean: true,
default: false
},
testcases: {
type: 'array',
desc: 'One or more testcases to feed to the workflow',
group: 'Runner Options'
},
filter: {
type: 'string',
desc: 'Name of the workflow to run',
group: 'Runner Options'
},
'log-level': {
type: 'string',
desc: 'Level of detail with which events are logged',
choices: ['debug', 'info', 'warn'],
default: 'info',
hidden: true,
group: 'Runner Options'
},
'colored-output': {
type: 'boolean',
desc: 'Use color in standard output',
boolean: true,
default: true,
group: 'Runner Options'
},
'config-file': {
type: 'string',
desc: 'Path to a configuration file',
group: 'Other Options'
}
}).argv];
case 1:
argv = _a.sent();
initial = {};
assignOptions(initial, argv);
assignOptions(options, __assign(__assign({}, initial), options));
return [2 /*return*/];
}
});
});
}
function applyConfigFile(options) {
var _a;
var file = options.config_file;
if (!file) {
return;
}
if (!((_a = fs.statSync(file, { throwIfNoEntry: false })) === null || _a === void 0 ? void 0 : _a.isFile())) {
throw new ToucaError('config_file_missing', file);
}
var content = fs.readFileSync(file, 'utf-8');
var parsed = JSON.parse(content)['touca'];
if (!parsed) {
throw new ToucaError('config_file_invalid', file);
}
assignOptions(options, parsed);
}
function applyConfigProfile(options) {
var _a, _b;
var name = 'default';
var home = findHomeDirectory();
var settings = path.join(home, 'settings');
if (fs.existsSync(settings)) {
var config = ini.parse(fs.readFileSync(settings, 'utf-8'));
name = (_b = (_a = config.settings) === null || _a === void 0 ? void 0 : _a.profile) !== null && _b !== void 0 ? _b : name;
}
var profile = path.join(home, 'profiles', name);
if (fs.existsSync(profile)) {
var config = ini.parse(fs.readFileSync(profile, 'utf-8'));
assignOptions(options, config.settings);
}
}
function applyEnvironmentVariables(options) {
assignOptions(options, {
api_key: process.env['TOUCA_API_KEY'],
api_url: process.env['TOUCA_API_URL'],
version: process.env['TOUCA_TEST_VERSION']
});
}
function applyApiUrl(options) {
if (!options.api_url) {
return;
}
var api_url = options.api_url;
var has_protocol = ['http', 'https'].some(function (v) { return api_url.startsWith(v); });
var url = new URL(has_protocol ? api_url : 'https://' + api_url);
var pathname = url.pathname
.split('/@/')
.map(function (v) { return v.split('/').filter(function (v) { return v.length !== 0; }); });
url.pathname = pathname[0].join('/');
options.api_url = url.toString();
if (pathname.length > 1) {
var slugs = pathname[1];
var keys_3 = ['team', 'suite', 'version'];
slugs.forEach(function (slug, i) { return (options[keys_3[i]] = slug); });
}
}
function applyCoreOptions(options) {
if (!options.concurrency) {
options.concurrency = true;
}
if (!options.offline) {
options.offline = !options.api_key && !options.api_url;
}
if (options.api_key && !options.api_url) {
options.api_url = 'https://api.touca.io';
}
}
function authenticate(options, transport) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!(!options.offline && options.api_key && options.api_url)) return [3 /*break*/, 2];
return [4 /*yield*/, transport.configure(options.api_url, options.api_key)];
case 1:
_a.sent();
_a.label = 2;
case 2: return [2 /*return*/];
}
});
});
}
function applyServerOptions(options, transport) {
return __awaiter(this, void 0, void 0, function () {
var response, body;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (options.offline || !options.api_url) {
return [2 /*return*/];
}
return [4 /*yield*/, transport.request('GET', '/platform')];
case 1:
response = _a.sent();
if (response.status != 200) {
throw new ToucaError('auth_server_down');
}
body = JSON.parse(response.body);
if (!body.ready) {
throw new ToucaError('auth_server_down');
}
if (typeof body.webapp === 'string') {
options.webUrl = body.webapp;
}
return [2 /*return*/];
}
});
});
}
function applyRunnerOptions(options) {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
var _c, _d, v, _e, e_3_1;
var e_3, _f;
return __generator(this, function (_g) {
switch (_g.label) {
case 0:
options.submit_async = (_a = options.submit_async) !== null && _a !== void 0 ? _a : false;
if (!options.output_directory) {
options.output_directory = path.join(findHomeDirectory(), 'results');
}
if (!options.workflows) {
options.workflows = [];
}
if (options.workflow_filter) {
options.workflows = options.workflows.filter(function (v) { return v.suite === options.workflow_filter; });
delete options.workflow_filter;
}
_g.label = 1;
case 1:
_g.trys.push([1, 8, 9, 10]);
_c = __values(options.workflows), _d = _c.next();
_g.label = 2;
case 2:
if (!!_d.done) return [3 /*break*/, 7];
v = _d.value;
if (!((_b = options.testcases) === null || _b === void 0 ? void 0 : _b.length)) return [3 /*break*/, 3];
v.testcases = options.testcases;
return [3 /*break*/, 5];
case 3:
if (!(v.testcases && !Array.isArray(v.testcases))) return [3 /*break*/, 5];
_e = v;
return [4 /*yield*/, v.testcases()];
case 4:
_e.testcases = _g.sent();
_g.label = 5;
case 5:
if (options.suite) {
v.suite = options.suite;
}
if (options.version) {
v.version = options.version;
}
_g.label = 6;
case 6:
_d = _c.next();
return [3 /*break*/, 2];
case 7: return [3 /*break*/, 10];
case 8:
e_3_1 = _g.sent();
e_3 = { error: e_3_1 };
return [3 /*break*/, 10];
case 9:
try {
if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
}
finally { if (e_3) throw e_3.error; }
return [7 /*endfinally*/];
case 10:
delete options.suite;
delete options.version;
delete options.testcases;
return [2 /*return*/];
}
});
});
}
function fetchRemoteOptions(input, transport) {
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, transport.request('POST', '/client/options', JSON.stringify(input))];
case 1:
response = _a.sent();
if (response.status === 401) {
throw new ToucaError('auth_invalid_key');
}
if (response.status !== 200) {
throw new ToucaError('config_option_fetch');
}
return [2 /*return*/, JSON.parse(response.body)];
}
});
});
}
function applyRemoteOptions(options, transport) {
return __awaiter(this, void 0, void 0, function () {
var res, _loop_1, res_1, res_1_1, v;
var e_4, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (options.offline ||
!options.api_key ||
!options.api_url ||
!options.workflows) {
return [2 /*return*/];
}
return [4 /*yield*/, fetchRemoteOptions(options.workflows.map(function (v) {
var _a;
return ({
team: options.team,
suite: v.suite,
version: v.version,
testcases: ((_a = v.testcases) === null || _a === void 0 ? void 0 : _a.length) ? undefined : []
});
}), transport)];
case 1:
res = _b.sent();
_loop_1 = function (v) {
var w = options.workflows.find(function (w) { return w.suite === v.suite; });
if (w && v.version) {
w.version = v.version;
}
if (w && v.testcases) {
w.testcases = v === null || v === void 0 ? void 0 : v.testcases;
}
};
try {
for (res_1 = __values(res), res_1_1 = res_1.next(); !res_1_1.done; res_1_1 = res_1.next()) {
v = res_1_1.value;
_loop_1(v);
}
}
catch (e_4_1) { e_4 = { error: e_4_1 }; }
finally {
try {
if (res_1_1 && !res_1_1.done && (_a = res_1.return)) _a.call(res_1);
}
finally { if (e_4) throw e_4.error; }
}
return [2 /*return*/];
}
});
});
}
function validateCoreOptions(options) {
validateOptionsType(options, 'boolean', ['concurrency', 'offline']);
validateOptionsType(options, 'string', [
'api_key',
'api_url',
'suite',
'team',
'version'
]);
var slugs = [options.team, options.suite, options.version];
if (slugs.some(Boolean)) {
throwIfMissing(options, ['team', 'suite', 'version']);
}
if (!options.offline) {
throwIfMissing(options, ['api_key', 'api_url']);
}
return slugs.some(Boolean) && !slugs.every(Boolean)
? false
: options.offline
? true
: [options.api_key, options.api_url].every(Boolean);
}
function validateRunnerOptions(options) {
var _a, _b;
validateOptionsType(options, 'boolean', [
'colored_output',
'concurrency',
'offline',
'overwrite_results',
'save_binary',
'save_json'
]);
validateOptionsType(options, 'string', [
'api_key',
'api_url',
'config_file',
'output_directory',
'suite',
'team',
'version',
'workflow_filter'
]);
if (!options.offline) {
throwIfMissing(options, ['api_key', 'api_url']);
}
if (!((_a = options.workflows) === null || _a === void 0 ? void 0 : _a.every(function (v) { return v.version; }))) {
throw new ToucaError('config_option_missing', 'version');
}
if (!((_b = options.workflows) === null || _b === void 0 ? void 0 : _b.every(function (v) { var _a; return (_a = v.testcases) === null || _a === void 0 ? void 0 : _a.length; }))) {
throw new ToucaError('config_option_missing', 'testcases');
}
}
export function updateCoreOptions(options, transport) {
if (transport === void 0) { transport = new Transport(); }
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
applyEnvironmentVariables(options);
applyApiUrl(options);
applyCoreOptions(options);
return [4 /*yield*/, authenticate(options, transport)];
case 1:
_a.sent();
return [2 /*return*/, validateCoreOptions(options)];
}
});
});
}
export function updateRunnerOptions(options, transport) {
if (transport === void 0) { transport = new Transport(); }
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, applyCliArguments(options)];
case 1:
_a.sent();
applyConfigFile(options);
applyConfigProfile(options);
applyEnvironmentVariables(options);
applyApiUrl(options);
applyCoreOptions(options);
return [4 /*yield*/, authenticate(options, transport)];
case 2:
_a.sent();
return [4 /*yield*/, applyServerOptions(options, transport)];
case 3:
_a.sent();
return [4 /*yield*/, applyRunnerOptions(options)];
case 4:
_a.sent();
return [4 /*yield*/, applyRemoteOptions(options, transport)];
case 5:
_a.sent();
validateRunnerOptions(options);
return [2 /*return*/];
}
});
});
}
//# sourceMappingURL=options.js.map