Coverage Report

Coverage Report - org.apache.maven.plugins.enforcer.EnforceMojo

Classes in this File

Line Coverage

Branch Coverage

Complexity

EnforceMojo

81%

63/77

93%

28/30

2.176

 package org.apache.maven.plugins.enforcer;
 
 /*
  * 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 java.util.ArrayList;
 import java.util.Hashtable;
 import java.util.Iterator;
 
 import org.apache.maven.enforcer.rule.api.EnforcerRule;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
 import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
 import org.apache.maven.execution.MavenSession;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.project.path.PathTranslator;
 import org.codehaus.plexus.PlexusConstants;
 import org.codehaus.plexus.PlexusContainer;
 import org.codehaus.plexus.context.Context;
 import org.codehaus.plexus.context.ContextException;
 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable;
 
 /**
  * This goal executes the defined enforcer-rules once per
  * module.
  * 
  * @requiresDependencyResolution test
  * @goal enforce
  * @phase validate
  * @threadSafe
  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
  * @version $Id: EnforceMojo.java 1127643 2011-05-25 19:24:38Z krosenvold $
  */
 public class EnforceMojo
     extends AbstractMojo
     implements Contextualizable
 {
 
     /**
      * Path Translator needed by the ExpressionEvaluator
      * 
      * @component role="org.apache.maven.project.path.PathTranslator"
      */
     protected PathTranslator translator;
 
     /**
      * The MavenSession
      * 
      * @parameter expression="${session}"
      * @readonly
      */
     protected MavenSession session;
 
     /**
      * POM
      * 
      * @parameter expression="${project}"
      * @readonly
      * @required
      */
     protected MavenProject project;
 
     /**
      * Flag to fail the build if a version check fails.
      * 
      * @parameter expression="${enforcer.fail}"
      *            default-value="true"
      */
     protected boolean fail = true;
 
     /**
      * Flag to easily skip all checks
      * 
      * @parameter expression="${enforcer.skip}"
      *            default-value="false"
      */
     protected boolean skip = false;
 
     /**
      * Fail on the first rule that doesn't pass
      * 
      * @parameter expression="${enforcer.failFast}"
      *            default-value="false"
      */
     protected boolean failFast = false;
 
     /**
      * Array of objects that implement the EnforcerRule
      * interface to execute.
      * 
      * @parameter
      * @required
      */
     private EnforcerRule[] rules;
     
     /**
      * Use this flag to disable rule result caching. This will cause
      * all rules to execute on each project even if the rule indicates it can
      * safely be cached.
      * @parameter expression="${enforcer.ignoreCache}"
      *  default-value="false"
      */
      protected boolean ignoreCache = false;
     
     /**
      * This is a static variable used to persist the cached results across plugin invocations.
      */
      protected static Hashtable cache = new Hashtable();
 
     
     // set by the contextualize method. Only way to get the
     // plugin's container in 2.0.x
     protected PlexusContainer container;
 
     public void contextualize ( Context context )
         throws ContextException
     {
         container = (PlexusContainer) context.get( PlexusConstants.PLEXUS_KEY );
     }
     
     /**
      * Entry point to the mojo
      */
     public void execute ()
         throws MojoExecutionException
     {
         Log log = this.getLog();
 
         EnforcerExpressionEvaluator evaluator = new EnforcerExpressionEvaluator( session, translator, project );
 
         // the entire execution can be easily skipped
         if ( !skip )
         {
             // list to store exceptions
             ArrayList list = new ArrayList();
 
             // make sure the rules exist
             if ( rules != null && rules.length > 0 )
             {
                 String currentRule = "Unknown";
 
                 // create my helper
                 EnforcerRuleHelper helper = new DefaultEnforcementRuleHelper( session, evaluator, log, container );
 
                 // if we are only warning, then disable
                 // failFast
                 if ( !fail )
                 {
                     failFast = false;
                 }
 
                 // go through each rule
                 for ( int i = 0; i < rules.length; i++ )
                 {
 
                     // prevent against empty rules
                     EnforcerRule rule = rules[i];
                     if ( rule != null )
                     {
                         // store the current rule for
                         // logging purposes
                         currentRule = rule.getClass().getName();
                         log.debug( "Executing rule: " + currentRule );
                         try
                         {
                             if ( ignoreCache || shouldExecute( rule ) )
                             {
                                 // execute the rule
                                 //noinspection SynchronizationOnLocalVariableOrMethodParameter
                                 synchronized ( rule )
                                 {
                                    rule.execute( helper );
                                 }
                             }
                         }
                         catch ( EnforcerRuleException e )
                         {
                             // i can throw an exception
                             // because failfast will be
                             // false if fail is false.
                             if ( failFast )
                             {
                                 throw new MojoExecutionException( currentRule + " failed with message:\n"
                                     + e.getMessage(), e );
                             }
                             else
                             {
                                 list.add( "Rule " + i + ": " + currentRule + " failed with message:\n" + e.getMessage() );
                                 log.debug( "Adding failure due to exception", e );
                             }
                         }
                     }
                 }
 
                 // if we found anything
                 if ( !list.isEmpty() )
                 {
                     Iterator iter = list.iterator();
                     while ( iter.hasNext() )
                     {
                         String failure = (String) iter.next();
                         log.warn( failure );
                     }
                     if ( fail )
                     {
                         throw new MojoExecutionException(
                                                           "Some Enforcer rules have failed. Look above for specific messages explaining why the rule failed." );
                     }
                 }
             }
             else
             {
                 throw new MojoExecutionException(
                                                   "No rules are configured. Use the skip flag if you want to disable execution." );
             }
         }
         else
         {
             log.info( "Skipping Rule Enforcement." );
         }
     }
 
     /**
      * This method determines if a rule should execute based
      * on the cache
      * 
      * @param rule
      * @return
      */
     protected boolean shouldExecute ( EnforcerRule rule )
     {
         if ( rule.isCacheable() )
         {
             Log log = this.getLog();
             log.debug( "Rule " + rule.getClass().getName() + " is cacheable." );
             String key = rule.getClass().getName() + " " + rule.getCacheId();
             if ( EnforceMojo.cache.containsKey( key ) )
             {
                 log.debug( "Key " + key + " was found in the cache" );
                 if ( rule.isResultValid( (EnforcerRule) cache.get( key ) ) )
                 {
                     log.debug( "The cached results are still valid. Skipping the rule: "+rule.getClass().getName() );
                     return false;
                 }
             }
             
             //add it to the cache of executed rules
             EnforceMojo.cache.put( key, rule );
         }
         return true;
     }
 
     /**
      * @return the fail
      */
     public boolean isFail ()
     {
         return this.fail;
     }
 
     /**
      * @param theFail the fail to set
      */
     public void setFail ( boolean theFail )
     {
         this.fail = theFail;
     }
 
     /**
      * @return the rules
      */
     public EnforcerRule[] getRules ()
     {
         return this.rules;
     }
 
     /**
      * @param theRules the rules to set
      */
     public void setRules ( EnforcerRule[] theRules )
     {
         this.rules = theRules;
     }
 
     /**
      * @return the skip
      */
     public boolean isSkip ()
     {
         return this.skip;
     }
 
     /**
      * @param theSkip the skip to set
      */
     public void setSkip ( boolean theSkip )
     {
         this.skip = theSkip;
     }
 
     /**
      * @return the failFast
      */
     public boolean isFailFast ()
     {
         return this.failFast;
     }
 
     /**
      * @param theFailFast the failFast to set
      */
     public void setFailFast ( boolean theFailFast )
     {
         this.failFast = theFailFast;
     }
 
     /**
      * @return the project
      */
     public MavenProject getProject ()
     {
         return this.project;
     }
 
     /**
      * @param theProject the project to set
      */
     public void setProject ( MavenProject theProject )
     {
         this.project = theProject;
     }
 
     /**
      * @return the session
      */
     public MavenSession getSession ()
     {
         return this.session;
     }
 
     /**
      * @param theSession the session to set
      */
     public void setSession ( MavenSession theSession )
     {
         this.session = theSession;
     }
 
     /**
      * @return the translator
      */
     public PathTranslator getTranslator ()
     {
         return this.translator;
     }
 
     /**
      * @param theTranslator the translator to set
      */
     public void setTranslator ( PathTranslator theTranslator )
     {
         this.translator = theTranslator;
     }
 }

1		package org.apache.maven.plugins.enforcer;
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 java.util.ArrayList;
23		import java.util.Hashtable;
24		import java.util.Iterator;
25
26		import org.apache.maven.enforcer.rule.api.EnforcerRule;
27		import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
28		import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
29		import org.apache.maven.execution.MavenSession;
30		import org.apache.maven.plugin.AbstractMojo;
31		import org.apache.maven.plugin.MojoExecutionException;
32		import org.apache.maven.plugin.logging.Log;
33		import org.apache.maven.project.MavenProject;
34		import org.apache.maven.project.path.PathTranslator;
35		import org.codehaus.plexus.PlexusConstants;
36		import org.codehaus.plexus.PlexusContainer;
37		import org.codehaus.plexus.context.Context;
38		import org.codehaus.plexus.context.ContextException;
39		import org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable;
40
41		/**
42		* This goal executes the defined enforcer-rules once per
43		* module.
44		*
45		* @requiresDependencyResolution test
46		* @goal enforce
47		* @phase validate
48		* @threadSafe
49		* @author <a href="mailto:brianf@apache.org">Brian Fox</a>
50		* @version $Id: EnforceMojo.java 1127643 2011-05-25 19:24:38Z krosenvold $
51		*/
52	10	public class EnforceMojo
53		extends AbstractMojo
54		implements Contextualizable
55		{
56
57		/**
58		* Path Translator needed by the ExpressionEvaluator
59		*
60		* @component role="org.apache.maven.project.path.PathTranslator"
61		*/
62		protected PathTranslator translator;
63
64		/**
65		* The MavenSession
66		*
67		* @parameter expression="${session}"
68		* @readonly
69		*/
70		protected MavenSession session;
71
72		/**
73		* POM
74		*
75		* @parameter expression="${project}"
76		* @readonly
77		* @required
78		*/
79		protected MavenProject project;
80
81		/**
82		* Flag to fail the build if a version check fails.
83		*
84		* @parameter expression="${enforcer.fail}"
85		* default-value="true"
86		*/
87	10	protected boolean fail = true;
88
89		/**
90		* Flag to easily skip all checks
91		*
92		* @parameter expression="${enforcer.skip}"
93		* default-value="false"
94		*/
95	10	protected boolean skip = false;
96
97		/**
98		* Fail on the first rule that doesn't pass
99		*
100		* @parameter expression="${enforcer.failFast}"
101		* default-value="false"
102		*/
103	10	protected boolean failFast = false;
104
105		/**
106		* Array of objects that implement the EnforcerRule
107		* interface to execute.
108		*
109		* @parameter
110		* @required
111		*/
112		private EnforcerRule[] rules;
113
114		/**
115		* Use this flag to disable rule result caching. This will cause
116		* all rules to execute on each project even if the rule indicates it can
117		* safely be cached.
118		* @parameter expression="${enforcer.ignoreCache}"
119		* default-value="false"
120		*/
121	10	protected boolean ignoreCache = false;
122
123		/**
124		* This is a static variable used to persist the cached results across plugin invocations.
125		*/
126	2	protected static Hashtable cache = new Hashtable();
127
128
129		// set by the contextualize method. Only way to get the
130		// plugin's container in 2.0.x
131		protected PlexusContainer container;
132
133		public void contextualize ( Context context )
134		throws ContextException
135		{
136	0	container = (PlexusContainer) context.get( PlexusConstants.PLEXUS_KEY );
137	0	}
138
139		/**
140		* Entry point to the mojo
141		*/
142		public void execute ()
143		throws MojoExecutionException
144		{
145	26	Log log = this.getLog();
146
147	26	EnforcerExpressionEvaluator evaluator = new EnforcerExpressionEvaluator( session, translator, project );
148
149		// the entire execution can be easily skipped
150	26	if ( !skip )
151		{
152		// list to store exceptions
153	26	ArrayList list = new ArrayList();
154
155		// make sure the rules exist
156	26	if ( rules != null && rules.length > 0 )
157		{
158	24	String currentRule = "Unknown";
159
160		// create my helper
161	24	EnforcerRuleHelper helper = new DefaultEnforcementRuleHelper( session, evaluator, log, container );
162
163		// if we are only warning, then disable
164		// failFast
165	24	if ( !fail )
166		{
167	2	failFast = false;
168		}
169
170		// go through each rule
171	244	for ( int i = 0; i < rules.length; i++ )
172		{
173
174		// prevent against empty rules
175	222	EnforcerRule rule = rules[i];
176	222	if ( rule != null )
177		{
178		// store the current rule for
179		// logging purposes
180	48	currentRule = rule.getClass().getName();
181	48	log.debug( "Executing rule: " + currentRule );
182		try
183		{
184	48	if ( ignoreCache \|\| shouldExecute( rule ) )
185		{
186		// execute the rule
187		//noinspection SynchronizationOnLocalVariableOrMethodParameter
188	34	synchronized ( rule )
189		{
190	34	rule.execute( helper );
191	24	}
192		}
193		}
194	10	catch ( EnforcerRuleException e )
195		{
196		// i can throw an exception
197		// because failfast will be
198		// false if fail is false.
199	10	if ( failFast )
200		{
201	2	throw new MojoExecutionException( currentRule + " failed with message:\n"
202		+ e.getMessage(), e );
203		}
204		else
205		{
206	8	list.add( "Rule " + i + ": " + currentRule + " failed with message:\n" + e.getMessage() );
207	8	log.debug( "Adding failure due to exception", e );
208		}
209	38	}
210		}
211		}
212
213		// if we found anything
214	22	if ( !list.isEmpty() )
215		{
216	4	Iterator iter = list.iterator();
217	12	while ( iter.hasNext() )
218		{
219	8	String failure = (String) iter.next();
220	8	log.warn( failure );
221	8	}
222	4	if ( fail )
223		{
224	2	throw new MojoExecutionException(
225		"Some Enforcer rules have failed. Look above for specific messages explaining why the rule failed." );
226		}
227		}
228	20	}
229		else
230		{
231	2	throw new MojoExecutionException(
232		"No rules are configured. Use the skip flag if you want to disable execution." );
233		}
234	20	}
235		else
236		{
237	0	log.info( "Skipping Rule Enforcement." );
238		}
239	20	}
240
241		/**
242		* This method determines if a rule should execute based
243		* on the cache
244		*
245		* @param rule
246		* @return
247		*/
248		protected boolean shouldExecute ( EnforcerRule rule )
249		{
250	44	if ( rule.isCacheable() )
251		{
252	28	Log log = this.getLog();
253	28	log.debug( "Rule " + rule.getClass().getName() + " is cacheable." );
254	28	String key = rule.getClass().getName() + " " + rule.getCacheId();
255	28	if ( EnforceMojo.cache.containsKey( key ) )
256		{
257	16	log.debug( "Key " + key + " was found in the cache" );
258	16	if ( rule.isResultValid( (EnforcerRule) cache.get( key ) ) )
259		{
260	14	log.debug( "The cached results are still valid. Skipping the rule: "+rule.getClass().getName() );
261	14	return false;
262		}
263		}
264
265		//add it to the cache of executed rules
266	14	EnforceMojo.cache.put( key, rule );
267		}
268	30	return true;
269		}
270
271		/**
272		* @return the fail
273		*/
274		public boolean isFail ()
275		{
276	0	return this.fail;
277		}
278
279		/**
280		* @param theFail the fail to set
281		*/
282		public void setFail ( boolean theFail )
283		{
284	14	this.fail = theFail;
285	14	}
286
287		/**
288		* @return the rules
289		*/
290		public EnforcerRule[] getRules ()
291		{
292	0	return this.rules;
293		}
294
295		/**
296		* @param theRules the rules to set
297		*/
298		public void setRules ( EnforcerRule[] theRules )
299		{
300	18	this.rules = theRules;
301	18	}
302
303		/**
304		* @return the skip
305		*/
306		public boolean isSkip ()
307		{
308	0	return this.skip;
309		}
310
311		/**
312		* @param theSkip the skip to set
313		*/
314		public void setSkip ( boolean theSkip )
315		{
316	0	this.skip = theSkip;
317	0	}
318
319		/**
320		* @return the failFast
321		*/
322		public boolean isFailFast ()
323		{
324	0	return this.failFast;
325		}
326
327		/**
328		* @param theFailFast the failFast to set
329		*/
330		public void setFailFast ( boolean theFailFast )
331		{
332	4	this.failFast = theFailFast;
333	4	}
334
335		/**
336		* @return the project
337		*/
338		public MavenProject getProject ()
339		{
340	0	return this.project;
341		}
342
343		/**
344		* @param theProject the project to set
345		*/
346		public void setProject ( MavenProject theProject )
347		{
348	10	this.project = theProject;
349	10	}
350
351		/**
352		* @return the session
353		*/
354		public MavenSession getSession ()
355		{
356	0	return this.session;
357		}
358
359		/**
360		* @param theSession the session to set
361		*/
362		public void setSession ( MavenSession theSession )
363		{
364	10	this.session = theSession;
365	10	}
366
367		/**
368		* @return the translator
369		*/
370		public PathTranslator getTranslator ()
371		{
372	0	return this.translator;
373		}
374
375		/**
376		* @param theTranslator the translator to set
377		*/
378		public void setTranslator ( PathTranslator theTranslator )
379		{
380	0	this.translator = theTranslator;
381	0	}
382		}