@opentap/runner-client 2.20.0-alpha.1.8.7789948835 → 2.20.0

package/dist/mjs/RunnerClient.js

@@ -0,0 +1,175 @@
+import { Image, RepositoryPackageReference, Session } from './DTOs';
+import { BaseClient } from './BaseClient';
+export class RunnerClient extends BaseClient {
+    constructor(baseSubject, options) {
+        super(baseSubject, options);
+        // Contains the endpoints for Defaults in the runner plugin.
+        this.default = {
+            /* Create a Session based on the dependencies of a TestPlan. Returned
+            Session will have referenced TestPlan pre-loaded. The Session will be
+            created with the base image and base settings. */
+            startSession: (testPlanRepositoryReference, timeout) => {
+                return this.request('StartDefaultSession', testPlanRepositoryReference !== null && testPlanRepositoryReference !== void 0 ? testPlanRepositoryReference : null, { timeout })
+                    .then(sessionJs => Session.fromJS(sessionJs))
+                    .then(this.success())
+                    .catch(this.error());
+            },
+            /* Create a Session based on the dependencies of a TestPlan, but with
+            an image which packages overrides the default and testplan dependencies.
+            Returned Session will have referenced TestPlan pre-loaded. The Session
+            will be created with the base image and base settings.
+            */
+            startSessionWithOverriddenImage: (testPlanReference, imageOverride, timeout) => {
+                const defaultSessionRequest = {
+                    testPlanReference: testPlanReference !== null && testPlanReference !== void 0 ? testPlanReference : null,
+                    imageOverride: imageOverride !== null && imageOverride !== void 0 ? imageOverride : null,
+                };
+                return this.request('StartDefaultSessionOverrideImage', defaultSessionRequest, { timeout })
+                    .then(sessionJs => Session.fromJS(sessionJs))
+                    .then(this.success())
+                    .catch(this.error());
+            },
+            /* Gets the base image. The base image is always included in the image
+            creation process */
+            getImage: () => {
+                return this.request('GetDefaultImage')
+                    .then(imageJs => Image.fromJS(imageJs))
+                    .then(this.success())
+                    .catch(this.error());
+            },
+            /* Sets the base image. The specified image is resolved and set as the
+            base image */
+            setImage: (image) => {
+                return this.request('SetDefaultImage', image)
+                    .then(imageJs => Image.fromJS(imageJs))
+                    .then(this.success())
+                    .catch(this.error());
+            },
+            /* Gets the base settings package. The base settings is always included
+            in the image creation process and loaded into the created session */
+            getSettings: () => {
+                return this.request('GetDefaultSettings')
+                    .then(repositoryPackageReferenceJs => repositoryPackageReferenceJs ? RepositoryPackageReference.fromJS(repositoryPackageReferenceJs) : undefined)
+                    .then(this.success())
+                    .catch(this.error());
+            },
+            /* Sets the base settings package. The base settings is always included
+            in the image creation process and loaded into the created session */
+            setSettings: (repositoryPackageReference) => {
+                return this.request('SetDefaultSettings', repositoryPackageReference).then(this.success()).catch(this.error());
+            },
+        };
+    }
+    /**
+     * Get the created image with the specified ID.
+     * @param imageId
+     * @returns {{Promise<Image>}}
+     */
+    getImage(imageId) {
+        return (imageId === null || imageId === void 0 ? void 0 : imageId.length) > 0
+            ? this.request('GetImage', imageId)
+                .then(imageJs => Image.fromJS(imageJs))
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('imageId is not defined');
+    }
+    /**
+     * Get all created images
+     * @returns {{Promise<Image[]>}}
+     */
+    getImages() {
+        return this.request('GetImages')
+            .then(imageArrayJs => imageArrayJs.map(imageJs => Image.fromJS(imageJs)))
+            .then(this.success())
+            .catch(this.error());
+    }
+    /**
+     * Get all sessions
+     * @returns {{Promise<Session[]>}}
+     */
+    getSessions() {
+        return this.request('GetSessions')
+            .then(sessionArrayJs => sessionArrayJs.map(sessionJs => Session.fromJS(sessionJs)))
+            .then(this.success())
+            .catch(this.error());
+    }
+    /**
+     * Create a OpenTAP package configuration image from a list image inputs consisting of user specified packages and repositories.
+     * @param {Image[]} images List of images
+     * @param {number} timeout Optional timeout in milliseconds
+     * @returns {{Promise<Image>}}
+     */
+    resolveImage(images, timeout) {
+        return (images === null || images === void 0 ? void 0 : images.length) > 0
+            ? this.request('ResolveImage', images, { timeout })
+                .then(imageJs => Image.fromJS(imageJs))
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('images list is not defined or is empty');
+    }
+    /**
+     * Dry runs to resolve an image from a list of images. Dry run means that no packages will be downloaded.
+     * @param {Image[]} images List of images
+     * @param {number} timeout Optional timeout in milliseconds
+     * @returns {{Promise<Image>}}
+     */
+    resolveImageDryRun(images, timeout) {
+        return (images === null || images === void 0 ? void 0 : images.length) > 0
+            ? this.request('ResolveImageDryRun', images, { timeout: timeout })
+                .then(imageJs => Image.fromJS(imageJs))
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('images list is not defined or is empty');
+    }
+    /**
+     * Shut down a session
+     * @param sessionId the ID of the session to shut down
+     * @returns {{Promise<void>}}
+     */
+    shutdownSession(sessionId) {
+        return (sessionId === null || sessionId === void 0 ? void 0 : sessionId.length) > 0
+            ? this.request('ShutdownSession', sessionId).then(this.success()).catch(this.error())
+            : Promise.reject('sessionId is not defined');
+    }
+    /**
+     * Start a session
+     * @returns {{Promise<Session>}}
+     */
+    startSession() {
+        return this.request('StartSession')
+            .then(sessionJs => Session.fromJS(sessionJs))
+            .then(this.success())
+            .catch(this.error());
+    }
+    /**
+     * Get the session manager image.
+     * @returns {{Promise<Image>}}
+     */
+    getSessionManagerImage() {
+        return this.request('GetSessionManagerImage')
+            .then(imageJs => Image.fromJS(imageJs))
+            .then(this.success())
+            .catch(this.error());
+    }
+    /**
+     * Start a session based on an image.
+     * @param imageId
+     * @returns {{Promise<Session>}}
+     */
+    startImageSession(image) {
+        return image
+            ? this.request('StartImageSession', image)
+                .then(sessionJs => Session.fromJS(sessionJs))
+                .then(this.success())
+                .catch(this.error())
+            : Promise.reject('image is not defined');
+    }
+    /**
+     * Update the `Runner` plugin to the given version
+     * @param runnerUpdateRequest
+     * @returns {{Promise<void>}}
+     */
+    updateRunner(runnerUpdateRequest) {
+        return this.request('UpdateRunner', runnerUpdateRequest).then(this.success()).catch(this.error());
+    }
+}

package/{lib → dist/mjs}/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Result, Resource, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
@@ -23,6 +23,64 @@ export declare class SessionClient extends BaseClient {
      * @returns Subscription array: Result and Test Run subscriptions
      */
     connectSessionResults(resultHandler: (result: Result | undefined, err: NatsError | Error | null) => void, testRunHandler: (testRun: TestRun | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): [Subscription, Subscription];
+    /**
+     * @param testRunHandler Function to be called when test run or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription array: Result and Test Run subscriptions
+     */
+    connectTestRunEvents(testRunHandler: (testRun: TestRun | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the TestPlanRun events for the given test plan run ID.
+     * @param  {string} testPlanRunId
+     * @param  {(event:OnTestPlanRun|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestPlanRunEvents(testPlanRunId: string, handler: (event: OnTestPlanRun | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the test plan run logs for the given test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {(logList:LogList|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestPlanRunLogs(testPlanRunId: string, handler: (logList: LogList | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the test plan run parameter events for the given test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {(event:Parameter[]|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestPlanRunParameterEvents(testPlanRunId: string, handler: (event: Parameter[] | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the test step run events for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {(testRun:OnTestStepRun|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestStepRunEvents(testPlanRunId: string, testStepRunId: string, handler: (testStepRunId: string | undefined, testRun: OnTestStepRun | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the test step run parameters for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {(event:Parameter[]|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestStepRunParameterEvents(testPlanRunId: string, testStepRunId: string, handler: (event: Parameter[] | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to listen to the test step run results for the given test step and test plan run ID
+     * @param  {string} testPlanRunId
+     * @param  {string} testStepRunId
+     * @param  {string} resultName
+     * @param  {(result:Result|undefined,err:NatsError|Error|null)=>void} handler
+     * @param  {SubscriptionOptions} options?
+     * @returns Subscription
+     */
+    connectTestStepRunResults(testPlanRunId: string, testStepRunId: string, resultName: string, handler: (result: Result | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
     /**
      * Unsubscibe from session events
      */