laborantin 0.0.14 → 0.0.21

data/lib/laborantin/runner/commands/analyze.rb

@@ -0,0 +1,58 @@
+#runner/commands/analyze.rb
+
+=begin
+
+This file is part of Laborantin.
+
+Laborantin is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Laborantin 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Laborantin.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright (c) 2009, Lucas Di Cioccio
+
+=end
+
+module Laborantin
+  module Commands
+    class Analyze < Command
+      describe "Runs the analyses"
+
+      option(:analyses) do
+        describe "comma separated list of analyses"
+        short '-a' 
+        long '--analyses=OPTIONAL' 
+        default []
+        type Array
+        complete do |cmd|
+          completion_propositions_iterating_on(cmd, Laborantin::Analysis.all.map(&:cli_name))
+        end
+      end
+
+      execute do
+        anae = if opts[:analyses].empty?
+                 Analysis.all
+               else
+                 Analysis.all.select do |e| 
+                   opts[:analyses].find do |cli_name|
+                      cli_name == e.cli_name
+                   end
+                 end
+               end
+
+        anae.each do |klass|
+          puts "Analyzing: #{klass.name}"
+          klass.new.analyze
+        end
+      end
+    end
+  end
+end

data/lib/laborantin/runner/commands/cleanup.rb

@@ -0,0 +1,40 @@
+#runner/commands/cleanup.rb
+
+=begin
+
+This file is part of Laborantin.
+
+Laborantin is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Laborantin 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Laborantin.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright (c) 2009, Lucas Di Cioccio
+
+=end
+
+module Laborantin
+  module Commands
+    class Cleanup < Command
+      plumbery!
+      describe "Removes the result directories of the environments without scenarios"
+      execute do
+        results = Laborantin::Commands::LoadResults.new.run([],opts)
+        results[:envs].each do |env|
+          scii = env.populate
+          if scii.empty?
+            FileUtils.rm_rf(env.rundir, :verbose => true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/laborantin/runner/commands/complete.rb

@@ -0,0 +1,111 @@
+
+#$DEBUG = true
+
+module Laborantin
+  module Commands
+    class Complete < Laborantin::Command
+      describe "completes a command line"
+      plumbery!
+
+      def maps_to_a_klass?(cmd)
+        runner.command_for_argv(cmd.split(' '))
+      end
+
+      def list_mapping_klasses(str)
+        #separate the case for modules
+        # labor config <tab>
+        # should propose config set|foo
+        if str == 'labor'
+          Command.reject(&:plumbery?).map{|cmd| runner.argv_klass_name(cmd).first}
+        else
+          size = str.split.size
+          cmds = Command.reject{|cmd| cmd.plumbery?}.map do |cmd|
+            runner.argv_klass_name(cmd).slice(0, size)
+          end
+
+          match = cmds.find do |cmd|
+            cmd.join(' ') == str
+          end
+
+          if match
+            cmds = Command.reject{|cmd| cmd.plumbery?}.map do |cmd|
+              runner.argv_klass_name(cmd).slice(0, size+1)
+            end
+          end
+
+          cmds.select do |cmd|
+            tst = cmd.join(' ').start_with?(str) 
+            STDERR.puts "#{cmd} | #{str} | #{tst}" if $DEBUG
+            tst 
+          end.map do |cmd|
+            cmd.last
+          end
+        end
+      end
+
+      def complete_option(opt, cmd)
+        opt.completion_block.call(cmd) if opt.completion_block
+      end
+
+      def list_long_option(klass, cmd)
+        # in the options of the command look for the one with long
+        opt = klass.options.find{|o| o.cli_long == cmd.split.last}
+
+        if opt 
+          complete_option(opt,cmd)
+        else
+        end
+      end
+
+      def list_short_option(klass, cmd)
+        # in the options of the command look for the one with long
+        opt = klass.options.find{|o| o.cli_short == cmd.split.last}
+        if opt 
+          complete_option(opt,cmd)
+        else
+          if cmd.split[-2].start_with?('-')
+            opt = klass.options.find{|o| o.cli_short == cmd.split[-2]}
+            complete_option(opt,cmd) if opt
+          else
+            klass.options.map(&:cli_short).select{|w|
+              w.start_with?(cmd)
+            }
+          end
+        end
+      end
+
+      def list_argv_and_options_line(klass, cmd)
+        klass.completion_block.call(cmd) if klass.completion_block
+      end
+
+      execute do |me|
+        STDERR.puts me.args if $DEBUG
+        cmd = STDIN.read.chomp
+        arg = me.args
+        cmd = cmd.sub(/^labor\s+/,'')
+
+        klass = maps_to_a_klass?(cmd)
+        list = if klass
+                 if cmd.split.last.start_with?('--')
+                   list_long_option(klass, cmd)
+                 elsif cmd.split.last.start_with?('-')
+                   list_short_option(klass, cmd)
+                 elsif cmd.split[-2] and cmd.split[-2].start_with?('--')
+                   list_long_option(klass, cmd)
+                 elsif cmd.split[-2] and cmd.split[-2].start_with?('-')
+                   list_short_option(klass, cmd)
+                 else
+                   list_argv_and_options_line(klass, cmd)
+                 end
+               else
+                 # complete finding a class
+                 list_mapping_klasses(cmd)
+               end
+
+        list ||= []
+
+        puts list.compact.uniq.join("\n")
+      end
+    end
+  end
+end

data/lib/laborantin/runner/commands/config.rb

@@ -0,0 +1,169 @@
+
+module Laborantin::Commands
+  module Config
+
+    class ConfigError < StandardError ; end 
+
+    class PathError < ConfigError ; end 
+
+    class RootNotHashError < PathError
+      def initialize
+        super "The root node of the config must be a Hash"
+      end
+    end
+
+    class PathNotHashError < PathError
+      def initialize(path)
+        super "There already is a non-hash value at: '#{path}'."
+      end
+    end
+
+    # Stores the runner configuration into the configuration file.
+    def save_config
+      raise RootNotHashError unless runner.config.is_a? Hash
+      File.open(runner.config_path, 'w') do |f|
+        f.puts YAML.dump(runner.config)
+      end
+    end
+
+    # Interprets a string provided path as an array of symbols (the nodes of the config tree).
+    def interpret_path(path)
+      path.split(':').map{|i| i.to_sym}
+    end
+
+    # Interprets a string provided value into a ruby object.
+    # * if val is 'true' then the true object of class TrueClass
+    # * if val is 'false' then the false object of class FalseClass * if val is
+    # a string that can be read like a decimal, it's a decimal (Fixnum or
+    # Bignum), unlike in ruby interpreter 1_000 is not valid for 1000, see
+    # source for details * otherwise the string val itself
+    def interpret_value(val)
+      case val
+      when 'true'
+        true
+      when 'false'
+        false
+      when val.to_i.to_s == val
+        val.to_i
+      else
+        val
+      end
+    end
+
+    # Given a path made of an array of nodes (i.e., symbols to respect the syntax).
+    # Returns the object corresponding to this node in the configuration tree.
+    # Returns nil if there is no such object.
+    # If path is empty, simply returns the root node (i.e., the runner's config).
+    def get_node(path)
+      tree = runner.config
+      return tree if path.empty? #easy solution
+      path = path.clone
+      while (node = path.shift)
+        if tree.is_a? Hash
+          if path.empty? #terminal node
+            return tree[node]
+          else 
+            tree = tree[node]
+          end
+        else #error
+          return nil
+        end
+      end
+    end
+
+    # Creates a path structure in the runner's config.
+    # If there already a non-hash node, will raise an error.
+    def build_path(path_arg)
+      path = path_arg.clone
+      tree = runner.config
+      while (node = path.shift)
+        case tree[node]
+        when Hash
+          tree = tree[node]
+        when NilClass
+          tree[node] = Hash.new
+          tree = tree[node]
+        else
+          raise PathNotHashError.new(orig.join(':'))
+        end
+      end
+    end
+
+    class Get < Laborantin::Command
+      include Config
+      describe "Show a configuration tree"
+      option(:path) do
+        describe "a column separated path of the config"
+        short '-p'
+        long '--path=OPTIONAL'
+        type String
+        default ''
+      end
+      execute do
+        path = interpret_path(opts[:path])
+        p get_node(path)
+      end
+    end
+
+    class Set < Laborantin::Command
+      include Config
+      describe "Set a configuration node"
+      option(:path) do
+        describe "a column separated path of the config"
+        short '-p'
+        long '--path=MANDATORY'
+        type String
+        default ''
+      end
+      option(:value) do
+        describe "the value to set the node to, interprets true, false, decimal integers, or string"
+        short '-v'
+        long '--value=MANDATORY'
+        type String
+        default ''
+      end
+      execute do
+        path = interpret_path(opts[:path])
+        value = interpret_value(opts[:value])
+        if path.empty?
+          puts "--path= should not be empty"
+        end
+        if value.is_a? String and value.empty?
+          puts "--value= should not be empty"
+        end
+
+        node = path.pop
+        begin
+          build_path(path)
+        rescue PathError => err
+          puts err
+          exit
+        end
+        get_node(path)[node] = value
+        save_config
+      end
+    end
+
+    class Del < Laborantin::Command
+      include Config
+      describe "Deletes a node from the configuration tree."
+      option(:path) do
+        describe "a column separated path"
+        short '-p'
+        long '--path=MANDATORY'
+        type String
+        default ''
+      end
+      execute do
+        path = interpret_path(opts[:path])
+        if path.empty?
+          puts "Cannot delete empty path, if you really want, remove #{runner.config_path}"
+        end
+        node = path.pop
+        tree = get_node(path)
+        tree.delete(node)
+        save_config
+      end
+    end
+  end
+end

data/lib/laborantin/runner/commands/create.rb

@@ -0,0 +1,61 @@
+#runner/commands/create.rb
+
+=begin
+
+This file is part of Laborantin.
+
+Laborantin is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Laborantin 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Laborantin.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright (c) 2009, Lucas Di Cioccio
+
+=end
+
+require	'fileutils'
+require 'find'
+require 'erb'
+
+module Laborantin
+  module Commands
+    class Create < Command
+      describe "prepares a directory structure for Laborantin"
+
+      option(:force) do
+        describe 'force overwrite, use with care'
+        short '-f'
+        long '--force'
+        default false
+      end
+
+      execute do
+        #Build Tree Structure
+        dirs_to_build = []
+
+        rootdir = File.join('.', (args.first) || '')
+
+        dirs_to_build << rootdir
+
+        %w{analyses commands lib config environments reports results scripts scenarii}.each do |dirname|
+          dirs_to_build << File.join(rootdir, dirname)
+        end
+
+        dirs_to_build.each do |path|
+          FileUtils::Verbose.mkdir_p(path)
+        end
+
+        #TODO: create a README, a NOTEBOOK
+      end
+    end
+  end
+end
+

data/lib/laborantin/runner/commands/describe.rb

@@ -0,0 +1,215 @@
+#runner/commands/describe.rb
+
+=begin
+
+This file is part of Laborantin.
+
+Laborantin is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Laborantin 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Laborantin.  If not, see <http://www.gnu.org/licenses/>.
+
+Copyright (c) 2009, Lucas Di Cioccio
+
+=end
+
+autoload :ERB, 'erb'
+module Laborantin
+  module Commands
+    class Describe < Command
+      describe "Gives a summary of what the current Laborantin project is"
+
+
+      option(:scenarii) do
+        describe "comma separated list of scenarios to describe"
+        short "-s"
+        long "--scenarii=OPTIONAL"
+        type Array
+        default []
+        complete do |cmd|
+          completion_propositions_iterating_on(cmd, Laborantin::Scenario.all.map(&:cli_name))
+        end
+      end
+
+      option(:environments) do
+        describe "comma separated list of environments to describe"
+        short "-e"
+        long "--envs=OPTIONAL"
+        type Array
+        default []
+        complete do |cmd|
+          completion_propositions_iterating_on(cmd, Laborantin::Environment.all.map(&:cli_name))
+        end
+      end
+
+      option(:analyses) do
+        describe "comma separated list of analyses to describe"
+        short "-a"
+        long "--analyses=OPTIONAL"
+        type Array
+        default []
+        complete do |cmd|
+          completion_propositions_iterating_on(cmd, Laborantin::Analysis.all.map(&:cli_name))
+        end
+      end
+
+      option(:output) do
+        describe "print in a file instead of STDOUT"
+        short '-o'
+        long '--output=OPTIONAL'
+        type String
+        default ''
+      end
+
+      FORMATS = ['default', 'txt', 'html']
+
+      option(:format) do
+        describe "format the output in a certain form, among: [#{FORMATS.join(', ')}]"
+        short '-f'
+        long '--format=OPTIONAL'
+        type String
+        default 'default'
+      end
+
+      def stdout?
+        opts[:output].empty?
+      end
+
+      def out
+        @out ||= if stdout?
+                   self #self.puts forward to the runner 
+                 else
+                   File.open(opts[:output], 'w')
+                 end
+      end
+
+      def close_out
+        @out.close unless stdout?
+      end
+
+      def environments
+        Environment.all
+      end
+
+      def scenarii
+        Scenario.all
+      end
+
+      def analyses
+        Analysis.all
+      end
+
+
+      HTML_TPL = <<ERB
+<html>
+<head>
+</head>
+<body>
+  <h1>Laborantin's description</h1>
+  <p>Project located at: <%= runner.root_dir %> </p>
+  <h2>List of environments</h2>
+  <ul>
+  <% Environment.all.each do |env| %>
+    <li><%= env.name %>
+    (<%= env.description %>)
+    </li>
+  <% end %>
+  </ul>
+  <h2>List of scenarios</h2>
+  <ul>
+  <% Scenario.all.each do |sc| %>
+    <li><%= sc.name %>
+    (<%= sc.description %>)
+      <ul>
+      <% sc.parameters.each_pair do |name, spec| %>
+        <li><%= name %></li>
+        <ul>
+          <li><%= spec.description %></li>
+          <li><%= spec.values.inspect %></li>
+        </ul>
+      <% end %>
+      </ul>
+    </li>
+  <% end %>
+  </ul>
+  <h2>List of analyses</h2>
+  <ul>
+  <% Analysis.all.each do |a| %>
+    <li><%= a.name %>
+    (<%= a.description %>)
+    <ul>
+    <% a.analyses.each do |hash| %>
+      <li>
+        <%= hash[:str] %>
+      </li>
+    <% end %>
+    </ul>
+    </li>
+  <% end %>
+  </ul>
+</body>
+</html>
+ERB
+
+    TXT_TPL = <<ERB
+Available environments:
+<% Environment.all.each do |env| %>
+  * <%= env.name %> (<%= env.description %>)
+<% end %>
+Available scenarios:
+<% Scenario.all.each do |sc| %>
+  * <%= sc.name %> (<%= sc.description %>)
+    <% sc.parameters.each_pair do |name, spec| %>
+    + <%= name %> (<%= spec.description %>) | <%= spec.values.inspect %>
+    <% end %>
+  <% end %>
+Available analyses:
+<% Analysis.all.each do |a| %>
+  * <%= a.name %> (<%= a.description %>)
+    <% a.analyses.each do |hash| %>
+    <% if hash[:params][:type] %>
+    + <%= hash[:str] %> (<%= hash[:params][:type] %>)
+    <% else %>
+    + <%= hash[:str] %> 
+    <% end %>
+    <% end %>
+<% end %>
+ERB
+
+      def html_format
+        ERB.new(HTML_TPL).result(binding)
+      end
+
+      def txt_format
+        ERB.new(TXT_TPL).result(binding).lines.reject{|l| l =~/^\s*$/}.join
+      end
+
+      alias :default_format :txt_format
+
+      def format_str
+        case opts[:format]
+        when 'html'
+          html_format
+        else
+          default_format
+        end
+      end
+
+      execute do
+        begin
+          out.puts format_str
+        ensure
+          close_out
+        end
+      end
+    end
+  end
+end