Coverage Report

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

Classes in this File

0/160

0/114

 /*
  * 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.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 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.analyzer.DependencyBundlingAnalyzer;
 import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.dependency.Dependency;
 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 {
 
     /**
      * The key to store aggregate exception in the root Maven execution context.
      */
     private static final String AGGREGATE_EXCEPTIONS = "AggregateExceptions";
 
     /**
      * 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 = generateDataFile();
         if (engine == null) {
             return;
         }
 
         if (getProject() == getLastProject()) {
             //ensure that the .ser file was created for each.
             for (MavenProject current : getReactorProjects()) {
                 final File dataFile = getDataFile(current);
                 if (dataFile == null && !skipProject(current)) { //dc was never run on this project. write the ser to the target.
                     getLog().error(String.format("Module '%s' did not execute dependency-check; an attempt will be made to perform "
                             + "the check but dependencies may be missed resulting in false negatives.", current.getName()));
                     generateDataFile(engine, current);
                 }
             }
             for (MavenProject current : getReactorProjects()) {
                 List<Dependency> dependencies = readDataFile(current);
                 if (dependencies == null) {
                     dependencies = new ArrayList<Dependency>();
                 }
                 final Set<MavenProject> childProjects = getDescendants(current);
                 for (MavenProject reportOn : childProjects) {
                     final List<Dependency> childDeps = readDataFile(reportOn);
                     if (childDeps != null && !childDeps.isEmpty()) {
                         if (getLog().isDebugEnabled()) {
                             getLog().debug(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
                         }
                         dependencies.addAll(childDeps);
                     } else if (getLog().isDebugEnabled()) {
                         getLog().debug(String.format("No dependencies read for %s", reportOn.getName()));
                     }
                 }
                 engine.getDependencies().clear();
                 engine.getDependencies().addAll(dependencies);
                 final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
                 try {
                     if (getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
                     }
                     bundler.analyze(null, engine);
                     if (getLog().isDebugEnabled()) {
                         getLog().debug(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
                     }
                 } catch (AnalysisException ex) {
                     getLog().warn("An error occurred grouping the dependencies; duplicate entries may exist in the report", ex);
                     getLog().debug("Bundling Exception", ex);
                 }
 
                 File outputDir = getCorrectOutputDirectory(current);
                 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(current.getBuild().getDirectory());
                 }
                 try {
                     writeReports(engine, current, outputDir);
                 } catch (ReportException ex) {
                     ExceptionCollection exCol = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
                     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 occured during dependency-check analysis", exCol);
                     } else {
                         getLog().debug("One or more exceptions occured during dependency-check analysis", exCol);
                     }
                 }
             }
         }
         engine.cleanup();
         Settings.cleanup();
     }
 
     /**
      * Gets the last project in the reactor - taking into account skipped
      * projects.
      *
      * @return the last project in the reactor
      */
     private MavenProject getLastProject() {
         for (int x = getReactorProjects().size() - 1; x >= 0; x--) {
             final MavenProject p = getReactorProjects().get(x);
             if (!skipProject(p)) {
                 return p;
             }
         }
         return null;
     }
 
     /**
      * Tests if the project is being skipped in the Maven site report.
      *
      * @param project a project in the reactor
      * @return true if the project is skipped; otherwise false
      */
     private boolean skipProject(MavenProject project) {
         final String skip = (String) project.getProperties().get("maven.site.skip");
         return "true".equalsIgnoreCase(skip) && isGeneratingSite();
     }
 
     /**
      * 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, runs a scan, and writes the serialized
      * dependencies to disk.
      *
      * @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 generateDataFile() 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 occured 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 null;
         }
         return generateDataFile(engine, getProject());
     }
 
     /**
      * Runs dependency-check's MavenEngine and writes the serialized
      * dependencies to disk.
      *
      * @param engine the MavenEngine to use when scanning.
      * @param project the project to scan and generate the data file for
      * @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 generateDataFile(MavenEngine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
         if (getLog().isDebugEnabled()) {
             getLog().debug(String.format("Begin Scanning: %s", project.getName()));
         }
         engine.getDependencies().clear();
         engine.resetFileTypeAnalyzers();
         scanArtifacts(project, engine);
         try {
             engine.analyzeDependencies();
         } catch (ExceptionCollection ex) {
             ExceptionCollection col = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
             if (col == null) {
                 col = ex;
             } else if (ex.isFatal()) {
                 col.setFatal(true);
                 col.getExceptions().addAll(ex.getExceptions());
             }
             if (col.isFatal()) {
                 final String msg = String.format("Fatal exception(s) analyzing %s", project.getName());
                 if (this.isFailOnError()) {
                     throw new MojoExecutionException(msg, ex);
                 }
                 getLog().error(msg, col);
                 return null;
             } else {
                 final String msg = String.format("Exception(s) analyzing %s", project.getName());
                 if (getLog().isDebugEnabled()) {
                     getLog().debug(msg, ex);
                 }
                 engine.getExecutionRoot().setContextValue(AGGREGATE_EXCEPTIONS, col);
             }
         }
         final File target = new File(project.getBuild().getDirectory());
         writeDataFile(project, target, engine.getDependencies());
         showSummary(project, engine.getDependencies());
         checkForFailure(engine.getDependencies());
         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.ArrayList;
23		import java.util.Collections;
24		import java.util.HashSet;
25		import java.util.List;
26		import java.util.Locale;
27		import java.util.Set;
28		import org.apache.maven.plugin.MojoExecutionException;
29		import org.apache.maven.plugin.MojoFailureException;
30		import org.apache.maven.plugins.annotations.LifecyclePhase;
31		import org.apache.maven.plugins.annotations.Mojo;
32		import org.apache.maven.plugins.annotations.Parameter;
33		import org.apache.maven.plugins.annotations.ResolutionScope;
34		import org.apache.maven.project.MavenProject;
35		import org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
36		import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
37		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
38		import org.owasp.dependencycheck.dependency.Dependency;
39		import org.owasp.dependencycheck.exception.ExceptionCollection;
40		import org.owasp.dependencycheck.exception.ReportException;
41		import org.owasp.dependencycheck.utils.Settings;
42
43		/**
44		* Maven Plugin that checks project dependencies and the dependencies of all
45		* child modules to see if they have any known published vulnerabilities.
46		*
47		* @author Jeremy Long
48		*/
49		@Mojo(
50		name = "aggregate",
51		defaultPhase = LifecyclePhase.VERIFY,
52		/aggregator = true,/
53		threadSafe = false,
54		requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
55		requiresOnline = true
56		)
57	0	public class AggregateMojo extends BaseDependencyCheckMojo {
58
59		/**
60		* The key to store aggregate exception in the root Maven execution context.
61		*/
62		private static final String AGGREGATE_EXCEPTIONS = "AggregateExceptions";
63
64		/**
65		* Executes the aggregate dependency-check goal. This runs dependency-check
66		* and generates the subsequent reports.
67		*
68		* @throws MojoExecutionException thrown if there is ane exception running
69		* the mojo
70		* @throws MojoFailureException thrown if dependency-check is configured to
71		* fail the build
72		*/
73		@Override
74		public void runCheck() throws MojoExecutionException, MojoFailureException {
75	0	final MavenEngine engine = generateDataFile();
76	0	if (engine == null) {
77	0	return;
78		}
79
80	0	if (getProject() == getLastProject()) {
81		//ensure that the .ser file was created for each.
82	0	for (MavenProject current : getReactorProjects()) {
83	0	final File dataFile = getDataFile(current);
84	0	if (dataFile == null && !skipProject(current)) { //dc was never run on this project. write the ser to the target.
85	0	getLog().error(String.format("Module '%s' did not execute dependency-check; an attempt will be made to perform "
86	0	+ "the check but dependencies may be missed resulting in false negatives.", current.getName()));
87	0	generateDataFile(engine, current);
88		}
89	0	}
90	0	for (MavenProject current : getReactorProjects()) {
91	0	List<Dependency> dependencies = readDataFile(current);
92	0	if (dependencies == null) {
93	0	dependencies = new ArrayList<Dependency>();
94		}
95	0	final Set<MavenProject> childProjects = getDescendants(current);
96	0	for (MavenProject reportOn : childProjects) {
97	0	final List<Dependency> childDeps = readDataFile(reportOn);
98	0	if (childDeps != null && !childDeps.isEmpty()) {
99	0	if (getLog().isDebugEnabled()) {
100	0	getLog().debug(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
101		}
102	0	dependencies.addAll(childDeps);
103	0	} else if (getLog().isDebugEnabled()) {
104	0	getLog().debug(String.format("No dependencies read for %s", reportOn.getName()));
105		}
106	0	}
107	0	engine.getDependencies().clear();
108	0	engine.getDependencies().addAll(dependencies);
109	0	final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
110		try {
111	0	if (getLog().isDebugEnabled()) {
112	0	getLog().debug(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
113		}
114	0	bundler.analyze(null, engine);
115	0	if (getLog().isDebugEnabled()) {
116	0	getLog().debug(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
117		}
118	0	} catch (AnalysisException ex) {
119	0	getLog().warn("An error occurred grouping the dependencies; duplicate entries may exist in the report", ex);
120	0	getLog().debug("Bundling Exception", ex);
121	0	}
122
123	0	File outputDir = getCorrectOutputDirectory(current);
124	0	if (outputDir == null) {
125		//in some regards we shouldn't be writting this, but we are anyway.
126		//we shouldn't write this because nothing is configured to generate this report.
127	0	outputDir = new File(current.getBuild().getDirectory());
128		}
129		try {
130	0	writeReports(engine, current, outputDir);
131	0	} catch (ReportException ex) {
132	0	ExceptionCollection exCol = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
133	0	if (exCol == null) {
134	0	exCol = new ExceptionCollection("Error writing aggregate report", ex);
135		} else {
136	0	exCol.addException(ex);
137		}
138	0	if (this.isFailOnError()) {
139	0	throw new MojoExecutionException("One or more exceptions occured during dependency-check analysis", exCol);
140		} else {
141	0	getLog().debug("One or more exceptions occured during dependency-check analysis", exCol);
142		}
143	0	}
144	0	}
145		}
146	0	engine.cleanup();
147	0	Settings.cleanup();
148	0	}
149
150		/**
151		* Gets the last project in the reactor - taking into account skipped
152		* projects.
153		*
154		* @return the last project in the reactor
155		*/
156		private MavenProject getLastProject() {
157	0	for (int x = getReactorProjects().size() - 1; x >= 0; x--) {
158	0	final MavenProject p = getReactorProjects().get(x);
159	0	if (!skipProject(p)) {
160	0	return p;
161		}
162		}
163	0	return null;
164		}
165
166		/**
167		* Tests if the project is being skipped in the Maven site report.
168		*
169		* @param project a project in the reactor
170		* @return true if the project is skipped; otherwise false
171		*/
172		private boolean skipProject(MavenProject project) {
173	0	final String skip = (String) project.getProperties().get("maven.site.skip");
174	0	return "true".equalsIgnoreCase(skip) && isGeneratingSite();
175		}
176
177		/**
178		* Returns a set containing all the descendant projects of the given
179		* project.
180		*
181		* @param project the project for which all descendants will be returned
182		* @return the set of descendant projects
183		*/
184		protected Set<MavenProject> getDescendants(MavenProject project) {
185	0	if (project == null) {
186	0	return Collections.emptySet();
187		}
188	0	final Set<MavenProject> descendants = new HashSet<MavenProject>();
189	0	int size = 0;
190	0	if (getLog().isDebugEnabled()) {
191	0	getLog().debug(String.format("Collecting descendants of %s", project.getName()));
192		}
193	0	for (String m : project.getModules()) {
194	0	for (MavenProject mod : getReactorProjects()) {
195		try {
196	0	File mpp = new File(project.getBasedir(), m);
197	0	mpp = mpp.getCanonicalFile();
198	0	if (mpp.compareTo(mod.getBasedir()) == 0 && descendants.add(mod)
199	0	&& getLog().isDebugEnabled()) {
200	0	getLog().debug(String.format("Decendent module %s added", mod.getName()));
201
202		}
203	0	} catch (IOException ex) {
204	0	if (getLog().isDebugEnabled()) {
205	0	getLog().debug("Unable to determine module path", ex);
206		}
207	0	}
208	0	}
209	0	}
210		do {
211	0	size = descendants.size();
212	0	for (MavenProject p : getReactorProjects()) {
213	0	if (project.equals(p.getParent()) \|\| descendants.contains(p.getParent())) {
214	0	if (descendants.add(p) && getLog().isDebugEnabled()) {
215	0	getLog().debug(String.format("Decendent %s added", p.getName()));
216
217		}
218	0	for (MavenProject modTest : getReactorProjects()) {
219	0	if (p.getModules() != null && p.getModules().contains(modTest.getName())
220	0	&& descendants.add(modTest)
221	0	&& getLog().isDebugEnabled()) {
222	0	getLog().debug(String.format("Decendent %s added", modTest.getName()));
223		}
224	0	}
225		}
226	0	final Set<MavenProject> addedDescendants = new HashSet<MavenProject>();
227	0	for (MavenProject dec : descendants) {
228	0	for (String mod : dec.getModules()) {
229		try {
230	0	File mpp = new File(dec.getBasedir(), mod);
231	0	mpp = mpp.getCanonicalFile();
232	0	if (mpp.compareTo(p.getBasedir()) == 0) {
233	0	addedDescendants.add(p);
234		}
235	0	} catch (IOException ex) {
236	0	if (getLog().isDebugEnabled()) {
237	0	getLog().debug("Unable to determine module path", ex);
238		}
239	0	}
240	0	}
241	0	}
242	0	for (MavenProject addedDescendant : addedDescendants) {
243	0	if (descendants.add(addedDescendant) && getLog().isDebugEnabled()) {
244	0	getLog().debug(String.format("Decendent module %s added", addedDescendant.getName()));
245		}
246	0	}
247	0	}
248	0	} while (size != 0 && size != descendants.size());
249	0	if (getLog().isDebugEnabled()) {
250	0	getLog().debug(String.format("%s has %d children", project, descendants.size()));
251		}
252	0	return descendants;
253		}
254
255		/**
256		* Test if the project has pom packaging
257		*
258		* @param mavenProject Project to test
259		* @return <code>true</code> if it has a pom packaging; otherwise
260		* <code>false</code>
261		*/
262		protected boolean isMultiModule(MavenProject mavenProject) {
263	0	return "pom".equals(mavenProject.getPackaging());
264		}
265
266		/**
267		* Initializes the engine, runs a scan, and writes the serialized
268		* dependencies to disk.
269		*
270		* @return the MavenEngine used to execute dependency-check
271		* @throws MojoExecutionException thrown if there is an exception running
272		* the mojo
273		* @throws MojoFailureException thrown if dependency-check is configured to
274		* fail the build if severe CVEs are identified.
275		*/
276		protected MavenEngine generateDataFile() throws MojoExecutionException, MojoFailureException {
277	0	MavenEngine engine = null;
278		try {
279	0	engine = initializeEngine();
280	0	} catch (DatabaseException ex) {
281	0	if (getLog().isDebugEnabled()) {
282	0	getLog().debug("Database connection error", ex);
283		}
284	0	final String msg = "An exception occured connecting to the local database. Please see the log file for more details.";
285	0	if (this.isFailOnError()) {
286	0	throw new MojoExecutionException(msg, ex);
287		}
288	0	getLog().error(msg, ex);
289	0	return null;
290	0	}
291	0	return generateDataFile(engine, getProject());
292		}
293
294		/**
295		* Runs dependency-check's MavenEngine and writes the serialized
296		* dependencies to disk.
297		*
298		* @param engine the MavenEngine to use when scanning.
299		* @param project the project to scan and generate the data file for
300		* @return the MavenEngine used to execute dependency-check
301		* @throws MojoExecutionException thrown if there is an exception running
302		* the mojo
303		* @throws MojoFailureException thrown if dependency-check is configured to
304		* fail the build if severe CVEs are identified.
305		*/
306		protected MavenEngine generateDataFile(MavenEngine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
307	0	if (getLog().isDebugEnabled()) {
308	0	getLog().debug(String.format("Begin Scanning: %s", project.getName()));
309		}
310	0	engine.getDependencies().clear();
311	0	engine.resetFileTypeAnalyzers();
312	0	scanArtifacts(project, engine);
313		try {
314	0	engine.analyzeDependencies();
315	0	} catch (ExceptionCollection ex) {
316	0	ExceptionCollection col = (ExceptionCollection) engine.getExecutionRoot().getContextValue(AGGREGATE_EXCEPTIONS);
317	0	if (col == null) {
318	0	col = ex;
319	0	} else if (ex.isFatal()) {
320	0	col.setFatal(true);
321	0	col.getExceptions().addAll(ex.getExceptions());
322		}
323	0	if (col.isFatal()) {
324	0	final String msg = String.format("Fatal exception(s) analyzing %s", project.getName());
325	0	if (this.isFailOnError()) {
326	0	throw new MojoExecutionException(msg, ex);
327		}
328	0	getLog().error(msg, col);
329	0	return null;
330		} else {
331	0	final String msg = String.format("Exception(s) analyzing %s", project.getName());
332	0	if (getLog().isDebugEnabled()) {
333	0	getLog().debug(msg, ex);
334		}
335	0	engine.getExecutionRoot().setContextValue(AGGREGATE_EXCEPTIONS, col);
336		}
337	0	}
338	0	final File target = new File(project.getBuild().getDirectory());
339	0	writeDataFile(project, target, engine.getDependencies());
340	0	showSummary(project, engine.getDependencies());
341	0	checkForFailure(engine.getDependencies());
342	0	return engine;
343		}
344
345		@Override
346		public boolean canGenerateReport() {
347	0	return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
348		}
349
350		/**
351		* The name of the report in the site.
352		*/
353	0	@SuppressWarnings("CanBeFinal")
354		@Parameter(property = "name", defaultValue = "dependency-check:aggregate", required = true)
355		private String name = "dependency-check:aggregate";
356
357		/**
358		* Returns the report name.
359		*
360		* @param locale the location
361		* @return the report name
362		*/
363		@Override
364		public String getName(Locale locale) {
365	0	return name;
366		}
367
368		/**
369		* Gets the description of the Dependency-Check report to be displayed in
370		* the Maven Generated Reports page.
371		*
372		* @param locale The Locale to get the description for
373		* @return the description
374		*/
375		@Override
376		public String getDescription(Locale locale) {
377	0	return "Generates an aggregate report of all child Maven projects providing details on any "
378		+ "published vulnerabilities within project dependencies. This report is a best "
379		+ "effort and may contain false positives and false negatives.";
380		}
381		}