Merge branch 'main' into feat/CBO

# Conflicts:
#	cost-benefit-calculator/src/test/java/org/hjug/cbc/CostBenefitCalculatorTest.java
#	effort-ranker/src/test/java/org/hjug/metrics/CBOClassParsingTest.java
#	effort-ranker/src/test/java/org/hjug/metrics/CBORuleRunnerTest.java
#	graph-data-generator/src/test/java/org/hjug/gdg/GraphDataGeneratorTest.java

Author: jimbethancourt

.github/workflows/codesee-arch-diagram.yml

@@ -1,81 +1,22 @@
+# This workflow was added by CodeSee. Learn more at https://codesee.io/
+# This is v2.0 of this workflow file
 on:
   push:
     branches:
       - main
   pull_request_target:
     types: [opened, synchronize, reopened]
 
-name: CodeSee Map
+name: CodeSee
+
+permissions: read-all
 
 jobs:
-  test_map_action:
+  codesee:
     runs-on: ubuntu-latest
     continue-on-error: true
-    name: Run CodeSee Map Analysis
+    name: Analyze the repo with CodeSee
     steps:
-      - name: checkout
-        id: checkout
-        uses: actions/checkout@v2
-        with:
-          repository: ${{ github.event.pull_request.head.repo.full_name }}
-          ref: ${{ github.event.pull_request.head.ref }}
-          fetch-depth: 0
-
-      # codesee-detect-languages has an output with id languages.
-      - name: Detect Languages
-        id: detect-languages
-        uses: Codesee-io/codesee-detect-languages-action@latest
-
-      - name: Configure JDK 16
-        uses: actions/setup-java@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).java }}
-        with:
-          java-version: '16'
-          distribution: 'zulu'
-
-      # CodeSee Maps Go support uses a static binary so there's no setup step required.
-
-      - name: Configure Node.js 14
-        uses: actions/setup-node@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).javascript }}
-        with:
-          node-version: '14'
-
-      - name: Configure Python 3.x
-        uses: actions/setup-python@v2
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).python }}
-        with:
-          python-version: '3.x'
-          architecture: 'x64'
-
-      - name: Configure Ruby '3.x'
-        uses: ruby/setup-ruby@v1
-        if: ${{ fromJSON(steps.detect-languages.outputs.languages).ruby }}
-        with:
-          ruby-version: '3.0'
-
-      # CodeSee Maps Rust support uses a static binary so there's no setup step required.
-
-      - name: Generate Map
-        id: generate-map
-        uses: Codesee-io/codesee-map-action@latest
-        with:
-          step: map
-          github_ref: ${{ github.ref }}
-          languages: ${{ steps.detect-languages.outputs.languages }}
-
-      - name: Upload Map
-        id: upload-map
-        uses: Codesee-io/codesee-map-action@latest
-        with:
-          step: mapUpload
-          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
-          github_ref: ${{ github.ref }}
-      
-      - name: Insights
-        id: insights
-        uses: Codesee-io/codesee-map-action@latest
+      - uses: Codesee-io/codesee-action@v2
         with:
-          step: insights
-          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
-          github_ref: ${{ github.ref }}
+          codesee-token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}

README.md

@@ -67,7 +67,6 @@ There is still much to be done.  Your feedback and collaboration would be greatl
 If you find this plugin useful, please star this repository and share with your friends & colleagues and on social media.
 
 ## Future Plans
-* Move from JUnit 4 to Junit 5.  Junit 5 is lacking the support for temporary files that JUnit 4 provides.
 * Add a Gradle plugin.
 * Incorporate Unit Test coverage metrics to quickly identify the safety of refactoring a God class.
 * Incorporate bug counts per God class to the Impact (Y-Axis) calculation.

change-proneness-ranker/src/test/java/org/hjug/git/ChangePronenessRankerTest.java

@@ -7,24 +7,24 @@
 import java.io.IOException;
 import java.util.*;
 import org.eclipse.jgit.api.errors.GitAPIException;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class ChangePronenessRankerTest {
 
     private ChangePronenessRanker changePronenessRanker;
     private RepositoryLogReader repositoryLogReader;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         repositoryLogReader = mock(RepositoryLogReader.class);
         changePronenessRanker = new ChangePronenessRanker(null, repositoryLogReader);
     }
 
     // TODO: this should probably be a cucumber test
     @Test
-    public void testChangePronenessCalculation() throws IOException, GitAPIException {
+    void testChangePronenessCalculation() throws IOException, GitAPIException {
         ScmLogInfo scmLogInfo = new ScmLogInfo("path", 1595275997, 0, 1);
 
         TreeMap<Integer, Integer> commitsWithChangeCounts = new TreeMap<>();
@@ -39,11 +39,11 @@ public void testChangePronenessCalculation() throws IOException, GitAPIException
         changePronenessRanker.rankChangeProneness(scmLogInfos);
 
         // 1 commit of a class we're interested in, 6 commits of other files after it
-        Assert.assertEquals((float) 1 / 7, scmLogInfo.getChangeProneness(), 0.1);
+        Assertions.assertEquals((float) 1 / 7, scmLogInfo.getChangeProneness(), 0.1);
     }
 
     @Test
-    public void testRankChangeProneness() throws IOException, GitAPIException {
+    void testRankChangeProneness() throws IOException, GitAPIException {
         ScmLogInfo scmLogInfo = new ScmLogInfo("file1", 1595275997, 0, 1);
 
         TreeMap<Integer, Integer> commitsWithChangeCounts = new TreeMap<>();
@@ -65,8 +65,8 @@ public void testRankChangeProneness() throws IOException, GitAPIException {
         changePronenessRanker.rankChangeProneness(scmLogInfos);
 
         // ranks higher since fewer commits since initial commit
-        Assert.assertEquals(2, scmLogInfo.getChangePronenessRank());
+        Assertions.assertEquals(2, scmLogInfo.getChangePronenessRank());
         // ranks lower since there have been more commits since initial commit
-        Assert.assertEquals(1, scmLogInfo2.getChangePronenessRank());
+        Assertions.assertEquals(1, scmLogInfo2.getChangePronenessRank());
     }
 }

change-proneness-ranker/src/test/java/org/hjug/git/GitLogReaderTest.java

@@ -8,32 +8,35 @@
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.lib.Repository;
 import org.eclipse.jgit.revwalk.RevCommit;
-import org.junit.*;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 
 public class GitLogReaderTest {
     // Borrowed bits and pieces from
     // https://gist.github.com/rherrmann/0c682ea327862cb6847704acf90b1d5d
 
-    @Rule
-    public TemporaryFolder tempFolder = new TemporaryFolder();
+    @TempDir
+    public File tempFolder;
 
     private Git git;
     private Repository repository;
 
-    @Before
+    @BeforeEach
     public void setUp() throws GitAPIException {
-        git = Git.init().setDirectory(tempFolder.getRoot()).call();
+        git = Git.init().setDirectory(tempFolder).call();
         repository = git.getRepository();
     }
 
-    @After
+    @AfterEach
     public void tearDown() {
         repository.close();
     }
 
     @Test
-    public void testFileLog() throws IOException, GitAPIException, InterruptedException {
+    void testFileLog() throws IOException, GitAPIException, InterruptedException {
         // This path works when referencing the full Tobago repository
         // String filePath = "tobago-core/src/main/java/org/apache/myfaces/tobago/facelets/AttributeHandler.java";
 
@@ -58,13 +61,13 @@ public void testFileLog() throws IOException, GitAPIException, InterruptedExcept
 
         ScmLogInfo scmLogInfo = gitLogReader.fileLog(repository, attributeHandler);
 
-        Assert.assertEquals(2, scmLogInfo.getCommitCount());
-        Assert.assertEquals(firstCommit.getCommitTime(), scmLogInfo.getEarliestCommit());
-        Assert.assertEquals(secondCommit.getCommitTime(), scmLogInfo.getMostRecentCommit());
+        Assertions.assertEquals(2, scmLogInfo.getCommitCount());
+        Assertions.assertEquals(firstCommit.getCommitTime(), scmLogInfo.getEarliestCommit());
+        Assertions.assertEquals(secondCommit.getCommitTime(), scmLogInfo.getMostRecentCommit());
     }
 
     @Test
-    public void testWalkFirstCommit() throws IOException, GitAPIException {
+    void testWalkFirstCommit() throws IOException, GitAPIException {
         GitLogReader gitLogReader = new GitLogReader();
 
         String attributeHandler = "AttributeHandler.java";
@@ -75,12 +78,12 @@ public void testWalkFirstCommit() throws IOException, GitAPIException {
 
         Map<Integer, Integer> result = gitLogReader.walkFirstCommit(repository, commit);
 
-        Assert.assertTrue(result.containsKey(commit.getCommitTime()));
-        Assert.assertEquals(1, result.get(commit.getCommitTime()).intValue());
+        Assertions.assertTrue(result.containsKey(commit.getCommitTime()));
+        Assertions.assertEquals(1, result.get(commit.getCommitTime()).intValue());
     }
 
     @Test
-    public void testCaptureChangCountByCommitTimestamp() throws Exception {
+    void testCaptureChangCountByCommitTimestamp() throws Exception {
         GitLogReader gitLogReader = new GitLogReader();
 
         String attributeHandler = "AttributeHandler.java";
@@ -105,8 +108,9 @@ public void testCaptureChangCountByCommitTimestamp() throws Exception {
 
         Map<Integer, Integer> commitCounts = gitLogReader.captureChangeCountByCommitTimestamp(repository);
 
-        Assert.assertEquals(1, commitCounts.get(firstCommit.getCommitTime()).intValue());
-        Assert.assertEquals(2, commitCounts.get(secondCommit.getCommitTime()).intValue());
+        Assertions.assertEquals(1, commitCounts.get(firstCommit.getCommitTime()).intValue());
+        Assertions.assertEquals(
+                2, commitCounts.get(secondCommit.getCommitTime()).intValue());
     }
 
     private void writeFile(String name, String content) throws IOException {

cost-benefit-calculator/src/test/java/org/hjug/cbc/CostBenefitCalculatorTest.java

@@ -11,30 +11,33 @@
 import org.hjug.git.GitLogReader;
 import org.hjug.metrics.GodClass;
 import org.hjug.metrics.PMDGodClassRuleRunner;
-import org.junit.*;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 
 public class CostBenefitCalculatorTest {
 
-    @Rule
-    public TemporaryFolder tempFolder = new TemporaryFolder();
+    @TempDir
+    public File tempFolder;
 
     private Git git;
     private Repository repository;
 
-    @Before
+    @BeforeEach
     public void setUp() throws GitAPIException {
-        git = Git.init().setDirectory(tempFolder.getRoot()).call();
+        git = Git.init().setDirectory(tempFolder).call();
         repository = git.getRepository();
     }
 
-    @After
+    @AfterEach
     public void tearDown() {
         repository.close();
     }
 
     @Test
-    public void testCostBenefitCalculation() throws IOException, GitAPIException, InterruptedException {
+    void testCostBenefitCalculation() throws IOException, GitAPIException, InterruptedException {
         String attributeHandler = "AttributeHandler.java";
         InputStream resourceAsStream = getClass().getClassLoader().getResourceAsStream(attributeHandler);
         writeFile(attributeHandler, convertInputStreamToString(resourceAsStream));
@@ -60,12 +63,12 @@ public void testCostBenefitCalculation() throws IOException, GitAPIException, In
         List<RankedDisharmony> disharmonies = costBenefitCalculator.calculateGodClassCostBenefitValues(
                 git.getRepository().getDirectory().getPath());
 
-        Assert.assertEquals(0, disharmonies.get(0).getRawPriority().intValue());
-        Assert.assertEquals(0, disharmonies.get(1).getRawPriority().intValue());
+        Assertions.assertEquals(0, disharmonies.get(0).getPriority().intValue());
+        Assertions.assertEquals(0, disharmonies.get(1).getPriority().intValue());
     }
 
     @Test
-    public void scanClassesInRepo2() throws IOException, GitAPIException {
+    void scanClassesInRepo2() throws IOException, GitAPIException {
         String attributeHandler = "AttributeHandler.java";
         InputStream resourceAsStream = getClass().getClassLoader().getResourceAsStream(attributeHandler);
         writeFile(attributeHandler, convertInputStreamToString(resourceAsStream));
@@ -86,11 +89,11 @@ public void scanClassesInRepo2() throws IOException, GitAPIException {
             godClassOptional.ifPresent(godClass -> godClasses.put(filePath, godClass));
         }
 
-        Assert.assertFalse(godClasses.isEmpty());
+        Assertions.assertFalse(godClasses.isEmpty());
     }
 
     @Test
-    public void scanClassesInRepo() throws IOException, GitAPIException {
+    void scanClassesInRepo() throws IOException, GitAPIException {
         String attributeHandler = "AttributeHandler.java";
         InputStream resourceAsStream = getClass().getClassLoader().getResourceAsStream(attributeHandler);
         writeFile(attributeHandler, convertInputStreamToString(resourceAsStream));
@@ -111,7 +114,7 @@ public void scanClassesInRepo() throws IOException, GitAPIException {
             godClassOptional.ifPresent(godClass -> godClasses.put(filePath, godClass));
         }
 
-        Assert.assertFalse(godClasses.isEmpty());
+        Assertions.assertFalse(godClasses.isEmpty());
     }
 
     private void writeFile(String name, String content) throws IOException {

effort-ranker/src/test/java/org/hjug/metrics/CBOClassParsingTest.java

@@ -1,29 +1,29 @@
 package org.hjug.metrics;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.util.Locale;
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class CBOClassParsingTest {
 
     private Locale defaultLocale;
 
-    @Before
+    @BeforeEach
     public void before() {
         defaultLocale = Locale.getDefault(Locale.Category.FORMAT);
         Locale.setDefault(Locale.Category.FORMAT, Locale.ENGLISH);
     }
 
-    @After
+    @AfterEach
     public void after() {
         Locale.setDefault(defaultLocale);
     }
 
     @Test
-    public void test() {
+    void test() {
         String result = "A value of 20 may denote a high amount of coupling within the class";
         CBOClass cboClass = new CBOClass("a", "a.txt", "org.hjug", result);
         assertEquals(Integer.valueOf(20), cboClass.getCouplingCount());