[MDEP-979] Clean up AbstractDependencyMojoTestCase setUp

Author: Ndacyayisenga-droid

src/test/java/org/apache/maven/plugins/dependency/AbstractDependencyMojoTestCase.java

@@ -43,25 +43,62 @@ public abstract class AbstractDependencyMojoTestCase extends AbstractMojoTestCas
 
     protected DependencyArtifactStubFactory stubFactory;
 
-    protected void setUp(String testDirectoryName, boolean createFiles) throws Exception {
-        setUp(testDirectoryName, createFiles, true);
-    }
-
-    protected void setUp(String testDirectoryName, boolean createFiles, boolean flattenedPath) throws Exception {
-        // required for mojo lookups to work
+    /**
+     * Initializes the test environment by creating a temporary directory and setting up the stub factory.
+     * Subclasses must call super.setUp() in their own setUp method to ensure proper initialization.
+     * To customize the test directory name, file creation, or path structure, override getTestDirectoryName(),
+     * shouldCreateFiles(), and shouldUseFlattenedPath() respectively.
+     *
+     * @throws Exception if setup fails
+     */
+    protected void setUp() throws Exception {
+        // Required for mojo lookups to work
         super.setUp();
 
-        testDir = Files.createTempDirectory(testDirectoryName).toFile();
+        testDir = Files.createTempDirectory(getTestDirectoryName()).toFile();
         testDir.deleteOnExit();
 
-        stubFactory = new DependencyArtifactStubFactory(this.testDir, createFiles, flattenedPath);
+        stubFactory = new DependencyArtifactStubFactory(testDir, shouldCreateFiles(), shouldUseFlattenedPath());
+    }
+
+    /**
+     * Returns the name of the temporary test directory. Subclasses can override to customize.
+     *
+     * @return the test directory name
+     */
+    protected String getTestDirectoryName() {
+        return "test-dir";
+    }
+
+    /**
+     * Determines whether files should be created by the stub factory. Subclasses can override to customize.
+     *
+     * @return true if files should be created, false otherwise
+     */
+    protected boolean shouldCreateFiles() {
+        return true;
+    }
+
+    /**
+     * Determines whether the stub factory should use flattened paths. Subclasses can override to customize.
+     *
+     * @return true if flattened paths should be used, false otherwise
+     */
+    protected boolean shouldUseFlattenedPath() {
+        return true;
     }
 
+    /**
+     * Cleans up the test environment by deleting the temporary directory.
+     * Subclasses must call super.tearDown() in their own tearDown method to ensure proper cleanup.
+     *
+     * @throws Exception if cleanup fails
+     */
     @Override
     protected void tearDown() throws Exception {
         if (testDir != null) {
             FileUtils.deleteDirectory(testDir);
-            assertFalse(testDir.exists());
+            assertFalse("Test directory should not exist after cleanup", testDir.exists());
         }
         super.tearDown();
     }

src/test/java/org/apache/maven/plugins/dependency/TestCollectMojo.java

@@ -32,10 +32,21 @@
 
 public class TestCollectMojo extends AbstractDependencyMojoTestCase {
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "markers";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return false;
+    }
+
     @Override
     protected void setUp() throws Exception {
         // required for mojo lookups to work
-        super.setUp("markers", false);
+        super.setUp();
+
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());
 

src/test/java/org/apache/maven/plugins/dependency/TestGetMojo.java

@@ -47,9 +47,20 @@
 public class TestGetMojo extends AbstractDependencyMojoTestCase {
     private GetMojo mojo;
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "markers";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return false;
+    }
+
+    @Override
     protected void setUp() throws Exception {
         // required for mojo lookups to work
-        super.setUp("markers", false);
+        super.setUp();
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());
 

src/test/java/org/apache/maven/plugins/dependency/TestListClassesMojo.java

@@ -38,8 +38,19 @@
 public class TestListClassesMojo extends AbstractDependencyMojoTestCase {
     private ListClassesMojo mojo;
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "markers";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return false;
+    }
+
+    @Override
     protected void setUp() throws Exception {
-        super.setUp("markers", false);
+        super.setUp();
 
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());

src/test/java/org/apache/maven/plugins/dependency/TestPropertiesMojo.java

@@ -27,9 +27,21 @@
 import org.apache.maven.project.MavenProject;
 
 public class TestPropertiesMojo extends AbstractDependencyMojoTestCase {
+
+    @Override
+    protected String getTestDirectoryName() {
+        return "markers";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return true;
+    }
+
+    @Override
     protected void setUp() throws Exception {
         // required for mojo lookups to work
-        super.setUp("markers", true);
+        super.setUp();
 
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());

src/test/java/org/apache/maven/plugins/dependency/exclusion/AnalyzeExclusionsMojoTest.java

@@ -60,8 +60,24 @@ public class AnalyzeExclusionsMojoTest extends AbstractDependencyMojoTestCase {
     private ResolverUtil resolverUtil;
 
     @Override
-    public void setUp() throws Exception {
-        super.setUp("analyze-exclusions", true, false);
+    protected String getTestDirectoryName() {
+        return "analyze-exclusions";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return true;
+    }
+
+    @Override
+    protected boolean shouldUseFlattenedPath() {
+        return false;
+    }
+
+    @Override
+    protected void setUp() throws Exception {
+        // required for mojo lookups to work
+        super.setUp();
 
         project = new DependencyProjectStub();
         project.setName("projectName");

src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestArtifactItem.java

@@ -25,8 +25,20 @@
 
 public class TestArtifactItem extends AbstractDependencyMojoTestCase {
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "artifactItems";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return false;
+    }
+
+    @Override
     protected void setUp() throws Exception {
-        setUp("artifactItems", false);
+        // required for mojo lookups to work
+        super.setUp();
     }
 
     public void testArtifactItemConstructor() throws IOException {

src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestCopyMojo.java

@@ -38,9 +38,26 @@
 public class TestCopyMojo extends AbstractDependencyMojoTestCase {
     private CopyMojo mojo;
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "copy";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return false;
+    }
+
+    @Override
+    protected boolean shouldUseFlattenedPath() {
+        return false;
+    }
+
     @Override
     protected void setUp() throws Exception {
-        super.setUp("copy", false, false);
+        // required for mojo lookups to work
+        super.setUp();
+
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());
 

src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestIncludeExcludeUnpackMojo.java

@@ -43,9 +43,25 @@ public class TestIncludeExcludeUnpackMojo extends AbstractDependencyMojoTestCase
 
     private UnpackMojo mojo;
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "unpack";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return true;
+    }
+
+    @Override
+    protected boolean shouldUseFlattenedPath() {
+        return false;
+    }
+
+    @Override
     protected void setUp() throws Exception {
         // required for mojo lookups to work
-        super.setUp("unpack", true, false);
+        super.setUp();
 
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());

src/test/java/org/apache/maven/plugins/dependency/fromConfiguration/TestUnpackMojo.java

@@ -45,8 +45,25 @@ public class TestUnpackMojo extends AbstractDependencyMojoTestCase {
 
     UnpackMojo mojo;
 
+    @Override
+    protected String getTestDirectoryName() {
+        return "unpack";
+    }
+
+    @Override
+    protected boolean shouldCreateFiles() {
+        return true;
+    }
+
+    @Override
+    protected boolean shouldUseFlattenedPath() {
+        return false;
+    }
+
+    @Override
     protected void setUp() throws Exception {
-        super.setUp("unpack", true, false);
+        // required for mojo lookups to work
+        super.setUp();
 
         MavenProject project = new DependencyProjectStub();
         getContainer().addComponent(project, MavenProject.class.getName());