Coverage Report

Coverage Report - org.apache.maven.plugin.war.packaging.DependenciesAnalysisPackagingTask

Classes in this File

Line Coverage

Branch Coverage

Complexity

DependenciesAnalysisPackagingTask

73%

34/46

35%

28/78

4,75

DependenciesAnalysisPackagingTask$DependenciesAnalysisCallbackImpl

73%

14/19

1/12

4,75

 package org.apache.maven.plugin.war.packaging;
 
 /*
  * 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.Dependency;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugin.war.util.WebappStructure;
 
 import java.io.File;
 
 /**
  * Analyzes the dependencies of the project with its previous state and update
  * the target directory accordingly.
  *
  * @author Stephane Nicoll
  * 
  * @version $Id: DependenciesAnalysisPackagingTask.java 1367293 2012-07-30 20:54:56Z olamy $
  */
 public class DependenciesAnalysisPackagingTask
     extends AbstractWarPackagingTask
 {
 
     public void performPackaging( final WarPackagingContext context )
         throws MojoExecutionException, MojoFailureException
     {
 
         context.getWebappStructure().analyseDependencies( new DependenciesAnalysisCallbackImpl( context ) );
 
     }
 
     protected void handleDependency( WarPackagingContext context, Dependency dependency, String notBundledMessage,
                                      String warOrZipMessage, String standardMessage, boolean removeFile )
     {
         if ( Artifact.SCOPE_PROVIDED.equals( dependency.getScope() )
             || Artifact.SCOPE_TEST.equals( dependency.getScope() ) || dependency.isOptional() )
         {
             context.getLog().debug( notBundledMessage );
         }
         else if ( "war".equals( dependency.getType() ) || "zip".equals( dependency.getType() ) )
         {
             context.getLog().warn( warOrZipMessage );
         }
         else if ( "tld".equals( dependency.getType() ) || "aar".equals( dependency.getType() )
             || "mar".equals( dependency.getType() ) || "xar".equals( dependency.getType() )
             || "jar".equals( dependency.getType() ) || "ejb".equals( dependency.getType() )
             || "ejb-client".equals( dependency.getType() ) || "test-jar".equals( dependency.getType() )
             || "par".equals( dependency.getType() ) )
         {
             context.getLog().info( standardMessage );
             if ( removeFile )
             {
                 removeDependency( context, dependency );
             }
         }
     }
 
     protected void handleDependencyScope( WarPackagingContext context, Dependency dependency, String warOrZipMessage,
                                           String standardMessage, boolean removeFile )
     {
         if ( "war".equals( dependency.getType() ) || "zip".equals( dependency.getType() ) )
         {
             context.getLog().warn( warOrZipMessage );
         }
         else if ( "tld".equals( dependency.getType() ) || "aar".equals( dependency.getType() )
             || "mar".equals( dependency.getType() ) || "xar".equals( dependency.getType() )
             || "jar".equals( dependency.getType() ) || "ejb".equals( dependency.getType() )
             || "ejb-client".equals( dependency.getType() ) || "test-jar".equals( dependency.getType() )
             || "par".equals( dependency.getType() ) )
         {
             context.getLog().info( standardMessage );
             if ( removeFile )
             {
                 removeDependency( context, dependency );
             }
         }
     }
 
     private void removeDependency( WarPackagingContext context, Dependency dependency )
     {
         final String targetFileName = context.getWebappStructure().getCachedTargetFileName( dependency );
         if ( targetFileName != null )
         {
             final String type = dependency.getType();
             File targetFile = null;
             if ( "tld".equals( type ) )
             {
                 targetFile = new File( context.getWebappDirectory(), ArtifactsPackagingTask.TLD_PATH + targetFileName );
             }
             else if ( "aar".equals( type ) )
             {
                 targetFile =
                     new File( context.getWebappDirectory(), ArtifactsPackagingTask.SERVICES_PATH + targetFileName );
             }
             else if ( "mar".equals( type ) )
             {
                 targetFile =
                     new File( context.getWebappDirectory(), ArtifactsPackagingTask.MODULES_PATH + targetFileName );
             }
             else if ( "xar".equals( type ) )
             {
                 targetFile =
                     new File( context.getWebappDirectory(), ArtifactsPackagingTask.EXTENSIONS_PATH + targetFileName );
             }
             else if ( "jar".equals( type ) || "ejb".equals( type ) || "ejb-client".equals( type )
                 || "test-jar".equals( type ) )
             {
                 targetFile = new File( context.getWebappDirectory(), LIB_PATH + targetFileName );
             }
             else if ( "par".equals( type ) )
             {
                 String targetFileName2 = targetFileName.substring( 0, targetFileName.lastIndexOf( '.' ) ) + ".jar";
                 targetFile = new File( context.getWebappDirectory(), LIB_PATH + targetFileName2 );
             }
 
             // now remove
             if ( targetFile == null )
             {
                 context.getLog().error( "Could not get file from dependency [" + dependency + "]" );
             }
             else if ( targetFile.exists() )
             {
                 context.getLog().debug( "Removing file [" + targetFile.getAbsolutePath() + "]" );
                 targetFile.delete();
             }
             else
             {
                 context.getLog().warn( "File to remove [" + targetFile.getAbsolutePath() + "] has not been found" );
             }
         }
         else
         {
             context.getLog().warn( "Could not retrieve the target file name of dependency [" + dependency + "]" );
         }
     }
 
 
     class DependenciesAnalysisCallbackImpl
         implements WebappStructure.DependenciesAnalysisCallback
     {
         private final WarPackagingContext context;
 
         DependenciesAnalysisCallbackImpl( WarPackagingContext context )
         {
             this.context = context;
         }
 
         public void unchangedDependency( Dependency dependency )
         {
             context.getLog().debug( "Dependency [" + dependency + "] has not changed since last build." );
         }
 
         public void newDependency( Dependency dependency )
         {
             context.getLog().debug( "New dependency [" + dependency + "]." );
         }
 
         public void removedDependency( Dependency dependency )
         {
             handleDependency( context, dependency, "Dependency [" + dependency
                 + "] has been removed from the project but it was not bundled anyway.", "Dependency [" + dependency
                 + "] has been removed from the project. If it was included in the build as an overlay, "
                 + "consider cleaning the target directory of the project (mvn clean)", "Dependency [" + dependency
                 + "] has been removed from the project.", true );
         }
 
         public void updatedVersion( Dependency dependency, String previousVersion )
         {
             handleDependency( context, dependency, "Version of dependency [" + dependency + "] has changed ("
                 + previousVersion + " -> " + dependency.getVersion() + ") but it was not bundled anyway.",
                                                    "Version of dependency [" + dependency + "] has changed ("
                                                        + previousVersion + " -> " + dependency.getVersion()
                                                        + "). If it was included in the build as an overlay, "
                                                        + "consider "
                                                        + "cleaning the target directory of the project (mvn clean)",
                                                    "Version of dependency [" + dependency + "] has changed ("
                                                        + previousVersion + " -> " + dependency.getVersion() + ").",
                                                    true );
         }
 
         public void updatedScope( Dependency dependency, String previousScope )
         {
             if ( Artifact.SCOPE_PROVIDED.equals( dependency.getScope() ) || Artifact.SCOPE_TEST.equals(
                 dependency.getScope() )
                 && ( !Artifact.SCOPE_PROVIDED.equals( previousScope )
                 && !Artifact.SCOPE_TEST.equals( previousScope ) ) )
             {
                 // It's now provided or test so it should be removed
                 handleDependencyScope( context, dependency, "Scope of dependency [" + dependency + "] has changed ("
                     + previousScope + " -> " + dependency.getScope()
                     + "). If it was included in the build as an overlay, "
                     + "consider cleaning the target directory of the project (mvn clean)", "Scope of dependency ["
                     + dependency + "] has changed (" + previousScope + " -> " + dependency.getScope() + ").", true );
             }
 
         }
 
 
         public void updatedOptionalFlag( Dependency dependency, boolean previousOptional )
         {
             if ( !previousOptional && dependency.isOptional() )
             {
                 // It wasn't optional but now it is anymore
                 handleDependency( context, dependency,
                                   "Dependency [" + dependency + "] is now optional but it was not bundled anyway.",
                                   "Dependency [" + dependency
                                       + "] is now optional. If it was included in the build as an overlay, "
                                       + "consider cleaning the target directory of the project (mvn clean)",
                                   "Dependency [" + dependency + "] is now optional", true );
 
 
             }
         }
 
         public void updatedUnknown( Dependency dependency, Dependency previousDep )
         {
             handleDependency( context, dependency, "Dependency [" + dependency + "] has changed (was " + previousDep
                 + ") but it was not bundled anyway.", "Dependency [" + dependency + "] has changed (was " + previousDep
                 + "). If it was included in the build as an overlay, " + "consider "
                 + "cleaning the target directory of the project (mvn clean)", "Dependency [" + dependency
                 + "] has changed (was " + previousDep + ").", true );
         }
 
     }
 
 }

1		package org.apache.maven.plugin.war.packaging;
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.Dependency;
24		import org.apache.maven.plugin.MojoExecutionException;
25		import org.apache.maven.plugin.MojoFailureException;
26		import org.apache.maven.plugin.war.util.WebappStructure;
27
28		import java.io.File;
29
30		/**
31		* Analyzes the dependencies of the project with its previous state and update
32		* the target directory accordingly.
33		*
34		* @author Stephane Nicoll
35		*
36		* @version $Id: DependenciesAnalysisPackagingTask.java 1367293 2012-07-30 20:54:56Z olamy $
37		*/
38	12	public class DependenciesAnalysisPackagingTask
39		extends AbstractWarPackagingTask
40		{
41
42		public void performPackaging( final WarPackagingContext context )
43		throws MojoExecutionException, MojoFailureException
44		{
45
46	12	context.getWebappStructure().analyseDependencies( new DependenciesAnalysisCallbackImpl( context ) );
47
48	12	}
49
50		protected void handleDependency( WarPackagingContext context, Dependency dependency, String notBundledMessage,
51		String warOrZipMessage, String standardMessage, boolean removeFile )
52		{
53	3	if ( Artifact.SCOPE_PROVIDED.equals( dependency.getScope() )
54		\|\| Artifact.SCOPE_TEST.equals( dependency.getScope() ) \|\| dependency.isOptional() )
55		{
56	0	context.getLog().debug( notBundledMessage );
57		}
58	3	else if ( "war".equals( dependency.getType() ) \|\| "zip".equals( dependency.getType() ) )
59		{
60	1	context.getLog().warn( warOrZipMessage );
61		}
62	2	else if ( "tld".equals( dependency.getType() ) \|\| "aar".equals( dependency.getType() )
63		\|\| "mar".equals( dependency.getType() ) \|\| "xar".equals( dependency.getType() )
64		\|\| "jar".equals( dependency.getType() ) \|\| "ejb".equals( dependency.getType() )
65		\|\| "ejb-client".equals( dependency.getType() ) \|\| "test-jar".equals( dependency.getType() )
66		\|\| "par".equals( dependency.getType() ) )
67		{
68	2	context.getLog().info( standardMessage );
69	2	if ( removeFile )
70		{
71	2	removeDependency( context, dependency );
72		}
73		}
74	3	}
75
76		protected void handleDependencyScope( WarPackagingContext context, Dependency dependency, String warOrZipMessage,
77		String standardMessage, boolean removeFile )
78		{
79	1	if ( "war".equals( dependency.getType() ) \|\| "zip".equals( dependency.getType() ) )
80		{
81	0	context.getLog().warn( warOrZipMessage );
82		}
83	1	else if ( "tld".equals( dependency.getType() ) \|\| "aar".equals( dependency.getType() )
84		\|\| "mar".equals( dependency.getType() ) \|\| "xar".equals( dependency.getType() )
85		\|\| "jar".equals( dependency.getType() ) \|\| "ejb".equals( dependency.getType() )
86		\|\| "ejb-client".equals( dependency.getType() ) \|\| "test-jar".equals( dependency.getType() )
87		\|\| "par".equals( dependency.getType() ) )
88		{
89	1	context.getLog().info( standardMessage );
90	1	if ( removeFile )
91		{
92	1	removeDependency( context, dependency );
93		}
94		}
95	1	}
96
97		private void removeDependency( WarPackagingContext context, Dependency dependency )
98		{
99	3	final String targetFileName = context.getWebappStructure().getCachedTargetFileName( dependency );
100	3	if ( targetFileName != null )
101		{
102	3	final String type = dependency.getType();
103	3	File targetFile = null;
104	3	if ( "tld".equals( type ) )
105		{
106	0	targetFile = new File( context.getWebappDirectory(), ArtifactsPackagingTask.TLD_PATH + targetFileName );
107		}
108	3	else if ( "aar".equals( type ) )
109		{
110	0	targetFile =
111		new File( context.getWebappDirectory(), ArtifactsPackagingTask.SERVICES_PATH + targetFileName );
112		}
113	3	else if ( "mar".equals( type ) )
114		{
115	0	targetFile =
116		new File( context.getWebappDirectory(), ArtifactsPackagingTask.MODULES_PATH + targetFileName );
117		}
118	3	else if ( "xar".equals( type ) )
119		{
120	0	targetFile =
121		new File( context.getWebappDirectory(), ArtifactsPackagingTask.EXTENSIONS_PATH + targetFileName );
122		}
123	3	else if ( "jar".equals( type ) \|\| "ejb".equals( type ) \|\| "ejb-client".equals( type )
124		\|\| "test-jar".equals( type ) )
125		{
126	3	targetFile = new File( context.getWebappDirectory(), LIB_PATH + targetFileName );
127		}
128	0	else if ( "par".equals( type ) )
129		{
130	0	String targetFileName2 = targetFileName.substring( 0, targetFileName.lastIndexOf( '.' ) ) + ".jar";
131	0	targetFile = new File( context.getWebappDirectory(), LIB_PATH + targetFileName2 );
132		}
133
134		// now remove
135	3	if ( targetFile == null )
136		{
137	0	context.getLog().error( "Could not get file from dependency [" + dependency + "]" );
138		}
139	3	else if ( targetFile.exists() )
140		{
141	3	context.getLog().debug( "Removing file [" + targetFile.getAbsolutePath() + "]" );
142	3	targetFile.delete();
143		}
144		else
145		{
146	0	context.getLog().warn( "File to remove [" + targetFile.getAbsolutePath() + "] has not been found" );
147		}
148	3	}
149		else
150		{
151	0	context.getLog().warn( "Could not retrieve the target file name of dependency [" + dependency + "]" );
152		}
153	3	}
154
155
156	12	class DependenciesAnalysisCallbackImpl
157		implements WebappStructure.DependenciesAnalysisCallback
158		{
159		private final WarPackagingContext context;
160
161		DependenciesAnalysisCallbackImpl( WarPackagingContext context )
162	12	{
163	12	this.context = context;
164	12	}
165
166		public void unchangedDependency( Dependency dependency )
167		{
168	11	context.getLog().debug( "Dependency [" + dependency + "] has not changed since last build." );
169	11	}
170
171		public void newDependency( Dependency dependency )
172		{
173	1	context.getLog().debug( "New dependency [" + dependency + "]." );
174	1	}
175
176		public void removedDependency( Dependency dependency )
177		{
178	2	handleDependency( context, dependency, "Dependency [" + dependency
179		+ "] has been removed from the project but it was not bundled anyway.", "Dependency [" + dependency
180		+ "] has been removed from the project. If it was included in the build as an overlay, "
181		+ "consider cleaning the target directory of the project (mvn clean)", "Dependency [" + dependency
182		+ "] has been removed from the project.", true );
183	2	}
184
185		public void updatedVersion( Dependency dependency, String previousVersion )
186		{
187	1	handleDependency( context, dependency, "Version of dependency [" + dependency + "] has changed ("
188		+ previousVersion + " -> " + dependency.getVersion() + ") but it was not bundled anyway.",
189		"Version of dependency [" + dependency + "] has changed ("
190		+ previousVersion + " -> " + dependency.getVersion()
191		+ "). If it was included in the build as an overlay, "
192		+ "consider "
193		+ "cleaning the target directory of the project (mvn clean)",
194		"Version of dependency [" + dependency + "] has changed ("
195		+ previousVersion + " -> " + dependency.getVersion() + ").",
196		true );
197	1	}
198
199		public void updatedScope( Dependency dependency, String previousScope )
200		{
201	1	if ( Artifact.SCOPE_PROVIDED.equals( dependency.getScope() ) \|\| Artifact.SCOPE_TEST.equals(
202		dependency.getScope() )
203		&& ( !Artifact.SCOPE_PROVIDED.equals( previousScope )
204		&& !Artifact.SCOPE_TEST.equals( previousScope ) ) )
205		{
206		// It's now provided or test so it should be removed
207	1	handleDependencyScope( context, dependency, "Scope of dependency [" + dependency + "] has changed ("
208		+ previousScope + " -> " + dependency.getScope()
209		+ "). If it was included in the build as an overlay, "
210		+ "consider cleaning the target directory of the project (mvn clean)", "Scope of dependency ["
211		+ dependency + "] has changed (" + previousScope + " -> " + dependency.getScope() + ").", true );
212		}
213
214	1	}
215
216
217		public void updatedOptionalFlag( Dependency dependency, boolean previousOptional )
218		{
219	0	if ( !previousOptional && dependency.isOptional() )
220		{
221		// It wasn't optional but now it is anymore
222	0	handleDependency( context, dependency,
223		"Dependency [" + dependency + "] is now optional but it was not bundled anyway.",
224		"Dependency [" + dependency
225		+ "] is now optional. If it was included in the build as an overlay, "
226		+ "consider cleaning the target directory of the project (mvn clean)",
227		"Dependency [" + dependency + "] is now optional", true );
228
229
230		}
231	0	}
232
233		public void updatedUnknown( Dependency dependency, Dependency previousDep )
234		{
235	0	handleDependency( context, dependency, "Dependency [" + dependency + "] has changed (was " + previousDep
236		+ ") but it was not bundled anyway.", "Dependency [" + dependency + "] has changed (was " + previousDep
237		+ "). If it was included in the build as an overlay, " + "consider "
238		+ "cleaning the target directory of the project (mvn clean)", "Dependency [" + dependency
239		+ "] has changed (was " + previousDep + ").", true );
240	0	}
241
242		}
243
244		}