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')
   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       )
 123     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 124     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 125       workerChoiceStrategy
 126     )
 127     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 128     expect(
 129       workerChoiceStrategyContext.workerChoiceStrategies.get(
 130         workerChoiceStrategy
 131       )
 132     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 133     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 134       workerChoiceStrategy
 135     )
 136   })
 137
 138   it('Verify that setWorkerChoiceStrategy() works with ROUND_ROBIN and dynamic pool', () => {
 139     const workerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
 140     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 141       dynamicPool
 142     )
 143     expect(
 144       workerChoiceStrategyContext.workerChoiceStrategies.get(
 145         workerChoiceStrategy
 146       )
 147     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 148     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 149       workerChoiceStrategy
 150     )
 151     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 152     expect(
 153       workerChoiceStrategyContext.workerChoiceStrategies.get(
 154         workerChoiceStrategy
 155       )
 156     ).toBeInstanceOf(RoundRobinWorkerChoiceStrategy)
 157     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 158       workerChoiceStrategy
 159     )
 160   })
 161
 162   it('Verify that setWorkerChoiceStrategy() works with LESS_USED and fixed pool', () => {
 163     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_USED
 164     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 165       fixedPool
 166     )
 167     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 168     expect(
 169       workerChoiceStrategyContext.workerChoiceStrategies.get(
 170         workerChoiceStrategy
 171       )
 172     ).toBeInstanceOf(LessUsedWorkerChoiceStrategy)
 173     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 174       workerChoiceStrategy
 175     )
 176   })
 177
 178   it('Verify that setWorkerChoiceStrategy() works with LESS_USED and dynamic pool', () => {
 179     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_USED
 180     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 181       dynamicPool
 182     )
 183     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 184     expect(
 185       workerChoiceStrategyContext.workerChoiceStrategies.get(
 186         workerChoiceStrategy
 187       )
 188     ).toBeInstanceOf(LessUsedWorkerChoiceStrategy)
 189     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 190       workerChoiceStrategy
 191     )
 192   })
 193
 194   it('Verify that setWorkerChoiceStrategy() works with LESS_BUSY and fixed pool', () => {
 195     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_BUSY
 196     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 197       fixedPool
 198     )
 199     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 200     expect(
 201       workerChoiceStrategyContext.workerChoiceStrategies.get(
 202         workerChoiceStrategy
 203       )
 204     ).toBeInstanceOf(LessBusyWorkerChoiceStrategy)
 205     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 206       workerChoiceStrategy
 207     )
 208   })
 209
 210   it('Verify that setWorkerChoiceStrategy() works with LESS_BUSY and dynamic pool', () => {
 211     const workerChoiceStrategy = WorkerChoiceStrategies.LESS_BUSY
 212     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 213       dynamicPool
 214     )
 215     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 216     expect(
 217       workerChoiceStrategyContext.workerChoiceStrategies.get(
 218         workerChoiceStrategy
 219       )
 220     ).toBeInstanceOf(LessBusyWorkerChoiceStrategy)
 221     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 222       workerChoiceStrategy
 223     )
 224   })
 225
 226   it('Verify that setWorkerChoiceStrategy() works with FAIR_SHARE and fixed pool', () => {
 227     const workerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 228     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 229       fixedPool
 230     )
 231     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 232     expect(
 233       workerChoiceStrategyContext.workerChoiceStrategies.get(
 234         workerChoiceStrategy
 235       )
 236     ).toBeInstanceOf(FairShareWorkerChoiceStrategy)
 237     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 238       workerChoiceStrategy
 239     )
 240   })
 241
 242   it('Verify that setWorkerChoiceStrategy() works with FAIR_SHARE and dynamic pool', () => {
 243     const workerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 244     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 245       dynamicPool
 246     )
 247     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 248     expect(
 249       workerChoiceStrategyContext.workerChoiceStrategies.get(
 250         workerChoiceStrategy
 251       )
 252     ).toBeInstanceOf(FairShareWorkerChoiceStrategy)
 253     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 254       workerChoiceStrategy
 255     )
 256   })
 257
 258   it('Verify that setWorkerChoiceStrategy() works with WEIGHTED_ROUND_ROBIN and fixed pool', () => {
 259     const workerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 260     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 261       fixedPool
 262     )
 263     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 264     expect(
 265       workerChoiceStrategyContext.workerChoiceStrategies.get(
 266         workerChoiceStrategy
 267       )
 268     ).toBeInstanceOf(WeightedRoundRobinWorkerChoiceStrategy)
 269     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 270       workerChoiceStrategy
 271     )
 272   })
 273
 274   it('Verify that setWorkerChoiceStrategy() works with WEIGHTED_ROUND_ROBIN and dynamic pool', () => {
 275     const workerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 276     const workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 277       dynamicPool
 278     )
 279     workerChoiceStrategyContext.setWorkerChoiceStrategy(workerChoiceStrategy)
 280     expect(
 281       workerChoiceStrategyContext.workerChoiceStrategies.get(
 282         workerChoiceStrategy
 283       )
 284     ).toBeInstanceOf(WeightedRoundRobinWorkerChoiceStrategy)
 285     expect(workerChoiceStrategyContext.workerChoiceStrategy).toBe(
 286       workerChoiceStrategy
 287     )
 288   })
 289
 290   it('Verify that worker choice strategy options enable median run time pool statistics', () => {
 291     const wwrWorkerChoiceStrategy = WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
 292     let workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 293       fixedPool,
 294       wwrWorkerChoiceStrategy,
 295       {
 296         medRunTime: true
 297       }
 298     )
 299     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 300       false
 301     )
 302     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 303       true
 304     )
 305     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 306       dynamicPool,
 307       wwrWorkerChoiceStrategy,
 308       {
 309         medRunTime: true
 310       }
 311     )
 312     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 313       false
 314     )
 315     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 316       true
 317     )
 318     const fsWorkerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
 319     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 320       fixedPool,
 321       fsWorkerChoiceStrategy,
 322       {
 323         medRunTime: true
 324       }
 325     )
 326     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 327       false
 328     )
 329     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 330       true
 331     )
 332     workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
 333       dynamicPool,
 334       fsWorkerChoiceStrategy,
 335       {
 336         medRunTime: true
 337       }
 338     )
 339     expect(workerChoiceStrategyContext.getRequiredStatistics().avgRunTime).toBe(
 340       false
 341     )
 342     expect(workerChoiceStrategyContext.getRequiredStatistics().medRunTime).toBe(
 343       true
 344     )
 345   })
 346 })