From b8ba9ce57735cf9bac5ffa7b9346084fac04f3a3 Mon Sep 17 00:00:00 2001 From: bwalding Date: Sun, 9 Feb 2003 13:26:40 +0000 Subject: [PATCH] An alternative way of validating the POM. Doesn't use the XSD as XSD doesn't take into account interpolation and inheritance. This does not replace the XSD validation, merely enhances it. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112863 13f79535-47bb-0310-9956-ffa450edef68 --- pom/plugin.jelly | 20 +++ .../main/org/apache/maven/ContentNotice.java | 108 ++++++++++++++ .../org/apache/maven/ContentValidator.java | 134 ++++++++++++++++++ 3 files changed, 262 insertions(+) create mode 100644 pom/src/main/org/apache/maven/ContentNotice.java create mode 100644 pom/src/main/org/apache/maven/ContentValidator.java diff --git a/pom/plugin.jelly b/pom/plugin.jelly index 12e326d9..1276b1c2 100644 --- a/pom/plugin.jelly +++ b/pom/plugin.jelly @@ -15,6 +15,12 @@ className="org.apache.maven.Validator" method="execute" /> + + @@ -37,6 +43,20 @@ POM is valid + + + + + + + + + ${notice.Level} : ${notice.Section} : ${notice.Message} + + + diff --git a/pom/src/main/org/apache/maven/ContentNotice.java b/pom/src/main/org/apache/maven/ContentNotice.java new file mode 100644 index 00000000..e18b1774 --- /dev/null +++ b/pom/src/main/org/apache/maven/ContentNotice.java @@ -0,0 +1,108 @@ +package org.apache.maven; + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache Maven" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache Maven", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + * ==================================================================== + */ + +/** + * @author Ben Walding + * @version $Id: ContentNotice.java,v 1.1 2003/02/09 13:26:40 bwalding Exp $ + */ +public class ContentNotice +{ + public static final String INFO = "INFO"; + public static final String WARN = "WARNING"; + public static final String ERROR = "ERROR"; + + private String section; + private String message; + private String level; + + public ContentNotice(String level, String section, String message) + { + this.level = level; + this.section = section; + this.message = message; + } + /** + * @return String + */ + public String getMessage() + { + return message; + } + + /** + * @return String + */ + public String getSection() + { + return section; + } + + /** + * @return String + */ + public String getLevel() + { + return level; + } + + public String toString() + { + return level + " : " + section + " : " + message; + } + +} diff --git a/pom/src/main/org/apache/maven/ContentValidator.java b/pom/src/main/org/apache/maven/ContentValidator.java new file mode 100644 index 00000000..211f52bb --- /dev/null +++ b/pom/src/main/org/apache/maven/ContentValidator.java @@ -0,0 +1,134 @@ +package org.apache.maven; + +/* ==================================================================== + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2003 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, + * if any, must include the following acknowledgment: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowledgment may appear in the software itself, + * if and wherever such third-party acknowledgments normally appear. + * + * 4. The names "Apache" and "Apache Software Foundation" and + * "Apache Maven" must not be used to endorse or promote products + * derived from this software without prior written permission. For + * written permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache", + * "Apache Maven", nor may "Apache" appear in their name, without + * prior written permission of the Apache Software Foundation. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + * + * ==================================================================== + */ + +import java.util.ArrayList; +import java.util.List; + +import org.apache.maven.project.Project; + +/** + * @author Ben Walding + * @version $Id: ContentValidator.java,v 1.1 2003/02/09 13:26:40 bwalding Exp $ + */ +public class ContentValidator +{ + List notices; + Project project; + public ContentValidator() + { + } + /** + * @return Project + */ + public Project getProject() + { + return project; + } + + /** + * Sets the project. + * @param project The project to set + */ + public void setProject(Project project) + { + this.project = project; + } + + protected void addNotice(ContentNotice notice) + { + notices.add(notice); + } + + protected void addNotice(String level, String section, String message) + { + addNotice(new ContentNotice(level, section, message)); + } + + public List execute() + { + notices = new ArrayList(); + validateProject(); + return notices; + } + + protected void validateProject() + { + if (project.getLogo() == null || project.getLogo().trim().length() == 0) + { + addNotice(ContentNotice.INFO, "/project/logo", "Element is null or empty. No logo will be displayed."); + } + + validateLicenses(); + } + + protected void validateLicenses() + { + if (project.getLicenses().size() == 0) + { + addNotice( + ContentNotice.WARN, + "/project/licenses", + "No licenses defined. Your project has a license and it should be entered into the licenses section."); + } + } + + protected void validateDevelopers() + { + } + +}