Fixed most reported issues by SonarCloud. #1492

ImLynxie · 2020-08-15T17:57:20Z

SonarCloud Issue fixes

This pull request is to resolve most of the issues that SonarCloud has picked up.

Pull request description

I've refactored most of the test cases that did not meet naming convention standards, attempted to fix the Cognitive Complexity issues within certain files, I haven't touched all of them as I was uncertain of the functionality. Mainly I've extracted parts of the original methods into their own methods to solve readability issues. I've also changed the unnecessary higher ranking access modifiers withing test cases, no changes were made to classes though, as I have no idea whether or not those methods should be used outside of the package/class itself.

…res.

ImLynxie · 2020-08-15T18:22:41Z

I've fixed an issue that was causing build failures, which regarded the order of imports within a class, that's been resolved but now there seems to be a new error causing build failures, and I don't think it has something to do directly with any of the code I've modified.

I've searched for the file that it's asking for, and it is inside the project directory.

[INFO] --- maven-install-plugin:2.4:install (default-install) @ model-view-presenter ---
[INFO] Installing C:\Users\Toxic Dreamz\Documents\Development Projects\java-design-patterns\model-view-presenter\target\model-view-presenter.jar to C:\Users\Toxic Dreamz.m2\repository\com\iluwatar\model-view-presenter\1.23.0-SNAPSHOT\model-view-presenter-1.23.0-SNAPSHOT.jar
[INFO] Installing C:\Users\Toxic Dreamz\Documents\Development Projects\java-design-patterns\model-view-presenter\pom.xml to C:\Users\Toxic Dreamz.m2\repository\com\iluwatar\model-view-presenter\1.23.0-SNAPSHOT\model-view-presenter-1.23.0-SNAPSHOT.pom
[INFO]
[INFO] --- license-maven-plugin:3.0:format (install-format) @ model-view-presenter ---
[INFO] Updating license headers...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 15.332 s
[INFO] Finished at: 2020-08-15T22:15:38+04:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal com.mycila:license-maven-plugin:3.0:format (install-format) on project model-view-presenter: Resource license-plugin-header-style.xml not found in file system, classpath or URL: no protocol: license-plugin-header-style.xml -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

iluwatar

I think at the moment build is failing due to unit test failure in Extension Objects pattern. See the attached image.

ImLynxie · 2020-08-16T18:25:39Z

Looks to me like it's a white space issue, there was a similiar whitespace issue within either the commander class or the sergeant class which caught my eye while reading to to write test cases for them, seems like I missed this one. I'll fix this right now, and push the changes.

…to fail.

ImLynxie · 2020-08-16T18:36:38Z

Issue has been fixed and pushed, I've tested the test case locally, and it has passed.

iluwatar

The build is still failing. This time it seems to be a Checkstyle issue in Unit of Work pattern.

ImLynxie · 2020-08-18T08:59:41Z

In that case, I'll just keep building until I don't run into any issues. I'll request a review after those build errors are gone.

iluwatar · 2020-08-18T16:48:21Z

You can detect Checkstyle issues faster using IDE. See instructions here: https://github.com/iluwatar/java-design-patterns/wiki/12.-IDE-instructions

ImLynxie · 2020-08-19T09:29:11Z

I am using IntelliJ IDEA, and the checkstyle issues have been resolved fully, I have built the whole project locally without errors.

ImLynxie · 2020-08-19T10:09:46Z

There is an issue that is also causing build failures but I don't exactly know of a right way to approach this.

This issue is being caused by <version></version> tags not being present within the child modules pom.xml, I'm thinking it's causing the child modules jupiter dependency to default to another version instead of using the parent modules jupiter version, this isn't the case with all modules, some seem to be just throwing these errors and some don't.

How To Recreate

Build the project with maven

Known Ways to Resolve Issue

Add <version>5.5.2</version> to the jupiter dependency within the child modules pom.xml.

Example

<dependency>
          <groupId>org.junit.jupiter</groupId>
          <artifactId>junit-jupiter-engine</artifactId>
          <version>5.5.2</version>
          <scope>test</scope>
</dependency>

iluwatar

Partial Response build fails because you are trying to mix JUnit 4 with JUnit 5. I think the current tests in that module have been written for JUnit 4. So either upgrade everything to 5 or stick with version 4.

You can detect the version from the imports. JUnit 4 imports look like this:

import static org.junit.Assert.assertEquals;
import org.junit.Before;
import org.junit.Test;

Whereas tests written for JUnit 5 have this kind of imports:

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;

ImLynxie · 2020-08-19T19:01:58Z

Unfortunately this was not the case, I've upgraded everything within that module to use JUnit 5, and it was still failing to build. The issue was being caused by an older version of the following dependency`

<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>

After changing that specific dependencies version to use version 5.4.0, the build was successful. Although I can't say if the issue was caused by mixing JUnit 4 and Junit 5, as I've only changed the version of the dependency after I upgraded everything to use JUnit 5

Fork Update

# Conflicts: # pom.xml

…es that were causing build failures.

…nto SonarCloud-Reports-Issue#1012

dirty-flag/pom.xml

partial-response/pom.xml

pom.xml

iluwatar · 2020-08-20T18:08:07Z

unit-of-work/pom.xml

+ <dependency>
+ <groupId>org.junit.jupiter</groupId>
+ <artifactId>junit-jupiter-engine</artifactId>
+ <version>5.0.0</version>


Use the one from parent pom.xml

If you would like me to use the version from the parent pom, then the version within the parent pom would have to be updated, as that version is causing build issues within this module.

The other issues have been resolved and I will not push any changes just yet, as I'd like to know if you want to open a new issue regarding updating the classes that rely on the older version of junit-jupiter-engine.

Acknowledge that. Then it's ok to leave as it is at this point. I'll create a follow-up issue to address the version problems.

iluwatar · 2020-08-21T14:33:46Z

This is part of task #1012. Created follow-up issue #1500.

iluwatar · 2020-08-21T14:34:16Z

@all-contributors please add @ToxicDreamz for code

allcontributors · 2020-08-21T14:34:28Z

@iluwatar

I've put up a pull request to add @ToxicDreamz! 🎉

iluwatar · 2020-08-21T14:36:33Z

Many thanks @ToxicDreamz for looking into this issue. Let's see how the Sonar analysis looks after merging this!

Toxic Dreamz added 2 commits August 15, 2020 21:47

Fixed most reported issues by SonarCloud.

31471ac

Fixed an issue with the order of imports that was causing build failu…

133ef52

…res.

iluwatar self-assigned this Aug 16, 2020

iluwatar added the status: under review label Aug 16, 2020

iluwatar requested changes Aug 16, 2020

View reviewed changes

Fixed a whitespace and spelling issue that was causing the test case …

57e45a3

…to fail.

ImLynxie requested a review from iluwatar August 16, 2020 19:03

iluwatar requested changes Aug 17, 2020

View reviewed changes

Fixed checkstyle errors causing build failures.

6921b0d

ImLynxie requested a review from iluwatar August 19, 2020 09:29

iluwatar requested changes Aug 19, 2020

View reviewed changes

Toxic Dreamz and others added 7 commits August 19, 2020 23:14

Fixed JUnit tests causing build issues due to mixing JUnit 4 & JUnit 5

860453b

Merge pull request #1 from iluwatar/master

60d8778

Fork Update

Merge branch 'SonarCloud-Reports-Issue#1012'

292ec5b

# Conflicts: # pom.xml

Merge branch 'master' into SonarCloud-Reports-Issue#1012

f5fddeb

Fixed pom.xml issues within the dirty-flag and partial-response modul…

c35b98b

…es that were causing build failures.

Merge remote-tracking branch 'origin/SonarCloud-Reports-Issue#1012' i…

6b5b2ac

…nto SonarCloud-Reports-Issue#1012

Fixed a test-case issue within the dirty-flag module.

885c8a6

ImLynxie requested a review from iluwatar August 19, 2020 21:31

iluwatar requested changes Aug 20, 2020

View reviewed changes

iluwatar approved these changes Aug 21, 2020

View reviewed changes

iluwatar added this to the 1.23.0 milestone Aug 21, 2020

iluwatar merged commit 0c552ef into iluwatar:master Aug 21, 2020

allcontributors bot mentioned this pull request Aug 21, 2020

docs: add ToxicDreamz as a contributor #1501

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed most reported issues by SonarCloud. #1492

Fixed most reported issues by SonarCloud. #1492

ImLynxie commented Aug 15, 2020

ImLynxie commented Aug 15, 2020

iluwatar left a comment

ImLynxie commented Aug 16, 2020

ImLynxie commented Aug 16, 2020

iluwatar left a comment

ImLynxie commented Aug 18, 2020

iluwatar commented Aug 18, 2020

ImLynxie commented Aug 19, 2020

ImLynxie commented Aug 19, 2020

iluwatar left a comment

ImLynxie commented Aug 19, 2020 •

edited

iluwatar Aug 20, 2020

ImLynxie Aug 20, 2020

ImLynxie Aug 20, 2020

iluwatar Aug 21, 2020

iluwatar commented Aug 21, 2020

iluwatar commented Aug 21, 2020

allcontributors bot commented Aug 21, 2020

iluwatar commented Aug 21, 2020

Fixed most reported issues by SonarCloud. #1492

Fixed most reported issues by SonarCloud. #1492

Conversation

ImLynxie commented Aug 15, 2020

ImLynxie commented Aug 15, 2020

iluwatar left a comment

Choose a reason for hiding this comment

ImLynxie commented Aug 16, 2020

ImLynxie commented Aug 16, 2020

iluwatar left a comment

Choose a reason for hiding this comment

ImLynxie commented Aug 18, 2020

iluwatar commented Aug 18, 2020

ImLynxie commented Aug 19, 2020

ImLynxie commented Aug 19, 2020

How To Recreate

Known Ways to Resolve Issue

Example

iluwatar left a comment

Choose a reason for hiding this comment

ImLynxie commented Aug 19, 2020 • edited

iluwatar Aug 20, 2020

Choose a reason for hiding this comment

ImLynxie Aug 20, 2020

Choose a reason for hiding this comment

ImLynxie Aug 20, 2020

Choose a reason for hiding this comment

iluwatar Aug 21, 2020

Choose a reason for hiding this comment

iluwatar commented Aug 21, 2020

iluwatar commented Aug 21, 2020

allcontributors bot commented Aug 21, 2020

iluwatar commented Aug 21, 2020

ImLynxie commented Aug 19, 2020 •

edited