addressed PR change requests

Author: yweber

.gitignore

@@ -7,5 +7,4 @@ build/
 
 .DS_Store
 .java-version
-/junit4/src/test/resources/maven-extension/target/
-/junit5/src/test/resources/maven-extension/target/
+target/

core/build.gradle

@@ -16,11 +16,14 @@ dependencies {
     implementation group: 'org.jboss.shrinkwrap', name: 'shrinkwrap-impl-base', version: shrinkWrapVersion
     implementation group: 'net.lingala.zip4j', name: 'zip4j', version: zip4jVersion
 
+    /*  This dependency needs to be explicitly added, because shrinkwrap-resolver-api-maven-embedded
+        and shrinkwrap-resolver-impl-maven-embedded depend on different versions of it.
+        This would lead to issues when the HiveMQ Testcontainer is included in maven projects. */
     implementation group: 'org.codehaus.plexus', name: 'plexus-utils', version: '3.2.1'
-    implementation (group: 'org.jboss.shrinkwrap.resolver', name: 'shrinkwrap-resolver-api-maven-embedded', version: shrinkwrapResolverDepchainVersion) {
+    implementation(group: 'org.jboss.shrinkwrap.resolver', name: 'shrinkwrap-resolver-api-maven-embedded', version: shrinkwrapResolverDepchainVersion) {
         exclude group: 'org.codehouse.plexus', module: 'plexus-utils'
     }
-    runtimeOnly (group: 'org.jboss.shrinkwrap.resolver', name: 'shrinkwrap-resolver-impl-maven-embedded', version: shrinkwrapResolverDepchainVersion) {
+    runtimeOnly(group: 'org.jboss.shrinkwrap.resolver', name: 'shrinkwrap-resolver-impl-maven-embedded', version: shrinkwrapResolverDepchainVersion) {
         exclude group: 'org.codehouse.plexus', module: 'plexus-utils'
     }
 

core/src/main/java/com/hivemq/testcontainer/core/HiveMQTestContainerCore.java

@@ -377,6 +377,7 @@ private void putSubclassesIntoJar(
      * @param extensionDirectory the name of the extension's directory
      * @param timeout the timeout
      * @return self
+     * @since 1.1.0
      */
     public @NotNull SELF disableExtension(
             final @NotNull String extensionName,
@@ -417,6 +418,7 @@ private void putSubclassesIntoJar(
      * @param extensionName the name of the extension to disable
      * @param extensionDirectory the name of the extension's directory
      * @return self
+     * @since 1.1.0
      */
     public @NotNull SELF disableExtension(
             final @NotNull String extensionName,
@@ -466,6 +468,7 @@ private void putSubclassesIntoJar(
      * @param extensionDirectory the name of the extension's directory
      * @param timeout the timeout
      * @return self
+     * @since 1.1.0
      */
     public @NotNull SELF enableExtension(
             final @NotNull String extensionName,
@@ -506,6 +509,7 @@ private void putSubclassesIntoJar(
      * @param extensionName the name of the extension to disable
      * @param extensionDirectory the name of the extension's directory
      * @return self
+     * @since 1.1.0
      */
     public @NotNull SELF enableExtension(
             final @NotNull String extensionName,

core/src/main/java/com/hivemq/testcontainer/core/MavenHiveMQExtensionSupplier.java

@@ -30,6 +30,7 @@
  * This class automates the process of packaging a HiveMQ extension from a maven project.
  *
  * @author Yannick Weber
+ * @since 1.1.0
  */
 public class MavenHiveMQExtensionSupplier implements Supplier<File> {
 
@@ -40,6 +41,7 @@ public class MavenHiveMQExtensionSupplier implements Supplier<File> {
      * It uses the pom.xml file of the current maven project.
      *
      * @return a {@link MavenHiveMQExtensionSupplier} for the current maven project
+     * @since 1.1.0
      */
     public static @NotNull MavenHiveMQExtensionSupplier direct() {
         return new MavenHiveMQExtensionSupplier("pom.xml");
@@ -49,6 +51,7 @@ public class MavenHiveMQExtensionSupplier implements Supplier<File> {
      * Creates a Maven HiveMQ extension {@link Supplier}.
      *
      * @param pomFile the path of the pom.xml of the HiveMQ extension to supply.
+     * @since 1.1.0
      */
     public MavenHiveMQExtensionSupplier(final @NotNull String pomFile) {
         this.pomFile = pomFile;
@@ -58,6 +61,7 @@ public MavenHiveMQExtensionSupplier(final @NotNull String pomFile) {
      * Packages the HiveMQ extension, copies it to a temporary directory and returns the directory as a {@link File}.
      *
      * @return the {@link File} of the packaged HiveMQ extension
+     * @since 1.1.0
      */
     @Override
     public @NotNull File get() {

readme.md

@@ -150,7 +150,7 @@ You can define a custom image and tag in the constructor:
 ### JUnit 5
 
     @RegisterExtension
-    final @NotNull HiveMQTestContainerExtension rule = 
+    final @NotNull HiveMQTestContainerExtension extension = 
         new HiveMQTestContainerExtension("hivemq/hivemq4", "latest")
             .withHiveMQConfig(new File("src/test/resources/config.xml"));
             
@@ -268,8 +268,6 @@ Note that disabling or enabling of extension during runtime is only supported in
         extension.disableExtension(hiveMQExtension);
     }
 
-It is possible to enable and disable extensions that are loaded from a file by providing their directory name and extension name:
-
 ## Enable/Disable an extension loaded from a folder
 
 You can enable or disable extensions loaded from an extension folder during runtime.