Coverage Report

Coverage Report - net.sf.statcvs.Main

Classes in this File

Line Coverage

Branch Coverage

Complexity

Main

0/160

0/98

3.875

 /*
     StatCvs - CVS statistics generation
     Copyright (C) 2002  Lukasz Pekacki <lukasz@pekacki.de>
     http://statcvs.sf.net/
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
     License as published by the Free Software Foundation; either
     version 2.1 of the License, or (at your option) any later version.
 
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Lesser General Public License for more details.
 
     You should have received a copy of the GNU Lesser General Public
     License along with this library; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
         $RCSfile: Main.java,v $
         Created on $Date: 2009/08/05 16:32:10 $
 */
 package net.sf.statcvs;
 
 import java.io.FileReader;
 import java.io.IOException;
 import java.io.Reader;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.logging.LogManager;
 import java.util.logging.Logger;
 
 import net.sf.statcvs.input.Builder;
 import net.sf.statcvs.input.CvsLogfileParser;
 import net.sf.statcvs.input.LogSyntaxException;
 import net.sf.statcvs.input.RepositoryFileManager;
 import net.sf.statcvs.model.Repository;
 import net.sf.statcvs.output.CommandLineParser;
 import net.sf.statcvs.output.ConfigurationException;
 import net.sf.statcvs.output.ConfigurationOptions;
 import net.sf.statcvs.output.ReportConfig;
 import net.sf.statcvs.pages.Page;
 import net.sf.statcvs.pages.ReportSuiteMaker;
 
 /**
  * StatCvs Main Class; it starts the application and controls command-line
  * related stuff
  * @author Lukasz Pekacki
  * @author Richard Cyganiak
  * @version $Id: Main.java,v 1.68 2009/08/05 16:32:10 benoitx Exp $
  */
 public class Main {
     private static Logger logger = Logger.getLogger("net.sf.statcvs");
     private static LogManager lm = LogManager.getLogManager();
 
     /**
      * Main method of StatCvs
      * @param args command line options
      */
     public static void main(final String[] args) {
         System.out.println(Messages.getString("PROJECT_NAME") + Messages.NL);
 
         if (args.length == 0) {
             printProperUsageAndExit();
         }
         if (args.length == 1) {
             final String arg = args[0].toLowerCase();
             if (arg.equals("-h") || arg.equals("-help")) {
                 printProperUsageAndExit();
             } else if (arg.equals("-version")) {
                 printVersionAndExit();
             }
         }
 
         try {
             new CommandLineParser(args).parse();
             generateDefaultHTMLSuite();
         } catch (final ConfigurationException cex) {
             System.err.println(cex.getMessage());
             System.exit(1);
         } catch (final LogSyntaxException lex) {
             printLogErrorMessageAndExit(lex.getMessage());
         } catch (final IOException ioex) {
             printIoErrorMessageAndExit(ioex.getMessage());
         } catch (final OutOfMemoryError oome) {
             printOutOfMemMessageAndExit();
         }
         System.exit(0);
     }
 
     private static void initLogManager(final String loggingProperties) {
         try {
             lm.readConfiguration(Main.class.getResourceAsStream(loggingProperties));
         } catch (final IOException e) {
             System.err.println("ERROR: Logging could not be initialized!");
         }
     }
 
     private static void printProperUsageAndExit() {
         System.out.println(
         //max. 80 chars
                 //         12345678901234567890123456789012345678901234567890123456789012345678901234567890
                 "Usage: java -jar statcvs.jar [options] <logfile> <directory>\n" + "\n" + "Required parameters:\n"
                         + "  <logfile>          path to the cvs logfile of the module\n"
                         + "  <directory>        path to the directory of the checked out module\n" + "\n" + "Some options:\n"
                         + "  -version           print version information and exit\n" + "  -output-dir <dir>  set directory where HTML suite will be saved\n"
                         + "  -include <pattern> include only files matching pattern, e.g. **/*.c;**/*.h\n"
                         + "  -exclude <pattern> exclude matching files, e.g. tests/**;docs/**\n"
                         + "  -tags <regexp>     show matching tags in lines of code chart, e.g. version-.*\n"
                         + "  -title <title>     set project title to be used in reports\n" + "  -xdoc              generate Maven XDoc instead of HTML\n"
                         + "  -trac <url>        integrate with Trac at <url>\n" + "  -xml               generate XML instead of HTML\n"
                         + "  -charset <charset> specify the charset to use for html/xdoc\n" + "  -verbose           print extra progress information\n"
                         + "  -viewcvs/viewvc/cvsweb/chora/jcvsweb/bugzilla/mantis <url>\n" + "                     add links to installation at <url>\n"
                         + "  -disable-twitter-button\n" + "\n" + "Full options list: http://statcvs.sf.net/manual");
         System.exit(1);
     }
 
     private static void printVersionAndExit() {
         System.out.println("Version " + Messages.getString("PROJECT_VERSION"));
         System.exit(1);
     }
 
     private static void printOutOfMemMessageAndExit() {
         System.err.println("OutOfMemoryError.");
         System.err.println("Try running java with the -mx option (e.g. -mx128m for 128Mb).");
         System.exit(1);
     }
 
     private static void printLogErrorMessageAndExit(final String message) {
         System.err.println("Logfile parsing failed.");
         System.err.println(message);
         System.exit(1);
     }
 
     private static void printIoErrorMessageAndExit(final String message) {
         System.err.println(message);
         System.exit(1);
     }
 
     /**
      * Generates HTML report. {@link net.sf.statcvs.output.ConfigurationOptions}
      * must be initialized before calling this method.
      * @throws LogSyntaxException if the logfile contains unexpected syntax
      * @throws IOException if some file can't be read or written
      * @throws ConfigurationException if a required ConfigurationOption was not set
      */
     public static void generateDefaultHTMLSuite() throws LogSyntaxException, IOException, ConfigurationException {
 
         if (ConfigurationOptions.getLogFileName() == null) {
             throw new ConfigurationException("Missing logfile name");
         }
         if (ConfigurationOptions.getCheckedOutDirectory() == null) {
             throw new ConfigurationException("Missing checked out directory");
         }
 
         final long memoryUsedOnStart = Runtime.getRuntime().totalMemory();
         final long startTime = System.currentTimeMillis();
 
         initLogManager(ConfigurationOptions.getLoggingProperties());
 
         logger.info("Parsing CVS log '" + ConfigurationOptions.getLogFileName() + "'");
 
         Reader logReader = null;
         Builder builder = null;
         try {
             logReader = new FileReader(ConfigurationOptions.getLogFileName());
             final RepositoryFileManager repFileMan = new RepositoryFileManager(ConfigurationOptions.getCheckedOutDirectory());
 
             builder = new Builder(repFileMan, ConfigurationOptions.getIncludePattern(), ConfigurationOptions.getExcludePattern(), ConfigurationOptions
                     .getSymbolicNamesPattern());
             new CvsLogfileParser(logReader, builder).parse();
         } finally {
             if (logReader != null) {
                 logReader.close();
             }
         }
         if (ConfigurationOptions.getProjectName() == null) {
             ConfigurationOptions.setProjectName(builder.getProjectName());
         }
         if (ConfigurationOptions.getWebRepository() != null) {
             ConfigurationOptions.getWebRepository().setAtticFileNames(builder.getAtticFileNames());
         }
         logger.info("Generating report for " + ConfigurationOptions.getProjectName() + " into " + ConfigurationOptions.getOutputDir());
         logger.info("Using " + ConfigurationOptions.getCssHandler());
         final Repository content = builder.createCvsContent();
         if (content.isEmpty()) {
             if (builder.allRejectedByExcludePattern()) {
                 logger.warning("Exclude pattern '" + ConfigurationOptions.getExcludePattern() + "' removed all files from repository");
             } else if (builder.allRejectedByIncludePattern()) {
                 logger.warning("Include pattern '" + ConfigurationOptions.getIncludePattern() + "' rejected all files from repository");
             } else {
                 logger.warning("Empty repository");
             }
         }
         if (builder.isLocalFilesNotFound()) {
             logger.warning("The log references many files that do not exist in the local copy.");
             logger.warning("Reports will be inaccurate or broken.");
             logger.warning("Log not generated in '" + ConfigurationOptions.getCheckedOutDirectory() + "'?");
         } else if (!builder.hasLocalCVSMetadata()) {
             logger.warning("No CVS metadata found in working copy. Reports may be inaccurate.");
         } else if (builder.isLogAndLocalFilesOutOfSync()) {
             logger.warning("Log and working copy are out of sync. Reports will be inaccurate.");
         }
 
         builder.clean();
         builder = null;
         
         // make JFreeChart work on systems without GUI
         System.setProperty("java.awt.headless", "true");
 
         final ReportConfig config = new ReportConfig(content, ConfigurationOptions.getProjectName(), ConfigurationOptions.getOutputDir(), ConfigurationOptions
                 .getMarkupSyntax(), ConfigurationOptions.getCssHandler(), ConfigurationOptions.getCharSet());
         config.setWebRepository(ConfigurationOptions.getWebRepository());
         config.setWebBugtracker(ConfigurationOptions.getWebBugtracker());
         config.setNonDeveloperLogins(ConfigurationOptions.getNonDeveloperLogins());
 
         final List extraReports = new ArrayList();
         //        extraReports.add(new RepoMapPageMaker(config).toFile());
         //        extraReports.add(new ChurnPageMaker(config).toFile());
 
         ReportSuiteMaker reportSuiteMaker = new ReportSuiteMaker(config, ConfigurationOptions.getNotes(), extraReports);
         if ("xml".equalsIgnoreCase(ConfigurationOptions.getOutputFormat())) {
             reportSuiteMaker.toXml();
         } else {
             Page page = reportSuiteMaker.toFile();
             
 //            logger.info("*********** Do A DUMP NOW ************");
 //            try {
 //                Thread.sleep(20000);
 //            } catch (InterruptedException e) {
 //                // TODO Auto-generated catch block
 //                e.printStackTrace();
 //            }
             
             
             page.write();
 
 //            logger.info("*********** Do A SECOND DUMP NOW ************");
 //            try {
 //                Thread.sleep(20000);
 //            } catch (InterruptedException e) {
 //                // TODO Auto-generated catch block
 //                e.printStackTrace();
 //            }
 }
 
         final long endTime = System.currentTimeMillis();
         final long memoryUsedOnEnd = Runtime.getRuntime().totalMemory();
 
         logger.info("runtime: " + (((double) endTime - startTime) / 1000) + " seconds");
         logger.info("memory usage: " + (((double) memoryUsedOnEnd - memoryUsedOnStart) / 1024) + " kb");
     }
 }

1		/*
2		StatCvs - CVS statistics generation
3		Copyright (C) 2002 Lukasz Pekacki <lukasz@pekacki.de>
4		http://statcvs.sf.net/
5
6		This library is free software; you can redistribute it and/or
7		modify it under the terms of the GNU Lesser General Public
8		License as published by the Free Software Foundation; either
9		version 2.1 of the License, or (at your option) any later version.
10
11		This library is distributed in the hope that it will be useful,
12		but WITHOUT ANY WARRANTY; without even the implied warranty of
13		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14		Lesser General Public License for more details.
15
16		You should have received a copy of the GNU Lesser General Public
17		License along with this library; if not, write to the Free Software
18		Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
20		$RCSfile: Main.java,v $
21		Created on $Date: 2009/08/05 16:32:10 $
22		*/
23		package net.sf.statcvs;
24
25		import java.io.FileReader;
26		import java.io.IOException;
27		import java.io.Reader;
28		import java.util.ArrayList;
29		import java.util.List;
30		import java.util.logging.LogManager;
31		import java.util.logging.Logger;
32
33		import net.sf.statcvs.input.Builder;
34		import net.sf.statcvs.input.CvsLogfileParser;
35		import net.sf.statcvs.input.LogSyntaxException;
36		import net.sf.statcvs.input.RepositoryFileManager;
37		import net.sf.statcvs.model.Repository;
38		import net.sf.statcvs.output.CommandLineParser;
39		import net.sf.statcvs.output.ConfigurationException;
40		import net.sf.statcvs.output.ConfigurationOptions;
41		import net.sf.statcvs.output.ReportConfig;
42		import net.sf.statcvs.pages.Page;
43		import net.sf.statcvs.pages.ReportSuiteMaker;
44
45		/**
46		* StatCvs Main Class; it starts the application and controls command-line
47		* related stuff
48		* @author Lukasz Pekacki
49		* @author Richard Cyganiak
50		* @version $Id: Main.java,v 1.68 2009/08/05 16:32:10 benoitx Exp $
51	0	*/
52	0	public class Main {
53	0	private static Logger logger = Logger.getLogger("net.sf.statcvs");
54	0	private static LogManager lm = LogManager.getLogManager();
55
56		/**
57		* Main method of StatCvs
58		* @param args command line options
59		*/
60	0	public static void main(final String[] args) {
61	0	System.out.println(Messages.getString("PROJECT_NAME") + Messages.NL);
62	0
63	0	if (args.length == 0) {
64	0	printProperUsageAndExit();
65	0	}
66	0	if (args.length == 1) {
67	0	final String arg = args[0].toLowerCase();
68	0	if (arg.equals("-h") \|\| arg.equals("-help")) {
69	0	printProperUsageAndExit();
70	0	} else if (arg.equals("-version")) {
71	0	printVersionAndExit();
72		}
73		}
74
75	0	try {
76	0	new CommandLineParser(args).parse();
77	0	generateDefaultHTMLSuite();
78	0	} catch (final ConfigurationException cex) {
79	0	System.err.println(cex.getMessage());
80	0	System.exit(1);
81	0	} catch (final LogSyntaxException lex) {
82	0	printLogErrorMessageAndExit(lex.getMessage());
83	0	} catch (final IOException ioex) {
84	0	printIoErrorMessageAndExit(ioex.getMessage());
85	0	} catch (final OutOfMemoryError oome) {
86	0	printOutOfMemMessageAndExit();
87	0	}
88	0	System.exit(0);
89	0	}
90
91		private static void initLogManager(final String loggingProperties) {
92	0	try {
93	0	lm.readConfiguration(Main.class.getResourceAsStream(loggingProperties));
94	0	} catch (final IOException e) {
95	0	System.err.println("ERROR: Logging could not be initialized!");
96	0	}
97	0	}
98
99	0	private static void printProperUsageAndExit() {
100	0	System.out.println(
101		//max. 80 chars
102		// 12345678901234567890123456789012345678901234567890123456789012345678901234567890
103		"Usage: java -jar statcvs.jar [options] <logfile> <directory>\n" + "\n" + "Required parameters:\n"
104		+ " <logfile> path to the cvs logfile of the module\n"
105		+ " <directory> path to the directory of the checked out module\n" + "\n" + "Some options:\n"
106		+ " -version print version information and exit\n" + " -output-dir <dir> set directory where HTML suite will be saved\n"
107		+ " -include <pattern> include only files matching pattern, e.g. */.c;*/.h\n"
108		+ " -exclude <pattern> exclude matching files, e.g. tests/;docs/\n"
109		+ " -tags <regexp> show matching tags in lines of code chart, e.g. version-.*\n"
110		+ " -title <title> set project title to be used in reports\n" + " -xdoc generate Maven XDoc instead of HTML\n"
111		+ " -trac <url> integrate with Trac at <url>\n" + " -xml generate XML instead of HTML\n"
112		+ " -charset <charset> specify the charset to use for html/xdoc\n" + " -verbose print extra progress information\n"
113	0	+ " -viewcvs/viewvc/cvsweb/chora/jcvsweb/bugzilla/mantis <url>\n" + " add links to installation at <url>\n"
114	0	+ " -disable-twitter-button\n" + "\n" + "Full options list: http://statcvs.sf.net/manual");
115	0	System.exit(1);
116	0	}
117	0
118	0	private static void printVersionAndExit() {
119	0	System.out.println("Version " + Messages.getString("PROJECT_VERSION"));
120	0	System.exit(1);
121	0	}
122	0
123	0	private static void printOutOfMemMessageAndExit() {
124	0	System.err.println("OutOfMemoryError.");
125	0	System.err.println("Try running java with the -mx option (e.g. -mx128m for 128Mb).");
126	0	System.exit(1);
127	0	}
128	0
129	0	private static void printLogErrorMessageAndExit(final String message) {
130	0	System.err.println("Logfile parsing failed.");
131	0	System.err.println(message);
132	0	System.exit(1);
133	0	}
134	0
135	0	private static void printIoErrorMessageAndExit(final String message) {
136	0	System.err.println(message);
137	0	System.exit(1);
138	0	}
139	0
140	0	/**
141		* Generates HTML report. {@link net.sf.statcvs.output.ConfigurationOptions}
142		* must be initialized before calling this method.
143		* @throws LogSyntaxException if the logfile contains unexpected syntax
144		* @throws IOException if some file can't be read or written
145		* @throws ConfigurationException if a required ConfigurationOption was not set
146		*/
147	0	public static void generateDefaultHTMLSuite() throws LogSyntaxException, IOException, ConfigurationException {
148	0
149	0	if (ConfigurationOptions.getLogFileName() == null) {
150	0	throw new ConfigurationException("Missing logfile name");
151	0	}
152	0	if (ConfigurationOptions.getCheckedOutDirectory() == null) {
153	0	throw new ConfigurationException("Missing checked out directory");
154	0	}
155	0
156	0	final long memoryUsedOnStart = Runtime.getRuntime().totalMemory();
157	0	final long startTime = System.currentTimeMillis();
158	0
159	0	initLogManager(ConfigurationOptions.getLoggingProperties());
160	0
161	0	logger.info("Parsing CVS log '" + ConfigurationOptions.getLogFileName() + "'");
162	0
163	0	Reader logReader = null;
164	0	Builder builder = null;
165	0	try {
166	0	logReader = new FileReader(ConfigurationOptions.getLogFileName());
167	0	final RepositoryFileManager repFileMan = new RepositoryFileManager(ConfigurationOptions.getCheckedOutDirectory());
168	0
169	0	builder = new Builder(repFileMan, ConfigurationOptions.getIncludePattern(), ConfigurationOptions.getExcludePattern(), ConfigurationOptions
170	0	.getSymbolicNamesPattern());
171	0	new CvsLogfileParser(logReader, builder).parse();
172	0	} finally {
173	0	if (logReader != null) {
174	0	logReader.close();
175	0	}
176	0	}
177	0	if (ConfigurationOptions.getProjectName() == null) {
178	0	ConfigurationOptions.setProjectName(builder.getProjectName());
179	0	}
180	0	if (ConfigurationOptions.getWebRepository() != null) {
181	0	ConfigurationOptions.getWebRepository().setAtticFileNames(builder.getAtticFileNames());
182	0	}
183	0	logger.info("Generating report for " + ConfigurationOptions.getProjectName() + " into " + ConfigurationOptions.getOutputDir());
184	0	logger.info("Using " + ConfigurationOptions.getCssHandler());
185	0	final Repository content = builder.createCvsContent();
186	0	if (content.isEmpty()) {
187	0	if (builder.allRejectedByExcludePattern()) {
188	0	logger.warning("Exclude pattern '" + ConfigurationOptions.getExcludePattern() + "' removed all files from repository");
189	0	} else if (builder.allRejectedByIncludePattern()) {
190	0	logger.warning("Include pattern '" + ConfigurationOptions.getIncludePattern() + "' rejected all files from repository");
191	0	} else {
192	0	logger.warning("Empty repository");
193	0	}
194	0	}
195	0	if (builder.isLocalFilesNotFound()) {
196	0	logger.warning("The log references many files that do not exist in the local copy.");
197	0	logger.warning("Reports will be inaccurate or broken.");
198	0	logger.warning("Log not generated in '" + ConfigurationOptions.getCheckedOutDirectory() + "'?");
199	0	} else if (!builder.hasLocalCVSMetadata()) {
200	0	logger.warning("No CVS metadata found in working copy. Reports may be inaccurate.");
201	0	} else if (builder.isLogAndLocalFilesOutOfSync()) {
202	0	logger.warning("Log and working copy are out of sync. Reports will be inaccurate.");
203	0	}
204	0
205	0	builder.clean();
206	0	builder = null;
207
208	0	// make JFreeChart work on systems without GUI
209	0	System.setProperty("java.awt.headless", "true");
210	0
211	0	final ReportConfig config = new ReportConfig(content, ConfigurationOptions.getProjectName(), ConfigurationOptions.getOutputDir(), ConfigurationOptions
212	0	.getMarkupSyntax(), ConfigurationOptions.getCssHandler(), ConfigurationOptions.getCharSet());
213	0	config.setWebRepository(ConfigurationOptions.getWebRepository());
214	0	config.setWebBugtracker(ConfigurationOptions.getWebBugtracker());
215	0	config.setNonDeveloperLogins(ConfigurationOptions.getNonDeveloperLogins());
216	0
217	0	final List extraReports = new ArrayList();
218	0	// extraReports.add(new RepoMapPageMaker(config).toFile());
219	0	// extraReports.add(new ChurnPageMaker(config).toFile());
220	0
221	0	ReportSuiteMaker reportSuiteMaker = new ReportSuiteMaker(config, ConfigurationOptions.getNotes(), extraReports);
222	0	if ("xml".equalsIgnoreCase(ConfigurationOptions.getOutputFormat())) {
223	0	reportSuiteMaker.toXml();
224		} else {
225	0	Page page = reportSuiteMaker.toFile();
226
227	0	// logger.info("********* Do A DUMP NOW **********");
228		// try {
229	0	// Thread.sleep(20000);
230	0	// } catch (InterruptedException e) {
231		// // TODO Auto-generated catch block
232	0	// e.printStackTrace();
233	0	// }
234
235
236	0	page.write();
237
238	0	// logger.info("********* Do A SECOND DUMP NOW **********");
239		// try {
240	0	// Thread.sleep(20000);
241	0	// } catch (InterruptedException e) {
242		// // TODO Auto-generated catch block
243	0	// e.printStackTrace();
244	0	// }
245		}
246
247	0	final long endTime = System.currentTimeMillis();
248	0	final long memoryUsedOnEnd = Runtime.getRuntime().totalMemory();
249
250	0	logger.info("runtime: " + (((double) endTime - startTime) / 1000) + " seconds");
251	0	logger.info("memory usage: " + (((double) memoryUsedOnEnd - memoryUsedOnStart) / 1024) + " kb");
252	0	}
253		}