test: improved local test running (#1441)

- Added node script to add terminal aliases (helps to easily run test groups)
- Integrated mocha watch
- Removed redundant sh helper scripts
- See mochajs/mocha#5149

---------

Co-authored-by: Arya <[email protected]>

Author: kirrg001

CONTRIBUTING.md

@@ -26,15 +26,33 @@ Install the [`aws-cli`](https://docs.aws.amazon.com/cli/latest/userguide/getting
 
 ## Executing Tests Locally
 
-Some of the tests require infrastructure components (databases etc.) to run locally. The easiest way to run all required components locally is to use Docker and on top of this [Docker Compose](https://docs.docker.com/compose/). Start the script `node bin/start-test-containers.js` to run all containers (not recommended).
-
-Instead:
+Some of the tests require infrastructure components (databases etc.) to run locally. The easiest way to run required components locally is to use Docker and on top of this [Docker Compose](https://docs.docker.com/compose/). 
 
 ```sh
 node bin/start-test-containers.js --mongo --redis
 ```
 
-It's not recommended to run all tests using `bin/run-tests.sh` - it takes too long. Take a look at the root package.json and run a specific test group or run e.g. `bin/run-collector-tests.sh` with the mocha `.only` attribute.
+### Using terminal aliases
+
+Add aliases to your terminal:
+
+```sh
+node bin/add-test-aliases.js bash|zsh
+```
+
+Add a mocha `.only` on the test you would like to execute and then run the target scope:
+
+```sh
+runcollector        # Run the 'collector' scope with watch mode
+runcollector-nw     # Run the 'collector' scope without watch mode
+```
+
+### Manually
+
+```sh
+bin/run-tests.sh --scope=@instana/collector
+bin/run-tests.sh --scope=@instana/collector --watch
+```
 
 If you want to see the Node.js collector's debug output while running the tests, make sure the environment variable `WITH_STDOUT` is set to a non-empty string.
 

bin/add-test-aliases.js

@@ -0,0 +1,62 @@
+/*
+ * (c) Copyright IBM Corp. 2024
+ */
+
+'use strict';
+
+const { execSync } = require('child_process');
+const fs = require('fs');
+const os = require('os');
+
+const addAliasIfNotExists = (aliasCommand, configFile) => {
+  let fileContent = '';
+  try {
+    fileContent = fs.readFileSync(configFile, 'utf8');
+  } catch (err) {
+    console.error(`Could not read ${configFile}: ${err.message}`);
+    return;
+  }
+
+  if (!fileContent.includes(aliasCommand)) {
+    fs.appendFileSync(configFile, `\n${aliasCommand}\n`);
+    console.log(`Added alias: ${aliasCommand}`);
+  } else {
+    console.log(`Alias already exists: ${aliasCommand}`);
+  }
+};
+
+const output = execSync('lerna list --json', { encoding: 'utf-8' });
+const packages = JSON.parse(output);
+const scopeNames = packages.map(pkg => pkg.name);
+const shellArg = process.argv[2];
+
+if (!shellArg) {
+  console.error('Error: Please specify either "bash" or "zsh".');
+  process.exit(1);
+}
+
+let configFile;
+if (shellArg === 'bash') {
+  configFile = `${os.homedir()}/.bashrc`;
+} else if (shellArg === 'zsh') {
+  configFile = `${os.homedir()}/.zshrc`;
+} else {
+  console.error('Error: Invalid argument. Please specify "bash" or "zsh".');
+  process.exit(1);
+}
+
+scopeNames.forEach(scope => {
+  const cleanedScope = scope.replace('@instana/', '');
+
+  const watchAlias = `alias run${cleanedScope}='bin/run-tests.sh --scope=${scope} --watch'`;
+  const nwAlias = `alias run${cleanedScope}-nw='bin/run-tests.sh --scope=${scope}'`;
+
+  addAliasIfNotExists(watchAlias, configFile);
+  addAliasIfNotExists(nwAlias, configFile);
+});
+
+console.log('Aliases added. Please run the following command to apply the changes:');
+console.log(`  source ${configFile}`);
+console.log('Alternatively, restart your terminal.');
+
+console.log('Done');