Revert "Resolve errors in layers.xsd" for 2.5

philwebb · philwebb · commit 585286e4720f · 2023-05-12T09:42:25.000-07:00
Revert layers.xsd fix to reduce risk of a regression since it has not yet made it into a 2.5 release. This reverts commit f185b07, reversing changes made to bf3c6df. See gh-31126
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/build.gradle b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/build.gradle
@@ -64,29 +64,22 @@ dependencies {
 	versionProperties(project(path: ":spring-boot-project:spring-boot-dependencies", configuration: "effectiveBom"))
 }
 
-ext {
-	versionElements = version.split("\\.")
-	xsdVersion = versionElements[0] + "." + versionElements[1]
-}
-
 syncDocumentationSourceForAsciidoctor {
 	from(documentPluginGoals) {
 		into "asciidoc/goals"
 	}
 }
 
 sourceSets {
-	main {
-		output.dir("${buildDir}/generated/resources/xsd", builtBy: "xsdResources")
-	}
 	intTest {
 		output.dir("${buildDir}/generated-resources", builtBy: "extractVersionProperties")
 	}
 }
 
 tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {
 	doFirst {
-		attributes "spring-boot-xsd-version" : project.ext.xsdVersion
+		def versionEl = version.split("\\.")
+		attributes "spring-boot-xsd-version": versionEl[0] + '.' + versionEl[1]
 	}
 }
 
@@ -136,12 +129,6 @@ task zip(type: Zip) {
 	}
 }
 
-task xsdResources(type: Sync) {
-	from "src/main/xsd/layers-${project.ext.xsdVersion}.xsd"
-	into "${buildDir}/generated/resources/xsd/org/springframework/boot/maven"
-	rename { fileName -> "layers.xsd" }
-}
-
 prepareMavenBinaries {
 	versions "3.8.1", "3.6.3", "3.5.4"
 }
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractPackagerMojo.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/AbstractPackagerMojo.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -171,7 +171,6 @@ private CustomLayers getCustomLayers(File configuration) {
 	private Document getDocumentIfAvailable(File xmlFile) throws Exception {
 		InputSource inputSource = new InputSource(new FileInputStream(xmlFile));
 		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
-		factory.setNamespaceAware(true);
 		DocumentBuilder builder = factory.newDocumentBuilder();
 		return builder.parse(inputSource);
 	}
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/CustomLayersProvider.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/java/org/springframework/boot/maven/CustomLayersProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,24 +16,16 @@
 
 package org.springframework.boot.maven;
 
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-import javax.xml.XMLConstants;
-import javax.xml.transform.dom.DOMSource;
-import javax.xml.validation.Schema;
-import javax.xml.validation.SchemaFactory;
-import javax.xml.validation.Validator;
-
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
-import org.xml.sax.SAXException;
 
 import org.springframework.boot.loader.tools.Layer;
 import org.springframework.boot.loader.tools.Library;
@@ -53,35 +45,13 @@
 class CustomLayersProvider {
 
 	CustomLayers getLayers(Document document) {
-		validate(document);
 		Element root = document.getDocumentElement();
 		List<ContentSelector<String>> applicationSelectors = getApplicationSelectors(root);
 		List<ContentSelector<Library>> librarySelectors = getLibrarySelectors(root);
 		List<Layer> layers = getLayers(root);
 		return new CustomLayers(layers, applicationSelectors, librarySelectors);
 	}
 
-	private void validate(Document document) {
-		Schema schema = loadSchema();
-		try {
-			Validator validator = schema.newValidator();
-			validator.validate(new DOMSource(document));
-		}
-		catch (SAXException | IOException ex) {
-			throw new IllegalStateException("Invalid layers.xml configuration", ex);
-		}
-	}
-
-	private Schema loadSchema() {
-		try {
-			SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
-			return factory.newSchema(getClass().getResource("layers.xsd"));
-		}
-		catch (SAXException ex) {
-			throw new IllegalStateException("Unable to load layers XSD");
-		}
-	}
-
 	private List<ContentSelector<String>> getApplicationSelectors(Element root) {
 		return getSelectors(root, "application", (element) -> getSelector(element, ApplicationContentFilter::new));
 	}
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.3.xsd b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.3.xsd
@@ -6,9 +6,9 @@
 	<xsd:element name="layers" type="layersType" />
 	<xsd:complexType name="layersType">
 		<xsd:sequence>
-			<xsd:element name="application" type="applicationType" minOccurs="0"/>
-			<xsd:element name="dependencies" type="dependenciesType" minOccurs="0"/>
-			<xsd:element name="layerOrder" type="layerOrderType" minOccurs="0"/>
+			<xsd:element name="application" type="applicationType" />
+			<xsd:element name="dependencies" type="dependenciesType" />
+			<xsd:element name="layerOrder" type="layerOrderType" />
 		</xsd:sequence>
 	</xsd:complexType>
 	<xsd:complexType name="applicationType">
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.4.xsd b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.4.xsd
@@ -6,9 +6,9 @@
 	<xsd:element name="layers" type="layersType" />
 	<xsd:complexType name="layersType">
 		<xsd:sequence>
-			<xsd:element name="application" type="applicationType" minOccurs="0"/>
-			<xsd:element name="dependencies" type="dependenciesType" minOccurs="0"/>
-			<xsd:element name="layerOrder" type="layerOrderType" minOccurs="0"/>
+			<xsd:element name="application" type="applicationType" />
+			<xsd:element name="dependencies" type="dependenciesType" />
+			<xsd:element name="layerOrder" type="layerOrderType" />
 		</xsd:sequence>
 	</xsd:complexType>
 	<xsd:complexType name="applicationType">
@@ -78,14 +78,14 @@
 		<xsd:complexContent>
 			<xsd:extension base="intoType">
 				<xsd:choice minOccurs="0">
-					<xsd:element type="xsd:string" name="includeModuleDependencies" minOccurs="0">
+					<xsd:element type="xsd:string" name="includeProjectDependencies" minOccurs="0">
 						<xsd:annotation>
 							<xsd:documentation><![CDATA[
 	Include dependencies on other modules in the build.
 							]]></xsd:documentation>
 						</xsd:annotation>
 					</xsd:element>
-					<xsd:element type="xsd:string" name="excludeModuleDependencies" minOccurs="0">
+					<xsd:element type="xsd:string" name="excludeProjectDependencies" minOccurs="0">
 						<xsd:annotation>
 							<xsd:documentation><![CDATA[
 	Exclude dependencies on other modules in the build.
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.5.xsd b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/main/xsd/layers-2.5.xsd
@@ -6,9 +6,9 @@
 	<xsd:element name="layers" type="layersType" />
 	<xsd:complexType name="layersType">
 		<xsd:sequence>
-			<xsd:element name="application" type="applicationType" minOccurs="0"/>
-			<xsd:element name="dependencies" type="dependenciesType" minOccurs="0"/>
-			<xsd:element name="layerOrder" type="layerOrderType" minOccurs="0"/>
+			<xsd:element name="application" type="applicationType" />
+			<xsd:element name="dependencies" type="dependenciesType" />
+			<xsd:element name="layerOrder" type="layerOrderType" />
 		</xsd:sequence>
 	</xsd:complexType>
 	<xsd:complexType name="applicationType">
@@ -78,14 +78,14 @@
 		<xsd:complexContent>
 			<xsd:extension base="intoType">
 				<xsd:choice minOccurs="0">
-					<xsd:element type="xsd:string" name="includeModuleDependencies" minOccurs="0">
+					<xsd:element type="xsd:string" name="includeProjectDependencies" minOccurs="0">
 						<xsd:annotation>
 							<xsd:documentation><![CDATA[
 	Include dependencies on other modules in the build.
 							]]></xsd:documentation>
 						</xsd:annotation>
 					</xsd:element>
-					<xsd:element type="xsd:string" name="excludeModuleDependencies" minOccurs="0">
+					<xsd:element type="xsd:string" name="excludeProjectDependencies" minOccurs="0">
 						<xsd:annotation>
 							<xsd:documentation><![CDATA[
 	Exclude dependencies on other modules in the build.
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/CustomLayersProviderTests.java b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/test/java/org/springframework/boot/maven/CustomLayersProviderTests.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -97,7 +97,6 @@ private Document getDocument(String resourceName) throws Exception {
 		ClassPathResource resource = new ClassPathResource(resourceName);
 		InputSource inputSource = new InputSource(resource.getInputStream());
 		DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
-		factory.setNamespaceAware(true);
 		DocumentBuilder documentBuilder = factory.newDocumentBuilder();
 		return documentBuilder.parse(inputSource);
 	}

Original file line number	Diff line number	Diff line change
`@@ -64,29 +64,22 @@ dependencies {`
`64`	`64`	`versionProperties(project(path: ":spring-boot-project:spring-boot-dependencies", configuration: "effectiveBom"))`
`65`	`65`	`}`
`66`	`66`
`67`		`-ext {`
`68`		`- versionElements = version.split("\\.")`
`69`		`- xsdVersion = versionElements[0] + "." + versionElements[1]`
`70`		`-}`
`71`		`-`
`72`	`67`	`syncDocumentationSourceForAsciidoctor {`
`73`	`68`	`from(documentPluginGoals) {`
`74`	`69`	`into "asciidoc/goals"`
`75`	`70`	`}`
`76`	`71`	`}`
`77`	`72`
`78`	`73`	`sourceSets {`
`79`		`- main {`
`80`		`- output.dir("${buildDir}/generated/resources/xsd", builtBy: "xsdResources")`
`81`		`- }`
`82`	`74`	`intTest {`
`83`	`75`	`output.dir("${buildDir}/generated-resources", builtBy: "extractVersionProperties")`
`84`	`76`	`}`
`85`	`77`	`}`
`86`	`78`
`87`	`79`	`tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {`
`88`	`80`	`doFirst {`
`89`		`- attributes "spring-boot-xsd-version" : project.ext.xsdVersion`
	`81`	`+ def versionEl = version.split("\\.")`
	`82`	`+ attributes "spring-boot-xsd-version": versionEl[0] + '.' + versionEl[1]`
`90`	`83`	`}`
`91`	`84`	`}`
`92`	`85`
`@@ -136,12 +129,6 @@ task zip(type: Zip) {`
`136`	`129`	`}`
`137`	`130`	`}`
`138`	`131`
`139`		`-task xsdResources(type: Sync) {`
`140`		`- from "src/main/xsd/layers-${project.ext.xsdVersion}.xsd"`
`141`		`- into "${buildDir}/generated/resources/xsd/org/springframework/boot/maven"`
`142`		`- rename { fileName -> "layers.xsd" }`
`143`		`-}`
`144`		`-`
`145`	`132`	`prepareMavenBinaries {`
`146`	`133`	`versions "3.8.1", "3.6.3", "3.5.4"`
`147`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2022 the original author or authors.`
	`2`	`+ * Copyright 2012-2021 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -171,7 +171,6 @@ private CustomLayers getCustomLayers(File configuration) {`
`171`	`171`	`private Document getDocumentIfAvailable(File xmlFile) throws Exception {`
`172`	`172`	`InputSource inputSource = new InputSource(new FileInputStream(xmlFile));`
`173`	`173`	`DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();`
`174`		`- factory.setNamespaceAware(true);`
`175`	`174`	`DocumentBuilder builder = factory.newDocumentBuilder();`
`176`	`175`	`return builder.parse(inputSource);`
`177`	`176`	`}`