@nsshunt/stsappframework 2.19.173 → 2.19.175

package/src/testHelpers.ts

@@ -1,326 +0,0 @@
-import debugModule from 'debug'
-const debug = debugModule(`proc:${process.pid}:testHelper`);
-
-import * as tough from 'tough-cookie'
-
-import https from 'https'
-import crypto from 'crypto';
-
-import 'jest-date'
-
-import axios from 'axios';
-
-import { GenericContainer, Network, Wait } from "testcontainers";
-
-import { $Options, $ResetOptions } from '@nsshunt/stsconfig'
-let goptions = $Options()
-
-import { Sleep } from '@nsshunt/stsutils'
-
-import { AuthUtilsNode, STSClientID } from './authutilsnode'
-
-export class TestHelper {
-    //#regexBase64URL = /^[A-Za-z0-9_-]+$/ // Base64URL  - https://base64.guru/standards/base64url
-    #regexURLSafeStringComponent = /[-a-zA-Z0-9@:%._+~#=]{1,256}/ // URL safe string component
-    //#regexBase64 = /(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?/ // Base64 - https://stackoverflow.com/questions/475074/regex-to-parse-or-validate-base64-data
-    #regexSTSBase64 = /SES_(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?/ // Base64
-    #regexJWT = /[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+/ // JWT (Base64URL.Base64URL.Base64URL)
-
-    #authUtilsNode = new AuthUtilsNode();
-
-    #databaseContainer: any;
-    #stsAuthContainer: any;
-    #network: any;
-    #authEndpoint = '';
-    #authPort = '';
-    #authHost = '';
-    #httpsAgent: https.Agent | null = null;
-
-    constructor() {
-        this.#authEndpoint = 'https://localhost:3002'; //@@
-    }
-
-    #GetHttpsAgent = () =>
-    {
-        if (this.#httpsAgent === null) {
-            // https://nodejs.org/api/http.html#class-httpagent
-            this.#httpsAgent = new https.Agent({ 
-                keepAlive: goptions.keepAlive,
-                maxSockets: goptions.maxSockets,
-                maxTotalSockets: goptions.maxTotalSockets,
-                maxFreeSockets: goptions.maxFreeSockets,
-                timeout: goptions.timeout,
-                rejectUnauthorized: false
-            });
-        }
-        return this.#httpsAgent;
-    }
-
-    StartNetwork = async () => {
-        this.#network = await new Network().start();
-    }
-
-    StopNetwork = async () => {
-        await this.#network.stop();
-    }
-
-    get network() {
-        return this.#network;
-    }
-
-    get authPort() {
-        return this.#authPort;
-    }
-
-    get authHost() {
-        return this.#authHost;
-    }
-
-    get authEndpoint() {
-        return this.#authEndpoint;
-    }
-
-    get getHttpsAgent() {
-        return this.#GetHttpsAgent();
-    }
-
-    CreateRandomString = () => {
-        const charset = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_~.'; //    /[0-9A-Za-z\-_~.]/
-        let random = '';
-        const randomValues: number[] = Array.from(crypto.getRandomValues(new Uint8Array(43)));
-        randomValues.forEach(v => (random += charset[v % charset.length]));
-        return random;
-    }
-
-    Login = async (username: string, password: string) => {
-        const client_id = process.env.CLIENT_ID as string;
-        const nonce = crypto.randomBytes(43).toString('base64'); //CreateRandomString();
-        const response_type = 'code';
-        const redirect_uri = process.env.REDIRECT_URI as string;
-        const response_mode = 'query';
-        const scope = process.env.SCOPE as string;
-        const state = crypto.randomBytes(43).toString('base64'); // CreateRandomString();
-        const code_verifier = this.CreateRandomString();
-        const code_challenge = crypto.createHash('sha256').update(code_verifier).digest('base64');
-        const code_challenge_method = 'S256';
-
-        const authoriseOptions: any = {
-            email: username,
-            password,
-            client_id,
-            nonce,
-            response_type,
-            redirect_uri,
-            response_mode,
-            scope,
-            state,
-            code_challenge,
-            code_challenge_method
-        }
-
-
-        const url = `${this.#authEndpoint}${goptions.asapiroot}/login`;
-        const headers = { 'Content-Type': 'application/json'};
-
-        const retVal = await axios({
-            url
-            ,method: 'post'
-            ,data: authoriseOptions
-            ,headers: headers
-            ,httpsAgent: this.#GetHttpsAgent()
-        });
-
-        //const cookieString = retVal.headers['set-cookie'];
-
-        /*
-        const api = request(this.#endpoint);
-        const retVal: any = await (api as any)
-            .post(`${goptions.asapiroot}/login`)
-            .send(authoriseOptions)
-        //.expect('set-cookie', /consent_cookie=.*; Max-Age=86; Path=\/; Expires=.*; HttpOnly; Secure; SameSite=Strict/);
-
-        const cookieString = retVal.header['set-cookie'];
-
-        if (cookieString) {
-            retVal.cookie = new Cookie(cookieString[0]);
-        }
-        */
-
-        return retVal;
-    }
-
-    GetAuthServerAPITokenFromServer = async (): Promise<string> => {
-        return await this.#authUtilsNode.GetAPITokenFromAuthServer(STSClientID.STSTestingService, 
-            "eN9u0mHZLGWZrdnE1zit2vL6xwUFW466sTZcbkXDml5KWxlvKaZ1uiOZmA==", 
-            goptions.asapiidentifier, this.#authEndpoint)
-    }
-
-    ValidateJWT = async (token: string): Promise<string> => {
-        return await this.#authUtilsNode.ValidateJWT(token, goptions.asapiidentifier, this.#authEndpoint);
-    }
-
-    StartDatabase = async () => {
-        this.#databaseContainer = await new GenericContainer("postgres")
-            .withExposedPorts(5432)
-            .withEnvironment({
-                POSTGRES_PASSWORD: "postgres",
-                //UV_THREADPOOL_SIZE: "64"
-            })
-            .withNetwork(this.#network)
-            .withNetworkAliases("database")
-            .start();
-
-        const httpPort = this.#databaseContainer.getMappedPort(5432);
-        const host = this.#databaseContainer.getHost();
-        const networkIpAddress = this.#databaseContainer.getIpAddress(this.#network.getName());
-        
-        process.env.DB_PORT = httpPort;
-        process.env.DB_HOST = host;
-
-        $ResetOptions();
-        goptions = $Options()
-
-        debug(`httpPort: [${httpPort}]`.green)
-        debug(`host: [${host}]`.green)
-        debug(`networkIpAddress: [${networkIpAddress}]`.green)
-        debug(`connectionString: [${goptions.connectionString}]`.green)
-        debug(`defaultDatabaseConnectionString: [${goptions.defaultDatabaseConnectionString }]`.green)
-    }
-
-    StopDatabase = async () => {
-        if (this.#databaseContainer) {
-            await this.#databaseContainer.stop();
-
-            debug(`Used the following parameters for the database during testing:`.yellow);
-            debug(`connectionString: [${goptions.connectionString}]`.yellow);
-            debug(`defaultDatabaseConnectionString: [${goptions.defaultDatabaseConnectionString }]`.yellow);
-        }
-    }
-
-    // Note: .withCopyFilesToContainer and .withCopyContentToContainer have a defect in that Jest will not close. A file handle/stream is left open
-    // within the underlying code.
-    InitializeDatabase = async () => {
-        const stsAuthContainerInit = await new GenericContainer("serza/stsauth:latest")
-            .withEnvironment({
-                DB_USER: "postgres",
-                DB_PASSWORD: "postgres",
-                DB_HOST: "database", // "192.168.14.101",
-                DB_PORT: "5432",
-                POOL_SIZE: "50",
-                MAX_CPU: "2",
-                DEBUG: "proc*",
-                HTTPS_SERVER_KEY_PATH: "/var/lib/sts/stsglobalresources/keys-tmp/server.key",
-                HTTPS_SERVER_CERT_PATH: "/var/lib/sts/stsglobalresources/keys-tmp/server.cert",
-                AS_CLIENT_ID: "q6a9F0kksXDDcrsCUKRwHKDnTNh7yZfxCShAgIJqfGg=",
-                AS_CLIENT_SECRET: "eN9u0mHZLGWZrdnE1zit2vL6xwUFW466sTZcbkXDml5KWxlvKaZ1uiOZmA==",
-                AS_ENDPOINT: "https://stscore.stsmda.org"
-            })
-            .withCommand(["node", "dist/app", "create"])
-            .withNetwork(this.#network)
-            .withNetworkAliases("stsauthrunnerinit")
-            .withWaitStrategy(Wait.forLogMessage(`User Permissions: {"status":200,"detail":["STSREST01ReadPermission","STSREST01CreatePermission","STSREST01UpdatePermission","STSREST01DeletePermission"]}`))
-            .start();
-
-        await Sleep(200);
-
-        await stsAuthContainerInit.stop();
-    }
-
-    StartAuthService = async () => {
-        this.#stsAuthContainer = await new GenericContainer("serza/stsauth:latest")
-            .withExposedPorts(3002)
-            .withEnvironment({
-                DB_USER: "postgres",
-                DB_PASSWORD: "postgres",
-                DB_HOST: "database", 
-                DB_PORT: "5432",
-                POOL_SIZE: "50",
-                MAX_CPU: "2",
-                DEBUG: "proc*",
-                HTTPS_SERVER_KEY_PATH: "/var/lib/sts/stsglobalresources/keys-tmp/server.key",
-                HTTPS_SERVER_CERT_PATH: "/var/lib/sts/stsglobalresources/keys-tmp/server.cert",
-                AS_CLIENT_ID: "q6a9F0kksXDDcrsCUKRwHKDnTNh7yZfxCShAgIJqfGg=",
-                AS_CLIENT_SECRET: "eN9u0mHZLGWZrdnE1zit2vL6xwUFW466sTZcbkXDml5KWxlvKaZ1uiOZmA==",
-                AS_ENDPOINT: "https://stscore.stsmda.org"
-            })
-            .withNetwork(this.#network)
-            .withNetworkAliases("stsauthrunner")
-            .withWaitStrategy(Wait.forHttp("/stsauth/v1.0/latency", 3002).usingTls().allowInsecure())
-            .start();
-
-        const httpAuthPort = this.#stsAuthContainer.getMappedPort(3002);
-
-        await Sleep(200);
-        debug(`-------------------------------------------------------------------------------------------`.green)
-        debug(`                                 *** STSAuth Started ***: [${httpAuthPort}]`.green)
-        debug(`-------------------------------------------------------------------------------------------`.green)
-
-        this.#authHost = 'https://localhost'
-        this.#authPort = httpAuthPort;
-        this.#authEndpoint = `${this.#authHost}:${this.#authPort}`;
-    }
-
-    StopAuthService = async () => {
-        if (this.#stsAuthContainer) {
-            await this.#stsAuthContainer.stop();
-            await Sleep(200);
-        }
-    }
-
-    TestLoginAndVerify = async () => {
-        expect.assertions(4);
-
-        const retVal = await this.Login('user01@stsmda.com.au', 'user01password');
-        expect(retVal.status).toEqual(200);
-
-        debug(`${JSON.stringify(retVal.data)}`.red);
-        debug(`${JSON.stringify(retVal.headers)}`.magenta);
-        debug(`${JSON.stringify(retVal.headers['set-cookie'])}`.yellow);
-
-        const cookies = retVal.headers['set-cookie'] as string[];
-        debug(`${cookies[0]}`.yellow);
-        debug(`${JSON.stringify(tough.Cookie.parse(cookies[0]))}`.green);
-
-        const cookie = tough.Cookie.parse(cookies[0]) as tough.Cookie;
-
-        const desiredCookieResultAxios = {
-            key: 'consent_cookie',
-            value: expect.stringMatching(this.#regexURLSafeStringComponent),
-            path: '/',
-            secure: true,
-            httpOnly: true,
-            sameSite: 'strict',
-        }
-
-        const cookieResult = JSON.parse(JSON.stringify(cookie));
-        expect(cookieResult).toMatchObject(desiredCookieResultAxios);
-
-        const cookieExpireDate = new Date(cookie.expires);
-        expect(cookieExpireDate).toBeAfter(new Date());
-
-        const desiredResult = {
-            sessionId: expect.stringMatching(this.#regexSTSBase64),
-            id_token: expect.stringMatching(this.#regexJWT),
-            consentRequired: [ 'res01.create', 'res01.read', 'res01.update', 'res01.delete' ]
-        }
-        expect(retVal.data.detail).toMatchObject(desiredResult);
-    }
-
-    TestValidateJWT = async () => {
-        expect.assertions(1);
-
-        const access_token = await this.GetAuthServerAPITokenFromServer();
-        debug(`access_token: [${access_token}]`.green);
-
-        const retVal = await this.ValidateJWT(access_token);
-        // https://jestjs.io/docs/expect#tomatchobjectobject
-        const desiredJWT = {
-            scope: 'offline_access session.read session.update',
-            iss: 'https://stsmda.com.au/stsauth/',
-            aud: 'https://stsmda.com.au/stsauthapi/v1.0/',
-            sub: 'session'
-        };
-
-        expect(retVal).toMatchObject(desiredJWT);
-    }
-}

package/types/testHelpers.d.ts

@@ -1,26 +0,0 @@
-/// <reference types="node" />
-import https from 'https';
-import 'jest-date';
-export declare class TestHelper {
-    #private;
-    constructor();
-    StartNetwork: () => Promise<void>;
-    StopNetwork: () => Promise<void>;
-    get network(): any;
-    get authPort(): string;
-    get authHost(): string;
-    get authEndpoint(): string;
-    get getHttpsAgent(): https.Agent;
-    CreateRandomString: () => string;
-    Login: (username: string, password: string) => Promise<import("axios").AxiosResponse<any, any>>;
-    GetAuthServerAPITokenFromServer: () => Promise<string>;
-    ValidateJWT: (token: string) => Promise<string>;
-    StartDatabase: () => Promise<void>;
-    StopDatabase: () => Promise<void>;
-    InitializeDatabase: () => Promise<void>;
-    StartAuthService: () => Promise<void>;
-    StopAuthService: () => Promise<void>;
-    TestLoginAndVerify: () => Promise<void>;
-    TestValidateJWT: () => Promise<void>;
-}
-//# sourceMappingURL=testHelpers.d.ts.map

package/types/testHelpers.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"testHelpers.d.ts","sourceRoot":"","sources":["../src/testHelpers.ts"],"names":[],"mappings":";AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAGzB,OAAO,WAAW,CAAA;AAalB,qBAAa,UAAU;;;IAqCnB,YAAY,sBAEX;IAED,WAAW,sBAEV;IAED,IAAI,OAAO,QAEV;IAED,IAAI,QAAQ,WAEX;IAED,IAAI,QAAQ,WAEX;IAED,IAAI,YAAY,WAEf;IAED,IAAI,aAAa,gBAEhB;IAED,kBAAkB,eAMjB;IAED,KAAK,aAAoB,MAAM,YAAY,MAAM,sDAuDhD;IAED,+BAA+B,QAAa,QAAQ,MAAM,CAAC,CAI1D;IAED,WAAW,UAAiB,MAAM,KAAG,QAAQ,MAAM,CAAC,CAEnD;IAED,aAAa,sBA0BZ;IAED,YAAY,sBAQX;IAID,kBAAkB,sBAyBjB;IAED,gBAAgB,sBAgCf;IAED,eAAe,sBAKd;IAED,kBAAkB,sBAqCjB;IAED,eAAe,sBAgBd;CACJ"}