feat: shuffle test suite order in run command (#5051)

Author: NivYarmus

bin/codecept.js

@@ -164,6 +164,7 @@ program
   .option('--tests', 'run only JS test files and skip features')
   .option('--no-timeouts', 'disable all timeouts')
   .option('-p, --plugins <k=v,k2=v2,...>', 'enable plugins, comma-separated')
+  .option('--shuffle', 'Shuffle the order in which test files run')
 
   // mocha options
   .option('--colors', 'force enabling of colors')

docs/commands.md

@@ -47,6 +47,12 @@ Run single test with steps printed
 npx codeceptjs run github_test.js --steps
 ```
 
+Run test files in shuffled order
+
+```sh
+npx codeceptjs run --shuffle
+```
+
 Run single test in debug mode (see more in [debugging](#Debugging) section)
 
 ```sh

lib/codecept.js

@@ -1,5 +1,6 @@
 const { existsSync, readFileSync } = require('fs')
 const { globSync } = require('glob')
+const shuffle = require('lodash.shuffle')
 const fsPath = require('path')
 const { resolve } = require('path')
 
@@ -180,6 +181,10 @@ class Codecept {
         })
       }
     }
+
+    if (this.opts.shuffle) {
+      this.testFiles = shuffle(this.testFiles)
+    }
   }
 
   /**

package.json

@@ -103,6 +103,7 @@
     "joi": "17.13.3",
     "js-beautify": "1.15.4",
     "lodash.clonedeep": "4.5.0",
+    "lodash.shuffle": "4.2.0",
     "lodash.merge": "4.6.2",
     "mkdirp": "3.0.1",
     "mocha": "11.6.0",