feat: improved testcase readability (#176)

* Created assertion data object such that we do not have to rely on logs to file anymore
* Used the context builder to create better variable names
* Enable assertions again
* Replace try catch for exceptions by proper "rejectedWith" function from chai

I also found a bug:
The require function caches contents of files. So when we require a "constant object" from a file multiple times we are actually using the same instance. During the search process this is no problem since all tests are ran in isolation. However, the final test suite puts all the tests in the same file so the results where not consistent.

I fixed this by removing cached files in the beforeEach method of mocha.

Author: dstallenberg

libraries/analysis-javascript/lib/type/discovery/element/ElementVisitor.ts

@@ -54,13 +54,35 @@ export class ElementVisitor extends AbstractSyntaxTreeVisitor {
     const id = this._getNodeId(path);
     const bindingId = this._getBindingId(path);
 
+    // Here we check if the id is already registered (we do not allow this normally)
     if (this._elementMap.has(id)) {
+      // Export specifiers can actually have the same exported and local object
+      // e.g. export { x }
       if (
         path.parentPath.isExportSpecifier() &&
         path.parentPath.get("exported") === path
       ) {
         return;
       }
+
+      // Import specifiers can actually have the same imported and local object
+      // e.g. import { x } from '...'
+      if (
+        path.parentPath.isImportSpecifier() &&
+        path.parentPath.get("imported") === path
+      ) {
+        return;
+      }
+
+      // Object properties can actually have the same value and key object
+      // e.g. const obj = { x }
+      if (
+        path.parentPath.isObjectProperty() &&
+        path.parentPath.get("value") === path
+      ) {
+        return;
+      }
+
       throw new Error(`Overriding element with id: ${id}`);
     }
 

libraries/instrumentation-javascript/package.json

@@ -46,10 +46,10 @@
     "test:watch": "mocha --config ../../.mocharc.json --watch"
   },
   "dependencies": {
+    "@syntest/analysis-javascript": "^0.1.0-beta.21",
     "@babel/core": "7.20.12",
     "@babel/traverse": "7.20.12",
     "@istanbuljs/schema": "^0.1.3",
-    "@syntest/analysis-javascript": "^0.1.0-beta.21",
     "@syntest/ast-visitor-javascript": "*",
     "@syntest/storage": "*",
     "istanbul-lib-coverage": "^3.2.0"

libraries/search-javascript/lib/search/crossover/TreeCrossover.ts

@@ -65,20 +65,51 @@ export class TreeCrossover extends Crossover<JavaScriptTestCase> {
 
     for (const swapA of swapStatementsA) {
       for (const swapB of swapStatementsB) {
-        if (!swapA.child.classType || !swapB.child.classType) {
-          throw new Error("All statements require a classType!");
-        }
-
         if (swapA.child.variableIdentifier === swapB.child.variableIdentifier) {
           if (
-            (swapA.child instanceof ConstructorCall ||
-              swapB.child instanceof ConstructorCall ||
-              swapA.child instanceof ConstantObject ||
-              swapB.child instanceof ConstantObject) && // if one of the two is a constructorcall or constant object both need to be
-            swapA.child.classType !== swapB.child.classType
+            swapA.child instanceof ConstructorCall &&
+            !(swapB.child instanceof ConstructorCall)
+          ) {
+            continue;
+          }
+
+          if (
+            swapB.child instanceof ConstructorCall &&
+            !(swapA.child instanceof ConstructorCall)
+          ) {
+            continue;
+          }
+
+          if (
+            swapA.child instanceof ConstructorCall &&
+            swapB.child instanceof ConstructorCall &&
+            swapA.child.export.id !== swapB.child.export.id
+          ) {
+            continue;
+          }
+
+          if (
+            swapA.child instanceof ConstantObject &&
+            !(swapB.child instanceof ConstantObject)
+          ) {
+            continue;
+          }
+
+          if (
+            swapB.child instanceof ConstantObject &&
+            !(swapA.child instanceof ConstantObject)
           ) {
             continue;
           }
+
+          if (
+            swapA.child instanceof ConstantObject &&
+            swapB.child instanceof ConstantObject &&
+            swapA.child.export.id !== swapB.child.export.id
+          ) {
+            continue;
+          }
+
           crossoverOptions.push({
             parentA: swapA,
             parentB: swapB,