Coverage Report

Coverage Report - org.owasp.dependencycheck.maven.AggregateMojo

Classes in this File

Line Coverage

Branch Coverage

Complexity

AggregateMojo

0/118

0/88

8.857

 /*
  * This file is part of dependency-check-maven.
  *
  * Licensed 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.
  *
  * Copyright (c) 2013 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.maven;
 
 import java.io.File;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Locale;
 import java.util.Set;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.exception.ExceptionCollection;
 import org.owasp.dependencycheck.exception.ReportException;
 import org.owasp.dependencycheck.utils.Settings;
 
 /**
  * Maven Plugin that checks project dependencies and the dependencies of all
  * child modules to see if they have any known published vulnerabilities.
  *
  * @author Jeremy Long
  */
 @Mojo(
         name = "aggregate",
         defaultPhase = LifecyclePhase.VERIFY,
         aggregator = true,
         threadSafe = false,
         requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
         requiresOnline = true
 )
 public class AggregateMojo extends BaseDependencyCheckMojo {
 
     /**
      * Executes the aggregate dependency-check goal. This runs dependency-check
      * and generates the subsequent reports.
      *
      * @throws MojoExecutionException thrown if there is ane exception running
      * the mojo
      * @throws MojoFailureException thrown if dependency-check is configured to
      * fail the build
      */
     @Override
     public void runCheck() throws MojoExecutionException, MojoFailureException {
         final MavenEngine engine = loadEngine();
         if (engine == null) {
             return;
         }
 
         ExceptionCollection exCol = scanArtifacts(getProject(), engine);
 
         for (MavenProject childProject : getDescendants(this.getProject())) {
             final ExceptionCollection ex = scanArtifacts(childProject, engine);
             if (ex != null) {
                 if (exCol == null) {
                     exCol = ex;
                 }
                 exCol.getExceptions().addAll(ex.getExceptions());
                 if (ex.isFatal()) {
                     exCol.setFatal(true);
                 }
             }
         }
 
         try {
             engine.analyzeDependencies();
         } catch (ExceptionCollection ex) {
             if (exCol == null) {
                 exCol = ex;
             } else if (ex.isFatal()) {
                 exCol.setFatal(true);
                 exCol.getExceptions().addAll(ex.getExceptions());
             }
             if (exCol.isFatal()) {
                 final String msg = String.format("Fatal exception(s) analyzing %s", getProject().getName());
                 if (this.isFailOnError()) {
                     throw new MojoExecutionException(msg, exCol);
                 }
                 getLog().error(msg);
                 if (getLog().isDebugEnabled()) {
                     getLog().debug(exCol);
                 }
                 return;
             } else {
                 final String msg = String.format("Exception(s) analyzing %s", getProject().getName());
                 if (getLog().isDebugEnabled()) {
                     getLog().debug(msg, exCol);
                 }
             }
         }
         File outputDir = getCorrectOutputDirectory(this.getProject());
         if (outputDir == null) {
             //in some regards we shouldn't be writting this, but we are anyway.
             //we shouldn't write this because nothing is configured to generate this report.
             outputDir = new File(this.getProject().getBuild().getDirectory());
         }
         try {
             writeReports(engine, this.getProject(), outputDir);
         } catch (ReportException ex) {
             if (exCol == null) {
                 exCol = new ExceptionCollection("Error writing aggregate report", ex);
             } else {
                 exCol.addException(ex);
             }
             if (this.isFailOnError()) {
                 throw new MojoExecutionException("One or more exceptions occurred during dependency-check analysis", exCol);
             } else {
                 getLog().debug("One or more exceptions occurred during dependency-check analysis", exCol);
             }
         }
         showSummary(this.getProject(), engine.getDependencies());
         checkForFailure(engine.getDependencies());
         engine.cleanup();
         Settings.cleanup();
     }
 
     /**
      * Returns a set containing all the descendant projects of the given
      * project.
      *
      * @param project the project for which all descendants will be returned
      * @return the set of descendant projects
      */
     protected Set<MavenProject> getDescendants(MavenProject project) {
         if (project == null) {
             return Collections.emptySet();
         }
         final Set<MavenProject> descendants = new HashSet<MavenProject>();
         int size = 0;
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("Collecting descendants of %s", project.getName()));
         }
         for (String m : project.getModules()) {
             for (MavenProject mod : getReactorProjects()) {
                 try {
                     File mpp = new File(project.getBasedir(), m);
                     mpp = mpp.getCanonicalFile();
                     if (mpp.compareTo(mod.getBasedir()) == 0 && descendants.add(mod)
                             && getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Decendent module %s added", mod.getName()));
 
                     }
                 } catch (IOException ex) {
                     if (getLog().isDebugEnabled()) {
                         getLog().debug("Unable to determine module path", ex);
                     }
                 }
             }
         }
         do {
             size = descendants.size();
             for (MavenProject p : getReactorProjects()) {
                 if (project.equals(p.getParent()) || descendants.contains(p.getParent())) {
                     if (descendants.add(p) && getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Decendent %s added", p.getName()));
 
                     }
                     for (MavenProject modTest : getReactorProjects()) {
                         if (p.getModules() != null && p.getModules().contains(modTest.getName())
                                 && descendants.add(modTest)
                                 && getLog().isDebugEnabled()) {
                             getLog().debug(String.format("Decendent %s added", modTest.getName()));
                         }
                     }
                 }
                 final Set<MavenProject> addedDescendants = new HashSet<MavenProject>();
                 for (MavenProject dec : descendants) {
                     for (String mod : dec.getModules()) {
                         try {
                             File mpp = new File(dec.getBasedir(), mod);
                             mpp = mpp.getCanonicalFile();
                             if (mpp.compareTo(p.getBasedir()) == 0) {
                                 addedDescendants.add(p);
                             }
                         } catch (IOException ex) {
                             if (getLog().isDebugEnabled()) {
                                 getLog().debug("Unable to determine module path", ex);
                             }
                         }
                     }
                 }
                 for (MavenProject addedDescendant : addedDescendants) {
                     if (descendants.add(addedDescendant) && getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Decendent module %s added", addedDescendant.getName()));
                     }
                 }
             }
         } while (size != 0 && size != descendants.size());
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("%s has %d children", project, descendants.size()));
         }
         return descendants;
     }
 
     /**
      * Test if the project has pom packaging
      *
      * @param mavenProject Project to test
      * @return <code>true</code> if it has a pom packaging; otherwise
      * <code>false</code>
      */
     protected boolean isMultiModule(MavenProject mavenProject) {
         return "pom".equals(mavenProject.getPackaging());
     }
 
     /**
      * Initializes the engine.
      *
      * @return the MavenEngine used to execute dependency-check
      * @throws MojoExecutionException thrown if there is an exception running
      * the Mojo
      * @throws MojoFailureException thrown if dependency-check is configured to
      * fail the build if severe CVEs are identified.
      */
     protected MavenEngine loadEngine() throws MojoExecutionException, MojoFailureException {
         MavenEngine engine = null;
         try {
             engine = initializeEngine();
         } catch (DatabaseException ex) {
             if (getLog().isDebugEnabled()) {
                 getLog().debug("Database connection error", ex);
             }
             final String msg = "An exception occurred connecting to the local database. Please see the log file for more details.";
             if (this.isFailOnError()) {
                 throw new MojoExecutionException(msg, ex);
             }
             getLog().error(msg, ex);
         }
         return engine;
     }
 
     @Override
     public boolean canGenerateReport() {
         return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
     }
 
     /**
      * The name of the report in the site.
      */
     @SuppressWarnings("CanBeFinal")
     @Parameter(property = "name", defaultValue = "dependency-check:aggregate", required = true)
     private String name = "dependency-check:aggregate";
 
     /**
      * Returns the report name.
      *
      * @param locale the location
      * @return the report name
      */
     @Override
     public String getName(Locale locale) {
         return name;
     }
 
     /**
      * Gets the description of the Dependency-Check report to be displayed in
      * the Maven Generated Reports page.
      *
      * @param locale The Locale to get the description for
      * @return the description
      */
     @Override
     public String getDescription(Locale locale) {
         return "Generates an aggregate report of all child Maven projects providing details on any "
                 + "published vulnerabilities within project dependencies. This report is a best "
                 + "effort and may contain false positives and false negatives.";
     }
 }

1		/*
2		* This file is part of dependency-check-maven.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		* Copyright (c) 2013 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.maven;
19
20		import java.io.File;
21		import java.io.IOException;
22		import java.util.Collections;
23		import java.util.HashSet;
24		import java.util.Locale;
25		import java.util.Set;
26		import org.apache.maven.plugin.MojoExecutionException;
27		import org.apache.maven.plugin.MojoFailureException;
28		import org.apache.maven.plugins.annotations.LifecyclePhase;
29		import org.apache.maven.plugins.annotations.Mojo;
30		import org.apache.maven.plugins.annotations.Parameter;
31		import org.apache.maven.plugins.annotations.ResolutionScope;
32		import org.apache.maven.project.MavenProject;
33		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
34		import org.owasp.dependencycheck.exception.ExceptionCollection;
35		import org.owasp.dependencycheck.exception.ReportException;
36		import org.owasp.dependencycheck.utils.Settings;
37
38		/**
39		* Maven Plugin that checks project dependencies and the dependencies of all
40		* child modules to see if they have any known published vulnerabilities.
41		*
42		* @author Jeremy Long
43		*/
44		@Mojo(
45		name = "aggregate",
46		defaultPhase = LifecyclePhase.VERIFY,
47		aggregator = true,
48		threadSafe = false,
49		requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
50		requiresOnline = true
51		)
52	0	public class AggregateMojo extends BaseDependencyCheckMojo {
53
54		/**
55		* Executes the aggregate dependency-check goal. This runs dependency-check
56		* and generates the subsequent reports.
57		*
58		* @throws MojoExecutionException thrown if there is ane exception running
59		* the mojo
60		* @throws MojoFailureException thrown if dependency-check is configured to
61		* fail the build
62		*/
63		@Override
64		public void runCheck() throws MojoExecutionException, MojoFailureException {
65	0	final MavenEngine engine = loadEngine();
66	0	if (engine == null) {
67	0	return;
68		}
69
70	0	ExceptionCollection exCol = scanArtifacts(getProject(), engine);
71
72	0	for (MavenProject childProject : getDescendants(this.getProject())) {
73	0	final ExceptionCollection ex = scanArtifacts(childProject, engine);
74	0	if (ex != null) {
75	0	if (exCol == null) {
76	0	exCol = ex;
77		}
78	0	exCol.getExceptions().addAll(ex.getExceptions());
79	0	if (ex.isFatal()) {
80	0	exCol.setFatal(true);
81		}
82		}
83	0	}
84
85		try {
86	0	engine.analyzeDependencies();
87	0	} catch (ExceptionCollection ex) {
88	0	if (exCol == null) {
89	0	exCol = ex;
90	0	} else if (ex.isFatal()) {
91	0	exCol.setFatal(true);
92	0	exCol.getExceptions().addAll(ex.getExceptions());
93		}
94	0	if (exCol.isFatal()) {
95	0	final String msg = String.format("Fatal exception(s) analyzing %s", getProject().getName());
96	0	if (this.isFailOnError()) {
97	0	throw new MojoExecutionException(msg, exCol);
98		}
99	0	getLog().error(msg);
100	0	if (getLog().isDebugEnabled()) {
101	0	getLog().debug(exCol);
102		}
103	0	return;
104		} else {
105	0	final String msg = String.format("Exception(s) analyzing %s", getProject().getName());
106	0	if (getLog().isDebugEnabled()) {
107	0	getLog().debug(msg, exCol);
108		}
109		}
110	0	}
111	0	File outputDir = getCorrectOutputDirectory(this.getProject());
112	0	if (outputDir == null) {
113		//in some regards we shouldn't be writting this, but we are anyway.
114		//we shouldn't write this because nothing is configured to generate this report.
115	0	outputDir = new File(this.getProject().getBuild().getDirectory());
116		}
117		try {
118	0	writeReports(engine, this.getProject(), outputDir);
119	0	} catch (ReportException ex) {
120	0	if (exCol == null) {
121	0	exCol = new ExceptionCollection("Error writing aggregate report", ex);
122		} else {
123	0	exCol.addException(ex);
124		}
125	0	if (this.isFailOnError()) {
126	0	throw new MojoExecutionException("One or more exceptions occurred during dependency-check analysis", exCol);
127		} else {
128	0	getLog().debug("One or more exceptions occurred during dependency-check analysis", exCol);
129		}
130	0	}
131	0	showSummary(this.getProject(), engine.getDependencies());
132	0	checkForFailure(engine.getDependencies());
133	0	engine.cleanup();
134	0	Settings.cleanup();
135	0	}
136
137		/**
138		* Returns a set containing all the descendant projects of the given
139		* project.
140		*
141		* @param project the project for which all descendants will be returned
142		* @return the set of descendant projects
143		*/
144		protected Set<MavenProject> getDescendants(MavenProject project) {
145	0	if (project == null) {
146	0	return Collections.emptySet();
147		}
148	0	final Set<MavenProject> descendants = new HashSet<MavenProject>();
149	0	int size = 0;
150	0	if (getLog().isDebugEnabled()) {
151	0	getLog().debug(String.format("Collecting descendants of %s", project.getName()));
152		}
153	0	for (String m : project.getModules()) {
154	0	for (MavenProject mod : getReactorProjects()) {
155		try {
156	0	File mpp = new File(project.getBasedir(), m);
157	0	mpp = mpp.getCanonicalFile();
158	0	if (mpp.compareTo(mod.getBasedir()) == 0 && descendants.add(mod)
159	0	&& getLog().isDebugEnabled()) {
160	0	getLog().debug(String.format("Decendent module %s added", mod.getName()));
161
162		}
163	0	} catch (IOException ex) {
164	0	if (getLog().isDebugEnabled()) {
165	0	getLog().debug("Unable to determine module path", ex);
166		}
167	0	}
168	0	}
169	0	}
170		do {
171	0	size = descendants.size();
172	0	for (MavenProject p : getReactorProjects()) {
173	0	if (project.equals(p.getParent()) \|\| descendants.contains(p.getParent())) {
174	0	if (descendants.add(p) && getLog().isDebugEnabled()) {
175	0	getLog().debug(String.format("Decendent %s added", p.getName()));
176
177		}
178	0	for (MavenProject modTest : getReactorProjects()) {
179	0	if (p.getModules() != null && p.getModules().contains(modTest.getName())
180	0	&& descendants.add(modTest)
181	0	&& getLog().isDebugEnabled()) {
182	0	getLog().debug(String.format("Decendent %s added", modTest.getName()));
183		}
184	0	}
185		}
186	0	final Set<MavenProject> addedDescendants = new HashSet<MavenProject>();
187	0	for (MavenProject dec : descendants) {
188	0	for (String mod : dec.getModules()) {
189		try {
190	0	File mpp = new File(dec.getBasedir(), mod);
191	0	mpp = mpp.getCanonicalFile();
192	0	if (mpp.compareTo(p.getBasedir()) == 0) {
193	0	addedDescendants.add(p);
194		}
195	0	} catch (IOException ex) {
196	0	if (getLog().isDebugEnabled()) {
197	0	getLog().debug("Unable to determine module path", ex);
198		}
199	0	}
200	0	}
201	0	}
202	0	for (MavenProject addedDescendant : addedDescendants) {
203	0	if (descendants.add(addedDescendant) && getLog().isDebugEnabled()) {
204	0	getLog().debug(String.format("Decendent module %s added", addedDescendant.getName()));
205		}
206	0	}
207	0	}
208	0	} while (size != 0 && size != descendants.size());
209	0	if (getLog().isDebugEnabled()) {
210	0	getLog().debug(String.format("%s has %d children", project, descendants.size()));
211		}
212	0	return descendants;
213		}
214
215		/**
216		* Test if the project has pom packaging
217		*
218		* @param mavenProject Project to test
219		* @return <code>true</code> if it has a pom packaging; otherwise
220		* <code>false</code>
221		*/
222		protected boolean isMultiModule(MavenProject mavenProject) {
223	0	return "pom".equals(mavenProject.getPackaging());
224		}
225
226		/**
227		* Initializes the engine.
228		*
229		* @return the MavenEngine used to execute dependency-check
230		* @throws MojoExecutionException thrown if there is an exception running
231		* the Mojo
232		* @throws MojoFailureException thrown if dependency-check is configured to
233		* fail the build if severe CVEs are identified.
234		*/
235		protected MavenEngine loadEngine() throws MojoExecutionException, MojoFailureException {
236	0	MavenEngine engine = null;
237		try {
238	0	engine = initializeEngine();
239	0	} catch (DatabaseException ex) {
240	0	if (getLog().isDebugEnabled()) {
241	0	getLog().debug("Database connection error", ex);
242		}
243	0	final String msg = "An exception occurred connecting to the local database. Please see the log file for more details.";
244	0	if (this.isFailOnError()) {
245	0	throw new MojoExecutionException(msg, ex);
246		}
247	0	getLog().error(msg, ex);
248	0	}
249	0	return engine;
250		}
251
252		@Override
253		public boolean canGenerateReport() {
254	0	return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
255		}
256
257		/**
258		* The name of the report in the site.
259		*/
260	0	@SuppressWarnings("CanBeFinal")
261		@Parameter(property = "name", defaultValue = "dependency-check:aggregate", required = true)
262		private String name = "dependency-check:aggregate";
263
264		/**
265		* Returns the report name.
266		*
267		* @param locale the location
268		* @return the report name
269		*/
270		@Override
271		public String getName(Locale locale) {
272	0	return name;
273		}
274
275		/**
276		* Gets the description of the Dependency-Check report to be displayed in
277		* the Maven Generated Reports page.
278		*
279		* @param locale The Locale to get the description for
280		* @return the description
281		*/
282		@Override
283		public String getDescription(Locale locale) {
284	0	return "Generates an aggregate report of all child Maven projects providing details on any "
285		+ "published vulnerabilities within project dependencies. This report is a best "
286		+ "effort and may contain false positives and false negatives.";
287		}
288		}