SimControl 0.1.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in SimControl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    SimControl (0.1.0)
+      active_support
+      i18n
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    fakefs (0.4.2)
+    i18n (0.6.4)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    slop (3.4.6)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  SimControl!
+  bundler (~> 1.3)
+  fakefs
+  pry
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 cschwartz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 christian.schwartz@gmail.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+SimControl
+==========
+
+Usage Example
+=============
+
+ * Create a new directory `control`, in the following assumed to be at
+   /home/simpy/control/, create a `Gemfile` with the
+   following content:
+
+   ```ruby
+   source 'https://rubygems.org'
+   gem 'SimControl'
+   ```
+   and run `bundle` to install the dependencies.
+
+ * Next, run `bundle exec simcontrol init` to create the basic directory structure:
+
+   ```
+   ├── Controlfile
+   ├── Gemfile
+   ├── Gemfile.lock
+   ├── results
+   └── scenarios
+   ```
+   
+   The Controlfile describes both the hosts on which the simulation will run, as well as general information about the simulation program.  The default Controlfile is given below 
+   
+   ```ruby
+   hosts do
+     #A host with name "hostname"
+     use "hostname"
+   
+     #Another host, with 3 cores to be used for simulation
+     use "another-hostname", cores: 3
+   end
+   
+   #currently only a python environment is implemented
+   simulation PythonEnvironment, "/home/simpy/simulation/simulation.py",
+     #use a virtualenv, not the global python
+     virtualenv: "/home/simpy/simpy-env",
+     #do not use the default system python but pypy
+     interpreter: "pypy"
+   ```
+
+ * In order to create your first simulation scenario, run
+
+   ```
+   bundle exec simcontrol scenario myScenario
+   ```
+   
+   which creates a results subfolder named myScenario as well as a scenario description file myScenario.rb in the scenarios folder, resulting in the following overall project structure: 
+   
+   ```
+   .
+   ├── Controlfile
+   ├── Gemfile
+   ├── Gemfile.lock
+   ├── results
+   │   └── myScenario
+   └── scenarios
+       └── myScenario.rb
+   ```
+
+   The default scenario description in myScenario.rb has the following content:
+   
+   ```
+   repetitions 10
+   numberOfServers = (1..100).step(10)
+   
+   numberOfServers.each do |currentNumberOfServers|
+     simulate numberOfServers: currentNumberOfServers,
+       duration: 1.day + 1.hour,
+       transientPhaseDuration: 1.hour
+   end
+   ```
+
+   This describes 10 scenarios, each with 10 repetitions are described. A system with a varying number of server components is simulated for a duration of 25 hours,  the first hour is exempt from statistic collection to account for the transient phase.
+
+ * 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).
+
+   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 |
+

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/SimControl.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'SimControl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "SimControl"
+  spec.version       = SimControl::VERSION
+  spec.authors       = ["Christian Schwartz"]
+  spec.email         = ["christian.schwartz@gmail.com"]
+  spec.description   = %q{A DSL for simpy based simulations on multiple hosts}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/cschwartz/SimControl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "active_support"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "fakefs"
+end

data/bin/simcontrol

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "simcontrol"
+
+SimControl::CLI.start(ARGV)

data/lib/SimControl.rb

@@ -0,0 +1,12 @@
+require "SimControl/version"
+require "SimControl/cli"
+require "SimControl/controller"
+require "SimControl/hosts"
+require "SimControl/environments/base"
+require "SimControl/environments/python"
+
+module SimControl
+  def self.root
+    File.expand_path('../..',__FILE__)
+  end
+end

data/lib/SimControl/cli.rb

@@ -0,0 +1,86 @@
+require "thor"
+require "socket"
+
+module SimControl
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "init", "creates scaffolding for SimControl in this directory"
+    def init
+      base_dir = Dir.pwd
+      destination_root= base_dir
+      empty_directory "scenarios"
+      empty_directory "results"
+      copy_file "scaffolding/Controlfile", "Controlfile"
+    end
+
+    desc "newScenario SCENARIO", "creates a new scenario of name SCENARIO"
+    def newScenario(name)
+      SimControl::CLI.init_generated_files_exist?
+
+      copy_file "scenario/scenario.rb", File.join("scenarios", "#{ name }.rb")
+      empty_directory File.join("results", name)
+    end
+
+    desc "simulate SCENARIO", "simulates a subsets of SCENARIO on the current HOSTNAME"
+    def simulate(scenario)
+      SimControl::CLI.init_generated_files_exist?
+      SimControl::CLI.scenario_files_exist?(scenario)
+
+      SimControl::Controller.execute(hostname, 
+                                    simulation_description,
+                                    scenario_description(scenario),
+                                    results_directory(scenario))
+    end
+
+    no_commands {
+      def hostname
+        Socket.gethostname
+      end
+
+      def simulation_description
+        File.open(control_file_name).read
+      end
+
+      def scenario_description(scenario)
+        File.open(scenario_file_name(scenario)).read
+      end
+
+      def results_directory(scenario)
+        File.join("results", scenario)
+      end
+
+      def control_file_name
+        File.join(Dir.pwd, "Controlfile")
+      end
+
+      def scenario_file_name(scenario)
+        File.join(Dir.pwd, "scenarios",  "#{ scenario }.rb")
+      end
+
+      def self.scenario_files_exist?(scenario)
+        raise Thor::Error.new "#{ CLI::scenario_path(scenario) } missing, run newScenario # scenario }" unless File.exists?(CLI::scenario_path(scenario))
+        raise Thor::Error.new "#{ CLI::results_path(scenario) } missing, run newScenario # scenario }" unless File.directory?(CLI::results_path(scenario))
+      end
+
+      def self.results_path(scenario_name)
+        results_path = File.join("results", scenario_name)
+      end
+
+      def self.scenario_path(scenario_name)
+        scenario_path = File.join("scenarios", "#{scenario_name}.rb")
+      end
+
+      def self.init_generated_files_exist?
+        raise Thor::Error.new "scenarios missing, run init" unless File.directory?("scenarios")
+        raise Thor::Error.new "results missing, run init" unless File.directory?("results")
+        raise Thor::Error.new "Controlfile missing, run init" unless File.exists?("Controlfile")
+      end
+
+      def self.source_root
+        File.join(SimControl.root, 'templates')
+      end
+  }
+  end
+end
+

data/lib/SimControl/controller.rb

@@ -0,0 +1,71 @@
+module SimControl
+  class Controller
+    attr_reader :current_simulation
+
+    def initialize(hostname, simulation_description, scenario_description, results_directory, args = {})
+      @hosts = args.delete(:hosts) || SimControl::Hosts.new
+
+      @hostname = hostname
+      @simulation_description = simulation_description
+      @scenario_description = scenario_description
+      @results_directory = results_directory
+
+      @scenarios = []
+
+      @meta_seed = 13
+      @max_seed = 2**(32 - 1) - 1
+    end 
+
+    def run
+      instance_eval(@simulation_description)
+      instance_eval(@scenario_description)
+
+      host_scenarios = @hosts.partition(all_scenarios, @hostname)
+
+      host_scenarios.each do |scenarios_per_core|
+        threads = []
+        scenarios_per_core.each do |scenario|
+          threads << Thread.new do
+            current_simulation.simulate(scenario, seeds)
+          end
+
+          threads.each do |thread|
+            thread.join
+          end
+        end
+      end
+    end
+
+    def repetitions(number_of_repetitions)
+      @number_of_repetitions = number_of_repetitions
+    end
+
+    def hosts(&hosts_block)
+      @hosts.process &hosts_block
+    end
+
+    def simulation(klass, script, arguments)
+      @current_simulation = klass.new script, arguments
+    end
+
+    def seeds
+      @rng = Random.new(@meta_seed)
+      (1..@number_of_repetitions).map { @rng.rand(@max_seed) }
+    end
+
+    def simulate(scenario)
+      @scenarios << scenario
+    end
+
+    def all_scenarios
+      @scenarios
+    end
+
+    class << self
+      def execute(hostname, simulation_description, scenario_description, results_directory)
+        controller = SimControl::Controller.new(hostname, simulation_description, scenario_description, results_directory)
+        controller.run
+      end
+    end
+  end
+end

data/lib/SimControl/environments/base.rb

@@ -0,0 +1,9 @@
+module SimControl
+  class BaseEnvironment
+    def simulate(args, seeds)
+      seeds.each do |seed|
+        execute(args.merge({seed: seed}))
+      end
+    end
+  end
+end

data/lib/SimControl/environments/python.rb

@@ -0,0 +1,24 @@
+module SimControl
+  class PythonEnvironment < BaseEnvironment
+    def initialize(script, args = {})
+      @script = script
+      @interpreter = args.delete(:interpreter)
+      @virtualenv = args.delete(:virtualenv)
+      raise "passing a virtualenv requires an interpreter" if @virtualenv and not @interpreter
+    end
+
+    def execute(scenario)
+      args = scenario.map { |k, v| "--#{ k } #{ v }" }.join " "
+      command = [interpreter, @script, args].reject(&:nil?).reject(&:empty?).join " "
+      `#{ command }`
+    end
+
+    def interpreter
+      if @virtualenv
+        File.join(@virtualenv, "bin", @interpreter) 
+      else 
+        @interpreter
+      end
+    end
+  end
+end

data/lib/SimControl/hosts.rb

@@ -0,0 +1,37 @@
+require "active_support/all"
+
+class SimControl::Hosts
+  def initialize
+    @hosts = {}
+  end
+
+  def use(host, args = {})
+    args[:cores] = args[:cores] || 1
+    @hosts[host] = args
+  end
+
+  def number_of_cores
+    @hosts.map { |k, v| v[:cores] }.reduce(0, :+)
+  end
+
+  def partition(all_scenarios, hostname)
+    return [] if number_of_cores == 0
+    scenario_groups = all_scenarios.in_groups_of(number_of_cores, false)
+    scenario_groups[host_indices hostname]
+  end
+
+  def host_indices(hostname)
+    return 0..0 unless @hosts.include? hostname
+    start_index = 0
+    @hosts.each do |current_hostname, options|
+      cores = options[:cores]
+      return (start_index ... (start_index + cores)) if current_hostname == hostname
+      start_index += cores
+    end
+  end
+
+  def process(&block)
+    instance_eval(&block)
+  end
+
+end

data/lib/SimControl/version.rb

@@ -0,0 +1,3 @@
+module SimControl
+  VERSION = "0.1.0"
+end

data/spec/acceptance/init_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+require "SimControl"
+
+require "fakefs/spec_helpers"
+
+describe SimControl::CLI do
+  let(:cli) { SimControl::CLI.new }
+
+  include FakeFS::SpecHelpers
+  describe "#init creates the control structure" do
+    let(:controlfile) { "Content" }
+    before(:each) do
+      FileUtils.mkdir_p("templates/scaffolding")
+      File.open("templates/scaffolding/Controlfile", "w") {  |f| f.write(controlfile) }
+    end
+
+    before(:each) do
+      cli.invoke :init
+    end
+
+    it "creates the scenarios folder" do
+      expect(File.directory?("scenarios")).to be(true)
+    end
+
+    it "creates the results folder" do
+      expect(File.directory?("results")).to be(true)
+    end
+
+    it "creates the Controlfile with appropriate content" do
+      expect(File.open("Controlfile", "r").read).to eq(controlfile)
+    end
+  end
+end

data/spec/acceptance/scenario_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+require "SimControl"
+
+require "fakefs/spec_helpers"
+
+describe SimControl::CLI do
+  let(:cli) { SimControl::CLI.new }
+
+  include FakeFS::SpecHelpers
+  describe "#newScenario" do
+    describe "with scenario name" do
+      let(:scenario) { "scenario" }
+
+      before(:each) do
+        FileUtils.mkdir("scenarios")
+        FileUtils.mkdir("results")
+        FileUtils.touch("Controlfile")
+        FileUtils.mkdir_p("templates/scenario")
+        File.open("templates/scenario/scenario.rb", "w") {  |f| f.write(scenario) }
+        cli.invoke :newScenario, ["myScenario"]
+      end
+
+      it "creates scenarios/myScenario.rb" do
+        expect(File.open("scenarios/myScenario.rb", "r").read).to eq(scenario)
+      end
+
+      it "creates results/myScenario/" do
+        expect(File.directory?("results/myScenario")).to be_true
+      end
+    end
+
+    describe "without scenario name" do
+      it "fails" do
+        expect do
+          cli.invoke :newScenario
+        end.to raise_error(Thor::InvocationError, /with no arguments/)
+      end
+    end
+
+    describe "without init having been run" do
+      it "fails if no scenarios folder exists" do
+        FileUtils.mkdir("results")
+        FileUtils.touch("Controlfile")
+        expect do
+          cli.invoke :newScenario, ["myScenario"]
+        end.to raise_error(Thor::Error, /scenarios missing/)
+      end
+
+      it "fails if no results folder exists" do
+        FileUtils.mkdir("scenarios")
+        FileUtils.touch("Controlfile")
+        expect do
+          cli.invoke :newScenario, ["myScenario"]
+        end.to raise_error(Thor::Error, /results missing/)
+      end
+
+      it "fails if no Controlfile exists" do
+        FileUtils.mkdir("scenarios")
+        FileUtils.mkdir("results")
+        expect do
+          cli.invoke :newScenario, ["myScenario"]
+        end.to raise_error(Thor::Error, /Controlfile missing/)
+      end
+    end
+  end
+end

data/spec/cli/simulate_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "simcontrol"
+
+require "fakefs/spec_helpers"
+
+describe SimControl::CLI do
+  include FakeFS::SpecHelpers
+  describe "simulate" do
+    before(:each) do
+      scenario = "hosts {}"
+      FileUtils.mkdir("scenarios")
+      FileUtils.mkdir("results")
+      FileUtils.touch("Controlfile")
+      FileUtils.touch("scenarios/myScenario.rb")
+      FileUtils.mkdir_p("results/myScenario")
+    end
+
+    it  "calls SimControl::Controller.execute()" do
+      scenario_description = "scenario"
+      simulation_description = "simulation"
+      results_path = File.join("results", "myScenario")
+      hostname = "a-hostname"
+      File.open("scenarios/myScenario.rb", "w") {  |f| f.write(scenario_description) }
+      File.open("Controlfile", "w") {  |f| f.write(simulation_description) }
+      Socket.stub(:gethostname).and_return { hostname }
+      SimControl::Controller.should_receive(:execute).with(hostname, simulation_description, scenario_description, results_path)
+      SimControl::CLI.new.invoke :simulate, ["myScenario"]
+    end
+
+    it "fails if no results directory exists" do
+      FileUtils.rm_rf("results")
+      expect do
+        SimControl::CLI.new.invoke :simulate, ["myScenario"]
+      end.to raise_error(Thor::Error, /results missing/)
+    end
+
+    it "fails if no results directory exists for the scenario" do
+      FileUtils.rm_rf("results/myScenario")
+      expect do
+        SimControl::CLI.new.invoke :simulate, ["myScenario"]
+      end.to raise_error(Thor::Error, /results\/myScenario missing/)
+    end
+
+    it "fails if no scenarios directory exists" do
+      FileUtils.rm_rf("scenarios")
+      expect do
+        SimControl::CLI.new.invoke :simulate, ["myScenario"]
+      end.to raise_error(Thor::Error, /scenarios missing/)
+    end
+
+    it "fails if the scenario description does not exist" do
+      FileUtils.rm("scenarios/myScenario.rb")
+      expect do
+        SimControl::CLI.new.invoke :simulate, ["myScenario"]
+      end.to raise_error(Thor::Error, /scenarios\/myScenario.rb missing/)
+    end
+
+    it "fails if the Controlfile does not exist" do
+      FileUtils.rm("Controlfile")
+      expect do
+        SimControl::CLI.new.invoke :simulate, ["myScenario"]
+      end.to raise_error(Thor::Error, /Controlfile missing/)
+    end
+  end
+end

data/spec/controller_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+
+describe SimControl::Controller do
+  describe "#execute" do
+    it "creates a new controller instance and runs it with the called arguments" do
+      hostname = "a-hostname"
+      simulation_description = double("simulation_description")
+      scenario_description = double("scenario_description")
+      results_directory = double("results_directory")
+      instance = double(SimControl::Controller)
+      SimControl::Controller.should_receive(:new).with(hostname, simulation_description, scenario_description, results_directory).and_return(instance)
+      instance.should_receive(:run)
+      SimControl::Controller.execute(hostname, simulation_description, scenario_description, results_directory)
+    end
+
+    it "calls methods called from the simulation description on the controller instance" do
+      simulation_description = <<Controlfile
+  hosts
+Controlfile
+      instance = SimControl::Controller.new("", simulation_description, "", "")
+      instance.should_receive(:hosts)
+      instance.run
+    end
+
+    it "calls methods called from the scenario description on the controller instance" do
+      scenario_description = <<scenario
+  simulate
+scenario
+      instance = SimControl::Controller.new("", "",  scenario_description, "")
+      instance.should_receive(:simulate)
+      instance.run
+    end
+  end 
+
+  describe "#hosts" do
+    it "yields the given block" do
+      proc = Proc.new do
+
+      end
+      hosts = double("Hosts")
+      hosts.should_receive(:process).with(&proc)
+      instance = SimControl::Controller.new("", "", "", "", hosts: hosts)
+      instance.hosts &proc
+    end
+  end
+
+  describe "#repetitions" do
+    it "allows to specify the number of repetitions" do
+      instance = SimControl::Controller.new("", "", "", "")
+      instance.repetitions 10
+      expect(instance.seeds.length).to eq(10)    
+      instance.run
+    end
+  end
+
+  describe "#simulation" do
+    let(:klass) { double("Klass") }
+    it "creates a new instance of the given class and passes the hash" do
+      script = "a-script"
+      hash = double("Hash")
+      instance = SimControl::Controller.new("", "", "", "")
+      klass.should_receive(:new).with(script, hash)
+      instance.simulation klass, script, hash
+    end
+
+    it "allows for the instance to be obtained as #current_simulation" do
+      simulation_instance = double("simulation_instance")
+      instance = SimControl::Controller.new("", "", "", "")
+      klass.stub(:new) { simulation_instance }
+      instance.simulation klass, "script", {}
+      expect(instance.current_simulation).to be(simulation_instance)
+    end
+  end
+
+  describe "#scenario" do
+    it "stores all provided scenarios in all_scenarios" do
+      scenario_a = {foo: 1}
+      scenario_b = {foo: 2}
+      instance = SimControl::Controller.new("", "", "", "")
+      instance.simulate scenario_a
+      instance.simulate scenario_b
+      expect(instance.all_scenarios).to include(scenario_a)
+      expect(instance.all_scenarios).to include(scenario_b)
+    end
+  end
+
+  describe "#run" do
+    let(:hostname) { "a-hostname" }
+    let(:scenario_a) { {setting: "a-value"} }
+    let(:scenario_b) { {setting: "another-value"} }
+    let(:seeds) { [1, 2] }
+    let(:simulation_instance) { double("simulation_instance") }
+    let(:hosts) { double("Hosts") }
+      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
+    }
+
+    it "calls execute on the simulation instance for each parameter combination for the given host" do
+      per_host_scenarios = [[scenario_a, scenario_b]]
+
+      hosts.should_receive(:partition).with(anything(), hostname).and_return(per_host_scenarios) 
+      simulation_instance.should_receive(:simulate).ordered.with(scenario_a, seeds)
+      simulation_instance.should_receive(:simulate).ordered.with(scenario_b, seeds)
+
+      subject.run
+    end
+
+    it "passes all_scenarios to partition" do
+      scenarios = [scenario_a, scenario_b]
+
+      subject.should_receive(:all_scenarios).and_return(scenarios)
+      hosts.should_receive(:partition).with(scenarios, anything()).and_return([scenarios]) 
+      simulation_instance.stub(:simulate)
+
+      subject.run
+    end
+
+
+    it "spawns multiple threads if the hosts support it" do
+      per_host_scenarios = [[scenario_a], [ scenario_b]]
+
+      hosts.should_receive(:partition).with(anything(), hostname).and_return(per_host_scenarios) 
+      thread = double("Thread")
+      Thread.should_receive(:new).twice.and_return(thread)
+      thread.should_receive(:join).twice
+
+      subject.run
+    end
+
+  end
+end

data/spec/environments/base_environment_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe SimControl::BaseEnvironment do
+  describe "#simulate" do
+    it "calls #execute for each seed" do
+      subject.should_receive(:execute).twice
+      subject.simulate({}, [1, 2])
+    end
+
+    it "injects the seed in the arguments hash" do
+      subject.should_receive(:execute) do |args|
+        expect(args[:seed]).to eq(1)
+      end
+
+      subject.should_receive(:execute) do |args|
+        expect(args[:seed]).to eq(2)
+      end
+
+      subject.simulate({}, [1, 2])
+    end
+
+    it "keeps the arguments hash" do
+      subject.should_receive(:execute) do |args|
+        expect(args[:foo]).to eq("bar")
+      end
+
+      subject.simulate({foo: "bar"}, [1])
+
+    end
+  end
+end

data/spec/environments/python_environment_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe SimControl::PythonEnvironment do
+  let(:script) { "a-script" }
+  describe "#simulate" do
+    it "calls the script if nothing is passed in args" do
+      simulation = SimControl::PythonEnvironment.new script
+      simulation.should_receive(:`).with(script)
+      simulation.execute({})
+    end
+
+    it "passes args to the script in -- syntax" do
+      simulation = SimControl::PythonEnvironment.new script
+      simulation.should_receive(:`).with("#{ script } --foo bar --baz 1")
+      simulation.execute({foo: "bar", baz: 1})
+    end
+
+    it "uses a given interpreter" do
+      simulation = SimControl::PythonEnvironment.new script, interpreter: "pypy"
+      simulation.should_receive(:`).with("pypy #{ script }")
+      simulation.execute({})
+    end
+
+    it "uses a given virtualenv and interpreter" do
+      simulation = SimControl::PythonEnvironment.new script, virtualenv: "foo/bar",  interpreter: "pypy"
+      simulation.should_receive(:`).with("foo/bar/bin/pypy #{ script }")
+      simulation.execute({})
+    end
+
+    it "raised an exception is a virtualenv is passed but no interpreter" do
+      expect do
+        SimControl::PythonEnvironment.new script, virtualenv: "foo/bar"
+      end.to raise_error /passing a virtualenv requires an interpreter/
+    end
+  end
+
+end

data/spec/hosts_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe SimControl::Hosts do
+  it "applies use directives in process" do
+    hosts = SimControl::Hosts.new
+    hosts.should_receive(:use).with("host-a")
+    hosts.process do
+      use "host-a"
+    end
+  end
+
+  describe "#number_of_cores" do
+    it "provides the total number of cores" do
+      hosts = SimControl::Hosts.new
+      hosts.use "host-a"
+      hosts.use "host-b", cores: 2
+      expect(hosts.number_of_cores).to eq(3)
+    end
+
+    it "returns 0 if no hosts exist" do
+      hosts = SimControl::Hosts.new
+      expect(hosts.number_of_cores).to eq(0)
+    end
+  end
+
+  it "splits scenarios evenly if all hosts have 1 core" do
+    hosts = SimControl::Hosts.new
+    hosts.use "host-a"
+    hosts.use "host-b"
+    scenario_a = {foo: 1}
+    scenario_b = {foo: 2}
+    scenario_c = {foo: 3}
+    scenario_d = {foo: 4}
+    all_scenarios = [scenario_a, scenario_b, scenario_c, scenario_d]
+    host_a_scenarios = hosts.partition all_scenarios, "host-a"
+    expect(host_a_scenarios.first).to include(scenario_a)
+    expect(host_a_scenarios.first).to include(scenario_b)
+    host_b_scenarios = hosts.partition all_scenarios, "host-b"
+    expect(host_b_scenarios.first).to include(scenario_c)
+    expect(host_b_scenarios.first).to include(scenario_d)
+  end
+
+  it "returns the empty list if no hosts exist" do
+    hosts = SimControl::Hosts.new
+    scenario_a = {foo: 1}
+    expect(hosts.partition [scenario_a], "a-host").to eq([])
+  end
+
+
+  describe "#host_indices" do
+    it "returns the indices of scenarios to use" do
+      hosts = SimControl::Hosts.new
+      hosts.use "host-a", cores: 2
+      hosts.use "host-b", cores: 3
+      hosts.use "host-c", cores: 2
+      hosts.use "host-d", cores: 4
+      hosts_range = hosts.host_indices "host-c"
+      expect(hosts_range).to include 5
+      expect(hosts_range).to include 6
+    end
+
+    it "returns the empty array if the host is not found" do
+      hosts = SimControl::Hosts.new
+      expect(hosts.host_indices "host").to eq(0..0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.before do
+    #remove this as soon as FakeFS is released > 0.4.2
+    class ::FakeFS::File
+      def self.binread(file)
+        File.open(file, 'rb') { |f| f.read }
+      end
+    end
+  end 
+
+  #shamelessly copied from thor's spec
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+end

data/templates/scaffolding/Controlfile

@@ -0,0 +1,14 @@
+hosts do
+  #A host with name "hostname"
+  use "hostname"
+
+  #Another host, with 3 cores to be used for simulation
+  use "another-hostname", cores: 3
+end
+
+#currently only a python environment is implemented
+simulation PythonEnvironment, "/path/to/simulation.py",
+  #use a virtualenv, not the global python
+  virtualenv: "/path/to/virtualenv",
+  #do not use the default system python but pypy
+  interpreter: "pypy"

data/templates/scenario/scenario.rb

@@ -0,0 +1,8 @@
+repetitions 10
+numberOfServers = (1..100).step(10)
+
+numberOfServers.each do |currentNumberOfServers|
+  simulate numberOfServers: currentNumberOfServers,
+    duration: 1.day + 1.hour,
+    transientPhaseDuration: 1.hour
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: SimControl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christian Schwartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A DSL for simpy based simulations on multiple hosts
+email:
+- christian.schwartz@gmail.com
+executables:
+- simcontrol
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- SimControl.gemspec
+- bin/simcontrol
+- lib/SimControl.rb
+- lib/SimControl/cli.rb
+- lib/SimControl/controller.rb
+- lib/SimControl/environments/base.rb
+- lib/SimControl/environments/python.rb
+- lib/SimControl/hosts.rb
+- lib/SimControl/version.rb
+- spec/acceptance/init_spec.rb
+- spec/acceptance/scenario_spec.rb
+- spec/cli/simulate_spec.rb
+- spec/controller_spec.rb
+- spec/environments/base_environment_spec.rb
+- spec/environments/python_environment_spec.rb
+- spec/hosts_spec.rb
+- spec/spec_helper.rb
+- templates/scaffolding/Controlfile
+- templates/scenario/scenario.rb
+homepage: https://github.com/cschwartz/SimControl
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A DSL for simpy based simulations on multiple hosts
+test_files:
+- spec/acceptance/init_spec.rb
+- spec/acceptance/scenario_spec.rb
+- spec/cli/simulate_spec.rb
+- spec/controller_spec.rb
+- spec/environments/base_environment_spec.rb
+- spec/environments/python_environment_spec.rb
+- spec/hosts_spec.rb
+- spec/spec_helper.rb