Rename maven plugin goal names

Author: ilyavy

README.md

@@ -6,9 +6,9 @@
 [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=pepperkit_git-hooks-maven-plugin&metric=security_rating)](https://sonarcloud.io/dashboard?id=pepperkit_git-hooks-maven-plugin)
 
 Maven plugin for easy git hooks configuration. Provides three goals to work with git hooks:
-1. `init` - installs configured git hooks;
-2. `validate` - prints all or specific hooks installed at the moment, to make sure that the plugin was configured correctly;
-3. `test` - executes all or specific hooks installed at the moment, to make sure that the hooks work as expected, 
+1. `initHooks` - installs configured git hooks;
+2. `printHooks` - prints all or specific hooks installed at the moment, to make sure that the plugin was configured correctly;
+3. `executeHooks` - executes all or specific hooks installed at the moment, to make sure that the hooks work as expected, 
    without the need to actually trigger the hook with git action.
 
 ## Usage
@@ -26,7 +26,7 @@ The example with *pre-commit* and *pre-push* hooks configured, will look like it
             <!-- It will automatically trigger `init` goal at each initialize project maven phase. -->
             <execution>
                 <goals>
-                    <goal>init</goal>
+                    <goal>initHooks</goal>
                 </goals>
             </execution>
         </executions>
@@ -44,11 +44,11 @@ Hook's content is any command line script, which is considered successful if exi
 If execution of the script is successful, git action will be proceeded, if not - it will be cancelled.
 
 Then you can execute one of the following goals manually:
-1. `mvn io.github.pepperkit:git-hooks-maven-plugin:init` - to manually install configured git hooks;
-2. `mvn io.github.pepperkit:git-hooks-maven-plugin:validate` - print all the installed hooks to the console;
-3. `mvn -DhookName=<hookName> io.github.pepperkit:git-hooks-maven-plugin:validate` - print only the specified hook;
-4. `mvn io.github.pepperkit:git-hooks-maven-plugin:test` - execute all the installed hooks;
-5. `mvn -DhookName=<hookName> io.github.pepperkit:git-hooks-maven-plugin:test` - execute only the specified hook.
+1. `mvn io.github.pepperkit:git-hooks-maven-plugin:initHooks` - to manually install configured git hooks;
+2. `mvn io.github.pepperkit:git-hooks-maven-plugin:printHooks` - print all the installed hooks to the console;
+3. `mvn -DhookName=<hookName> io.github.pepperkit:git-hooks-maven-plugin:printHooks` - print only the specified hook;
+4. `mvn io.github.pepperkit:git-hooks-maven-plugin:executeHooks` - execute all the installed hooks;
+5. `mvn -DhookName=<hookName> io.github.pepperkit:git-hooks-maven-plugin:executeHooks` - execute only the specified hook.
 
 ## Project's structure
 ```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>io.github.pepperkit</groupId>
     <artifactId>git-hooks-maven-plugin</artifactId>
-    <version>0.9.0-SNAPSHOT</version>
+    <version>1.0.0-SNAPSHOT</version>
     <packaging>maven-plugin</packaging>
     <name>Git Hooks Maven Plugin</name>
     <description>Maven plugin, which enables control on git hooks via easy configuration.</description>

src/main/java/io/github/pepperkit/githooks/TestMojo.java renamed to src/main/java/io/github/pepperkit/githooks/ExecuteHooksMojo.java

@@ -15,8 +15,8 @@
  * Executes all or specific hooks installed at the moment, to make sure that the hooks work as expected,
  * without the need to actually trigger the hook with git action.
  */
-@Mojo(name = "test")
-public class TestMojo extends AbstractMojo {
+@Mojo(name = "executeHooks")
+public class ExecuteHooksMojo extends AbstractMojo {
 
     /**
      * The name of the hook to be tested. If not provided, all the hooks will be tested.

src/main/java/io/github/pepperkit/githooks/GitHooksActionProcessor.java

@@ -39,7 +39,7 @@ static void processHooks(GitHooksAction action, String hookName, Log logger) thr
                 }
                 if (hooksProcessed == 0) {
                     logger.info("No hooks are configured. Make sure you have correctly configured plugin "
-                            + "and ran init goal first to install the hooks.");
+                            + "and ran initHooks goal first to install the hooks.");
                 }
             } else {
                 hookNameBeingProcessed = hookName;

src/main/java/io/github/pepperkit/githooks/InitMojo.java renamed to src/main/java/io/github/pepperkit/githooks/InitHooksMojo.java

@@ -20,8 +20,8 @@
 /**
  * The main Mojo, installs configured git hooks.
  */
-@Mojo(name = "init", defaultPhase = LifecyclePhase.INITIALIZE)
-public class InitMojo extends AbstractMojo {
+@Mojo(name = "initHooks", defaultPhase = LifecyclePhase.INITIALIZE)
+public class InitHooksMojo extends AbstractMojo {
 
     /**
      * Hooks configured by the user.

src/main/java/io/github/pepperkit/githooks/ValidateMojo.java renamed to src/main/java/io/github/pepperkit/githooks/PrintHooksMojo.java

@@ -14,8 +14,8 @@
 /**
  * Prints all or specific hooks installed at the moment, to make sure that the plugin was configured correctly.
  */
-@Mojo(name = "validate")
-public class ValidateMojo extends AbstractMojo {
+@Mojo(name = "printHooks")
+public class PrintHooksMojo extends AbstractMojo {
 
     /**
      * The name of the hook to be validated. If not provided, all the hooks will be validated.

src/system-test/java/io/github/pepperkit/githooks/steps/BaseMojoSysTest.java

@@ -11,20 +11,20 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.startupcheck.IsRunningStartupCheckStrategy;
 import org.testcontainers.images.builder.ImageFromDockerfile;
-import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 @Testcontainers
 public class BaseMojoSysTest {
 
     public static org.testcontainers.containers.Container.ExecResult cmdResult;
 
-    public static GenericContainer<?> container = new GenericContainer<>(new ImageFromDockerfile()
-            .withFileFromPath(".", Paths.get(".")))
-            .withWorkingDirectory("/test-projects")
-            .withStartupCheckStrategy(new IsRunningStartupCheckStrategy())
-            .withCreateContainerCmdModifier(cmd -> cmd
-                    .withStdinOpen(true)
-                    .withTty(true)
-                    .withCmd("/bin/sh"));
+    public static GenericContainer<?> container = new GenericContainer<>(
+            new ImageFromDockerfile("git-hooks-maven-plugin-test", true)
+                    .withFileFromPath(".", Paths.get(".")))
+                    .withWorkingDirectory("/test-projects")
+                    .withStartupCheckStrategy(new IsRunningStartupCheckStrategy())
+                    .withCreateContainerCmdModifier(cmd -> cmd
+                            .withStdinOpen(true)
+                            .withTty(true)
+                            .withCmd("/bin/sh"));
 }

src/system-test/java/io/github/pepperkit/githooks/steps/GivenStepDefinitions.java

@@ -29,11 +29,11 @@ public void repoIsSetUp() throws IOException, InterruptedException {
         container.execInContainer("git", "init");
     }
 
-    @Given("init goal was launched before with hooks presented in configuration")
-    @Given("init goal was launched before with the specified hook presented in configuration")
+    @Given("initHooks goal was launched before with hooks presented in configuration")
+    @Given("initHooks goal was launched before with the specified hook presented in configuration")
     public void initWithHooksConfigured() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:init");
+                "io.github.pepperkit:git-hooks-maven-plugin:initHooks");
         assertThat(cmdResult.getStdout())
                 .contains("BUILD SUCCESS");
 
@@ -42,11 +42,11 @@ public void initWithHooksConfigured() throws IOException, InterruptedException {
                 .contains("pre-commit hook is invoked");
     }
 
-    @Given("init goal was launched before with no hooks presented in configuration")
-    @Given("init goal was launched before with the specified hook not presented in configuration")
+    @Given("initHooks goal was launched before with no hooks presented in configuration")
+    @Given("initHooks goal was launched before with the specified hook not presented in configuration")
     public void initWithNoHooksConfigured() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "no_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:init");
+                "io.github.pepperkit:git-hooks-maven-plugin:initHooks");
         assertThat(cmdResult.getStdout())
                 .contains("BUILD SUCCESS");
     }

src/system-test/java/io/github/pepperkit/githooks/steps/ThenStepDefinitions.java

@@ -73,7 +73,7 @@ public void printsAllHooksInstalled() {
     public void printsNoHooksConfigured() {
         assertThat(cmdResult.getStdout())
                 .contains("No hooks are configured. Make sure you have correctly configured plugin and "
-                        + "ran init goal first to install the hooks.")
+                        + "ran initHooks goal first to install the hooks.")
                 .contains("BUILD SUCCESS");
     }
 

src/system-test/java/io/github/pepperkit/githooks/steps/WhenStepDefinitions.java

@@ -11,46 +11,45 @@
 import io.cucumber.java.en.When;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class WhenStepDefinitions extends BaseMojoSysTest {
 
-    @When("init goal of the plugin is launched with hooks presented in plugin's configuration")
+    @When("initHooks goal of the plugin is launched with hooks presented in plugin's configuration")
     public void initGoalIsLaunchedWithHooks() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:init");
+                "io.github.pepperkit:git-hooks-maven-plugin:initHooks");
     }
 
-    @When("init goal of the plugin is launched with hooks deleted from plugin's configuration")
-    @When("init goal of the plugin is launched with another plugin's configuration")
+    @When("initHooks goal of the plugin is launched with hooks deleted from plugin's configuration")
+    @When("initHooks goal of the plugin is launched with another plugin's configuration")
     public void hooksDeletedFromPom() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "no_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:init");
+                "io.github.pepperkit:git-hooks-maven-plugin:initHooks");
         assertThat(cmdResult.getStdout())
                 .contains("BUILD SUCCESS");
     }
 
-    @When("validate goal of plugin is launched without specifying a particular hook")
+    @When("printHooks goal of plugin is launched without specifying a particular hook")
     public void validateGoalLaunchedWithoutSpecificHooks() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:validate");
+                "io.github.pepperkit:git-hooks-maven-plugin:printHooks");
     }
 
-    @When("validate goal of plugin is launched with the specific hook name provided")
+    @When("printHooks goal of plugin is launched with the specific hook name provided")
     public void validateGoalLaunchedWithPreCommitHookSpecified() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "-DhookName=pre-commit", "io.github.pepperkit:git-hooks-maven-plugin:validate");
+                "-DhookName=pre-commit", "io.github.pepperkit:git-hooks-maven-plugin:printHooks");
     }
 
-    @When("test goal of plugin is launched without specifying a particular hook")
+    @When("executeHooks goal of plugin is launched without specifying a particular hook")
     public void testGoalLaunchedWithoutSpecificHooks() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "io.github.pepperkit:git-hooks-maven-plugin:test");
+                "io.github.pepperkit:git-hooks-maven-plugin:executeHooks");
     }
 
-    @When("test goal of plugin is launched with the specific hook name provided")
+    @When("executeHooks goal of plugin is launched with the specific hook name provided")
     public void testGoalLaunchedWithPrePushHookSpecified() throws IOException, InterruptedException {
         cmdResult = container.execInContainer("mvn", "-f", "pre_commit_push_hooks-pom.xml",
-                "-DhookName=pre-push", "io.github.pepperkit:git-hooks-maven-plugin:test");
+                "-DhookName=pre-push", "io.github.pepperkit:git-hooks-maven-plugin:executeHooks");
     }
 }