End To End Test Suite extended #583

SuyDesignz · 2022-08-10T12:38:07Z

Extension Of The End To End Module

The extension of the EndToEnd tests includes the following new features/Fixes:

(Fix) Identification in json changed to SHA256 hash
(feature) extension of the comparative values as discussed in the issue End to end testing - "comparative values"
(Fix) made json more flexible to better store results per test function
current json format looks like this :

[...]
 "function_name" : "normalizationLevelTest",
  "test_results" : [ {
    "result_similarity" : 100.0,
    "result_minimal_similarity" : 100.0,
    "result_maximum_similarity" : 100.0,
    "result_matched_token_number" : 56,
    "test_identifier" : "85FF00F531A497F002D40E9C8430CB159EFC40E618925FD757E35EB2A533227E"
  },
[...]

(feature) Made adjustments to the use of paths in a mapper to be able to add languages flexibly LanguageToPathMapper.java
(feature) Create the memory tests to insert the temporary results into the memory json file. This is necessary to be able to save changes made to languages automatically so that the endToEnd tests run successfully again after a change made to the recognition.
(feature) Documentation written to the README.md. Here is a step by step guide how to create new endToEnd tests for languages
(feature) The endToEnd test for java extended
(feature) Made it possible to create a quick over all test with the help of JPlagTestSuiteHelper.java

[...]
    @Test
    void overAllTests() throws IOException, ExitException, NoSuchAlgorithmException {
        String[] testClassNames = jplagTestSuiteHelper.getAllTestFileNames();
        runJPlagTestSuite(testClassNames);
    }
[...]

For more necessary information please have a look at the README.md file.

Meeting summary

DONE:

Make adjustment to identifiktaor and use the test data names instead of the SHA256 hash
Remove the "result_similarity" field in the json file as this is composed of the max and min similarity.
View JUnit DynamicTest and its use in the OverAllTests cases.
Extend with the possibility to run other test configurations
Modify the README.md file to add the new endToEndTests

…mparativeValueExtension

… to be able to create multiple resources folders per language.

…mparativeValueExtension # Conflicts: # jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JPlagTestSuiteHelper.java # jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JsonHelper.java # jplag.endToEndTesting/src/test/java/de/jplag/end_to_end_testing/JavaEndToEndTest.java

…mparativeValueExtension

…tingComparativeValueExtension

…r language to path translation

…dTestingComparativeValueExtension

SuyDesignz · 2022-08-10T12:48:59Z

Regarding the buidl error I am already looking for the problem. Likewise, I have local problem to build the project, since the module of Scala throws reference error with me

SuyDesignz · 2022-08-10T12:55:07Z

There seems to be problem with comparing the SHA256 hashes created on my windows machine and the one created by the unix build.

dfuchss · 2022-08-10T13:02:51Z

Thats may be related to line endings (\r\n for windows \n for windows). How did you created the SHA? (In Java or Locally)

...g.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JPlagTestSuiteHelper.java

…ne ending errors

SuyDesignz · 2022-08-11T13:10:07Z

Meeting summary

Make adjustment to identifiktaor and use the test data names instead of the SHA256 hash
remove the "result_similarity" field in the json file as this is composed of the max and min similarity.
Extend with the possibility to run other test configurations.
View JUnit DynamicTest and its use in the OverAllTests cases.

SuyDesignz · 2022-08-23T08:28:20Z

@jplag/studdev can someone look over the PR so that this can be completed?

tsaglam · 2022-08-23T12:46:21Z

can someone look over the PR so that this can be completed?

@robinmaisch maybe you can review this PR and @SuyDesignz reviews your PR 594?

robinmaisch

I admit that I don't get the bigger picture from just this diff, but I tried to refactor the code to be more readable or more "common practice" (based on what I perceive as such), which more often than not was accomplished by working with Collections/Streams. I prefer them over Arrays any day, but again, that's just me.

I typed the code into this website untested, so there might be some parentheses missing or something like that. Hopefully, my suggestions are still helpful. Good job!

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/FileHelper.java

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/model/ResultDescription.java

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/FileHelper.java

jplag.endToEndTesting/src/test/java/de/jplag/end_to_end_testing/EndToEndSuiteTest.java

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/TestSuiteHelper.java

tsaglam · 2022-08-25T12:30:53Z

@SuyDesignz, please finish this PR today so it is ready to merge.

…g/helper/TestSuiteHelper.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

…g/EndToEndSuiteTest.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

…g/helper/FileHelper.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

SuyDesignz · 2022-08-25T19:34:11Z

I currently have problems to implement the new structure with the languages in the endToEnd tests. Since the languages are actually loaded automatically and this has now changed, I must first look at how I can adapt this now.

SuyDesignz · 2022-08-25T19:35:14Z

Mapper and all other functions have to be adapted now.

My current estimate is that the adjustment will take a little longer.
I did not have the change with the language on the screen.

…tingComparativeValueExtension # Conflicts: # jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JPlagTestSuiteHelper.java # jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/model/TestCaseModel.java # jplag.endToEndTesting/src/test/java/de/jplag/end_to_end_testing/JavaEndToEndTest.java

SuyDesignz · 2022-08-25T21:54:05Z

Done with the adjustments and suggested changes.

dfuchss

Some comments

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/FileHelper.java

dfuchss · 2022-08-26T07:21:37Z

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/TestSuiteHelper.java

+    /**
+     * Creates the permutation of all data contained in the passed parameters and adds it to the given path.
+     * @param fileNames for which the permutations are needed
+     * @param path to which the permutations are to be copied
+     * @return all permutations of the specified files to the path specified
+     */
+    public static List<String[]> getTestCases(String[] fileNames, Path path) {
+        ArrayList<String[]> testCases = new ArrayList<>();
+        int outerCounter = 1;
+        for (String fileName : fileNames) {
+            for (int counter = outerCounter; counter < fileNames.length; counter++) {
+                testCases.add(new String[] {Path.of(path.toAbsolutePath().toString(), fileName).toString(),
+                        Path.of(path.toAbsolutePath().toString(), fileNames[counter]).toString()});
+            }
+            outerCounter++;
+        }
+        return testCases;
+    }


I agree here. Please change that.

jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/model/ResultDescription.java

SuyDesignz · 2022-08-26T07:46:21Z

I'm not sure right now what I should change in the function?

dfuchss · 2022-08-26T08:03:42Z

I'm not sure right now what I should change in the function?

What function?

SuyDesignz · 2022-08-26T08:09:06Z

That I should change something about the function "getTestCases" in /helper/TestSuiteHelper.java

 public static List<String[]> getTestCases(String[] fileNames, Path path) {

#583 (comment)

dfuchss · 2022-08-26T08:17:46Z

That I should change something about the function "getTestCases" in /helper/TestSuiteHelper.java
 public static List<String[]> getTestCases(String[] fileNames, Path path) {
#583 (comment)

It's cleaner to use two for(int i = 0,... ) loops here; instead of using a enhanced for loop with index counter outside.

sonarcloud · 2022-08-26T08:37:12Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

86.6% Coverage
0.0% Duplication

dfuchss · 2022-08-26T08:44:44Z

@SuyDesignz did you resolved all open conversations? If so, just drop a comment here :)

SuyDesignz · 2022-08-26T08:51:14Z

@dfuchss Yes I did :) not sure why I can't close #583 (comment) but the other comments have been edited

SuyDesignz added 19 commits August 7, 2022 01:56

comparative values expanded

8089a0a

Merge branch 'feature/EndToEndTesting' into feature/endToEndTestingCo…

36bdb44

…mparativeValueExtension

adding language specific mapper for the json result paths

6616335

changed static identifier to hashCode. Resources loading made dynamic…

ab47b27

… to be able to create multiple resources folders per language.

implemented save temporary results with jackson json

36db863

Merge branch 'feature/EndToEndTesting' into feature/endToEndTestingCo…

0ec54ed

…mparativeValueExtension

saving the temporary json results for comparison implemented

5485b5f

change test identifier from an int to string as SHA256 hash

207b28f

mapper implemented for the paths

f511e61

implementation of storage testing

373342e

Merge remote-tracking branch 'origin/master' into feature/endToEndTes…

4f633d6

…tingComparativeValueExtension

insert comments and documentation for functions

87b1133

Add comments

72e4042

Code cleaned up and comments written. New mapper class implemented fo…

19b9547

…r language to path translation

removed unused code and functions

f418266

ReadMe file extended by "how to add new languages".

7e06ab4

Merge branch 'endToEndComparativeValueExtension' into feature/endToEn…

a5833bd

…dTestingComparativeValueExtension

fixed README file

ef789b7

dfuchss reviewed Aug 10, 2022

View reviewed changes

...g.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JPlagTestSuiteHelper.java Outdated Show resolved Hide resolved

dfuchss reviewed Aug 10, 2022

View reviewed changes

...g.endToEndTesting/src/main/java/de/jplag/end_to_end_testing/helper/JPlagTestSuiteHelper.java Outdated Show resolved Hide resolved

tsaglam added enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change labels Aug 10, 2022

tsaglam added this to the v4.0.0 milestone Aug 10, 2022

SuyDesignz added 2 commits August 11, 2022 03:59

Changing the json format without DefaultPrettyPrinter() to exclude li…

9249ef8

…ne ending errors

fixed formatting

71a81e9

robinmaisch reviewed Aug 23, 2022

View reviewed changes

SuyDesignz and others added 6 commits August 25, 2022 20:40

Update jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testin…

8a1fee7

…g/helper/TestSuiteHelper.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

Update jplag.endToEndTesting/src/test/java/de/jplag/end_to_end_testin…

c3c7f5d

…g/EndToEndSuiteTest.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

Update jplag.endToEndTesting/src/test/java/de/jplag/end_to_end_testin…

4c24b9d

…g/EndToEndSuiteTest.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

Update jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testin…

8b24abd

…g/helper/FileHelper.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

Update jplag.endToEndTesting/src/main/java/de/jplag/end_to_end_testin…

718c94b

…g/helper/FileHelper.java Co-authored-by: Robin Maisch <robinmaisch@users.noreply.github.com>

Change Proposed Adjustments. Improvement of the code and readability

d51f7ac

SuyDesignz added 5 commits August 25, 2022 13:35

Modified language options class included in the endToEnd testing suite

bb7316b

Changed README file

963f341

fixed result path

4e87efb

removed code smells detected by sonarcloud

b657b4e

dfuchss requested changes Aug 26, 2022

View reviewed changes

Functions improved and comments adjusted

1efbf81

SuyDesignz requested a review from dfuchss August 26, 2022 08:27

dfuchss approved these changes Aug 26, 2022

View reviewed changes

dfuchss merged commit fa07106 into jplag:master Aug 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

End To End Test Suite extended #583

End To End Test Suite extended #583

SuyDesignz commented Aug 10, 2022 •

edited

SuyDesignz commented Aug 10, 2022

SuyDesignz commented Aug 10, 2022

dfuchss commented Aug 10, 2022

SuyDesignz commented Aug 11, 2022

SuyDesignz commented Aug 23, 2022

tsaglam commented Aug 23, 2022 •

edited

robinmaisch left a comment

tsaglam commented Aug 25, 2022

SuyDesignz commented Aug 25, 2022

SuyDesignz commented Aug 25, 2022 •

edited

SuyDesignz commented Aug 25, 2022

dfuchss left a comment

dfuchss Aug 26, 2022

SuyDesignz commented Aug 26, 2022

dfuchss commented Aug 26, 2022

SuyDesignz commented Aug 26, 2022

dfuchss commented Aug 26, 2022

sonarcloud bot commented Aug 26, 2022

dfuchss commented Aug 26, 2022

SuyDesignz commented Aug 26, 2022 •

edited

End To End Test Suite extended #583

End To End Test Suite extended #583

Conversation

SuyDesignz commented Aug 10, 2022 • edited

Extension Of The End To End Module

Meeting summary

SuyDesignz commented Aug 10, 2022

SuyDesignz commented Aug 10, 2022

dfuchss commented Aug 10, 2022

SuyDesignz commented Aug 11, 2022

Meeting summary

SuyDesignz commented Aug 23, 2022

tsaglam commented Aug 23, 2022 • edited

robinmaisch left a comment

Choose a reason for hiding this comment

tsaglam commented Aug 25, 2022

SuyDesignz commented Aug 25, 2022

SuyDesignz commented Aug 25, 2022 • edited

SuyDesignz commented Aug 25, 2022

dfuchss left a comment

Choose a reason for hiding this comment

dfuchss Aug 26, 2022

Choose a reason for hiding this comment

SuyDesignz commented Aug 26, 2022

dfuchss commented Aug 26, 2022

SuyDesignz commented Aug 26, 2022

dfuchss commented Aug 26, 2022

sonarcloud bot commented Aug 26, 2022

dfuchss commented Aug 26, 2022

SuyDesignz commented Aug 26, 2022 • edited

SuyDesignz commented Aug 10, 2022 •

edited

tsaglam commented Aug 23, 2022 •

edited

SuyDesignz commented Aug 25, 2022 •

edited

SuyDesignz commented Aug 26, 2022 •

edited