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