protractor-cucumber-boilerplate/framework/credential_manager/ServerCredentialManager.js

const utils = require("../helpers/utils");
const path = require("path");
const request = require("request-promise");
const credentialServerPort = utils.parseArgv("credentialServerPort", process.argv) || 3099;
const SERVICE_URI = "http://localhost:" + credentialServerPort + "/credentials";

/**
 * Class representing Credential Manager
 */
class ServerCredentialManager {

    /**
     * Create pool of userIds based on creds object
     * @param {Object} creds - set of user credentials
     * @param {string} [pool] - name of pool
     * @throws {Error}
     * @example CredentialManager.createPool(credentials);
     */
    static createPool(creds, pool) {
        let requestURI = SERVICE_URI;
        if (pool) {
            requestURI += "?pool=" + pool;
        }

        return request({
            method: "POST",
            uri: requestURI,
            body: creds,
            json: true
        })
        .catch(e => {
            throw new Error("Credential pool has not been created")
        })
    }

    /**
     * Return free credentials from pool
     * @return {Promise<Object>} - promise that resolves with set of credentials
     * @throws {Error}
     * @example
     * CredentialManager.getCredentials();
     * const currentCredentials = await CredentialManager.credentials;
     */
    static getCredentials(pool) {
        let requestURI = SERVICE_URI;
        if (pool) {
            this.pool = pool;
            requestURI += "?pool=" + pool;
        }
        this.credentials = request({
            method: "GET",
            uri: requestURI,
        })
        .then(body => JSON.parse(body))
        .catch(e => {
            throw e
        })
    }

    /**
     * Free credentials
     * @throws {Error}
     * @example CredentialManager.freeCredentials();
     */
    static freeCredentials() {
        let requestURI = SERVICE_URI;
        if (this.pool) {
            requestURI += "?pool=" + pool;
        }
        return this.credentials.then(credentials => {
            if (credentials) {
                return request({
                    method: "PUT",
                    uri: requestURI,
                    body: {
                        username: credentials.username
                    },
                    json: true
                })
            }
        })
        .catch(e => {
            throw e
        })
    }

    /**
     * Free credentials
     * @param property - property to update
     * @param value - value to update
     * @param [pool] - pool to update
     * @throws {Error}
     * @example CredentialManager.updateProperty("cookie", "myCookie");
     */
    static updateProperty(property, value, pool) {
        let requestURI = SERVICE_URI + "/update";
        if (pool) {
            requestURI += "?pool=" + pool;
        }
        return this.credentials.then(credentials => {
            if (credentials) {
                return request({
                    method: "PUT",
                    uri: requestURI,
                    body: {
                        username: credentials.username,
                        property: property,
                        value: value
                    },
                    json: true
                })
            }
        })
        .catch(e => {
            throw e
        })
    }

    /**
     * Return specified credentials by username
     * @param username - username to get
     * @param [pool] - pool to update
     * @return {Promise<Object>} - promise that resolves with set of credentials
     * @throws {Error}
     * @example
     * CredentialManager.getCredentialsByUsername(ta1@email.com);
     * const currentCredentials = await CredentialManager.credentials;
     */
    static getCredentialsByUsername(username, pool) {
        let requestURI = SERVICE_URI + "/" + username;
        if (pool) {
            requestURI += "?pool=" + pool;
        }
        this.credentials = request({
            method: "GET",
            uri: requestURI,
        })
        .then(body => JSON.parse(body))
        .catch(e => {
            throw e
        })
    }

}

module.exports = ServerCredentialManager;