Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

Engine

13%

9/65

1/44

3.7

 /*
  * 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) 2014 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.maven;
 
 import java.util.List;
 import java.util.logging.Logger;
 import org.apache.maven.project.MavenProject;
 import org.owasp.dependencycheck.analyzer.Analyzer;
 import org.owasp.dependencycheck.analyzer.CPEAnalyzer;
 import org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 import org.owasp.dependencycheck.utils.Settings;
 
 /**
  * A modified version of the core engine specifically designed to persist some
  * data between multiple executions of a multi-module Maven project.
  *
  * @author Jeremy Long <jeremy.long@owasp.org>
  */
 public class Engine extends org.owasp.dependencycheck.Engine {
 
     /**
      * The logger.
      */
     private static final transient Logger LOGGER = Logger.getLogger(Engine.class.getName());
     /**
      * A key used to persist an object in the MavenProject.
      */
     private static final String CPE_ANALYZER_KEY = "dependency-check-CPEAnalyzer";
     /**
      * The current MavenProject.
      */
     private MavenProject currentProject;
     /**
      * The list of MavenProjects that are part of the current build.
      */
     private List<MavenProject> reactorProjects;
     /**
      * Key used in the MavenProject context values to note whether or not an
      * update has been executed.
      */
     public static final String UPDATE_EXECUTED_FLAG = "dependency-check-update-executed";
 
     /**
      * Creates a new Engine to perform anyalsis on dependencies.
      *
      * @param project the current Maven project
      * @param reactorProjects the reactor projects for the current Maven
      * execution
      * @throws DatabaseException thrown if there is an issue connecting to the
      * database
      */
     public Engine(MavenProject project, List<MavenProject> reactorProjects) throws DatabaseException {
         this.currentProject = project;
         this.reactorProjects = reactorProjects;
         initializeEngine();
     }
 
     /**
      * Runs the analyzers against all of the dependencies.
      */
     @Override
     public void analyzeDependencies() {
         final MavenProject root = getExecutionRoot();
         if (root != null) {
             LOGGER.fine(String.format("Checking root project, %s, if updates have already been completed", root.getArtifactId()));
         } else {
             LOGGER.fine("Checking root project, null, if updates have already been completed");
         }
         if (root != null && root.getContextValue(UPDATE_EXECUTED_FLAG) != null) {
             System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
         }
         super.analyzeDependencies();
         if (root != null) {
             root.setContextValue(UPDATE_EXECUTED_FLAG, Boolean.TRUE);
         }
     }
 
     /**
      * This constructor should not be called. Use Engine(MavenProject) instead.
      *
      * @throws DatabaseException thrown if there is an issue connecting to the
      * database
      */
     private Engine() throws DatabaseException {
     }
 
     /**
      * Initializes the given analyzer. This skips the initialization of the
      * CPEAnalyzer if it has been initialized by a previous execution.
      *
      * @param analyzer the analyzer to initialize
      * @return the initialized analyzer
      */
     @Override
     protected Analyzer initializeAnalyzer(Analyzer analyzer) {
         if ((analyzer instanceof CPEAnalyzer)) {
             CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
             if (cpe != null) {
                 return cpe;
             }
             cpe = (CPEAnalyzer) super.initializeAnalyzer(analyzer);
             storeCPEAnalyzer(cpe);
         }
         return super.initializeAnalyzer(analyzer);
     }
 
     /**
      * Releases resources used by the analyzers by calling close() on each
      * analyzer.
      */
     @Override
     public void cleanup() {
         super.cleanup();
         if (currentProject == null || reactorProjects == null) {
             return;
         }
         if (this.currentProject == reactorProjects.get(reactorProjects.size() - 1)) {
             final CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
             if (cpe != null) {
                 cpe.close();
             }
         }
     }
 
     /**
      * Closes the given analyzer. This skips closing the CPEAnalyzer.
      *
      * @param analyzer the analyzer to close
      */
     @Override
     protected void closeAnalyzer(Analyzer analyzer) {
         if ((analyzer instanceof CPEAnalyzer)) {
             if (getPreviouslyLoadedCPEAnalyzer() == null) {
                 super.closeAnalyzer(analyzer);
             }
         } else {
             super.closeAnalyzer(analyzer);
         }
     }
 
     /**
      * Gets the CPEAnalyzer from the root Maven Project.
      *
      * @return an initialized CPEAnalyzer
      */
     private CPEAnalyzer getPreviouslyLoadedCPEAnalyzer() {
         CPEAnalyzer cpe = null;
         final MavenProject project = getExecutionRoot();
         if (project != null) {
             final Object obj = project.getContextValue(CPE_ANALYZER_KEY);
             if (obj != null && obj instanceof CPEAnalyzer) {
                 cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
             }
         }
         return cpe;
     }
 
     /**
      * Stores a CPEAnalyzer in the root Maven Project.
      *
      * @param cpe the CPEAnalyzer to store
      */
     private void storeCPEAnalyzer(CPEAnalyzer cpe) {
         final MavenProject p = getExecutionRoot();
         if (p != null) {
             p.setContextValue(CPE_ANALYZER_KEY, cpe);
         }
     }
 
     /**
      * Returns the root Maven Project.
      *
      * @return the root Maven Project
      */
     private MavenProject getExecutionRoot() {
         if (reactorProjects == null) {
             return null;
         }
         for (MavenProject p : reactorProjects) {
             if (p.isExecutionRoot()) {
                 return p;
             }
         }
         //the following should  never run, but leaving it as a failsafe.
         if (this.currentProject == null) {
             return null;
         }
         MavenProject p = this.currentProject;
         while (p.getParent() != null) {
             p = p.getParent();
         }
         return p;
     }
 
     /**
      * Resets the file type analyzers so that they can be re-used to scan
      * additional directories. Without the reset the analyzer might be disabled
      * because the first scan/analyze did not identify any files that could be
      * processed by the analyzer.
      */
     public void resetFileTypeAnalyzers() {
         for (FileTypeAnalyzer a : getFileTypeAnalyzers()) {
             a.reset();
         }
     }
 }

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) 2014 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.maven;
19
20		import java.util.List;
21		import java.util.logging.Logger;
22		import org.apache.maven.project.MavenProject;
23		import org.owasp.dependencycheck.analyzer.Analyzer;
24		import org.owasp.dependencycheck.analyzer.CPEAnalyzer;
25		import org.owasp.dependencycheck.analyzer.FileTypeAnalyzer;
26		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
27		import org.owasp.dependencycheck.utils.Settings;
28
29		/**
30		* A modified version of the core engine specifically designed to persist some
31		* data between multiple executions of a multi-module Maven project.
32		*
33		* @author Jeremy Long <jeremy.long@owasp.org>
34		*/
35		public class Engine extends org.owasp.dependencycheck.Engine {
36
37		/**
38		* The logger.
39		*/
40	1	private static final transient Logger LOGGER = Logger.getLogger(Engine.class.getName());
41		/**
42		* A key used to persist an object in the MavenProject.
43		*/
44		private static final String CPE_ANALYZER_KEY = "dependency-check-CPEAnalyzer";
45		/**
46		* The current MavenProject.
47		*/
48		private MavenProject currentProject;
49		/**
50		* The list of MavenProjects that are part of the current build.
51		*/
52		private List<MavenProject> reactorProjects;
53		/**
54		* Key used in the MavenProject context values to note whether or not an
55		* update has been executed.
56		*/
57		public static final String UPDATE_EXECUTED_FLAG = "dependency-check-update-executed";
58
59		/**
60		* Creates a new Engine to perform anyalsis on dependencies.
61		*
62		* @param project the current Maven project
63		* @param reactorProjects the reactor projects for the current Maven
64		* execution
65		* @throws DatabaseException thrown if there is an issue connecting to the
66		* database
67		*/
68	1	public Engine(MavenProject project, List<MavenProject> reactorProjects) throws DatabaseException {
69	1	this.currentProject = project;
70	1	this.reactorProjects = reactorProjects;
71	1	initializeEngine();
72	1	}
73
74		/**
75		* Runs the analyzers against all of the dependencies.
76		*/
77		@Override
78		public void analyzeDependencies() {
79	0	final MavenProject root = getExecutionRoot();
80	0	if (root != null) {
81	0	LOGGER.fine(String.format("Checking root project, %s, if updates have already been completed", root.getArtifactId()));
82		} else {
83	0	LOGGER.fine("Checking root project, null, if updates have already been completed");
84		}
85	0	if (root != null && root.getContextValue(UPDATE_EXECUTED_FLAG) != null) {
86	0	System.setProperty(Settings.KEYS.AUTO_UPDATE, Boolean.FALSE.toString());
87		}
88	0	super.analyzeDependencies();
89	0	if (root != null) {
90	0	root.setContextValue(UPDATE_EXECUTED_FLAG, Boolean.TRUE);
91		}
92	0	}
93
94		/**
95		* This constructor should not be called. Use Engine(MavenProject) instead.
96		*
97		* @throws DatabaseException thrown if there is an issue connecting to the
98		* database
99		*/
100	0	private Engine() throws DatabaseException {
101	0	}
102
103		/**
104		* Initializes the given analyzer. This skips the initialization of the
105		* CPEAnalyzer if it has been initialized by a previous execution.
106		*
107		* @param analyzer the analyzer to initialize
108		* @return the initialized analyzer
109		*/
110		@Override
111		protected Analyzer initializeAnalyzer(Analyzer analyzer) {
112	0	if ((analyzer instanceof CPEAnalyzer)) {
113	0	CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
114	0	if (cpe != null) {
115	0	return cpe;
116		}
117	0	cpe = (CPEAnalyzer) super.initializeAnalyzer(analyzer);
118	0	storeCPEAnalyzer(cpe);
119		}
120	0	return super.initializeAnalyzer(analyzer);
121		}
122
123		/**
124		* Releases resources used by the analyzers by calling close() on each
125		* analyzer.
126		*/
127		@Override
128		public void cleanup() {
129	1	super.cleanup();
130	1	if (currentProject == null \|\| reactorProjects == null) {
131	1	return;
132		}
133	0	if (this.currentProject == reactorProjects.get(reactorProjects.size() - 1)) {
134	0	final CPEAnalyzer cpe = getPreviouslyLoadedCPEAnalyzer();
135	0	if (cpe != null) {
136	0	cpe.close();
137		}
138		}
139	0	}
140
141		/**
142		* Closes the given analyzer. This skips closing the CPEAnalyzer.
143		*
144		* @param analyzer the analyzer to close
145		*/
146		@Override
147		protected void closeAnalyzer(Analyzer analyzer) {
148	0	if ((analyzer instanceof CPEAnalyzer)) {
149	0	if (getPreviouslyLoadedCPEAnalyzer() == null) {
150	0	super.closeAnalyzer(analyzer);
151		}
152		} else {
153	0	super.closeAnalyzer(analyzer);
154		}
155	0	}
156
157		/**
158		* Gets the CPEAnalyzer from the root Maven Project.
159		*
160		* @return an initialized CPEAnalyzer
161		*/
162		private CPEAnalyzer getPreviouslyLoadedCPEAnalyzer() {
163	0	CPEAnalyzer cpe = null;
164	0	final MavenProject project = getExecutionRoot();
165	0	if (project != null) {
166	0	final Object obj = project.getContextValue(CPE_ANALYZER_KEY);
167	0	if (obj != null && obj instanceof CPEAnalyzer) {
168	0	cpe = (CPEAnalyzer) project.getContextValue(CPE_ANALYZER_KEY);
169		}
170		}
171	0	return cpe;
172		}
173
174		/**
175		* Stores a CPEAnalyzer in the root Maven Project.
176		*
177		* @param cpe the CPEAnalyzer to store
178		*/
179		private void storeCPEAnalyzer(CPEAnalyzer cpe) {
180	0	final MavenProject p = getExecutionRoot();
181	0	if (p != null) {
182	0	p.setContextValue(CPE_ANALYZER_KEY, cpe);
183		}
184	0	}
185
186		/**
187		* Returns the root Maven Project.
188		*
189		* @return the root Maven Project
190		*/
191		private MavenProject getExecutionRoot() {
192	0	if (reactorProjects == null) {
193	0	return null;
194		}
195	0	for (MavenProject p : reactorProjects) {
196	0	if (p.isExecutionRoot()) {
197	0	return p;
198		}
199	0	}
200		//the following should never run, but leaving it as a failsafe.
201	0	if (this.currentProject == null) {
202	0	return null;
203		}
204	0	MavenProject p = this.currentProject;
205	0	while (p.getParent() != null) {
206	0	p = p.getParent();
207		}
208	0	return p;
209		}
210
211		/**
212		* Resets the file type analyzers so that they can be re-used to scan
213		* additional directories. Without the reset the analyzer might be disabled
214		* because the first scan/analyze did not identify any files that could be
215		* processed by the analyzer.
216		*/
217		public void resetFileTypeAnalyzers() {
218	0	for (FileTypeAnalyzer a : getFileTypeAnalyzers()) {
219	0	a.reset();
220	0	}
221	0	}
222		}