tests/pools/selection-strategies/worker-choice-strategy-context.test.js

   1 const { expect } = require('expect')
   2 const sinon = require('sinon')
   3 const {
   4   FixedThreadPool,
   5   DynamicThreadPool,
   6   WorkerChoiceStrategies
   7 } = require('../../../lib/index')
   8 const {
   9   WorkerChoiceStrategyContext
  10 } = require('../../../lib/pools/selection-strategies/worker-choice-strategy-context')
  11 const {
  12   RoundRobinWorkerChoiceStrategy
  13 } = require('../../../lib/pools/selection-strategies/round-robin-worker-choice-strategy')
  14 const {
  15   LessUsedWorkerChoiceStrategy
  16 } = require('../../../lib/pools/selection-strategies/less-used-worker-choice-strategy')
  17 const {
  18   LessBusyWorkerChoiceStrategy
  19 } = require('../../../lib/pools/selection-strategies/less-busy-worker-choice-strategy')
  20 const {
  21   FairShareWorkerChoiceStrategy
  22 } = require('../../../lib/pools/selection-strategies/fair-share-worker-choice-strategy')
  23 const {
  24   WeightedRoundRobinWorkerChoiceStrategy
  25 } = require('../../../lib/pools/selection-strategies/weighted-round-robin-worker-choice-strategy')
  26
  27 describe('Worker choice strategy context test suite', () => {
  28   const min = 1
  29   const max = 3
  30   let fixedPool, dynamicPool
  31
  32   before(() => {
  33     fixedPool = new FixedThreadPool(
  34       max,
  35       './tests/worker-files/thread/testWorker.js'
  36     )
  37     dynamicPool = new DynamicThreadPool(
  38       min,
  39       max,
  40       './tests/worker-files/thread/testWorker.js'
  41     )
  42   })
  43
  44   afterEach(() => {
  45     sinon.restore()
  46   })
  47
  48   after(async () => {
  49     await fixedPool.destroy()
  50     await dynamicPool.destroy()
  51   })
  52
  53   it('Verify that constructor() initializes the context with all the available worker choice strategies', () => {
  54     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
  55       fixedPool
  56     )
  57     expect(workerChoiceStrategyContext.workerChoiceStrategies.size).toBe(
  58       Object.keys(WorkerChoiceStrategies).length
  59     )
  60   })
  61
  62   it('Verify that execute() return the worker chosen by the strategy with fixed pool', () => {
  63     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
  64       fixedPool
  65     )
  66     const WorkerChoiceStrategyStub = sinon.createStubInstance(
  67       RoundRobinWorkerChoiceStrategy,
  68       {
  69         choose: sinon.stub().returns(0)
  70       }
  71     )
  72     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
  73       WorkerChoiceStrategies.ROUND_ROBIN
  74     )
  75     workerChoiceStrategyContext.workerChoiceStrategies.set(
  76       workerChoiceStrategyContext.workerChoiceStrategy,
  77       WorkerChoiceStrategyStub
  78     )
  79     const chosenWorkerKey = workerChoiceStrategyContext.execute()
  80     expect(
  81       workerChoiceStrategyContext.workerChoiceStrategies.get(
  82         workerChoiceStrategyContext.workerChoiceStrategy
  83       ).choose.calledOnce
  84     ).toBe(true)
  85     expect(chosenWorkerKey).toBe(0)
  86   })
  87
  88   it('Verify that execute() return the worker chosen by the strategy with dynamic pool', () => {
  89     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
  90       dynamicPool
  91     )
  92     const WorkerChoiceStrategyStub = sinon.createStubInstance(
  93       RoundRobinWorkerChoiceStrategy,
  94       {
  95         choose: sinon.stub().returns(0)
  96       }
  97     )
  98     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
  99       WorkerChoiceStrategies.ROUND_ROBIN
 100     )
 101     workerChoiceStrategyContext.workerChoiceStrategies.set(
 102       workerChoiceStrategyContext.workerChoiceStrategy,
 103       WorkerChoiceStrategyStub
 104     )
 105     const chosenWorkerKey = workerChoiceStrategyContext.execute()
 106     expect(
 107       workerChoiceStrategyContext.workerChoiceStrategies.get(
 108         workerChoiceStrategyContext.workerChoiceStrategy
 109       ).choose.calledOnce
 110     ).toBe(true)
 111     expect(chosenWorkerKey).toBe(0)
 112   })
 113
 114   it('Verify that setWorkerChoiceStrategy() works with ROUND_ROBIN and fixed pool', () => {
 115     const workerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
 116     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 117       fixedPool
 118     )
 119     expect(
 120       workerChoiceStrategyContext.workerChoiceStrategies.get(
 121         workerChoiceStrategy
 122       ).isDynamicPool
 123     ).toBe(false)
 124     expect(
 125       workerChoiceStrategyContext.workerChoiceStrategies.get(
 126         workerChoiceStrategy
 127       )
 128     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 129     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 130       workerChoiceStrategy
 131     )
 132     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 133     expect(
 134       workerChoiceStrategyContext.workerChoiceStrategies.get(
 135         workerChoiceStrategy
 136       )
 137     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 138     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 139       workerChoiceStrategy
 140     )
 141   })
 142
 143   it('Verify that setWorkerChoiceStrategy() works with ROUND_ROBIN and dynamic pool', () => {
 144     const workerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
 145     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 146       dynamicPool
 147     )
 148     expect(
 149       workerChoiceStrategyContext.workerChoiceStrategies.get(
 150         workerChoiceStrategy
 151       ).isDynamicPool
 152     ).toBe(true)
 153     expect(
 154       workerChoiceStrategyContext.workerChoiceStrategies.get(
 155         workerChoiceStrategy
 156       )
 157     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 158     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 159       workerChoiceStrategy
 160     )
 161     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 162     expect(
 163       workerChoiceStrategyContext.workerChoiceStrategies.get(
 164         workerChoiceStrategy
 165       )
 166     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 167     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 168       workerChoiceStrategy
 169     )
 170   })
 171
 172   it('Verify that setWorkerChoiceStrategy() works with LESS_USED and fixed pool', () => {
 173     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_USED
 174     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 175       fixedPool
 176     )
 177     expect(
 178       workerChoiceStrategyContext.workerChoiceStrategies.get(
 179         workerChoiceStrategy
 180       ).isDynamicPool
 181     ).toBe(false)
 182     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 183     expect(
 184       workerChoiceStrategyContext.workerChoiceStrategies.get(
 185         workerChoiceStrategy
 186       )
 187     ).toBeInstanceOf(LessUsedWorkerChoiceStrategy)
 188     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 189       workerChoiceStrategy
 190     )
 191   })
 192
 193   it('Verify that setWorkerChoiceStrategy() works with LESS_USED and dynamic pool', () => {
 194     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_USED
 195     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 196       dynamicPool
 197     )
 198     expect(
 199       workerChoiceStrategyContext.workerChoiceStrategies.get(
 200         workerChoiceStrategy
 201       ).isDynamicPool
 202     ).toBe(true)
 203     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 204     expect(
 205       workerChoiceStrategyContext.workerChoiceStrategies.get(
 206         workerChoiceStrategy
 207       )
 208     ).toBeInstanceOf(LessUsedWorkerChoiceStrategy)
 209     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 210       workerChoiceStrategy
 211     )
 212   })
 213
 214   it('Verify that setWorkerChoiceStrategy() works with LESS_BUSY and fixed pool', () => {
 215     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_BUSY
 216     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 217       fixedPool
 218     )
 219     expect(
 220       workerChoiceStrategyContext.workerChoiceStrategies.get(
 221         workerChoiceStrategy
 222       ).isDynamicPool
 223     ).toBe(false)
 224     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 225     expect(
 226       workerChoiceStrategyContext.workerChoiceStrategies.get(
 227         workerChoiceStrategy
 228       )
 229     ).toBeInstanceOf(LessBusyWorkerChoiceStrategy)
 230     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 231       workerChoiceStrategy
 232     )
 233   })
 234
 235   it('Verify that setWorkerChoiceStrategy() works with LESS_BUSY and dynamic pool', () => {
 236     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_BUSY
 237     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 238       dynamicPool
 239     )
 240     expect(
 241       workerChoiceStrategyContext.workerChoiceStrategies.get(
 242         workerChoiceStrategy
 243       ).isDynamicPool
 244     ).toBe(true)
 245     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 246     expect(
 247       workerChoiceStrategyContext.workerChoiceStrategies.get(
 248         workerChoiceStrategy
 249       )
 250     ).toBeInstanceOf(LessBusyWorkerChoiceStrategy)
 251     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 252       workerChoiceStrategy
 253     )
 254   })
 255
 256   it('Verify that setWorkerChoiceStrategy() works with FAIR_SHARE and fixed pool', () => {
 257     const workerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 258     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 259       fixedPool
 260     )
 261     expect(
 262       workerChoiceStrategyContext.workerChoiceStrategies.get(
 263         workerChoiceStrategy
 264       ).isDynamicPool
 265     ).toBe(false)
 266     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 267     expect(
 268       workerChoiceStrategyContext.workerChoiceStrategies.get(
 269         workerChoiceStrategy
 270       )
 271     ).toBeInstanceOf(FairShareWorkerChoiceStrategy)
 272     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 273       workerChoiceStrategy
 274     )
 275   })
 276
 277   it('Verify that setWorkerChoiceStrategy() works with FAIR_SHARE and dynamic pool', () => {
 278     const workerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 279     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 280       dynamicPool
 281     )
 282     expect(
 283       workerChoiceStrategyContext.workerChoiceStrategies.get(
 284         workerChoiceStrategy
 285       ).isDynamicPool
 286     ).toBe(true)
 287     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 288     expect(
 289       workerChoiceStrategyContext.workerChoiceStrategies.get(
 290         workerChoiceStrategy
 291       )
 292     ).toBeInstanceOf(FairShareWorkerChoiceStrategy)
 293     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 294       workerChoiceStrategy
 295     )
 296   })
 297
 298   it('Verify that setWorkerChoiceStrategy() works with WEIGHTED_ROUND_ROBIN and fixed pool', () => {
 299     const workerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 300     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 301       fixedPool
 302     )
 303     expect(
 304       workerChoiceStrategyContext.workerChoiceStrategies.get(
 305         workerChoiceStrategy
 306       ).isDynamicPool
 307     ).toBe(false)
 308     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 309     expect(
 310       workerChoiceStrategyContext.workerChoiceStrategies.get(
 311         workerChoiceStrategy
 312       )
 313     ).toBeInstanceOf(WeightedRoundRobinWorkerChoiceStrategy)
 314     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 315       workerChoiceStrategy
 316     )
 317   })
 318
 319   it('Verify that setWorkerChoiceStrategy() works with WEIGHTED_ROUND_ROBIN and dynamic pool', () => {
 320     const workerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 321     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 322       dynamicPool
 323     )
 324     expect(
 325       workerChoiceStrategyContext.workerChoiceStrategies.get(
 326         workerChoiceStrategy
 327       ).isDynamicPool
 328     ).toBe(true)
 329     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 330     expect(
 331       workerChoiceStrategyContext.workerChoiceStrategies.get(
 332         workerChoiceStrategy
 333       )
 334     ).toBeInstanceOf(WeightedRoundRobinWorkerChoiceStrategy)
 335     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 336       workerChoiceStrategy
 337     )
 338   })
 339
 340   it.only('Verify that worker choice strategy options enable median run time pool statistics', () => {
 341     const wwrWorkerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 342     let workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 343       fixedPool,
 344       wwrWorkerChoiceStrategy,
 345       {
 346         medRunTime: true
 347       }
 348     )
 349     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 350       false
 351     )
 352     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 353       true
 354     )
 355     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 356       dynamicPool,
 357       wwrWorkerChoiceStrategy,
 358       {
 359         medRunTime: true
 360       }
 361     )
 362     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 363       false
 364     )
 365     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 366       true
 367     )
 368     const fsWorkerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 369     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 370       fixedPool,
 371       fsWorkerChoiceStrategy,
 372       {
 373         medRunTime: true
 374       }
 375     )
 376     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 377       false
 378     )
 379     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 380       true
 381     )
 382     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 383       dynamicPool,
 384       fsWorkerChoiceStrategy,
 385       {
 386         medRunTime: true
 387       }
 388     )
 389     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 390       false
 391     )
 392     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 393       true
 394     )
 395   })
 396 })