From 25cc51894f9c9ce3bfadcd01adc82bd3060f4778 Mon Sep 17 00:00:00 2001 From: Jan Diederich Date: Fri, 1 Dec 2023 22:40:54 +0100 Subject: [PATCH] useXsd removed --- .../pom.xml | 1 - .../postbuild.groovy | 6 +--- .../license/AbstractDownloadLicensesMojo.java | 11 +------ .../mojo/license/AbstractLicensesXmlMojo.java | 5 ++- .../LicensesXmlInsertVersionsMojo.java | 11 +------ .../download/LicenseSummaryWriter.java | 32 +------------------ .../license/download/LicenseSummaryTest.java | 12 ++----- 7 files changed, 8 insertions(+), 70 deletions(-) diff --git a/src/it/aggregate-download-licenses-extended-spreadsheet/pom.xml b/src/it/aggregate-download-licenses-extended-spreadsheet/pom.xml index 7cdc2d7bf..440e75bf5 100644 --- a/src/it/aggregate-download-licenses-extended-spreadsheet/pom.xml +++ b/src/it/aggregate-download-licenses-extended-spreadsheet/pom.xml @@ -56,7 +56,6 @@ true true true - true The Apache Software License, Version 2.0|Apache License, Version 2.0|Apache Public License 2.0 diff --git a/src/it/aggregate-download-licenses-extended-spreadsheet/postbuild.groovy b/src/it/aggregate-download-licenses-extended-spreadsheet/postbuild.groovy index 07fbbc443..6a6fe753f 100644 --- a/src/it/aggregate-download-licenses-extended-spreadsheet/postbuild.groovy +++ b/src/it/aggregate-download-licenses-extended-spreadsheet/postbuild.groovy @@ -83,8 +83,4 @@ try (OdfSpreadsheetDocument spreadsheet = OdfSpreadsheetDocument.loadDocument(ca List tableList = spreadsheet.getTableList() OdfTable table = tableList.get(0) assert table.getRowCount() >= 3 -} - -// ----------- Check for XSD file ---------------- -licensesXsd = new File(basedir, 'target/generated-resources/licenses.xsd') -assert licensesXsd.exists() \ No newline at end of file +} \ No newline at end of file diff --git a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java index 07fde3bb2..ca741add0 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java @@ -614,15 +614,6 @@ public abstract class AbstractDownloadLicensesMojo extends AbstractLicensesXmlMo @Parameter(property = "license.writeVersions", defaultValue = "true") private boolean writeVersions; - /** - * If {@code true}, a licenses.xsd file will be written in the same directory as the - * XML file, and be referenced in the XML file. - * - * @since 2.4 - */ - @Parameter(property = "license.useXsd", defaultValue = "false") - private boolean useXsd; - /** * Connect timeout in milliseconds passed to the HTTP client when downloading licenses from remote URLs. * @@ -933,7 +924,7 @@ public void execute() throws MojoExecutionException, MojoFailureException { private void writeLicenseSummaries( List depProjectLicenses, File outputFile, File excelOutputFile, File calcOutputFile) throws ParserConfigurationException, TransformerException, IOException { - writeLicenseSummary(depProjectLicenses, outputFile, writeVersions, useXsd); + writeLicenseSummary(depProjectLicenses, outputFile, writeVersions); if (writeExcelFile) { ExcelFileWriter.write(depProjectLicenses, excelOutputFile); } diff --git a/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java index 212e53894..b77b007d4 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java @@ -157,11 +157,10 @@ protected Path[] getAutodetectEolFiles() { return new Path[] {licensesOutputFile.toPath()}; } - protected void writeLicenseSummary( - List deps, File licensesOutputFile, boolean writeVersions, boolean useXsd) + protected void writeLicenseSummary(List deps, File licensesOutputFile, boolean writeVersions) throws ParserConfigurationException, TransformerException, IOException { initEncoding(); LicenseSummaryWriter.writeLicenseSummary( - deps, licensesOutputFile, charset, licensesOutputFileEol, writeVersions, useXsd); + deps, licensesOutputFile, charset, licensesOutputFileEol, writeVersions); } } diff --git a/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java b/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java index c9490b99c..fe1fae60d 100644 --- a/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java +++ b/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java @@ -76,15 +76,6 @@ public class LicensesXmlInsertVersionsMojo extends AbstractLicensesXmlMojo { @Parameter(property = "license.skipDownloadLicenses", defaultValue = "false") private boolean skipDownloadLicenses; - /** - * If {@code true}, a licenses.xsd file will be written in the same directory as the - * XML file, and be referenced in the XML file. - * - * @since 2.4 - */ - @Parameter(property = "license.useXsd", defaultValue = "false") - private boolean useXsd; - public void execute() throws MojoExecutionException, MojoFailureException { if (skipDownloadLicenses) { @@ -161,7 +152,7 @@ public ArtifactFilters getArtifactFilters() { dependencyLicenseInfo.setVersion(dependency.getVersion()); } - writeLicenseSummary(projectLicenseInfos, licensesOutputFile, true, useXsd); + writeLicenseSummary(projectLicenseInfos, licensesOutputFile, true); } catch (MojoFailureException e) { throw e; } catch (Exception e) { diff --git a/src/main/java/org/codehaus/mojo/license/download/LicenseSummaryWriter.java b/src/main/java/org/codehaus/mojo/license/download/LicenseSummaryWriter.java index 70c1fff8c..2eef92a9b 100644 --- a/src/main/java/org/codehaus/mojo/license/download/LicenseSummaryWriter.java +++ b/src/main/java/org/codehaus/mojo/license/download/LicenseSummaryWriter.java @@ -34,13 +34,9 @@ import java.io.File; import java.io.IOException; -import java.io.InputStream; import java.io.StringWriter; import java.nio.charset.Charset; import java.nio.file.Files; -import java.nio.file.NoSuchFileException; -import java.nio.file.Path; -import java.nio.file.Paths; import java.util.Collection; import java.util.List; import java.util.Optional; @@ -55,8 +51,6 @@ import org.codehaus.mojo.license.Eol; import org.codehaus.mojo.license.extended.ExtendedInfo; import org.codehaus.mojo.license.extended.InfoFile; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; @@ -70,19 +64,12 @@ */ public class LicenseSummaryWriter { - private static final Logger LOG = LoggerFactory.getLogger(LicenseSummaryWriter.class); - static final String LICENSES_XSD_FILE = "licenses.xsd"; private static final String LICENSE_FOLDER = "/org/codehaus/mojo/license/"; static final String LICENSE_PATH = LICENSE_FOLDER + LICENSES_XSD_FILE; public static void writeLicenseSummary( - List dependencies, - File outputFile, - Charset charset, - Eol eol, - boolean writeVersions, - boolean useXsd) + List dependencies, File outputFile, Charset charset, Eol eol, boolean writeVersions) throws ParserConfigurationException, TransformerException, IOException { DocumentBuilderFactory fact = DocumentBuilderFactory.newInstance(); DocumentBuilder parser = fact.newDocumentBuilder(); @@ -90,23 +77,6 @@ public static void writeLicenseSummary( Element root = doc.createElement("licenseSummary"); - if (useXsd) { - root.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"); - root.setAttribute("xsi:noNamespaceSchemaLocation", LICENSES_XSD_FILE); - Path targetXsd = Paths.get(outputFile.toPath().getParent().toFile().getAbsolutePath(), LICENSES_XSD_FILE); - File targetFile = targetXsd.toFile(); - if (targetFile.exists()) { - LOG.debug("Target XSD file {} already does exist", targetXsd); - } else { - try (InputStream inputStream = LicenseSummaryWriter.class.getResourceAsStream(LICENSE_PATH)) { - if (inputStream == null) { - throw new NoSuchFileException(LICENSE_PATH); - } - Files.copy(inputStream, targetXsd); - } - } - } - doc.appendChild(root); Node dependenciesNode = doc.createElement("dependencies"); root.appendChild(dependenciesNode); diff --git a/src/test/java/org/codehaus/mojo/license/download/LicenseSummaryTest.java b/src/test/java/org/codehaus/mojo/license/download/LicenseSummaryTest.java index 61d10cde5..bea9a9892 100644 --- a/src/test/java/org/codehaus/mojo/license/download/LicenseSummaryTest.java +++ b/src/test/java/org/codehaus/mojo/license/download/LicenseSummaryTest.java @@ -17,7 +17,6 @@ import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; -import java.nio.file.Paths; import java.util.ArrayList; import java.util.Collections; import java.util.HashSet; @@ -40,7 +39,6 @@ import org.slf4j.LoggerFactory; import org.xml.sax.SAXException; -import static org.codehaus.mojo.license.download.LicenseSummaryWriter.LICENSES_XSD_FILE; import static org.codehaus.mojo.license.download.LicenseSummaryWriter.LICENSE_PATH; import static org.junit.Assert.assertTrue; @@ -120,7 +118,7 @@ public void testWriteReadLicenseSummary() { File licenseSummaryFile = File.createTempFile("licSummary", "tmp"); LicenseSummaryWriter.writeLicenseSummary( - licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF, true, true); + licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF, true); assertTrue(licenseSummaryFile.exists()); FileInputStream fis = new FileInputStream(licenseSummaryFile); @@ -140,18 +138,12 @@ public void testWriteReadLicenseSummary() Assert.assertEquals("lgpl version 3.0", lic0.getComments()); validateXml(licenseSummaryFile); - - // Check if the LICENSES_XSD_FILE was copied to the target directory. - Path targetXsd = - Paths.get(licenseSummaryFile.toPath().getParent().toFile().getAbsolutePath(), LICENSES_XSD_FILE); - File targetFile = targetXsd.toFile(); - assertTrue(targetFile.exists()); } { File licenseSummaryFile = File.createTempFile("licSummaryNoVersionNoXsd", "tmp"); LicenseSummaryWriter.writeLicenseSummary( - licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF, false, false); + licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF, false); assertTrue(licenseSummaryFile.exists()); FileInputStream fis = new FileInputStream(licenseSummaryFile);