splunk-sdk/tests/service_tests/datamodels.js

SDK for usage with the Splunk REST API

var assert = require('chai').assert;

var splunkjs = require('../../index');
var tutils = require('../utils');
var utils = splunkjs.Utils;

var idCounter = 0;
var getNextId = function () {
    return "id" + (idCounter++) + "_" + ((new Date()).valueOf());
};

exports.setup = function (svc) {
    return (
        describe("Datamodels test", () => {
            beforeEach(async function () {
                this.service = svc;
                this.dataModels = svc.dataModels();
                this.skip = false;
                var that = this;
                let info = await this.service.serverInfo();
                if (parseInt(info.properties().version.split(".")[0], 10) < 6) {
                    that.skip = true;
                    splunkjs.Logger.log("Skipping data model tests...");
                }
            });

            it("DataModels - fetch a built-in data model", async function () {
                if (this.skip) {
                    return;
                }
                var that = this;
                let dataModels = await that.dataModels.fetch();
                let dm = dataModels.item("internal_audit_logs");
                // Check for the 3 objects we expect
                assert.ok(dm.objectByName("Audit"));
                assert.ok(dm.objectByName("searches"));
                assert.ok(dm.objectByName("modify"));

                // Check for an object that shouldn't exist
                assert.strictEqual(null, dm.objectByName(getNextId()));
            });

            it("DataModels - create & delete an empty data model", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/empty_data_model.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModels = await that.dataModels.fetch();
                let initialSize = dataModels.list().length;
                let dataModel = await dataModels.create(name, args);
                let updatedDataModels = await that.dataModels.fetch();
                // Make sure we have 1 more data model than we started with
                assert.strictEqual(initialSize + 1, updatedDataModels.list().length);
                // Delete the data model we just created, by name.
                await updatedDataModels.item(name).remove();
                let newDataModels = await that.dataModels.fetch();
                assert.strictEqual(initialSize, newDataModels.list().length);
            });

            it("DataModels - create a data model with spaces in the name, which are swapped for -'s", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/empty_data_model.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me- " + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                assert.strictEqual(name.replace(" ", "_"), dataModel.name);
            });

            it("DataModels - create a data model with 0 objects", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/empty_data_model.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();
                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                // Check for 0 objects before fetch
                assert.strictEqual(0, dataModel.objects.length);
                let dataModels = await that.dataModels.fetch();
                assert.strictEqual(0, dataModels.item(name).objects.length);
            });

            it("DataModels - create a data model with 1 search object", async function () {
                if (this.skip) {
                    return;
                }
                let dataModels = this.service.dataModels();

                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/object_with_one_search.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                // Check for 1 object before fetch
                assert.strictEqual(1, dataModel.objects.length);
                dataModels = await that.dataModels.fetch();
                // Check for 1 object after fetch
                assert.strictEqual(1, dataModels.item(name).objects.length);
            });

            it("DataModels - create a data model with 2 search objects", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/object_with_two_searches.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                // Check for 2 objects before fetch
                assert.strictEqual(2, dataModel.objects.length);
                dataModels = await that.dataModels.fetch();
                // Check for 2 objects after fetch
                assert.strictEqual(2, dataModels.item(name).objects.length);
            });

            it("DataModels - data model objects are created correctly", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/object_with_two_searches.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                assert.ok(dataModel.hasObject("search1"));
                assert.ok(dataModel.hasObject("search2"));

                let search1 = dataModel.objectByName("search1");
                assert.ok(search1);
                assert.strictEqual("௵௱௰௯ - search 1", search1.displayName);

                let search2 = dataModel.objectByName("search2");
                assert.ok(search2);
                assert.strictEqual("௵௱௰௯ - search 2", search2.displayName);
            });

            it("DataModels - data model handles unicode characters", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/model_with_unicode_headers.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                assert.strictEqual(name, dataModel.name);
                assert.strictEqual("ဩᚙ௵", dataModel.displayName);
                assert.strictEqual("௵௱௰௯", dataModel.description);
            });

            it("DataModels - create data model with empty headers", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/model_with_empty_headers.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                assert.strictEqual(name, dataModel.name);
                assert.strictEqual("", dataModel.displayName);
                assert.strictEqual("", dataModel.description);

                // Make sure we're not getting a summary of the data model
                assert.strictEqual("0", dataModel.concise);
            });

            it("DataModels - test acceleration settings", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_with_test_objects.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                dataModel.acceleration.enabled = true;
                dataModel.acceleration.earliestTime = "-2mon";
                dataModel.acceleration.cronSchedule = "5/* * * * *";

                assert.strictEqual(true, dataModel.isAccelerated());
                assert.strictEqual(true, dataModel.acceleration.enabled);
                assert.strictEqual("-2mon", dataModel.acceleration.earliestTime);
                assert.strictEqual("5/* * * * *", dataModel.acceleration.cronSchedule);

                dataModel.acceleration.enabled = false;
                dataModel.acceleration.earliestTime = "-1mon";
                dataModel.acceleration.cronSchedule = "* * * * *";

                assert.strictEqual(false, dataModel.isAccelerated());
                assert.strictEqual(false, dataModel.acceleration.enabled);
                assert.strictEqual("-1mon", dataModel.acceleration.earliestTime);
                assert.strictEqual("* * * * *", dataModel.acceleration.cronSchedule);
            });

            it("DataModels - test data model object metadata", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_with_test_objects.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("event1");
                assert.ok(obj);

                assert.strictEqual("event1 ·Ä©·öô", obj.displayName);
                assert.strictEqual("event1", obj.name);
                assert.deepEqual(dataModel, obj.dataModel);
            });

            it("DataModels - test data model object parent", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_with_test_objects.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("event1");
                assert.ok(obj);
                assert.ok(!obj.parent());
            });

            it("DataModels - test data model object lineage", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/inheritance_test_data.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("level_0");
                assert.ok(obj);
                assert.strictEqual(1, obj.lineage.length);
                assert.strictEqual("level_0", obj.lineage[0]);
                assert.strictEqual("BaseEvent", obj.parentName);

                obj = dataModel.objectByName("level_1");
                assert.ok(obj);
                assert.strictEqual(2, obj.lineage.length);
                assert.deepEqual(["level_0", "level_1"], obj.lineage);
                assert.strictEqual("level_0", obj.parentName);

                obj = dataModel.objectByName("level_2");
                assert.ok(obj);
                assert.strictEqual(3, obj.lineage.length);
                assert.deepEqual(["level_0", "level_1", "level_2"], obj.lineage);
                assert.strictEqual("level_1", obj.parentName);

                // Make sure there's no extra children
                assert.ok(!dataModel.objectByName("level_3"));
            });

            it("DataModels - test data model object fields", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/inheritance_test_data.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                let that = this;

                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("level_2");
                assert.ok(obj);

                let timeField = obj.fieldByName("_time");
                assert.ok(timeField);
                assert.strictEqual("timestamp", timeField.type);
                assert.ok(timeField.isTimestamp());
                assert.ok(!timeField.isNumber());
                assert.ok(!timeField.isString());
                assert.ok(!timeField.isObjectcount());
                assert.ok(!timeField.isChildcount());
                assert.ok(!timeField.isIPv4());
                assert.deepEqual(["BaseEvent"], timeField.lineage);
                assert.strictEqual("_time", timeField.name);
                assert.strictEqual(false, timeField.required);
                assert.strictEqual(false, timeField.multivalued);
                assert.strictEqual(false, timeField.hidden);
                assert.strictEqual(false, timeField.editable);
                assert.strictEqual(null, timeField.comment);

                let lvl2 = obj.fieldByName("level_2");
                assert.strictEqual("level_2", lvl2.owner);
                assert.deepEqual(["level_0", "level_1", "level_2"], lvl2.lineage);
                assert.strictEqual("objectCount", lvl2.type);
                assert.ok(!lvl2.isTimestamp());
                assert.ok(!lvl2.isNumber());
                assert.ok(!lvl2.isString());
                assert.ok(lvl2.isObjectcount());
                assert.ok(!lvl2.isChildcount());
                assert.ok(!lvl2.isIPv4());
                assert.strictEqual("level_2", lvl2.name);
                assert.strictEqual("level 2", lvl2.displayName);
                assert.strictEqual(false, lvl2.required);
                assert.strictEqual(false, lvl2.multivalued);
                assert.strictEqual(false, lvl2.hidden);
                assert.strictEqual(false, lvl2.editable);
                assert.strictEqual(null, lvl2.comment);
            });

            it("DataModels - test data model object properties", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_for_pivot.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("test_data");
                assert.ok(obj);
                assert.strictEqual(5, obj.fieldNames().length);
                assert.strictEqual(10, obj.allFieldNames().length);
                assert.ok(obj.fieldByName("has_boris"));
                assert.ok(obj.hasField("has_boris"));
                assert.ok(obj.fieldByName("_time"));
                assert.ok(obj.hasField("_time"));
            });

            it("DataModels - create local acceleration job", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/inheritance_test_data.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();
                let obj;
                let that = this;
                let dataModel = await that.dataModels.create(name, args);
                obj = dataModel.objectByName("level_2");
                assert.ok(obj);
                job = await obj.createLocalAccelerationJob(null);
                assert.ok(job);
                await tutils.pollUntil(
                    job,
                    function (j) {
                        return job.properties()["isDone"];
                    },
                    10
                );
                assert.strictEqual("| datamodel \"" + name + "\" level_2 search | tscollect", job.properties().request.search);
                await job.cancel();
            });

            it("DataModels - create local acceleration job with earliest time", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/inheritance_test_data.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("level_2");
                assert.ok(obj);
                let job = await obj.createLocalAccelerationJob("-1d");
                assert.ok(job);
                await tutils.pollUntil(
                    job,
                    function (j) {
                        return job.properties()["isDone"];
                    },
                    10
                );
                assert.strictEqual("| datamodel \"" + name + "\" level_2 search | tscollect", job.properties().request.search);

                // Make sure the earliest time is 1 day behind
                let yesterday = new Date(Date.now() - (1000 * 60 * 60 * 24));
                let month = (yesterday.getMonth() + 1);
                if (month <= 9) {
                    month = "0" + month;
                }
                let date = yesterday.getDate();
                if (date <= 9) {
                    date = "0" + date;
                }
                let expectedDate = yesterday.getFullYear() + "-" + month + "-" + date;
                assert.ok(utils.startsWith(job._state.content.earliestTime, expectedDate));

                await job.cancel();
            });

            it("DataModels - test data model constraints", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_with_test_objects.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("event1");
                assert.ok(obj);
                let constraints = obj.constraints;
                assert.ok(constraints);
                let onlyOne = true;
                for (var i = 0; i < constraints.length; i++) {
                    var constraint = constraints[i];
                    assert.ok(!!onlyOne);
                    assert.strictEqual("event1", constraint.owner);
                    assert.strictEqual("uri=\"*.php\" OR uri=\"*.py\"\nNOT (referer=null OR referer=\"-\")", constraint.query);
                }
            });

            it("DataModels - test data model calculations, and the different types", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/data_model_with_test_objects.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("event1");
                assert.ok(obj);
                let calculations = obj.calculations;
                assert.strictEqual(4, Object.keys(calculations).length);
                assert.strictEqual(4, obj.calculationIDs().length);

                let evalCalculation = calculations["93fzsv03wa7"];
                assert.ok(evalCalculation);
                assert.strictEqual("event1", evalCalculation.owner);
                assert.deepEqual(["event1"], evalCalculation.lineage);
                assert.strictEqual("Eval", evalCalculation.type);
                assert.ok(evalCalculation.isEval());
                assert.ok(!evalCalculation.isLookup());
                assert.ok(!evalCalculation.isGeoIP());
                assert.ok(!evalCalculation.isRex());
                assert.strictEqual(null, evalCalculation.comment);
                assert.strictEqual(true, evalCalculation.isEditable());
                assert.strictEqual("if(cidrmatch(\"192.0.0.0/16\", clientip), \"local\", \"other\")", evalCalculation.expression);

                assert.strictEqual(1, Object.keys(evalCalculation.outputFields).length);
                assert.strictEqual(1, evalCalculation.outputFieldNames().length);

                let field = evalCalculation.outputFields["new_field"];
                assert.ok(field);
                assert.strictEqual("My New Field", field.displayName);

                let lookupCalculation = calculations["sr3mc8o3mjr"];
                assert.ok(lookupCalculation);
                assert.strictEqual("event1", lookupCalculation.owner);
                assert.deepEqual(["event1"], lookupCalculation.lineage);
                assert.strictEqual("Lookup", lookupCalculation.type);
                assert.ok(lookupCalculation.isLookup());
                assert.ok(!lookupCalculation.isEval());
                assert.ok(!lookupCalculation.isGeoIP());
                assert.ok(!lookupCalculation.isRex());
                assert.strictEqual(null, lookupCalculation.comment);
                assert.strictEqual(true, lookupCalculation.isEditable());
                assert.deepEqual({ lookupField: "a_lookup_field", inputField: "host" }, lookupCalculation.inputFieldMappings);
                assert.strictEqual(2, Object.keys(lookupCalculation.inputFieldMappings).length);
                assert.strictEqual("a_lookup_field", lookupCalculation.inputFieldMappings.lookupField);
                assert.strictEqual("host", lookupCalculation.inputFieldMappings.inputField);
                assert.strictEqual("dnslookup", lookupCalculation.lookupName);

                let regexpCalculation = calculations["a5v1k82ymic"];
                assert.ok(regexpCalculation);
                assert.strictEqual("event1", regexpCalculation.owner);
                assert.deepEqual(["event1"], regexpCalculation.lineage);
                assert.strictEqual("Rex", regexpCalculation.type);
                assert.ok(regexpCalculation.isRex());
                assert.ok(!regexpCalculation.isLookup());
                assert.ok(!regexpCalculation.isEval());
                assert.ok(!regexpCalculation.isGeoIP());
                assert.strictEqual(2, regexpCalculation.outputFieldNames().length);
                assert.strictEqual("_raw", regexpCalculation.inputField);
                assert.strictEqual(" From: (?<from>.*) To: (?<to>.*) ", regexpCalculation.expression);

                let geoIPCalculation = calculations["pbe9bd0rp4"];
                assert.ok(geoIPCalculation);
                assert.strictEqual("event1", geoIPCalculation.owner);
                assert.deepEqual(["event1"], geoIPCalculation.lineage);
                assert.strictEqual("GeoIP", geoIPCalculation.type);
                assert.ok(geoIPCalculation.isGeoIP());
                assert.ok(!geoIPCalculation.isLookup());
                assert.ok(!geoIPCalculation.isEval());
                assert.ok(!geoIPCalculation.isRex());
                assert.strictEqual("ဩᚙ௵ comment of pbe9bd0rp4", geoIPCalculation.comment);
                assert.strictEqual(5, geoIPCalculation.outputFieldNames().length);
                assert.strictEqual("output_from_reverse_hostname", geoIPCalculation.inputField);
            });

            it("DataModels - run queries", async function () {
                if (this.skip) {
                    return;
                }
                var that = this;
                let dataModels = await that.dataModels.fetch();
                let dm = dataModels.item("internal_audit_logs");
                let obj = dm.objectByName("searches");
                let job = await obj.startSearch({}, "");
                await tutils.pollUntil(
                    job,
                    function (j) {
                        return job.properties()["isDone"];
                    },
                    10);
                assert.strictEqual("| datamodel internal_audit_logs searches search", job.properties().request.search);
                await job.cancel();

                job = await obj.startSearch({ status_buckets: 5, enable_lookups: false }, "| head 3");
                await tutils.pollUntil(
                    job,
                    function (j) {
                        return job.properties()["isDone"];
                    },
                    10);
                assert.strictEqual("| datamodel internal_audit_logs searches search | head 3", job.properties().request.search);
                await job.cancel();
            });

            it("DataModels - baseSearch is parsed correctly", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/model_with_multiple_types.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();
                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("search1");
                assert.ok(obj);
                assert.ok(obj instanceof splunkjs.Service.DataModelObject);
                assert.strictEqual("BaseSearch", obj.parentName);
                assert.ok(obj.isBaseSearch());
                assert.ok(!obj.isBaseTransaction());
                assert.strictEqual("search index=_internal | head 10", obj.baseSearch);
            });

            it("DataModels - baseTransaction is parsed correctly", async function () {
                if (this.skip) {
                    return;
                }
                let args;
                try {
                    args = JSON.parse(utils.readFile(__filename, "../../data/model_with_multiple_types.json"));
                }
                catch (err) {
                    // Fail if we can't read the file, likely to occur in the browser
                    assert.ok(!err);
                }
                let name = "delete-me-" + getNextId();

                var that = this;
                let dataModel = await that.dataModels.create(name, args);
                let obj = dataModel.objectByName("transaction1");
                assert.ok(obj);
                assert.ok(obj instanceof splunkjs.Service.DataModelObject);
                assert.strictEqual("BaseTransaction", obj.parentName);
                assert.ok(obj.isBaseTransaction());
                assert.ok(!obj.isBaseSearch());
                assert.deepEqual(["event1"], obj.objectsToGroup);
                assert.deepEqual(["host", "from"], obj.groupByFields);
                assert.strictEqual("25s", obj.maxPause);
                assert.strictEqual("100m", obj.maxSpan);
            })
        })
    )
};

if (module.id === __filename && module.parent.id.includes('mocha')) {
    var splunkjs = require('../../index');
    var options = require('../cmdline');

    let cmdline = options.create().parse(process.argv);

    // If there is no command line, we should return
    if (!cmdline) {
        throw new Error("Error in parsing command line parameters");
    }

    let svc = new splunkjs.Service({
        scheme: cmdline.opts.scheme,
        host: cmdline.opts.host,
        port: cmdline.opts.port,
        username: cmdline.opts.username,
        password: cmdline.opts.password,
        version: cmdline.opts.version
    });

    // Exports tests on a successful login
    module.exports = new Promise(async (resolve, reject) => {
        try {
            await svc.login();
            return resolve(exports.setup(svc))
        } catch (error) {
            throw new Error("Login failed - not running tests", error || "");
        }
    });
}