diff options
Diffstat (limited to 'src/batchtools/headless/src/main/java/com/galois/fiveui/HeadlessRunner.java')
| -rw-r--r-- | src/batchtools/headless/src/main/java/com/galois/fiveui/HeadlessRunner.java | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/src/batchtools/headless/src/main/java/com/galois/fiveui/HeadlessRunner.java b/src/batchtools/headless/src/main/java/com/galois/fiveui/HeadlessRunner.java new file mode 100644 index 0000000..aba0ad7 --- /dev/null +++ b/src/batchtools/headless/src/main/java/com/galois/fiveui/HeadlessRunner.java @@ -0,0 +1,181 @@ +/** + * Module : HeadlessRunner.java Copyright : (c) 2012, Galois, Inc. + * + * Maintainer : Stability : Provisional Portability: Portable + * + * 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. + */ +package com.galois.fiveui; + +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.io.PrintWriter; +import java.net.URISyntaxException; +import com.galois.fiveui.Result; +import com.google.common.collect.ImmutableList; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.CommandLineParser; +import org.apache.commons.cli.GnuParser; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Option; +import org.apache.commons.cli.OptionBuilder; +import org.apache.commons.cli.Options; +import org.apache.commons.cli.ParseException; +import org.apache.log4j.Level; +import org.apache.log4j.Logger; +import org.apache.log4j.BasicConfigurator; + +/** + * The main entry point for running headless rule set runs. + * <p> + * The {@link #main(String[])} method of this class sets up a WebDriver, loads + * a headless run description from disk, and executes the run which includes + * loading seed URL's, performing a webcrawl, and running rule sets on each of + * the crawled pages. + * + * @author bjones + * + */ +public class HeadlessRunner { + + private static Logger logger = Logger.getLogger("com.galois.fiveui.HeadlessRunner"); + + /** + * @param args list of headless run description filenames + * @throws IOException + * @throws URISyntaxException + * @throws ParseException + */ + @SuppressWarnings("static-access") + public static void main(final String[] args) + throws IOException, URISyntaxException, ParseException { + + // Setup command line options + Options options = new Options(); + Option help = new Option( "h", "print this help message" ); + Option output = OptionBuilder.withArgName("outfile") + .hasArg() + .withDescription("write output to file") + .create("o"); + Option report = OptionBuilder.withArgName("report directory") + .hasArg() + .withDescription("write HTML reports to given directory") + .create("r"); + options.addOption(output); + options.addOption(report); + options.addOption("v", false, "verbose output"); + options.addOption("vv", false, "VERY verbose output"); + options.addOption(help); + + // Parse command line options + CommandLineParser parser = new GnuParser(); + CommandLine cmd = null; + try { + cmd = parser.parse( options, args); + } catch (ParseException e) { + System.err.println( "Command line option parsing failed. Reason: " + e.getMessage() ); + System.exit(1); + } + + // Display help if requested + if (cmd.hasOption("h")) { + HelpFormatter formatter = new HelpFormatter(); + formatter.printHelp("headless <input file 1> [<input file 2> ...]", options); + System.exit(1); + } + + // Set logging levels + BasicConfigurator.configure(); + Logger fiveuiLogger = Logger.getLogger("com.galois.fiveui"); + Logger rootLogger = Logger.getRootLogger(); + if (cmd.hasOption("v")) { + fiveuiLogger.setLevel(Level.DEBUG); + rootLogger.setLevel(Level.ERROR); + } else if (cmd.hasOption("vv")) { + fiveuiLogger.setLevel(Level.DEBUG); + rootLogger.setLevel(Level.DEBUG); + } else { + fiveuiLogger.setLevel(Level.ERROR); + rootLogger.setLevel(Level.ERROR); + } + + // Setup output file if requested + PrintWriter outStream = null; + if (cmd.hasOption("o")) { + String outfile = cmd.getOptionValue("o"); + try { + outStream = new PrintWriter(new BufferedWriter(new FileWriter(outfile))); + } catch (IOException e) { + System.err.println("Could not open outfile for writing: " + cmd.getOptionValue("outfile")); + System.exit(1); + } + } else { + outStream = new PrintWriter(new BufferedWriter(new PrintWriter(System.out))); + } + + // Setup HTML reports directory before the major work happens in case we + // have to throw an exception. + PrintWriter summaryFile = null; + PrintWriter byURLFile = null; + PrintWriter byRuleFile = null; + if (cmd.hasOption("r")) { + String repDir = cmd.getOptionValue("r"); + try { + File file = new File(repDir); + if (!file.exists()) { + file.mkdir(); + logger.info("report directory created: " + repDir); + } else { + logger.info("report directory already exists!"); + } + summaryFile = new PrintWriter(new FileWriter(repDir + File.separator + "summary.html")); + byURLFile = new PrintWriter(new FileWriter(repDir + File.separator + "byURL.html")); + byRuleFile = new PrintWriter(new FileWriter(repDir + File.separator + "byRule.html")); + } catch (IOException e) { + System.err.println("could not open report directory / files for writing"); + System.exit(1); + } + } + + // Major work: process input files + ImmutableList<Result> results = null; + for (String in: cmd.getArgs()) { + HeadlessRunDescription descr = HeadlessRunDescription.parse(in); + logger.debug("invoking headless run..."); + BatchRunner runner = new BatchRunner(); + results = runner.runHeadless(descr); + logger.debug("runHeadless returned " + results.size() + " results"); + // write results to the output stream as we go + for (Result result : results) { + outStream.println(result.toString()); + } + outStream.flush(); + } + outStream.close(); + + // Write report files if requested + if (cmd.hasOption("r") && results != null) { + Reporter kermit = new Reporter(results); + summaryFile.write(kermit.getSummary()); + summaryFile.close(); + byURLFile.write(kermit.getByURL()); + byURLFile.close(); + byRuleFile.write(kermit.getByRule()); + byRuleFile.close(); + } + } +} + |