Coverage Report

Coverage Report - org.apache.maven.project.validation.DefaultModelValidator

Classes in this File

Line Coverage

Branch Coverage

Complexity

DefaultModelValidator

0/120

0/72

5.667

 package org.apache.maven.project.validation;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *  http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.model.Build;
 import org.apache.maven.model.Dependency;
 import org.apache.maven.model.DependencyManagement;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.Parent;
 import org.apache.maven.model.Plugin;
 import org.apache.maven.model.ReportPlugin;
 import org.apache.maven.model.Reporting;
 import org.apache.maven.model.Repository;
 import org.apache.maven.model.Resource;
 import org.codehaus.plexus.util.StringUtils;
 
 import java.io.File;
 import java.util.Iterator;
 import java.util.List;
 
 /**
  * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
  * @version $Id: DefaultModelValidator.java 764520 2009-04-13 16:34:12Z pgier $
  */
 public class DefaultModelValidator
     implements ModelValidator
 {
     private static final String ID_REGEX = "[A-Za-z0-9_\\-.]+";
 
     ///////////////////////////////////////////////////////////////////////////
     // ModelValidator Implementation
 
     public ModelValidationResult validate( Model model )
     {
         ModelValidationResult result = new ModelValidationResult();
 
         validateStringNotEmpty( "modelVersion", result, model.getModelVersion() );
 
         validateId( "groupId", result, model.getGroupId() );
 
         validateId( "artifactId", result, model.getArtifactId() );
 
         validateStringNotEmpty( "packaging", result, model.getPackaging() );
         
         if ( !model.getModules().isEmpty() && !"pom".equals( model.getPackaging() ) )
         {
             result.addMessage( "Packaging '" + model.getPackaging() + "' is invalid. Aggregator projects " +
                     "require 'pom' as packaging." );
         }
         
         Parent parent = model.getParent();
         if ( parent != null )
         {
             if ( parent.getGroupId().equals( model.getGroupId() ) && 
                     parent.getArtifactId().equals( model.getArtifactId() ) )
             {
                 result.addMessage( "The parent element cannot have the same ID as the project." );
             }
         }
 
         validateStringNotEmpty( "version", result, model.getVersion() );
 
         for ( Iterator it = model.getDependencies().iterator(); it.hasNext(); )
         {
             Dependency d = (Dependency) it.next();
 
             validateId( "dependencies.dependency.artifactId", result, d.getArtifactId() );
 
             validateId( "dependencies.dependency.groupId", result, d.getGroupId() );
 
             validateStringNotEmpty( "dependencies.dependency.type", result, d.getType(), d.getManagementKey() );
 
             validateStringNotEmpty( "dependencies.dependency.version", result, d.getVersion(), d.getManagementKey() );
 
             if ( Artifact.SCOPE_SYSTEM.equals( d.getScope() ) )
             {
                 String systemPath = d.getSystemPath();
                 
                 if ( StringUtils.isEmpty( systemPath ) )
                 {
                     result.addMessage( "For dependency " + d + ": system-scoped dependency must specify systemPath." );
                 }
                 else
                 {
                     if ( ! new File( systemPath ).isAbsolute() )
                     {
                         result.addMessage( "For dependency " + d + ": system-scoped dependency must " +
                                 "specify an absolute path systemPath." );
                     }
                 }
             }
             else if ( StringUtils.isNotEmpty( d.getSystemPath() ) )
             {
                 result.addMessage(
                     "For dependency " + d + ": only dependency with system scope can specify systemPath." );
             }
         }
 
         DependencyManagement mgmt = model.getDependencyManagement();
         if ( mgmt != null )
         {
             for ( Iterator it = mgmt.getDependencies().iterator(); it.hasNext(); )
             {
                 Dependency d = (Dependency) it.next();
 
                 validateSubElementStringNotEmpty( d, "dependencyManagement.dependencies.dependency.artifactId", result,
                                                   d.getArtifactId() );
 
                 validateSubElementStringNotEmpty( d, "dependencyManagement.dependencies.dependency.groupId", result,
                                                   d.getGroupId() );
 
                 if ( Artifact.SCOPE_SYSTEM.equals( d.getScope() ) )
                 {
                     String systemPath = d.getSystemPath();
                     
                     if ( StringUtils.isEmpty( systemPath ) )
                     {
                         result.addMessage( "For managed dependency " + d + ": system-scoped dependency must specify systemPath." );
                     }
                     else
                     {
                         if ( ! new File( systemPath ).isAbsolute() )
                         {
                             result.addMessage( "For managed dependency " + d + ": system-scoped dependency must " +
                                     "specify an absolute path systemPath." );
                         }
                     }
                 }
                 else if ( StringUtils.isNotEmpty( d.getSystemPath() ) )
                 {
                     result.addMessage(
                         "For managed dependency " + d + ": only dependency with system scope can specify systemPath." );
                 }
             }
         }
 
         Build build = model.getBuild();
         if ( build != null )
         {
             for ( Iterator it = build.getPlugins().iterator(); it.hasNext(); )
             {
                 Plugin p = (Plugin) it.next();
 
                 validateStringNotEmpty( "build.plugins.plugin.artifactId", result, p.getArtifactId() );
 
                 validateStringNotEmpty( "build.plugins.plugin.groupId", result, p.getGroupId() );
             }
 
             for ( Iterator it = build.getResources().iterator(); it.hasNext(); )
             {
                 Resource r = (Resource) it.next();
 
                 validateStringNotEmpty( "build.resources.resource.directory", result, r.getDirectory() );
             }
 
             for ( Iterator it = build.getTestResources().iterator(); it.hasNext(); )
             {
                 Resource r = (Resource) it.next();
 
                 validateStringNotEmpty( "build.testResources.testResource.directory", result, r.getDirectory() );
             }
         }
 
         Reporting reporting = model.getReporting();
         if ( reporting != null )
         {
             for ( Iterator it = reporting.getPlugins().iterator(); it.hasNext(); )
             {
                 ReportPlugin p = (ReportPlugin) it.next();
 
                 validateStringNotEmpty( "reporting.plugins.plugin.artifactId", result, p.getArtifactId() );
 
                 validateStringNotEmpty( "reporting.plugins.plugin.groupId", result, p.getGroupId() );
             }
         }
 
         validateRepositories( result, model.getRepositories(), "repositories.repository" );
 
         validateRepositories( result, model.getPluginRepositories(), "pluginRepositories.pluginRepository" );
 
         forcePluginExecutionIdCollision( model, result );
 
         return result;
     }
 
     private boolean validateId( String fieldName, ModelValidationResult result, String id )
     {
         if ( !validateStringNotEmpty( fieldName, result, id ) )
         {
             return false;
         }
         else
         {
             boolean match = id.matches( ID_REGEX );
             if ( !match )
             {
                 result.addMessage( "'" + fieldName + "' with value '" + id + "' does not match a valid id pattern." );
             }
             return match;
         }
     }
 
     private void validateRepositories( ModelValidationResult result, List repositories, String prefix )
     {
         for ( Iterator it = repositories.iterator(); it.hasNext(); )
         {
             Repository repository = (Repository) it.next();
 
             validateStringNotEmpty( prefix + ".id", result, repository.getId() );
 
             validateStringNotEmpty( prefix + ".url", result, repository.getUrl() );
         }
     }
 
     private void forcePluginExecutionIdCollision( Model model, ModelValidationResult result )
     {
         Build build = model.getBuild();
 
         if ( build != null )
         {
             List plugins = build.getPlugins();
 
             if ( plugins != null )
             {
                 for ( Iterator it = plugins.iterator(); it.hasNext(); )
                 {
                     Plugin plugin = (Plugin) it.next();
 
                     // this will force an IllegalStateException, even if we don't have to do inheritance assembly.
                     try
                     {
                         plugin.getExecutionsAsMap();
                     }
                     catch ( IllegalStateException collisionException )
                     {
                         result.addMessage( collisionException.getMessage() );
                     }
                 }
             }
         }
     }
 
 
     // ----------------------------------------------------------------------
     // Field validation
     // ----------------------------------------------------------------------
 
     private boolean validateStringNotEmpty( String fieldName, ModelValidationResult result, String string )
     {
         return validateStringNotEmpty( fieldName, result, string, null );
     }
 
     /**
      * Asserts:
      * <p/>
      * <ul>
      * <li><code>string.length != null</code>
      * <li><code>string.length > 0</code>
      * </ul>
      */
     private boolean validateStringNotEmpty( String fieldName, ModelValidationResult result, String string, String sourceHint )
     {
         if ( !validateNotNull( fieldName, result, string, sourceHint ) )
         {
             return false;
         }
 
         if ( string.length() > 0 )
         {
             return true;
         }
 
         if ( sourceHint != null )
         {
             result.addMessage( "'" + fieldName + "' is missing for " + sourceHint );
         }
         else
         {
             result.addMessage( "'" + fieldName + "' is missing." );
         }
 
 
         return false;
     }
 
     /**
      * Asserts:
      * <p/>
      * <ul>
      * <li><code>string.length != null</code>
      * <li><code>string.length > 0</code>
      * </ul>
      */
     private boolean validateSubElementStringNotEmpty( Object subElementInstance, String fieldName,
                                                       ModelValidationResult result, String string )
     {
         if ( !validateSubElementNotNull( subElementInstance, fieldName, result, string ) )
         {
             return false;
         }
 
         if ( string.length() > 0 )
         {
             return true;
         }
 
         result.addMessage( "In " + subElementInstance + ":\n\n       -> '" + fieldName + "' is missing." );
 
         return false;
     }
 
     /**
      * Asserts:
      * <p/>
      * <ul>
      * <li><code>string != null</code>
      * </ul>
      */
     private boolean validateNotNull( String fieldName, ModelValidationResult result, Object object, String sourceHint )
     {
         if ( object != null )
         {
             return true;
         }
 
         if ( sourceHint != null )
         {
             result.addMessage( "'" + fieldName + "' is missing for " + sourceHint );
         }
         else
         {
             result.addMessage( "'" + fieldName + "' is missing." );
         }
 
         return false;
     }
 
     /**
      * Asserts:
      * <p/>
      * <ul>
      * <li><code>string != null</code>
      * </ul>
      */
     private boolean validateSubElementNotNull( Object subElementInstance, String fieldName,
                                                ModelValidationResult result, Object object )
     {
         if ( object != null )
         {
             return true;
         }
 
         result.addMessage( "In " + subElementInstance + ":\n\n       -> '" + fieldName + "' is missing." );
 
         return false;
     }
 }

1		package org.apache.maven.project.validation;
2
3		/*
4		* Licensed to the Apache Software Foundation (ASF) under one
5		* or more contributor license agreements. See the NOTICE file
6		* distributed with this work for additional information
7		* regarding copyright ownership. The ASF licenses this file
8		* to you under the Apache License, Version 2.0 (the
9		* "License"); you may not use this file except in compliance
10		* with the License. You may obtain a copy of the License at
11		*
12		* http://www.apache.org/licenses/LICENSE-2.0
13		*
14		* Unless required by applicable law or agreed to in writing,
15		* software distributed under the License is distributed on an
16		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17		* KIND, either express or implied. See the License for the
18		* specific language governing permissions and limitations
19		* under the License.
20		*/
21
22		import org.apache.maven.artifact.Artifact;
23		import org.apache.maven.model.Build;
24		import org.apache.maven.model.Dependency;
25		import org.apache.maven.model.DependencyManagement;
26		import org.apache.maven.model.Model;
27		import org.apache.maven.model.Parent;
28		import org.apache.maven.model.Plugin;
29		import org.apache.maven.model.ReportPlugin;
30		import org.apache.maven.model.Reporting;
31		import org.apache.maven.model.Repository;
32		import org.apache.maven.model.Resource;
33		import org.codehaus.plexus.util.StringUtils;
34
35		import java.io.File;
36		import java.util.Iterator;
37		import java.util.List;
38
39		/**
40		* @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
41		* @version $Id: DefaultModelValidator.java 764520 2009-04-13 16:34:12Z pgier $
42		*/
43	0	public class DefaultModelValidator
44		implements ModelValidator
45		{
46		private static final String ID_REGEX = "[A-Za-z0-9_\\-.]+";
47
48		///////////////////////////////////////////////////////////////////////////
49		// ModelValidator Implementation
50
51		public ModelValidationResult validate( Model model )
52		{
53	0	ModelValidationResult result = new ModelValidationResult();
54
55	0	validateStringNotEmpty( "modelVersion", result, model.getModelVersion() );
56
57	0	validateId( "groupId", result, model.getGroupId() );
58
59	0	validateId( "artifactId", result, model.getArtifactId() );
60
61	0	validateStringNotEmpty( "packaging", result, model.getPackaging() );
62
63	0	if ( !model.getModules().isEmpty() && !"pom".equals( model.getPackaging() ) )
64		{
65	0	result.addMessage( "Packaging '" + model.getPackaging() + "' is invalid. Aggregator projects " +
66		"require 'pom' as packaging." );
67		}
68
69	0	Parent parent = model.getParent();
70	0	if ( parent != null )
71		{
72	0	if ( parent.getGroupId().equals( model.getGroupId() ) &&
73		parent.getArtifactId().equals( model.getArtifactId() ) )
74		{
75	0	result.addMessage( "The parent element cannot have the same ID as the project." );
76		}
77		}
78
79	0	validateStringNotEmpty( "version", result, model.getVersion() );
80
81	0	for ( Iterator it = model.getDependencies().iterator(); it.hasNext(); )
82		{
83	0	Dependency d = (Dependency) it.next();
84
85	0	validateId( "dependencies.dependency.artifactId", result, d.getArtifactId() );
86
87	0	validateId( "dependencies.dependency.groupId", result, d.getGroupId() );
88
89	0	validateStringNotEmpty( "dependencies.dependency.type", result, d.getType(), d.getManagementKey() );
90
91	0	validateStringNotEmpty( "dependencies.dependency.version", result, d.getVersion(), d.getManagementKey() );
92
93	0	if ( Artifact.SCOPE_SYSTEM.equals( d.getScope() ) )
94		{
95	0	String systemPath = d.getSystemPath();
96
97	0	if ( StringUtils.isEmpty( systemPath ) )
98		{
99	0	result.addMessage( "For dependency " + d + ": system-scoped dependency must specify systemPath." );
100		}
101		else
102		{
103	0	if ( ! new File( systemPath ).isAbsolute() )
104		{
105	0	result.addMessage( "For dependency " + d + ": system-scoped dependency must " +
106		"specify an absolute path systemPath." );
107		}
108		}
109	0	}
110	0	else if ( StringUtils.isNotEmpty( d.getSystemPath() ) )
111		{
112	0	result.addMessage(
113		"For dependency " + d + ": only dependency with system scope can specify systemPath." );
114		}
115	0	}
116
117	0	DependencyManagement mgmt = model.getDependencyManagement();
118	0	if ( mgmt != null )
119		{
120	0	for ( Iterator it = mgmt.getDependencies().iterator(); it.hasNext(); )
121		{
122	0	Dependency d = (Dependency) it.next();
123
124	0	validateSubElementStringNotEmpty( d, "dependencyManagement.dependencies.dependency.artifactId", result,
125		d.getArtifactId() );
126
127	0	validateSubElementStringNotEmpty( d, "dependencyManagement.dependencies.dependency.groupId", result,
128		d.getGroupId() );
129
130	0	if ( Artifact.SCOPE_SYSTEM.equals( d.getScope() ) )
131		{
132	0	String systemPath = d.getSystemPath();
133
134	0	if ( StringUtils.isEmpty( systemPath ) )
135		{
136	0	result.addMessage( "For managed dependency " + d + ": system-scoped dependency must specify systemPath." );
137		}
138		else
139		{
140	0	if ( ! new File( systemPath ).isAbsolute() )
141		{
142	0	result.addMessage( "For managed dependency " + d + ": system-scoped dependency must " +
143		"specify an absolute path systemPath." );
144		}
145		}
146	0	}
147	0	else if ( StringUtils.isNotEmpty( d.getSystemPath() ) )
148		{
149	0	result.addMessage(
150		"For managed dependency " + d + ": only dependency with system scope can specify systemPath." );
151		}
152	0	}
153		}
154
155	0	Build build = model.getBuild();
156	0	if ( build != null )
157		{
158	0	for ( Iterator it = build.getPlugins().iterator(); it.hasNext(); )
159		{
160	0	Plugin p = (Plugin) it.next();
161
162	0	validateStringNotEmpty( "build.plugins.plugin.artifactId", result, p.getArtifactId() );
163
164	0	validateStringNotEmpty( "build.plugins.plugin.groupId", result, p.getGroupId() );
165	0	}
166
167	0	for ( Iterator it = build.getResources().iterator(); it.hasNext(); )
168		{
169	0	Resource r = (Resource) it.next();
170
171	0	validateStringNotEmpty( "build.resources.resource.directory", result, r.getDirectory() );
172	0	}
173
174	0	for ( Iterator it = build.getTestResources().iterator(); it.hasNext(); )
175		{
176	0	Resource r = (Resource) it.next();
177
178	0	validateStringNotEmpty( "build.testResources.testResource.directory", result, r.getDirectory() );
179	0	}
180		}
181
182	0	Reporting reporting = model.getReporting();
183	0	if ( reporting != null )
184		{
185	0	for ( Iterator it = reporting.getPlugins().iterator(); it.hasNext(); )
186		{
187	0	ReportPlugin p = (ReportPlugin) it.next();
188
189	0	validateStringNotEmpty( "reporting.plugins.plugin.artifactId", result, p.getArtifactId() );
190
191	0	validateStringNotEmpty( "reporting.plugins.plugin.groupId", result, p.getGroupId() );
192	0	}
193		}
194
195	0	validateRepositories( result, model.getRepositories(), "repositories.repository" );
196
197	0	validateRepositories( result, model.getPluginRepositories(), "pluginRepositories.pluginRepository" );
198
199	0	forcePluginExecutionIdCollision( model, result );
200
201	0	return result;
202		}
203
204		private boolean validateId( String fieldName, ModelValidationResult result, String id )
205		{
206	0	if ( !validateStringNotEmpty( fieldName, result, id ) )
207		{
208	0	return false;
209		}
210		else
211		{
212	0	boolean match = id.matches( ID_REGEX );
213	0	if ( !match )
214		{
215	0	result.addMessage( "'" + fieldName + "' with value '" + id + "' does not match a valid id pattern." );
216		}
217	0	return match;
218		}
219		}
220
221		private void validateRepositories( ModelValidationResult result, List repositories, String prefix )
222		{
223	0	for ( Iterator it = repositories.iterator(); it.hasNext(); )
224		{
225	0	Repository repository = (Repository) it.next();
226
227	0	validateStringNotEmpty( prefix + ".id", result, repository.getId() );
228
229	0	validateStringNotEmpty( prefix + ".url", result, repository.getUrl() );
230	0	}
231	0	}
232
233		private void forcePluginExecutionIdCollision( Model model, ModelValidationResult result )
234		{
235	0	Build build = model.getBuild();
236
237	0	if ( build != null )
238		{
239	0	List plugins = build.getPlugins();
240
241	0	if ( plugins != null )
242		{
243	0	for ( Iterator it = plugins.iterator(); it.hasNext(); )
244		{
245	0	Plugin plugin = (Plugin) it.next();
246
247		// this will force an IllegalStateException, even if we don't have to do inheritance assembly.
248		try
249		{
250	0	plugin.getExecutionsAsMap();
251		}
252	0	catch ( IllegalStateException collisionException )
253		{
254	0	result.addMessage( collisionException.getMessage() );
255	0	}
256	0	}
257		}
258		}
259	0	}
260
261
262		// ----------------------------------------------------------------------
263		// Field validation
264		// ----------------------------------------------------------------------
265
266		private boolean validateStringNotEmpty( String fieldName, ModelValidationResult result, String string )
267		{
268	0	return validateStringNotEmpty( fieldName, result, string, null );
269		}
270
271		/**
272		* Asserts:
273		* <p/>
274		* <ul>
275		* <li><code>string.length != null</code>
276		* <li><code>string.length > 0</code>
277		* </ul>
278		*/
279		private boolean validateStringNotEmpty( String fieldName, ModelValidationResult result, String string, String sourceHint )
280		{
281	0	if ( !validateNotNull( fieldName, result, string, sourceHint ) )
282		{
283	0	return false;
284		}
285
286	0	if ( string.length() > 0 )
287		{
288	0	return true;
289		}
290
291	0	if ( sourceHint != null )
292		{
293	0	result.addMessage( "'" + fieldName + "' is missing for " + sourceHint );
294		}
295		else
296		{
297	0	result.addMessage( "'" + fieldName + "' is missing." );
298		}
299
300
301	0	return false;
302		}
303
304		/**
305		* Asserts:
306		* <p/>
307		* <ul>
308		* <li><code>string.length != null</code>
309		* <li><code>string.length > 0</code>
310		* </ul>
311		*/
312		private boolean validateSubElementStringNotEmpty( Object subElementInstance, String fieldName,
313		ModelValidationResult result, String string )
314		{
315	0	if ( !validateSubElementNotNull( subElementInstance, fieldName, result, string ) )
316		{
317	0	return false;
318		}
319
320	0	if ( string.length() > 0 )
321		{
322	0	return true;
323		}
324
325	0	result.addMessage( "In " + subElementInstance + ":\n\n -> '" + fieldName + "' is missing." );
326
327	0	return false;
328		}
329
330		/**
331		* Asserts:
332		* <p/>
333		* <ul>
334		* <li><code>string != null</code>
335		* </ul>
336		*/
337		private boolean validateNotNull( String fieldName, ModelValidationResult result, Object object, String sourceHint )
338		{
339	0	if ( object != null )
340		{
341	0	return true;
342		}
343
344	0	if ( sourceHint != null )
345		{
346	0	result.addMessage( "'" + fieldName + "' is missing for " + sourceHint );
347		}
348		else
349		{
350	0	result.addMessage( "'" + fieldName + "' is missing." );
351		}
352
353	0	return false;
354		}
355
356		/**
357		* Asserts:
358		* <p/>
359		* <ul>
360		* <li><code>string != null</code>
361		* </ul>
362		*/
363		private boolean validateSubElementNotNull( Object subElementInstance, String fieldName,
364		ModelValidationResult result, Object object )
365		{
366	0	if ( object != null )
367		{
368	0	return true;
369		}
370
371	0	result.addMessage( "In " + subElementInstance + ":\n\n -> '" + fieldName + "' is missing." );
372
373	0	return false;
374		}
375		}