Add test for 2.x annotations

We add a separate equivalent test for 2.x annotations.

Author: ppkarwasz

log4j-docgen/pom.xml

@@ -32,6 +32,9 @@
 
     <!-- Dependency versions -->
     <asciidoctorj-api.version>3.0.0-alpha.2</asciidoctorj-api.version>
+    <!-- We explicitly test against `log4j-core` 2.x -->
+    <log4j-core.version>2.22.1</log4j-core.version>
+    <log4j-plugins.version>3.0.0-beta1</log4j-plugins.version>
   </properties>
 
   <dependencies>
@@ -76,9 +79,23 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-params</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>${log4j-core.version}</version>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-plugins</artifactId>
+      <version>${log4j-plugins.version}</version>
       <scope>test</scope>
     </dependency>
 
@@ -93,14 +110,14 @@
   <build>
     <plugins>
 
-      <!--
-        ~ We split compilation in two executions, so we can fail on warnings for our sources,
-        ~ but be more tolerant for generated sources.
-        -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <executions>
+          <!--
+                      ~ We split compilation in two executions, so we can fail on warnings for our sources,
+                      ~ but be more tolerant for generated sources.
+                      -->
           <execution>
             <id>default-compile</id>
             <phase>none</phase>
@@ -136,6 +153,16 @@
               <failOnWarning>true</failOnWarning>
             </configuration>
           </execution>
+          <!-- Remove test sources from compilation -->
+          <execution>
+            <id>default-test-compile</id>
+            <configuration>
+              <!-- Classes used only for annotation processing -->
+              <excludes>
+                <exclude>example/**</exclude>
+              </excludes>
+            </configuration>
+          </execution>
         </executions>
       </plugin>
 

log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java

@@ -82,7 +82,7 @@
 import org.jspecify.annotations.Nullable;
 
 @ServiceProvider(value = Processor.class, resolution = Resolution.OPTIONAL)
-@SupportedAnnotationTypes("org.apache.logging.log4j.plugins.*")
+@SupportedAnnotationTypes({"org.apache.logging.log4j.core.config.plugins.*", "org.apache.logging.log4j.plugins.*"})
 @NullMarked
 public class DocGenProcessor extends AbstractProcessor {
 

log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/processor/AsciidocConverterTest.java

@@ -67,7 +67,9 @@ void convertToAsciidoc() throws Exception {
         final StandardJavaFileManager fileManager = tool.getStandardFileManager(null, Locale.ROOT, UTF_8);
 
         final Path basePath = Paths.get(System.getProperty("basedir", "."));
-        final Path sourcePath = basePath.resolve("src/test/it/example/JavadocExample.java");
+        final Path sourcePath = Paths.get(AsciidocConverterTest.class
+                .getResource("/processor/asciidoc/example/JavadocExample.java")
+                .toURI());
         final Iterable<? extends JavaFileObject> sources = fileManager.getJavaFileObjects(sourcePath);
 
         final Path destPath = basePath.resolve("target/test-site");

log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/processor/DocGenProcessorTest.java

@@ -19,7 +19,6 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 
-import java.io.IOException;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -40,17 +39,23 @@
 import javax.tools.StandardLocation;
 import javax.tools.ToolProvider;
 import org.apache.logging.log4j.docgen.xsd.SchemaGenerator;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 import org.xmlunit.assertj3.XmlAssert;
 
 public class DocGenProcessorTest {
 
-    @Test
-    void descriptorGenerationSucceeds() {
+    static Stream<String> descriptorGenerationSucceeds() {
+        return Stream.of("v2", "v3");
+    }
+
+    @ParameterizedTest
+    @MethodSource
+    void descriptorGenerationSucceeds(final String version) {
         final Path basePath = Paths.get(System.getProperty("basedir", "."));
         final Path schema = basePath.resolve("target/generated-site/resources/xsd/plugins-0.1.0.xsd");
         final URL expected = SchemaGenerator.class.getResource("/expected/processor/META-INF/log4j/plugins.xml");
-        final Path actual = assertDoesNotThrow(DocGenProcessorTest::generateDescriptor);
+        final Path actual = assertDoesNotThrow(() -> generateDescriptor(version));
         XmlAssert.assertThat(actual)
                 .isValidAgainst(schema)
                 .and(expected)
@@ -59,21 +64,22 @@ void descriptorGenerationSucceeds() {
                 .areIdentical();
     }
 
-    private static Path generateDescriptor() throws IOException {
+    private static Path generateDescriptor(final String version) throws Exception {
         final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
         final DiagnosticCollector<JavaFileObject> ds = new DiagnosticCollector<>();
         final StandardJavaFileManager fileManager =
                 compiler.getStandardFileManager(null, Locale.ROOT, StandardCharsets.UTF_8);
 
         final Path basePath = Paths.get(System.getProperty("basedir", "."));
-        final Path sourcePath = basePath.resolve("src/test/it");
+        final Path sourcePath = Paths.get(
+                DocGenProcessorTest.class.getResource("/processor/" + version).toURI());
         final Iterable<? extends JavaFileObject> sources;
         try (final Stream<Path> files = Files.walk(sourcePath)) {
             sources = fileManager.getJavaFileObjects(
                     files.filter(Files::isRegularFile).toArray(Path[]::new));
         }
 
-        final Path destPath = basePath.resolve("target/test-site/processor");
+        final Path destPath = basePath.resolve("target/test-site/processor/" + version);
         Files.createDirectories(destPath);
         fileManager.setLocationFromPaths(StandardLocation.CLASS_OUTPUT, Set.of(destPath));
 

log4j-docgen/src/test/resources/expected/processor/META-INF/log4j/plugins.xml

@@ -114,7 +114,7 @@ It also implements:
 * xref:Appender.adoc[],
 * xref:BaseAppender.adoc[]</description>
         </plugin>
-        <plugin name="MyOldLayout" className="example.MyOldLayout">
+        <plugin name="MyLayout" className="example.MyOldLayout">
             <supertypes>
                 <supertype>example.Layout</supertype>
                 <supertype>java.lang.Object</supertype>

log4j-docgen/src/test/it/example/JavadocExample.java log4j-docgen/src/test/resources/processor/asciidoc/example/JavadocExample.java

@@ -0,0 +1,188 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package example;
+
+import java.util.List;
+import java.util.Set;
+import javax.lang.model.element.TypeElement;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
+import org.apache.logging.log4j.core.config.plugins.PluginElement;
+import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;
+
+/**
+ * Example plugin
+ * <p>
+ *     This is an example plugin. It has the following characteristics:
+ * </p>
+ * <ol>
+ *     <li>Plugin name: {@code MyPlugin},</li>
+ *     <li>Namespace: default (i.e. {@code Core}).</li>
+ * </ol>
+ * <p>
+ *     It also implements:
+ * </p>
+ * <ul>
+ *     <li>{@link Appender},</li>
+ *     <li>{@link BaseAppender}</li>
+ * </ul>
+ */
+@Plugin(name = "MyAppender", category = "namespace")
+public final class MyAppender extends AbstractAppender implements Appender {
+
+    /**
+     * Parent builder with some private fields that are not returned by
+     * {@link javax.lang.model.util.Elements#getAllMembers(TypeElement)}.
+     */
+    public static class ParentBuilder {
+
+        /**
+         * A {@code char} attribute.
+         */
+        @PluginBuilderAttribute
+        private char charAtt = 'L';
+
+        /**
+         * An {@code int} attribute.
+         */
+        @PluginBuilderAttribute
+        private int intAtt = 4242;
+
+        /**
+         * An element with multiplicity 1.
+         */
+        @PluginElement("layout")
+        private Layout layout;
+    }
+
+    public static final class Builder extends ParentBuilder
+            implements org.apache.logging.log4j.plugins.util.Builder<MyAppender> {
+
+        /**
+         * A {@code short} attribute annotated on type.
+         */
+        private @PluginBuilderAttribute short shortAtt = 42;
+
+        /**
+         * A {@code long} attribute annotated on type.
+         */
+        private @PluginBuilderAttribute long longAtt = 424242L;
+
+        /**
+         * A {@code String} attribute.
+         */
+        @PluginBuilderAttribute
+        @Required
+        private String stringAtt;
+
+        /**
+         * An attribute whose name differs from the field name.
+         */
+        @PluginBuilderAttribute("anotherName")
+        private String origName;
+
+        /**
+         * An attribute that is an enumeration annotated on type.
+         */
+        private @PluginBuilderAttribute MyEnum enumAtt;
+
+        /**
+         * An attribute of type {@code float}.
+         */
+        private @PluginBuilderAttribute float floatAtt;
+
+        /**
+         * An attribute of type {@code double}.
+         */
+        private @PluginBuilderAttribute double aDouble;
+
+        private Object notAnAttribute;
+
+        /**
+         * A collection element.
+         */
+        @PluginElement("appenderList")
+        private List<Appender2> appenderList;
+
+        /**
+         * A set of layouts
+         */
+        @PluginElement("layoutSet")
+        private LayoutSet layoutSet;
+
+        /**
+         * A {@code boolean} attribute with annotated type.
+         */
+        public Builder setBooleanAtt(final @PluginBuilderAttribute boolean booleanAtt) {
+            return this;
+        }
+
+        /**
+         * A {@code byte} attribute with annotated parameter.
+         */
+        public Builder setByteAtt(@PluginBuilderAttribute final byte byteAtt) {
+            return this;
+        }
+
+        /**
+         * An element with multiplicity n with annotated setter.
+         */
+        public Builder setFilters(final @PluginElement("filters") Filter[] filters) {
+            return this;
+        }
+
+        /**
+         * An element that is not an interface with annotated parameter.
+         */
+        public Builder setAbstractElement(@PluginElement("abstractAppender") final AbstractAppender abstractAppender) {
+            return this;
+        }
+
+        /**
+         * An element with an annotated type.
+         */
+        public Builder setNestedAppender(final @PluginElement("nestedAppender") Appender nestedAppender) {
+            return this;
+        }
+
+        /**
+         * A setter with a varargs type.
+         */
+        public Builder setVarargs(@PluginElement("layouts") final Layout3... layouts) {
+            return this;
+        }
+
+        @Override
+        public MyAppender build() {
+            return null;
+        }
+    }
+
+    @PluginBuilderFactory
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    public static interface Appender2 {}
+
+    public static interface Layout2 {}
+
+    public static interface Layout3 {}
+
+    public abstract static class LayoutSet implements Set<Layout2> {}
+}