Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

Engine

12%

9/70

1/50

3.727

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