Merge pull request #412 from fugerit-org/411-chore-fj-doc-maven-plugin-verify-plugin-should-be-added-to-direct-plugin-template-path

fugerit79 · web-flow · commit ada128cec78f · 2025-04-27T11:13:31.000+02:00
[fj-doc-maven-plugin] verify plugin should be added for direct plugi…
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- [fj-doc-maven-plugin] verify plugin should be for direct plugin template path <https://github.com/fugerit-org/fj-doc/pull/411>
+
 ## [8.13.6] - 2025-04-26
 
 ### Added
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/BasicVenusFacade.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/BasicVenusFacade.java
@@ -148,8 +148,8 @@ protected static void addExtensionList( File pomFile, VenusContext context ) thr
             addJunit5( model, context );
             // addLombok parameter
             addLombok( model, context );
-            addDirectPlugin( context, model );
             addVerifyPlugin( context, model );
+            addDirectPlugin( context, model );
             log.info( "end dependencies size : {}", model.getDependencies().size() );
             try (OutputStream pomStream = new FileOutputStream( pomFile ) ) {
                 modelIO.writeModelToStream( model, pomStream );
@@ -228,14 +228,19 @@ private static void addDirectPlugin(VenusContext context, Model model ) throws I
             if (context.isDirectPluginNotAvailable()) {
                 log.warn("addDirectPlugin skipped, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_DIRECT_PLUGIN);
             } else {
+                if ( context.isAddVerifyPlugin() ) {
+                    addVerifyPluginExecution( model, "freemarker-verify-direct",
+                            "src/main/resources/"+context.getVenusDirectConfig()+"/template",
+                            "freemarker-syntax-verify-direct-report");
+                }
                 FeatureFacade.copyFeatureList( context.getProjectDir(), "direct" );
                 log.info("addDirectPlugin true, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_DIRECT_PLUGIN);
                 Plugin plugin = PluginUtils.findOrCreatePLugin( model );
                 PluginExecution execution = PluginUtils.createPluginExecution(
                         "venus-direct", LifecyclePhase.COMPILE.id(), PluginUtils.GOAL_DIRECT );
                 plugin.getExecutions().add( execution );
                 String xml = "<configuration>\n" +
-                        "    <configPath>${project.basedir}/src/main/resources/venus-direct-config/venus-direct-config.yaml</configPath>\n" +
+                        "    <configPath>${project.basedir}/src/main/resources/"+context.getVenusDirectConfig()+"/venus-direct-config.yaml</configPath>\n" +
                         "    <outputAll>true</outputAll>\n" +
                         "    <directEnv>\n" +
                         "        <projectBasedir>${project.basedir}</projectBasedir>\n" +
@@ -248,24 +253,31 @@ private static void addDirectPlugin(VenusContext context, Model model ) throws I
         }
     }
 
+    private static void addVerifyPluginExecution( Model model, String id, String templateBaseDir, String reportOutputFolder ) throws IOException {
+        log.info( "addVerifyPluginExecution id:{}, templateBaseDir:{}", id, templateBaseDir );
+        Plugin plugin = PluginUtils.findOrCreatePLugin( model );
+        PluginExecution execution = PluginUtils.createPluginExecution(
+                id, LifecyclePhase.COMPILE.id(), LifecyclePhase.VERIFY.id() );
+        plugin.getExecutions().add( execution );
+        String xml = "<configuration>\n" +
+                "      <templateBasePath>${project.basedir}/"+templateBaseDir+"</templateBasePath>\n" +
+                "      <generateReport>true</generateReport>\n" +
+                "      <failOnErrors>true</failOnErrors>\n" +
+                "      <reportOutputFolder>${project.build.directory}/"+reportOutputFolder+"</reportOutputFolder>\n" +
+                "    </configuration>";
+        execution.setConfiguration( PluginUtils.getPluginConfiguration( xml ) );
+    }
+
     private static void addVerifyPlugin(VenusContext context, Model model ) throws IOException {
         // addVerifyPlugin?
         if ( context.isAddVerifyPlugin() ) {
             if ( context.isVerifyPluginNotAvailable() ) {
                 log.warn( "addVerifyPlugin skipped, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_VERIFY_PLUGIN );
             } else {
                 log.info( "addVerifyPlugin true, version {} has been selected, minimum required version is : {}", context.getVersion(), VenusContext.VERSION_NA_VERIFY_PLUGIN );
-                Plugin plugin = PluginUtils.findOrCreatePLugin( model );
-                PluginExecution execution = PluginUtils.createPluginExecution(
-                        "freemarker-verify", LifecyclePhase.COMPILE.id(), LifecyclePhase.VERIFY.id() );
-                plugin.getExecutions().add( execution );
-                String xml = "<configuration>\n" +
-                        "      <templateBasePath>${project.basedir}/src/main/resources/"+context.getArtificatIdForFolder()+"/template</templateBasePath>\n" +
-                        "      <generateReport>true</generateReport>\n" +
-                        "      <failOnErrors>true</failOnErrors>\n" +
-                        "      <reportOutputFolder>${project.build.directory}/freemarker-syntax-verify-report</reportOutputFolder>\n" +
-                        "    </configuration>";
-                execution.setConfiguration( PluginUtils.getPluginConfiguration( xml ) );
+                addVerifyPluginExecution( model, "freemarker-verify",
+                        "src/main/resources/"+context.getArtificatIdForFolder()+"/template",
+                        "freemarker-syntax-verify-report" );
             }
         } else {
             log.info( "addVerifyPlugin : false" );
diff --git a/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/VenusContext.java b/fj-doc-maven-plugin/src/main/java/org/fugerit/java/doc/project/facade/VenusContext.java
@@ -41,6 +41,8 @@ public static String toResourcePathFmConfigXml( String artifactId ) {
 
     public static final String VERSION_NA_FREEMARKER_NATIVE = "8.11.8";
 
+    private static final String VENUS_DIRECT_CONFIG_DEFAULT = "venus-direct-config";
+
     @Getter
     private File projectDir;
 
@@ -192,4 +194,8 @@ public File getTestResourcesFolder() {
         return this.getAndCreateFolder( new File( this.getProjectDir(), "src/test/resources" ) );
     }
 
+    public String getVenusDirectConfig() {
+        return VENUS_DIRECT_CONFIG_DEFAULT;
+    }
+
 }
diff --git a/fj-doc-maven-plugin/src/test/java/test/org/fugerit/java/doc/project/facade/TestInit.java b/fj-doc-maven-plugin/src/test/java/test/org/fugerit/java/doc/project/facade/TestInit.java
@@ -61,6 +61,34 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         };
     }
 
+    @Test
+    void createDirectInitNoVerify() throws MojoExecutionException, MojoFailureException {
+        File projectDir = initConfigWorker( FlavourFacade.FLAVOUR_DIRECT+"-no-verify" );
+        String currentFlavour = FlavourFacade.FLAVOUR_DIRECT;
+        MojoInit mojoInit = new MojoInit() {
+            @Override
+            public void execute() throws MojoExecutionException, MojoFailureException {
+                this.baseInitFolder = projectDir.getAbsolutePath();
+                this.projectVersion = "1.0.0-SNAPSHOT";
+                this.groupId = "org.fugerit.java.test.gradle";
+                this.artifactId = "fugerit-test-"+currentFlavour+"-no-verify";
+                this.javaRelease = "21";
+                this.version = DIRECT_PLUGIN_AVAILABLE;
+                this.extensions = "fj-doc-base,fj-doc-base-json,fj-doc-base-yaml,fj-doc-base-kotlin,fj-doc-freemarker,fj-doc-mod-fop,fj-doc-mod-poi,fj-doc-mod-opencsv";
+                this.addDocFacade = true;
+                this.force = true;
+                this.excludeXmlApis = true;
+                this.addVerifyPlugin = false;
+                this.addJunit5 = true;
+                this.addLombok = true;
+                this.flavour = currentFlavour;
+                super.execute();
+            }
+        };
+        mojoInit.execute();
+        Assertions.assertTrue( projectDir.exists() );
+    }
+
     @Test
     void testMojoQuarkus3GradleGroovyAndKts() throws MojoExecutionException, MojoFailureException {
         for ( String currentFlavour : Arrays.asList( FlavourFacade.FLAVOUR_QUARKUS_3_GRADLE, FlavourFacade.FLAVOUR_QUARKUS_3_GRADLE_KTS ) ) {

Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,8 @@ public static String toResourcePathFmConfigXml( String artifactId ) {`
`41`	`41`
`42`	`42`	`public static final String VERSION_NA_FREEMARKER_NATIVE = "8.11.8";`
`43`	`43`
	`44`	`+ private static final String VENUS_DIRECT_CONFIG_DEFAULT = "venus-direct-config";`
	`45`	`+`
`44`	`46`	`@Getter`
`45`	`47`	`private File projectDir;`
`46`	`48`
`@@ -192,4 +194,8 @@ public File getTestResourcesFolder() {`
`192`	`194`	`return this.getAndCreateFolder( new File( this.getProjectDir(), "src/test/resources" ) );`
`193`	`195`	`}`
`194`	`196`
	`197`	`+ public String getVenusDirectConfig() {`
	`198`	`+ return VENUS_DIRECT_CONFIG_DEFAULT;`
	`199`	`+ }`
	`200`	`+`
`195`	`201`	`}`