You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2024/02/21 14:21:29 UTC
(logging-log4j-tools) 09/29: Refactor `SchemaGeneratorTest`
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 660ebc74c15b6a8850a19cf3a1f2083b257c78ea
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Feb 13 21:00:35 2024 +0100
Refactor `SchemaGeneratorTest`
---
.../docgen/internal/FreeMarkerGeneratorTest.java | 2 +-
.../log4j/docgen/internal/SchemaGeneratorTest.java | 34 +++++++++++-----------
.../plugins-sample.xml => example-plugins.xml} | 0
.../xsd/log4j-config.xsd => generated-plugins.xsd} | 0
4 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/FreeMarkerGeneratorTest.java b/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/FreeMarkerGeneratorTest.java
index 1648607..debcdde 100644
--- a/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/FreeMarkerGeneratorTest.java
+++ b/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/FreeMarkerGeneratorTest.java
@@ -34,7 +34,7 @@ public class FreeMarkerGeneratorTest {
@Test
void generatePluginDocumentation() throws Exception {
final PluginBundleStaxReader reader = new PluginBundleStaxReader();
- final PluginSet set = reader.read("src/test/resources/META-INF/log4j/plugins-sample.xml");
+ final PluginSet set = reader.read("src/test/resources/example-plugins.xml");
final Path templateDir = Paths.get("src/test/resources/templates");
final Path expectedDirectory = Paths.get("src/test/resources/expected/freemarker");
final Path outputDirectory = Paths.get("target/test-site/freemarker");
diff --git a/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/SchemaGeneratorTest.java b/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/SchemaGeneratorTest.java
index 149e0a7..adee706 100644
--- a/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/SchemaGeneratorTest.java
+++ b/log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/internal/SchemaGeneratorTest.java
@@ -16,30 +16,27 @@
*/
package org.apache.logging.log4j.docgen.internal;
-import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
-
-import java.io.IOException;
-import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
-import javax.xml.stream.XMLStreamException;
import javax.xml.transform.Source;
import org.apache.logging.log4j.docgen.PluginSet;
import org.apache.logging.log4j.docgen.io.stax.PluginBundleStaxReader;
import org.apache.logging.log4j.docgen.xsd.SchemaGenerator;
import org.apache.logging.log4j.docgen.xsd.SchemaGeneratorRequest;
import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.CleanupMode;
+import org.junit.jupiter.api.io.TempDir;
import org.xmlunit.assertj3.XmlAssert;
import org.xmlunit.builder.Input;
public class SchemaGeneratorTest {
@Test
- void schemaGeneration() {
+ void schemaGeneration(@TempDir(cleanup = CleanupMode.ON_SUCCESS) final Path outputDir) throws Exception {
final Source xmlSchema =
Input.fromURI("https://www.w3.org/2001/XMLSchema.xsd").build();
- final Path expectedSchema = Paths.get("src/test/resources/expected/xsd/log4j-config.xsd");
- final Path actualSchema = assertDoesNotThrow(SchemaGeneratorTest::generateSchema);
+ final Path expectedSchema = Paths.get("src/test/resources/generated-plugins.xsd");
+ final Path actualSchema = generateSchema(outputDir);
XmlAssert.assertThat(actualSchema)
.isValidAgainst(xmlSchema)
.and(expectedSchema)
@@ -48,17 +45,20 @@ public class SchemaGeneratorTest {
.areIdentical();
}
- private static Path generateSchema() throws XMLStreamException, IOException {
+ private static Path generateSchema(final Path outputDir) throws Exception {
+
+ // Read sample plugins
final PluginBundleStaxReader reader = new PluginBundleStaxReader();
- final PluginSet set = reader.read("src/test/resources/META-INF/log4j/plugins-sample.xml");
- final SchemaGenerator generator = new DefaultSchemaGenerator();
- final SchemaGeneratorRequest request = new SchemaGeneratorRequest();
- final Path outputDirectory = Paths.get("target/test-site/xsd");
- Files.createDirectories(outputDirectory);
- request.addPluginSet(set);
- request.setOutputDirectory(outputDirectory);
+ final PluginSet pluginSet = reader.read("src/test/resources/example-plugins.xml");
+ // Generate the schema
+ final SchemaGeneratorRequest request = new SchemaGeneratorRequest();
+ request.addPluginSet(pluginSet);
+ request.setOutputDirectory(outputDir);
+ final SchemaGenerator generator = new DefaultSchemaGenerator();
generator.generateSchema(request);
- return outputDirectory.resolve(request.getFileName());
+
+ // Return the generated XSD file path
+ return outputDir.resolve(request.getFileName());
}
}
diff --git a/log4j-docgen/src/test/resources/META-INF/log4j/plugins-sample.xml b/log4j-docgen/src/test/resources/example-plugins.xml
similarity index 100%
rename from log4j-docgen/src/test/resources/META-INF/log4j/plugins-sample.xml
rename to log4j-docgen/src/test/resources/example-plugins.xml
diff --git a/log4j-docgen/src/test/resources/expected/xsd/log4j-config.xsd b/log4j-docgen/src/test/resources/generated-plugins.xsd
similarity index 100%
rename from log4j-docgen/src/test/resources/expected/xsd/log4j-config.xsd
rename to log4j-docgen/src/test/resources/generated-plugins.xsd