SimControl 0.1.2 → 0.1.3

data/README.md

@@ -79,20 +79,20 @@ Usage Example
 
  * Next, we consider the execution of the simulation on one of the hosts specified in the Controlfile by running `bundle exec simulate myScenario`.  First, all scenarios, i.e. calls to simulate, are enumerated. Then, they are assigned to the hosts specified via the host call, were each host is considered multiple times if multiple cores are specified.  In our example, the 3 of the 10 scenarios will be assigned to hostname and the first core of another-hostname, while 2 scenarios will be assigned the remaining cores of another-hostname.  Then, simcontrol obtains the local hostname and the assigned scenarios and one scenario group is started per core.  The command to simulate a scenario is obtained as follows:
 
-   The class and options hash passed to the simulation method in Controlfile are used to construct a `PythonEnvironment` instance, which is able to start the simulation environment. Note, that the simulation method merges the options hash with computed options, e.g. the path to the scenarios results directory and the seed to use for the stimulation.  The full set of parameters used to invoke the simulation are obtained from the parameters of the simulate method in myScenario.rb, were each of the options passed to the simulation as unix-style long parameters (i.e. foo: 4 is converted to --foo 4).
+   The class and options hash passed to the simulation method in Controlfile are used to construct a `PythonEnvironment` instance, which is able to start the simulation environment. Note, that the simulation method merges the options hash with computed options, e.g. the path to the scenarios results directory and the seed to use for the stimulation.  The full set of parameters used to invoke the simulation are obtained from the parameters of the simulate method in myScenario.rb, were each of the (hash) options passed to the simulation as unix-style long parameters (i.e. foo: 4 is converted to --foo 4) and the first parameter is passed as a command.
 
    In our example this results in the following simulation scenarios. Note, that in our example each of the scenarios is executed with varying parameter values for SEED (seed generation is discussed later).  
 
    | Host         | Core | Command |
    |--------------|------|---------|
-   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario/ |
-   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 21 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 21 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 2    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 2    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 3    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
-   | another-host | 3    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario/ |
+   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | host         | %    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 21 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 1    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 21 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 2    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 2    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 3    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 1 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
+   | another-host | 3    | /home/simpy/simpy-env/bin/pypy /home/simpy/simulation/simulation.py command --numberOfServers 11 --duration 90000 --transientPhaseDuration 3600 --seed SEED --results /home/simpy/control/results/myScenario |
 

data/lib/SimControl.rb

@@ -2,6 +2,7 @@ require "SimControl/version"
 require "SimControl/cli"
 require "SimControl/controller"
 require "SimControl/hosts"
+require "SimControl/scenario"
 require "SimControl/environments/base"
 require "SimControl/environments/python"
 

data/lib/SimControl/controller.rb

@@ -4,6 +4,7 @@ module SimControl
 
     def initialize(hostname, simulation_description, scenario_description, results_directory, args = {})
       @hosts = args.delete(:hosts) || SimControl::Hosts.new
+      @scenario_klass = args.delete(:scenario_klass) || SimControl::Scenario
 
       @hostname = hostname
       @simulation_description = simulation_description
@@ -16,6 +17,10 @@ module SimControl
       @max_seed = 2**(32 - 1) - 1
     end 
 
+    def create_scenario(*args)
+      @scenario_klass.new(*args)
+    end
+
     def run
       instance_eval(@simulation_description)
       instance_eval(@scenario_description)
@@ -53,8 +58,8 @@ module SimControl
       (1..@number_of_repetitions).map { @rng.rand(@max_seed) }
     end
 
-    def simulate(scenario)
-      @scenarios << scenario
+    def simulate(*scenario)
+      @scenarios << (create_scenario *scenario)
     end
 
     def all_scenarios

data/lib/SimControl/environments/python.rb

@@ -14,7 +14,7 @@ module SimControl
     end
 
     def args(scenario)
-      scenario.map { |k, v| "--#{ k } #{ v }" }.join " "
+      scenario.args
     end
 
     def execute(scenario)

data/lib/SimControl/scenario.rb

@@ -0,0 +1,24 @@
+module SimControl
+  class Scenario
+    def initialize(*args)
+      options = Hash.try_convert(args.last)
+      if options
+        args.pop
+      end
+      @commands = args
+      @options = options
+    end
+
+    def options
+      @options.map { |k, v| "--#{ k } #{ v }" }.join " "
+    end
+
+    def commands
+      @commands.join(" ").strip
+    end
+
+    def args
+      [commands, options].join " "
+    end
+  end
+end

data/lib/SimControl/version.rb

@@ -1,3 +1,3 @@
 module SimControl
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/controller_spec.rb

@@ -72,13 +72,25 @@ scenario
     end
   end
 
+  describe "#create_scenario" do
+    it "passes the parameters to Scenario.new and returns the new scenario instance" do
+      scenario_klass = double("Scenario")
+      a_scenario = double("ScenarioInstance")
+      instance = SimControl::Controller.new("", "", "", "", scenario_klass: scenario_klass)
+      scenario_klass.should_receive(:new).with("a-command", a_hash: 1).and_return(a_scenario)
+      expect(instance.create_scenario("a-command", a_hash: 1)).to eq(a_scenario)
+    end
+  end
+
   describe "#scenario" do
     it "stores all provided scenarios in all_scenarios" do
-      scenario_a = {foo: 1}
-      scenario_b = {foo: 2}
+      scenario_a = double("Scenario")
+      scenario_b = double("Scenario")
       instance = SimControl::Controller.new("", "", "", "")
-      instance.simulate scenario_a
-      instance.simulate scenario_b
+      instance.stub(:create_scenario).with("a-command", a_hash: 1).and_return(scenario_a)
+      instance.stub(:create_scenario).with("b-command", b_hash: 2).and_return(scenario_b)
+      instance.simulate "a-command", a_hash: 1
+      instance.simulate "b-command", b_hash: 2
       expect(instance.all_scenarios).to include(scenario_a)
       expect(instance.all_scenarios).to include(scenario_b)
     end
@@ -91,7 +103,7 @@ scenario
     let(:seeds) { [1, 2] }
     let(:simulation_instance) { double("simulation_instance") }
     let(:hosts) { double("Hosts") }
-      subject { SimControl::Controller.new(hostname, "", "", "", hosts: hosts).tap do |c|
+    subject { SimControl::Controller.new(hostname, "", "", "", hosts: hosts).tap do |c|
         c.stub(:seeds).and_return(seeds)
         c.stub(:current_simulation).and_return(simulation_instance)
       end

data/spec/environments/python_environment_spec.rb

@@ -23,11 +23,6 @@ describe SimControl::PythonEnvironment do
       expect(simulation.script).to eq("a-script")
     end
 
-    it "passes args to the script in -- syntax" do
-      simulation = SimControl::PythonEnvironment.new script
-      expect(simulation.args({foo: "bar", baz: 1})).to eq("--foo bar --baz 1")
-    end
-
     it "uses a given interpreter" do
       simulation = SimControl::PythonEnvironment.new script, interpreter: "pypy"
       expect(simulation.interpreter).to eq("pypy")
@@ -40,9 +35,10 @@ describe SimControl::PythonEnvironment do
     
     it "composes the command" do
       simulation = SimControl::PythonEnvironment.new script
-      simulation.stub(:args).and_return "--args 1"
+      scenario = double("scenario")
+      scenario.should_receive(:args).and_return("--args 1")
       simulation.stub(:interpreter).and_return "/foo/jpython"
-      expect(simulation.command(args: 1)).to eq("/foo/jpython a-script --args 1")
+      expect(simulation.command(scenario)).to eq("/foo/jpython a-script --args 1")
     end
 
     it "raised an exception is a virtualenv is passed but no interpreter" do

data/spec/scenario_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe SimControl::Scenario do
+  it "generates options in -- syntax" do
+    scenario = SimControl::Scenario.new foo: "bar", baz: 1
+    expect(scenario.options).to eq("--foo bar --baz 1")
+  end
+
+  it "generates commands by concatenating" do
+    scenario = SimControl::Scenario.new "foo", "bar"
+    expect(scenario.commands).to eq("foo bar")
+  end
+
+  it "generates the complete arguments string" do
+    scenario = SimControl::Scenario.new "foo", "bar", baz: "1", qux: 2
+    expect(scenario.args).to eq("foo bar --baz 1 --qux 2")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SimControl
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-19 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -163,6 +163,7 @@ files:
 - lib/SimControl/environments/base.rb
 - lib/SimControl/environments/python.rb
 - lib/SimControl/hosts.rb
+- lib/SimControl/scenario.rb
 - lib/SimControl/version.rb
 - spec/acceptance/init_spec.rb
 - spec/acceptance/scenario_spec.rb
@@ -171,6 +172,7 @@ files:
 - spec/environments/base_environment_spec.rb
 - spec/environments/python_environment_spec.rb
 - spec/hosts_spec.rb
+- spec/scenario_spec.rb
 - spec/spec_helper.rb
 - templates/scaffolding/Controlfile
 - templates/scenario/scenario.rb
@@ -207,4 +209,5 @@ test_files:
 - spec/environments/base_environment_spec.rb
 - spec/environments/python_environment_spec.rb
 - spec/hosts_spec.rb
+- spec/scenario_spec.rb
 - spec/spec_helper.rb