test: add random test sequencer (#184)

Signed-off-by: Jeffrey Tang <[email protected]>

Author: JeffreyDallas

DEV.md

@@ -23,3 +23,10 @@ Below we describe how you can set up local environment and contribute to `solo`.
 * In order to run E2E test, we need to set up cluster and install the chart.
   * Run `./test/e2e/setup-e2e.sh`
   * Run `npm run test-e2e`
+
+* Tests are run in random order. The random seed value is shown as message such as:
+`Using timestamp seed 1711414247085 for random test order`
+
+* If you like to rerun tests with the same seed, use environment variable `RANDOM_SEED=<integer_number>` with `npm run test-e2e` command.
+  * Example: `RANDOM_SEED=20 npm run test-e2e`, 
+  and you should see an output like: `Using preset seed 20 for random test order`

jest.config.mjs

@@ -21,7 +21,8 @@ const config = {
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(mjs?)$',
   moduleFileExtensions: ['js', 'mjs'],
   verbose: true,
-  reporters: ['default', 'jest-junit']
+  reporters: ['default', 'jest-junit'],
+  testSequencer: './test/testSequencer.mjs'
 }
 
 export default config

package-lock.json

@@ -50,6 +50,7 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
+    "@jest/test-sequencer": "^29.7.0",
     "eslint": "^8.57.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-headers": "^1.1.2",
@@ -64,7 +65,8 @@
     "remark-lint-list-item-indent": "^3.1.2",
     "remark-lint-unordered-list-marker-style": "^3.1.2",
     "remark-preset-lint-consistent": "^5.1.2",
-    "remark-preset-lint-recommended": "^6.1.3"
+    "remark-preset-lint-recommended": "^6.1.3",
+    "seedrandom": "^3.0.5"
   },
   "repository": {
     "type": "git",

package.json

@@ -0,0 +1,42 @@
+/**
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the ""License"");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an ""AS IS"" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+import Sequencer from '@jest/test-sequencer'
+import Seedrandom from 'seedrandom'
+import { NewLogger } from '../src/core/logging.mjs'
+import chalk from 'chalk'
+
+export default class testSequencer extends Sequencer.default {
+  logger = NewLogger('debug')
+  sort (tests) {
+    // get value of environment variable RANDOM_SEED if it is set
+    // or use current timestamp
+    let seed
+    if (process.env.RANDOM_SEED) {
+      seed = process.env.RANDOM_SEED
+      this.logger.showUser(chalk.green(`Using preset seed ${seed} for random test order`))
+    } else {
+      seed = new Date().getTime().toString()
+      this.logger.showUser(chalk.green(`Using timestamp seed ${seed} for random test order`))
+    }
+
+    const randomNumGenerator = new Seedrandom(seed)
+    const copyTests = Array.from(tests)
+
+    // use randomNumGenerator.int32() to generate random even or odd nuber
+    return copyTests.sort((testA, testB) => (randomNumGenerator.int32() % 2 === 0 ? -1 : 1))
+  }
+}