test: cleanup tests description
authorJérôme Benoit <jerome.benoit@sap.com>
Fri, 14 Apr 2023 20:13:32 +0000 (22:13 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Fri, 14 Apr 2023 20:13:32 +0000 (22:13 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/pool.ts
tests/pools/cluster/fixed.test.js
tests/pools/thread/fixed.test.js
tests/worker/abstract-worker.test.js
tests/worker/cluster-worker.test.js
tests/worker/thread-worker.test.js

index 5c90ff77c8b3e62ea444bbb998f03ec53937dc1f..f7f4e4e5d354791e05b8aee2511f1f5d06354318 100644 (file)
@@ -152,7 +152,7 @@ export interface IPool<
    */
   findFreeWorkerNodeKey: () => number
   /**
-   * Performs the task specified in the constructor with the data parameter.
+   * Execute the function specified in the constructor with the task data parameter.
    *
    * @param data - The input for the specified task. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
index 4aaa57c750920944e6cf2c4ed02f43104cb12fa0..d84c2c5c3f727e6b639a7c5eca00941931fae6ca 100644 (file)
@@ -72,7 +72,7 @@ describe('Fixed cluster pool test suite', () => {
     expect(result).toBe(false)
   })
 
-  it('Verify that is possible to invoke the execute method without input', async () => {
+  it('Verify that is possible to invoke the execute() method without input', async () => {
     const result = await pool.execute()
     expect(result).toBe(false)
   })
index 6cccd6dbc6dd76166710e422f990372d9879649a..f2b36fa7d9eeb617919c86dcdbbf1d797f7e777e 100644 (file)
@@ -72,7 +72,7 @@ describe('Fixed thread pool test suite', () => {
     expect(result).toBe(false)
   })
 
-  it('Verify that is possible to invoke the execute method without input', async () => {
+  it('Verify that is possible to invoke the execute() method without input', async () => {
     const result = await pool.execute()
     expect(result).toBe(false)
   })
index 2eae1f81bfdc0251d416882ec1d1b3eb15d2bc51..b62ba9425e1289fb8afc6361edc32f2be2ca9531 100644 (file)
@@ -49,13 +49,13 @@ describe('Abstract worker test suite', () => {
     )
   })
 
-  it('Verify that handleError function is working properly', () => {
+  it('Verify that handleError() method is working properly', () => {
     const error = new Error('My error')
     const worker = new ThreadWorker(() => {})
     expect(worker.handleError(error)).toStrictEqual(error)
   })
 
-  it('Verify that get main worker throw error if main worker is not set', () => {
+  it('Verify that getMainWorker() throw error if main worker is not set', () => {
     expect(() =>
       new StubPoolWithIsMainWorker(() => {}).getMainWorker()
     ).toThrowError('Main worker was not set')
index ff749c8f721f964762c144ece84a7933711367fa..f026862d033838c837523f4547e7b1cb078fde2e 100644 (file)
@@ -7,7 +7,7 @@ describe('Cluster worker test suite', () => {
     expect(worker.opts.maxInactiveTime).toStrictEqual(60000)
   })
 
-  it('Verify that handleError function works properly', () => {
+  it('Verify that handleError() method works properly', () => {
     const errorMessage = 'Error as a string'
     const worker = new ClusterWorker(() => {})
     expect(worker.handleError(errorMessage)).toStrictEqual(errorMessage)
index 624e395c04f80cb752adc73f8e95d84b19300dab..ff3cbff3f53e07d461f101b2e85098b06303aa5d 100644 (file)
@@ -17,7 +17,7 @@ describe('Thread worker test suite', () => {
     expect(worker.opts.maxInactiveTime).toStrictEqual(60000)
   })
 
-  it('Verify worker invoke the getMainWorker and postMessage methods', () => {
+  it('Verify worker invoke the getMainWorker() and postMessage() methods', () => {
     const worker = new SpyWorker(() => {})
     worker.sendToMainWorker({ ok: 1 })
     expect(numberOfMessagesPosted).toBe(1)