Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

AggregateMojo

0/103

0/56

5.25

 /*
  * 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 java.util.logging.Level;
 import java.util.logging.Logger;
 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.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.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 <jeremy.long@owasp.org>
  */
 @Mojo(
         name = "aggregate",
         defaultPhase = LifecyclePhase.SITE,
         aggregator = true,
         threadSafe = true,
         requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
         requiresOnline = true
 )
 public class AggregateMojo extends BaseDependencyCheckMojo {
 
     /**
      * Logger field reference.
      */
     private static final Logger LOGGER = Logger.getLogger(AggregateMojo.class.getName());
 
     /**
      * 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 Engine engine = generateDataFile();
 
         if (getProject() == getReactorProjects().get(getReactorProjects().size() - 1)) {
 
             //ensure that the .ser file was created for each.
             for (MavenProject current : getReactorProjects()) {
                 final File dataFile = getDataFile(current);
                 if (dataFile == null) { //dc was never run on this project. write the ser to the target.
                     LOGGER.fine(String.format("Executing dependency-check on %s", 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()) {
                         LOGGER.fine(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
                         dependencies.addAll(childDeps);
                     } else {
                         LOGGER.fine(String.format("No dependencies read for %s", reportOn.getName()));
                     }
                 }
                 engine.getDependencies().clear();
                 engine.getDependencies().addAll(dependencies);
                 final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
                 try {
                     LOGGER.fine(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
                     bundler.analyze(null, engine);
                     LOGGER.fine(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
                 } catch (AnalysisException ex) {
                     LOGGER.log(Level.WARNING, "An error occured grouping the dependencies; duplicate entries may exist in the report", ex);
                     LOGGER.log(Level.FINE, "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());
                 }
                 writeReports(engine, current, outputDir);
             }
         }
         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;
         LOGGER.fine(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) {
                         if (descendants.add(mod)) {
                             LOGGER.fine(String.format("Decendent module %s added", mod.getName()));
                         }
                     }
                 } catch (IOException ex) {
                     LOGGER.log(Level.FINE, "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)) {
                         LOGGER.fine(String.format("Decendent %s added", p.getName()));
                     }
                     for (MavenProject modTest : getReactorProjects()) {
                         if (p.getModules() != null && p.getModules().contains(modTest.getName())) {
                             if (descendants.add(modTest)) {
                                 LOGGER.fine(String.format("Decendent %s added", modTest.getName()));
                             }
                         }
                     }
                 }
                 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) {
                                 if (descendants.add(p)) {
                                     LOGGER.fine(String.format("Decendent module %s added", p.getName()));
                                 }
                             }
                         } catch (IOException ex) {
                             LOGGER.log(Level.FINE, "Unable to determine module path", ex);
                         }
                     }
                 }
             }
         } while (size != 0 && size != descendants.size());
         LOGGER.fine(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());
     }
 
     /**
      * Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.
      *
      * @return the Engine 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 Engine generateDataFile() throws MojoExecutionException, MojoFailureException {
         final Engine engine;
         try {
             engine = initializeEngine();
         } catch (DatabaseException ex) {
             LOGGER.log(Level.FINE, "Database connection error", ex);
             throw new MojoExecutionException("An exception occured connecting to the local database. Please see the log file for more details.", ex);
         }
         return generateDataFile(engine, getProject());
     }
 
     /**
      * Runs dependency-check's Engine and writes the serialized dependencies to disk.
      *
      * @param engine the Engine to use when scanning.
      * @param project the project to scan and generate the data file for
      * @return the Engine 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 Engine generateDataFile(Engine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
         LOGGER.fine(String.format("Begin Scanning: %s", project.getName()));
         engine.getDependencies().clear();
         engine.resetFileTypeAnalyzers();
         scanArtifacts(project, engine);
         engine.analyzeDependencies();
         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
     }
 
     /**
      * Returns the report name.
      *
      * @param locale the location
      * @return the report name
      */
     public String getName(Locale locale) {
         return "dependency-check:aggregate";
     }
 
     /**
      * 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
      */
     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 java.util.logging.Level;
29		import java.util.logging.Logger;
30		import org.apache.maven.plugin.MojoExecutionException;
31		import org.apache.maven.plugin.MojoFailureException;
32		import org.apache.maven.plugins.annotations.LifecyclePhase;
33		import org.apache.maven.plugins.annotations.Mojo;
34		import org.apache.maven.plugins.annotations.ResolutionScope;
35		import org.apache.maven.project.MavenProject;
36		import org.owasp.dependencycheck.analyzer.DependencyBundlingAnalyzer;
37		import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
38		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
39		import org.owasp.dependencycheck.dependency.Dependency;
40		import org.owasp.dependencycheck.utils.Settings;
41
42		/**
43		* Maven Plugin that checks project dependencies and the dependencies of all child modules to see if they have any known published
44		* vulnerabilities.
45		*
46		* @author Jeremy Long <jeremy.long@owasp.org>
47		*/
48		@Mojo(
49		name = "aggregate",
50		defaultPhase = LifecyclePhase.SITE,
51		aggregator = true,
52		threadSafe = true,
53		requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME,
54		requiresOnline = true
55		)
56	0	public class AggregateMojo extends BaseDependencyCheckMojo {
57
58		/**
59		* Logger field reference.
60		*/
61	0	private static final Logger LOGGER = Logger.getLogger(AggregateMojo.class.getName());
62
63		/**
64		* Executes the aggregate dependency-check goal. This runs dependency-check and generates the subsequent reports.
65		*
66		* @throws MojoExecutionException thrown if there is ane exception running the mojo
67		* @throws MojoFailureException thrown if dependency-check is configured to fail the build
68		*/
69		@Override
70		public void runCheck() throws MojoExecutionException, MojoFailureException {
71	0	final Engine engine = generateDataFile();
72
73	0	if (getProject() == getReactorProjects().get(getReactorProjects().size() - 1)) {
74
75		//ensure that the .ser file was created for each.
76	0	for (MavenProject current : getReactorProjects()) {
77	0	final File dataFile = getDataFile(current);
78	0	if (dataFile == null) { //dc was never run on this project. write the ser to the target.
79	0	LOGGER.fine(String.format("Executing dependency-check on %s", current.getName()));
80	0	generateDataFile(engine, current);
81		}
82	0	}
83
84	0	for (MavenProject current : getReactorProjects()) {
85	0	List<Dependency> dependencies = readDataFile(current);
86	0	if (dependencies == null) {
87	0	dependencies = new ArrayList<Dependency>();
88		}
89	0	final Set<MavenProject> childProjects = getDescendants(current);
90	0	for (MavenProject reportOn : childProjects) {
91	0	final List<Dependency> childDeps = readDataFile(reportOn);
92	0	if (childDeps != null && !childDeps.isEmpty()) {
93	0	LOGGER.fine(String.format("Adding %d dependencies from %s", childDeps.size(), reportOn.getName()));
94	0	dependencies.addAll(childDeps);
95		} else {
96	0	LOGGER.fine(String.format("No dependencies read for %s", reportOn.getName()));
97		}
98	0	}
99	0	engine.getDependencies().clear();
100	0	engine.getDependencies().addAll(dependencies);
101	0	final DependencyBundlingAnalyzer bundler = new DependencyBundlingAnalyzer();
102		try {
103	0	LOGGER.fine(String.format("Dependency count pre-bundler: %s", engine.getDependencies().size()));
104	0	bundler.analyze(null, engine);
105	0	LOGGER.fine(String.format("Dependency count post-bundler: %s", engine.getDependencies().size()));
106	0	} catch (AnalysisException ex) {
107	0	LOGGER.log(Level.WARNING, "An error occured grouping the dependencies; duplicate entries may exist in the report", ex);
108	0	LOGGER.log(Level.FINE, "Bundling Exception", ex);
109	0	}
110
111	0	File outputDir = getCorrectOutputDirectory(current);
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(current.getBuild().getDirectory());
116		}
117	0	writeReports(engine, current, outputDir);
118	0	}
119		}
120	0	engine.cleanup();
121	0	Settings.cleanup();
122	0	}
123
124		/**
125		* Returns a set containing all the descendant projects of the given project.
126		*
127		* @param project the project for which all descendants will be returned
128		* @return the set of descendant projects
129		*/
130		protected Set<MavenProject> getDescendants(MavenProject project) {
131	0	if (project == null) {
132	0	return Collections.emptySet();
133		}
134	0	final Set<MavenProject> descendants = new HashSet<MavenProject>();
135	0	int size = 0;
136	0	LOGGER.fine(String.format("Collecting descendants of %s", project.getName()));
137	0	for (String m : project.getModules()) {
138	0	for (MavenProject mod : getReactorProjects()) {
139		try {
140	0	File mpp = new File(project.getBasedir(), m);
141	0	mpp = mpp.getCanonicalFile();
142	0	if (mpp.compareTo(mod.getBasedir()) == 0) {
143	0	if (descendants.add(mod)) {
144	0	LOGGER.fine(String.format("Decendent module %s added", mod.getName()));
145		}
146		}
147	0	} catch (IOException ex) {
148	0	LOGGER.log(Level.FINE, "Unable to determine module path", ex);
149	0	}
150	0	}
151	0	}
152		do {
153	0	size = descendants.size();
154	0	for (MavenProject p : getReactorProjects()) {
155	0	if (project.equals(p.getParent()) \|\| descendants.contains(p.getParent())) {
156	0	if (descendants.add(p)) {
157	0	LOGGER.fine(String.format("Decendent %s added", p.getName()));
158		}
159	0	for (MavenProject modTest : getReactorProjects()) {
160	0	if (p.getModules() != null && p.getModules().contains(modTest.getName())) {
161	0	if (descendants.add(modTest)) {
162	0	LOGGER.fine(String.format("Decendent %s added", modTest.getName()));
163		}
164		}
165	0	}
166		}
167	0	for (MavenProject dec : descendants) {
168	0	for (String mod : dec.getModules()) {
169		try {
170	0	File mpp = new File(dec.getBasedir(), mod);
171	0	mpp = mpp.getCanonicalFile();
172	0	if (mpp.compareTo(p.getBasedir()) == 0) {
173	0	if (descendants.add(p)) {
174	0	LOGGER.fine(String.format("Decendent module %s added", p.getName()));
175		}
176		}
177	0	} catch (IOException ex) {
178	0	LOGGER.log(Level.FINE, "Unable to determine module path", ex);
179	0	}
180	0	}
181	0	}
182	0	}
183	0	} while (size != 0 && size != descendants.size());
184	0	LOGGER.fine(String.format("%s has %d children", project, descendants.size()));
185	0	return descendants;
186		}
187
188		/**
189		* Test if the project has pom packaging
190		*
191		* @param mavenProject Project to test
192		* @return <code>true</code> if it has a pom packaging; otherwise <code>false</code>
193		*/
194		protected boolean isMultiModule(MavenProject mavenProject) {
195	0	return "pom".equals(mavenProject.getPackaging());
196		}
197
198		/**
199		* Initilizes the engine, runs a scan, and writes the serialized dependencies to disk.
200		*
201		* @return the Engine used to execute dependency-check
202		* @throws MojoExecutionException thrown if there is an exception running the mojo
203		* @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
204		*/
205		protected Engine generateDataFile() throws MojoExecutionException, MojoFailureException {
206		final Engine engine;
207		try {
208	0	engine = initializeEngine();
209	0	} catch (DatabaseException ex) {
210	0	LOGGER.log(Level.FINE, "Database connection error", ex);
211	0	throw new MojoExecutionException("An exception occured connecting to the local database. Please see the log file for more details.", ex);
212	0	}
213	0	return generateDataFile(engine, getProject());
214		}
215
216		/**
217		* Runs dependency-check's Engine and writes the serialized dependencies to disk.
218		*
219		* @param engine the Engine to use when scanning.
220		* @param project the project to scan and generate the data file for
221		* @return the Engine used to execute dependency-check
222		* @throws MojoExecutionException thrown if there is an exception running the mojo
223		* @throws MojoFailureException thrown if dependency-check is configured to fail the build if severe CVEs are identified.
224		*/
225		protected Engine generateDataFile(Engine engine, MavenProject project) throws MojoExecutionException, MojoFailureException {
226	0	LOGGER.fine(String.format("Begin Scanning: %s", project.getName()));
227	0	engine.getDependencies().clear();
228	0	engine.resetFileTypeAnalyzers();
229	0	scanArtifacts(project, engine);
230	0	engine.analyzeDependencies();
231	0	final File target = new File(project.getBuild().getDirectory());
232	0	writeDataFile(project, target, engine.getDependencies());
233	0	showSummary(project, engine.getDependencies());
234	0	checkForFailure(engine.getDependencies());
235	0	return engine;
236		}
237
238		@Override
239		public boolean canGenerateReport() {
240	0	return true; //aggregate always returns true for now - we can look at a more complicated/acurate solution later
241		}
242
243		/**
244		* Returns the report name.
245		*
246		* @param locale the location
247		* @return the report name
248		*/
249		public String getName(Locale locale) {
250	0	return "dependency-check:aggregate";
251		}
252
253		/**
254		* Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
255		*
256		* @param locale The Locale to get the description for
257		* @return the description
258		*/
259		public String getDescription(Locale locale) {
260	0	return "Generates an aggregate report of all child Maven projects providing details on any "
261		+ "published vulnerabilities within project dependencies. This report is a best "
262		+ "effort and may contain false positives and false negatives.";
263		}
264		}