refactor

Author: potapovDim

bin/rerun

@@ -11,7 +11,7 @@ const argv = require('minimist')(process.argv.slice(2))
 if(argv.protractor) {
   const defaultBuilder = {
     maxSessionCount: argv.maxSessionCount || 5,
-    specRerunCount: argv.specRerunCount || 2,
+    attemptsCount: argv.attemptsCount || 2,
     stackAnalize: () => true,
     everyCycleCallback: async () => true,
     grepWord: argv.grepWord || '',

lib/commandExecutorBuilder.js

@@ -8,7 +8,7 @@ function buildCommandExecutor(failedByAssert, runOpts) {
     currentExecutionVariable,
     longestProcessTime,
     debugProcess,
-    addCommandOptionsAfterRun,
+    reformatCommand,
     stackAnalize
   } = runOpts
 
@@ -85,7 +85,7 @@ function buildCommandExecutor(failedByAssert, runOpts) {
       // stackAnalize - check that stack contains or not contains some specific data
       if(code !== 0 && stackAnalize && stackAnalize(executionStack)) {
         commandToRerun = cmd
-      } else if(code !== 0 && addCommandOptionsAfterRun) {
+      } else if(code !== 0 && reformatCommand) {
         commandToRerun = cmd
       } else {
         failedByAssert.push(cmd)
@@ -100,8 +100,8 @@ function buildCommandExecutor(failedByAssert, runOpts) {
         }
       }
 
-      if(addCommandOptionsAfterRun && commandToRerun) {
-        commandToRerun = addCommandOptionsAfterRun(commandToRerun, executionStack)
+      if(reformatCommand && commandToRerun) {
+        commandToRerun = reformatCommand(commandToRerun, executionStack)
       }
       // addSpecificOptionsBeforeRun was defined - we should remove useless opts what will be added in next iteration
       if(additionalOpts) {

lib/helpers.js

@@ -19,7 +19,7 @@ const getFormedRunCommand = (file, conf = path.resolve(process.cwd(), './protrac
   * @param {array<string>} directoryToSkip option, directories what should be exclude from files list
   * @returns {array<string>}
   */
-const getSpecFilesPath = function(dir, fileList = [], directoryToSkip = []) {
+const getFilesArray = function(dir, fileList = [], directoryToSkip = []) {
   const files = fs.readdirSync(dir)
   files.forEach(function(file) {
     const isDirr = fs.statSync(path.join(dir, file)).isDirectory()
@@ -31,7 +31,7 @@ const getSpecFilesPath = function(dir, fileList = [], directoryToSkip = []) {
     if(shouldBeExcluded) {return }
 
     if(isDirr) {
-      fileList = getSpecFilesPath(path.join(dir, file), fileList, directoryToSkip)
+      fileList = getFilesArray(path.join(dir, file), fileList, directoryToSkip)
     } else {
       fileList.push(path.join(dir, file))
     }
@@ -60,6 +60,6 @@ module.exports = {
   getFormedRunCommand,
   getPollTime,
   sleep,
-  getSpecFilesPath,
+  getFilesArray,
   returnStringType
 }

lib/index.js

@@ -1,5 +1,5 @@
 const {buildCommandExecutor} = require('./commandExecutorBuilder')
-const {sleep, getFormedRunCommand, getSpecFilesPath, getPollTime} = require('./helpers')
+const {sleep, getFormedRunCommand, getFilesArray, getPollTime} = require('./helpers')
 
 function reRunnerBuilder(runOptions) {
 
@@ -8,12 +8,12 @@ function reRunnerBuilder(runOptions) {
 
   const {
     stackAnalize,
-    specRerunCount: commandRunTriesCount,
+    attemptsCount,
     grepWord,
     debugProcess,
-    reformatCommand: addCommandOptionsAfterRun,
+    reformatCommand,
     intervalPoll,
-    everyCycleCallback: afterSingleRunCallBack,
+    everyCycleCallback,
     specsDir,
     longestProcessTime,
     formCommanWithOption: addSpecificOptionsBeforeRun,
@@ -33,20 +33,20 @@ function reRunnerBuilder(runOptions) {
     currentExecutionVariable,
     longestProcessTime,
     debugProcess,
-    addCommandOptionsAfterRun,
+    reformatCommand,
     stackAnalize
   })
 
 
   async function reRunner(commandsArray) {
     // if run arr was not defined as argument commandsArray will defined as default array
-    commandsArray = (commandsArray || getSpecFilesPath(specsDir)
+    commandsArray = (commandsArray || getFilesArray(specsDir)
       .map((file) => getFormedRunCommand(file)))
       .filter(function(cmd) {return cmd.includes(grepWord)})
 
-    const failedCommands = await new Array(commandRunTriesCount)
+    const failedCommands = await new Array(attemptsCount)
       // create array with current length
-      .fill(commandRunTriesCount)
+      .fill(attemptsCount)
       // execute run
       .reduce((resolver, /*current*/ current, index) => {
 
@@ -85,8 +85,12 @@ function reRunnerBuilder(runOptions) {
         if(currentSessionCount) {await sleep(2000)}
       } while(commands.length || currentSessionCount)
 
-      if(afterSingleRunCallBack && typeof afterSingleRunCallBack === 'function') {
-        try {await afterSingleRunCallBack()} catch(e) {console.log(e)}
+      if(everyCycleCallback && typeof everyCycleCallback === 'function') {
+        try {
+          await everyCycleCallback()
+        } catch(e) {
+          console.log(e)
+        }
       }
 
       clearInterval(asserter)
@@ -110,7 +114,7 @@ function reRunnerBuilder(runOptions) {
 module.exports = {
   buildExeRun: ({
     maxSessionCount = 5,
-    specRerunCount = 2,
+    attemptsCount = 2,
     stackAnalize,
     everyCycleCallback,
     reformatCommand,
@@ -127,7 +131,7 @@ module.exports = {
       debugProcess,
       longestProcessTime,
       maxSessionCount,
-      specRerunCount,
+      attemptsCount,
       reformatCommand,
       stackAnalize,
       grepWord,
@@ -139,6 +143,6 @@ module.exports = {
     return reRunnerBuilder(reformattedArgs)
   },
   sleep,
-  walkSync: getSpecFilesPath,
+  walkSync: getFilesArray,
   getRunCommand: getFormedRunCommand
 }

readme.md

@@ -52,7 +52,7 @@ const commandsArray = specsArr.map(filePath)
   getReruner(obj) params
   @{everyCycleCallback} function, will execute after full cycle done, before next cycle
   @{maxSessionCount} number, for example we have hub for 10 browsers, so maxSessionCount equal 10
-  @{specRerunCount} number, hom many times will reruned failed processes
+  @{attemptsCount} number, hom many times will reruned failed processes
   @{stackAnalize} function, if stack trace includes some math this process will not go to rerun scope
 */
 const cycleCB = () => console.log('Cycle done')
@@ -61,7 +61,7 @@ const stackAnalize = (stack) => !stack.includes('ASSERTION ERROR')
 const runner = getReruner({
    everyCycleCallback: cycleCB,
    maxSessionCount: 1,
-   specRerunCount: 3,
+   attemptsCount: 3,
    stackAnalize: stackAnalize,
    debugProcess: processEnv.DEBUG_PROCESS
  })

unit_specs/commandExecutorBuilder.spec.js

@@ -41,18 +41,18 @@ describe('buildCommandExecutor', () => {
     }
   })
 
-  it('addCommandOptionsAfterRun', async () => {
+  it('reformatCommand', async () => {
     const failedByAssert = []
     let holder = null
 
     const cmd = `node -e "console.log('test'); process.exit(1)"`
 
-    const addCommandOptionsAfterRun = (cmd, stack) => {
+    const reformatCommand = (cmd, stack) => {
       holder = {}
       holder.cmd = cmd
       holder.stack = stack
     }
-    const executeCommandAsync = buildCommandExecutor(failedByAssert, {addCommandOptionsAfterRun})
+    const executeCommandAsync = buildCommandExecutor(failedByAssert, {reformatCommand})
     await executeCommandAsync(cmd)
     expect(holder.cmd).to.eq(cmd)
     expect(holder.stack).to.eql('test\n')
@@ -63,7 +63,7 @@ describe('buildCommandExecutor', () => {
     let holder = null
     const cmd = `node -e "console.log('test'); process.exit(1)"`
 
-    const addCommandOptionsAfterRun = (cmd, stack) => {
+    const reformatCommand = (cmd, stack) => {
       if(!holder) holder = {}
       holder.cmd = cmd
       holder.stack = stack
@@ -74,7 +74,7 @@ describe('buildCommandExecutor', () => {
       return false
     }
     const executeCommandAsync = buildCommandExecutor(failedByAssert, {
-      addCommandOptionsAfterRun, stackAnalize
+      reformatCommand, stackAnalize
     })
     await executeCommandAsync(cmd)
     expect(holder.fromStackAnalize).to.eq('test\n')
@@ -128,7 +128,7 @@ describe('buildCommandExecutor', () => {
       return false
     }
 
-    const addCommandOptionsAfterRun = (cmd, stack) => {
+    const reformatCommand = (cmd, stack) => {
       if(!holder) holder = {}
       holder.cmd = cmd
       holder.stack = stack
@@ -137,7 +137,7 @@ describe('buildCommandExecutor', () => {
 
     const executeCommandAsync = buildCommandExecutor(failedByAssert, {
       stackAnalize,
-      addCommandOptionsAfterRun,
+      reformatCommand,
       currentExecutionVariable
     })
 

unit_specs/index.spec.js

@@ -35,23 +35,23 @@ describe('kernel', () => {
     {
       const cmd = `node -e "console.log('test'); process.exit(1)"`
       const stackAnalize = () => true
-      const specRerunCount = 15
+      const attemptsCount = 15
       const cmds = [cmd]
       const reRunner = buildExeRun({
         stackAnalize,
-        specRerunCount,
+        attemptsCount,
         currentExecutionVariable: 'CURRENT_EXECUTION_COUNT'
       })
       const failedCmds = await reRunner(cmds)
       expect(failedCmds.failedCommands.length).to.eq(1)
-      expect(failedCmds.failedCommands.every((failedCmd) => failedCmd.includes(`CURRENT_EXECUTION_COUNT=${specRerunCount - 1}`))).to.eq(true)
+      expect(failedCmds.failedCommands.every((failedCmd) => failedCmd.includes(`CURRENT_EXECUTION_COUNT=${attemptsCount - 1}`))).to.eq(true)
     }
   })
   it('formCommanWithOption', async () => {
     let holder = null
     const cmd = `node -e "console.log('test'); process.exit(1)"`
     const stackAnalize = () => true
-    const specRerunCount = 2
+    const attemptsCount = 2
     const formCommanWithOption = (cmd) => {
       return {
         cmd: `TEST_ENV=test ${cmd}`,
@@ -62,7 +62,7 @@ describe('kernel', () => {
     const reRunner = buildExeRun({
       stackAnalize,
       formCommanWithOption,
-      specRerunCount
+      attemptsCount
     })
     const failedCmds = await reRunner(cmds)
     expect(failedCmds.failedByAssert).to.eql([])