Add unit tests for Java, split test cases per language #42

ResistantBear · 2024-01-23T13:53:18Z

Added unit tests for basic file metrics for java source code. Also introduces a new function to reduce code duplication inside the test case. Splits the test cases of GenericParser.test.ts into multiple test files, to have one test file for each programming language.

MCC is not yet tested due to the unclear definition of that metric (see #41).

Main author @mylinhdao

Closes #40

resources/java/IfStatement.java

resources/java/RealLineOfCodeAndComments.java

resources/java/SingleCharacterClassName.java

ce-bo · 2024-01-25T14:45:03Z

resources/java/WhileAndForLoop.java

+            System.out.println("Iteration " + (counter + 1));
+            counter++;
+        }
+    }


do while,

for(var item : items),

what about Iterable.foreach(() => {}). How is this case handled e.g. in Sonar?

According to https://docs.sonarsource.com/sonarqube/latest/user-guide/metric-definitions/, SonarQube does increase the complexity by one for "if, for, while, case, &&, ||, ?, ->". That means that in your example, it would actually increase the complexity by one, but not because of the "foreach"-call itself, but because of the lambda function with the arrow operator. Calling foreach with some non-lambda function should not do anything accordingly.

I guess that whole discussion should be part of #41, however

This question is not blocking the extension of more cases for control structures in this code file.

test/parser/CSharpMetric.test.ts

test/parser/GOMetrics.test.ts

test/parser/JavaMetrics.test.ts

test/parser/TestHelper.ts

ce-bo · 2024-01-25T14:58:21Z

PTAL, in general LGTM.
Please create issue or link existing one for adding mcc tests as soon as we agree upon a metric definition.

ce-bo · 2024-01-30T12:28:03Z

I guess this is still in progress, so I moved it into the right state :-)

ResistantBear · 2024-01-31T09:44:46Z

We have encountered an issue where some tests "just fail" because of tree.rootNode being undefined when running all tests (both test.ts files and compiled .test.js files) e.g. via "npm test". This seems to be triggered by the higher number of test files or test cases in this PR, but also happened seldomly before.

As it turns out, this is probably caused by a race condition in the tree-sitter library.
See tree-sitter/node-tree-sitter#181
There is a potential fix for this linked, but it never got merged:
tree-sitter/node-tree-sitter#75

We probably cannot do anything here to handle this issue on our side...

…r.calculateMetrics()

…rity #40

… resources #40

#40

…shots

ResistantBear · 2024-02-01T16:14:01Z

We have encountered an issue where some tests "just fail" because of tree.rootNode being undefined when running all tests (both test.ts files and compiled .test.js files) e.g. via "npm test". This seems to be triggered by the higher number of test files or test cases in this PR, but also happened seldomly before.

As it turns out, this is probably caused by a race condition in the tree-sitter library. See tree-sitter/node-tree-sitter#181 There is a potential fix for this linked, but it never got merged: tree-sitter/node-tree-sitter#75

We probably cannot do anything here to handle this issue on our side...

It turned out that this issue is triggered especially if the number of test files is higher than the number of worker processes used by jest.
As a (temporal) mitigation for this issue, I reduced the number of test files by excluding the compiled .js files in the /dist/test folder from running with jest, as well as setting --maxWorkers to 24.

…AVA) #40

ResistantBear

Splitted out the issue that default statements in switch-case-blocks are counted for the complexity metric into #64
Splitted out issue caused by the race condition inside the tree-sitter library into #65

All other remarks are resolved.

mylinhdao

All remarks are solved.

ResistantBear linked an issue Jan 23, 2024 that may be closed by this pull request

Add tests for file metrics for Java #40

Closed