Skip to content

Commit

Permalink
Merge pull request #31126 from abel533
Browse files Browse the repository at this point in the history
* pr/31126:
  Polish "Resolve errors in layers.xsd"
  Resolve errors in layers.xsd

Closes gh-31126
  • Loading branch information
philwebb committed May 20, 2022
2 parents bf3c6df + 05a6447 commit f185b07
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -64,22 +64,29 @@ 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 {
def versionEl = version.split("\\.")
attributes "spring-boot-xsd-version": versionEl[0] + '.' + versionEl[1]
attributes "spring-boot-xsd-version" : project.ext.xsdVersion
}
}

Expand Down Expand Up @@ -129,6 +136,12 @@ 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"
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2021 the original author or authors.
* Copyright 2012-2022 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.
Expand Down Expand Up @@ -171,6 +171,7 @@ 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);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2022 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.
Expand All @@ -16,16 +16,24 @@

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;
Expand All @@ -45,13 +53,35 @@
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));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<xsd:element name="layers" type="layersType" />
<xsd:complexType name="layersType">
<xsd:sequence>
<xsd:element name="application" type="applicationType" />
<xsd:element name="dependencies" type="dependenciesType" />
<xsd:element name="layerOrder" type="layerOrderType" />
<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:sequence>
</xsd:complexType>
<xsd:complexType name="applicationType">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<xsd:element name="layers" type="layersType" />
<xsd:complexType name="layersType">
<xsd:sequence>
<xsd:element name="application" type="applicationType" />
<xsd:element name="dependencies" type="dependenciesType" />
<xsd:element name="layerOrder" type="layerOrderType" />
<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:sequence>
</xsd:complexType>
<xsd:complexType name="applicationType">
Expand Down Expand Up @@ -78,21 +78,21 @@
<xsd:complexContent>
<xsd:extension base="intoType">
<xsd:choice minOccurs="0">
<xsd:element type="xsd:string" name="includeProjectDependencies" minOccurs="0">
<xsd:element type="xsd:string" name="includeModuleDependencies" 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="excludeProjectDependencies" minOccurs="0">
<xsd:element type="xsd:string" name="excludeModuleDependencies" minOccurs="0">
<xsd:annotation>
<xsd:documentation><![CDATA[
Exclude dependencies on other modules in the build.
]]></xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
</xsd:choice>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<xsd:element name="layers" type="layersType" />
<xsd:complexType name="layersType">
<xsd:sequence>
<xsd:element name="application" type="applicationType" />
<xsd:element name="dependencies" type="dependenciesType" />
<xsd:element name="layerOrder" type="layerOrderType" />
<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:sequence>
</xsd:complexType>
<xsd:complexType name="applicationType">
Expand Down Expand Up @@ -78,21 +78,21 @@
<xsd:complexContent>
<xsd:extension base="intoType">
<xsd:choice minOccurs="0">
<xsd:element type="xsd:string" name="includeProjectDependencies" minOccurs="0">
<xsd:element type="xsd:string" name="includeModuleDependencies" 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="excludeProjectDependencies" minOccurs="0">
<xsd:element type="xsd:string" name="excludeModuleDependencies" minOccurs="0">
<xsd:annotation>
<xsd:documentation><![CDATA[
Exclude dependencies on other modules in the build.
]]></xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
</xsd:choice>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2021 the original author or authors.
* Copyright 2012-2022 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.
Expand Down Expand Up @@ -97,6 +97,7 @@ 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);
}
Expand Down

0 comments on commit f185b07

Please sign in to comment.