Skip to content

TSERV-1452 Adding license type "slm" so we can start to install slm l… #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ntomczyk-smartbear merged 5 commits into from
Apr 21, 2023
Merged

TSERV-1452 Adding license type "slm" so we can start to install slm l… #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
46bea8f
TSERV-1452 Adding license type "slm" so we can start to install slm l…
lootic Apr 19, 2023
04ab337
TSERV-1452 Fixing documentation and changing so we more clearly show …
lootic Apr 19, 2023
3b33472
TSERV-1452 Use slice instead of splice. Use includes instead of writi…
lootic Apr 20, 2023
4fafe75
TSERV-1452 Pushed documentation fix.
lootic Apr 20, 2023
37168a1
TSERV-1452 More documentation fixes.
lootic Apr 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,21 +224,28 @@ To check the current license expiry and size, use the license info command.
To install a fixed license, specify `type=fixed`, the user information and the path to either a .key file or a .zip
file with licenses in it (as received from SmartBear).

`testengine license install type=fixed fistName=Joe lastName=Tester email=joe.tester@example.com /home/joe/Downloads/licenses.zip`
`testengine license install type=fixed firstName=Joe lastName=Tester email=joe.tester@example.com /home/joe/Downloads/licenses.zip`

**Note:** When you install a new license, any existing old license is overwritten without deactivation. It is generally
a good idea to first uninstall it.

### Install a floating license
To install a fixed license, specify `type=floating`, and the location of the floating license server (typically an IP
and port 1099)
and port 443)

`testengine license install type=floating <ip-address|hostname>:1099`
`testengine license install type=floating <ip-address|hostname>:443`

### Install an SLM license
To install an SLM license, specify `type=slm`, and then options `accessKey` or `licenseServer` or both to specify from
where you wish to check out your SLM license. If port is not specified it will automatically add default port for server
on-premise 40892.

`testengine license install type=slm accessKey=c5c4f014-4745-44a8-bfab-c0df7c66c5a7 licenseServer=https://mySlmServer:40892`

### Uninstall a license (floating or fixed)
To uninstall, you use the uninstall command.

`testengine license install type=floating <ip-address|hostname>:1099`
`testengine license uninstall`

A fixed license will be deactivated and a floating license will be checked back in to the floating license server.

Expand Down
250 changes: 134 additions & 116 deletions bin/license_functions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,26 @@ module.exports.dispatcher = function (args) {

switch (args[0].toLowerCase()) {
case 'install': {
let argsWithoutFilename = args.splice(1, args.length - 2);
let argsWithoutFilename;
let shouldInstallSlm = args.includes("type=slm");
if (shouldInstallSlm) {
argsWithoutFilename = args.slice(1, args.length);
} else {
if (args.length < 2) {
util.error("When installing a JPROD license licensefile or host:port is mandatory.")
printModuleHelp();
process.exit(1);
}
argsWithoutFilename = args.slice(1, args.length - 1);
}
let options = util.optionsFromArgs(argsWithoutFilename, [
'licenseServer',
'accessKey',
'type',
'lastName',
'firstName',
'email']);
if (args.length < 2) {
printModuleHelp();
process.exit(1);
} else {
installLicense(options, args[args.length - 1]);
}
installLicense(options, shouldInstallSlm ? null : args[args.length - 1]);
break;
}
case 'uninstall':
Expand All @@ -53,8 +61,8 @@ function printModuleHelp() {
util.error("Usage: testengine license <command>");
util.error("Commands: ");
util.error(" info");
util.error(" install type=<fixed|floating> [lastName=<name>] [firstName=<firstName>] ");
util.error(" [email=<email-address>] <licensefile|host:port>");
util.error(" install type=<fixed|floating|slm> [lastName=<name>] [firstName=<firstName>] [email=<email-address>]");
util.error(" [licenseServer=<slmLicenseServer] [accessKey=<slmAccessKey>] [<licensefile|host:port>]");
util.error(" uninstall");
util.error(" help");
}
Expand All @@ -71,33 +79,58 @@ function installLicense(options, licenseOrLicenseServer) {
case 'fixed':
installFixedLicense(options, licenseOrLicenseServer);
break;
case 'slm':
if (!options.accessKey && !options.licenseServer) {
util.error("At least one of the options accessKey or licenseServer needs to be specified when installing" +
"an SLM license");
}
installSlmLicense(options)
break;
default:
util.printErrorAndExit("Error: Specifying fixed or floating license is mandatory");
util.printErrorAndExit("Error: Specifying fixed, floating or slm license is mandatory");
}
}

function installSlmLicense(options) {
let endPoint = config.server + '/api/v1/license';
let payload = {
'issuer': 'SLM'
};
if (options.licenseServer) {
payload['server'] = options.licenseServer;
}
if (options.accessKey) {
payload['accessKey'] = options.accessKey;
}
request.post(endPoint)
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send(payload)
.end((err, result) => {
if (err === null) {
util.output("The following license was installed:");
util.output(licenseInfoToString(result.body))
} else {
handleError(err, result);
}
});
}

function uninstallLicense() {
let endPoint = config.server + '/api/v1/license';
request.delete(endPoint)
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send()
.end((err, result) => {
if (err === null) {
util.output("License successfully uninstalled");
} else {
if ('status' in err) {
switch (err['status']) {
case 403:
util.printErrorAndExit("User doesn't have permission to uninstall a license");
break;
default:
util.printErrorAndExit(err['status'] + ': ' + result.body['message']);
}
}
}
});
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send()
.end((err, result) => {
if (err === null) {
util.output("License successfully uninstalled");
} else {
handleError(err, result);
}
});
}

function installFixedLicense(options, licenseFile) {
Expand All @@ -112,37 +145,19 @@ function installFixedLicense(options, licenseFile) {
readStream.on('open', function () {
let buffer = Buffer.from(JSON.stringify(activationInfo), 'utf8');
request.post(endPoint)
.auth(config.username, config.password)
.accept('application/json')
.type('multipart/form-data')
.attach('file', licenseFile)
.attach('activationInfo', buffer, "data.json")
.end((err, result) => {
if (err === null) {
util.output("The following license was installed:");
util.output(licenseInfoToString(result.body))
} else {
if ('status' in err) {
switch (err['status']) {
case 403:
util.printErrorAndExit("User doesn't have permission to install a license");
break;
case 400:
util.printErrorAndExit("Failed to install license, error: " + result.body['message']);
break;
default:
if ('message' in result.body) {
util.printErrorAndExit(err['status'] + ': ' + result.body['message']);
} else {
util.printErrorAndExit(err['status'] + ': ' + err['message']);
}
return;
}
} else {
util.printErrorAndExit(err);
}
}
});
.auth(config.username, config.password)
.accept('application/json')
.type('multipart/form-data')
.attach('file', licenseFile)
.attach('activationInfo', buffer, "data.json")
.end((err, result) => {
if (err === null) {
util.output("The following license was installed:");
util.output(licenseInfoToString(result.body))
} else {
handleError(err, result)
}
});
});
readStream.on('error', function (err) {
util.error("Error: " + err.message);
Expand All @@ -162,69 +177,72 @@ function installFloatingLicense(licenseServerHost, licenseServerPort) {
'port': licenseServerPort
};
request.post(endPoint)
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send(payload)
.end((err, result) => {
if (err === null) {
util.output("The following license was installed:");
util.output(licenseInfoToString(result.body))
} else {
if ('status' in err) {
switch (err['status']) {
case 403:
util.printErrorAndExit("User doesn't have enough credentials to install a license");
break;
case 400:
util.printErrorAndExit("Failed to install license, error: " + result.body['message']);
break;
default:
util.printErrorAndExit(err['status'] + ': ' + err['message']);
}
} else {
util.printErrorAndExit(err);
}
}
});
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send(payload)
.end((err, result) => {
if (err === null) {
util.output("The following license was installed:");
util.output(licenseInfoToString(result.body))
} else {
handleError(err, result);
}
});
}

function showLicenseInfo() {
let endPoint = config.server + '/api/v1/license';
request.get(endPoint)
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send()
.end((err, result) => {
if (err === null) {
util.output("Current license:");
util.output(licenseInfoToString(result.body))
} else {
if ('status' in err) {
switch (err['status']) {
case 401:
case 403:
util.printErrorAndExit("User doesn't have credentials to show license");
break;
case 404:
util.printErrorAndExit("No license installed");
break;
default:
util.printErrorAndExit(err['status'] + ': ' + err['message']);
}
} else {
util.printErrorAndExit(err);
}
}
});
.auth(config.username, config.password)
.accept('application/json')
.type('application/json')
.send()
.end((err, result) => {
if (err === null) {
util.output("Current license:");
util.output(licenseInfoToString(result.body))
} else {
handleError(err, result);
}
});

}

function handleError(err, result) {
if ('status' in err) {
switch (err['status']) {
case 400:
util.printErrorAndExit(result.body['message']);
break;
case 401:
case 403:
util.printErrorAndExit("User doesn't have credentials to show license");
break;
case 404:
util.printErrorAndExit("No license installed");
break;
default:
util.printErrorAndExit(err['status'] + ': ' + result.body['message']);
}
} else {
util.printErrorAndExit(err);
}
}

function licenseInfoToString(licenseInfo) {
return "License ID: " + licenseInfo['licenseId'] + "\n" +
"Licensed to user: " + licenseInfo['userName'] + "\n" +
"Organization: " + licenseInfo['organization'] + "\n" +
"Expires: " + licenseInfo['expireDate'] + "\n" +
"Max Concurrent TestJobs: " + licenseInfo['maxConcurrentJobs'];
if(licenseInfo.issuer === "NO_LICENSE") {
return "No license installed"
}
if (licenseInfo.issuer === "SLM") {
return "License ID: " + licenseInfo['licenseNumber'] + "\n" +
"Expires: " + licenseInfo['expirationDate'] + "\n" +
"Max Concurrent TestJobs: " + licenseInfo['properties']['maxConcurrentJobs'];
} else {
return "License ID: " + licenseInfo['licenseId'] + "\n" +
"Licensed to user: " + licenseInfo['userName'] + "\n" +
"Organization: " + licenseInfo['organization'] + "\n" +
"Expires: " + licenseInfo['expireDate'] + "\n" +
"Max Concurrent TestJobs: " + licenseInfo['maxConcurrentJobs'];
}
}