doc/BigBench/Executor.html in bigbench-0.0.4 vs doc/BigBench/Executor.html in bigbench-0.0.5
- old
+ new
@@ -56,21 +56,11 @@
<div id="class-metadata">
- <!-- Method Quickref -->
-<nav id="method-list-section" class="section">
- <h3 class="section-header">Methods</h3>
-
- <ul class="link-list">
- <li><a href="#method-c-run-21">::run!</a>
-
- </ul>
-</nav>
-
</div>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
@@ -103,26 +93,24 @@
<li><a href="../BigBench/Bot.html">BigBench::Bot</a>
<li><a href="../BigBench/Configuration.html">BigBench::Configuration</a>
- <li><a href="../BigBench/Configuration/Config.html">BigBench::Configuration::Config</a>
-
- <li><a href="../BigBench/Configuration/InvalidOptions.html">BigBench::Configuration::InvalidOptions</a>
-
<li><a href="../BigBench/Executor.html">BigBench::Executor</a>
- <li><a href="../BigBench/Executor/InvalidCommand.html">BigBench::Executor::InvalidCommand</a>
+ <li><a href="../BigBench/Executor/Executable.html">BigBench::Executor::Executable</a>
<li><a href="../BigBench/Fragment.html">BigBench::Fragment</a>
<li><a href="../BigBench/Fragment/Fragment.html">BigBench::Fragment::Fragment</a>
<li><a href="../BigBench/Output.html">BigBench::Output</a>
<li><a href="../BigBench/PostProcessor.html">BigBench::PostProcessor</a>
+ <li><a href="../BigBench/PostProcessor/Context.html">BigBench::PostProcessor::Context</a>
+
<li><a href="../BigBench/PostProcessor/Environment.html">BigBench::PostProcessor::Environment</a>
<li><a href="../BigBench/PostProcessor/Environment/Appearings.html">BigBench::PostProcessor::Environment::Appearings</a>
<li><a href="../BigBench/PostProcessor/Environment/AttributeCluster.html">BigBench::PostProcessor::Environment::AttributeCluster</a>
@@ -149,10 +137,12 @@
<li><a href="../BigBench/PostProcessor/Statistics.html">BigBench::PostProcessor::Statistics</a>
<li><a href="../BigBench/PostProcessor/Test.html">BigBench::PostProcessor::Test</a>
+ <li><a href="../BigBench/PostProcessor/TestPretty.html">BigBench::PostProcessor::TestPretty</a>
+
<li><a href="../BigBench/Runner.html">BigBench::Runner</a>
<li><a href="../BigBench/Runner/NoBenchmarksDefined.html">BigBench::Runner::NoBenchmarksDefined</a>
<li><a href="../BigBench/Store.html">BigBench::Store</a>
@@ -183,36 +173,21 @@
<div id="description" class="description">
<p>Dispatches the command line commands to <a
href="../BigBench.html">BigBench</a> calls. Available commands are:</p>
-<p>Usage:</p>
+<p>Tasks:</p>
-<pre># Local Testing
-bigbench run local PATH_TO_TEST # Runs a test from the local machine. No redis needed.
+<pre>bigbench -v # Show the version
+bigbench bot [REDIS_URL_WITH_PORT] [REDIS_PASSWORD] # Start a bot on the current machine
+bigbench bots TEST_FILE [REDIS_URL_WITH_PORT] [REDIS_PASSWORD] # Run the TEST_FILE on all bots
+bigbench generate TEST_FILE # Generates a simple test file to customize further
+bigbench help [TASK] # Describe available tasks or one specific task
+bigbench local TEST_FILE # Run the TEST_FILE on the local machine
+bigbench process TEST_FILE [POST_PROCESSOR] # Run all post processors of the testfile or the single POST_PROCESSOR
+bigbench reset [REDIS_URL_WITH_PORT] [REDIS_PASSWORD] # Reset everything including the redis storage</pre>
-# Remote Testing
-bigbench run bots PATH_TO_TEST [REDIS_URL_WITH_PORT REDIS_PASSWORD] # Deploys and starts the test on all bots
-bigbench start bot [REDIS_URL_WITH_PORT REDIS_PASSWORD] # Starts a bot on a remote machine
-
-# Reseting
-bigbench reset all # Resets everything
-
-# Post Processors
-bigbench run postprocessors PATH_TO_TEST # Runs all post processors of the test without running the test itself
-bigbench run postprocessor PATH_TO_TEST POSTPROCESSOR # Runs the specified post processor on the output file
-
-# Help
-bigbench --help || show help # Displays this help</pre>
-
-<p>Options:</p>
-
-<pre class="ruby"><span class="ruby-constant">REDIS_URL_WITH_PORT</span> <span class="ruby-comment"># Defaults to http://localhost:6379</span>
-<span class="ruby-constant">REDIS_PASSWORD</span> <span class="ruby-comment"># Defaults to no password</span>
-<span class="ruby-constant">POSTPROCESSOR</span> <span class="ruby-comment"># A post processor module or its short name e.g. 'statistics'</span>
-</pre>
-
</div><!-- description -->
@@ -220,70 +195,14 @@
- <!-- Constants -->
- <section id="constants-list" class="section">
- <h3 class="section-header">Constants</h3>
- <dl>
-
- <dt id="COMMANDS">COMMANDS
-
- <dd class="description">
-
-
- </dl>
- </section>
-
<!-- Methods -->
- <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
- <h3 class="section-header">Public Class Methods</h3>
-
-
- <div id="method-c-run-21" class="method-detail ">
-
- <div class="method-heading">
- <span class="method-name">run!</span><span
- class="method-args">(argv)</span>
- <span class="method-click-advice">click to toggle source</span>
- </div>
-
-
- <div class="method-description">
-
- <p>Parses and runs the <a href="../BigBench.html">BigBench</a> funtion that is
-supplied via the commandline’s ARGV. It throws an
-<code>InvalidCommand</code> exception if the command is unknown.</p>
-
-
-
- <div class="method-source-code" id="run-21-source">
- <pre><span class="ruby-comment"># File lib/bigbench/executor.rb, line 32</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">run!</span>(<span class="ruby-identifier">argv</span>)
- <span class="ruby-constant">BigBench</span><span class="ruby-operator">::</span><span class="ruby-constant">Output</span>.<span class="ruby-identifier">start</span>
-
- <span class="ruby-identifier">check_arguments!</span>(<span class="ruby-identifier">argv</span>)
- <span class="ruby-identifier">send</span> <span class="ruby-identifier">to_executor_method</span>(<span class="ruby-identifier">argv</span>), <span class="ruby-identifier">argv</span>
-
- <span class="ruby-constant">BigBench</span><span class="ruby-operator">::</span><span class="ruby-constant">Output</span>.<span class="ruby-identifier">done</span>
-<span class="ruby-keyword">end</span></pre>
- </div><!-- run-21-source -->
-
- </div>
-
-
-
-
- </div><!-- run-21-method -->
-
-
- </section><!-- public-class-method-details -->
-
</section><!-- 5Buntitled-5D -->
</div><!-- documentation -->