RubyGems - nutella_framework - Versions diffs - 0.2.1 → 0.3.0 - Mend

nutella_framework 0.2.1 → 0.3.0

Files changed (21) hide show

checksums.yaml +4 -4
data/Gemfile +1 -0
data/VERSION +1 -1
data/actors/main_interface/main_interface_bot.rb +17 -5
data/actors/main_interface/public/index.html +5 -1
data/data/index.html +21 -0
data/data/startup +13 -0
data/lib/core/commands/compile.rb +21 -0
data/lib/core/commands/dependencies.rb +21 -0
data/lib/core/commands/help.rb +9 -3
data/lib/core/commands/install.rb +2 -24
data/lib/core/commands/runs.rb +4 -4
data/lib/core/commands/start.rb +112 -32
data/lib/core/commands/stop.rb +16 -0
data/lib/core/commands/template.rb +132 -0
data/lib/core/run_command.rb +59 -5
data/lib/core/template_command.rb +46 -0
data/lib/core/tmux.rb +1 -1
data/nutella_framework.gemspec +14 -4
data/test/test_run_command.rb +54 -0
metadata +29 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fa6667c9ae02d2334bae79b81176c8297cb4d60
-  data.tar.gz: 8a7cbbb915d58d5a7c1de1e4010647a7ef618cd0
+  metadata.gz: 25372f33a5d356902733e9c5c56e632cf7d03f00
+  data.tar.gz: 615a93c90ef6cba3206ee4f10e819bd3179c58fe
 SHA512:
-  metadata.gz: 5fcc6cab7b5665c59329d0e5ed75265094ec763ad7ed20578411696424e90f89ad1a2be1bfffddcaa6366370c6b69109c0ceb381f094d651eb3841696e5f8e87
-  data.tar.gz: 42b82c3abefeb8145934b03729b4f93fdce1df48e0a325503c02bab44e04e8b914b0bf04cf1ce5bcbf72215d325292edc4459d65d6ebd38978d735fb2f77eb95
+  metadata.gz: 12dd8ec3456123428114c3c9b1c32eb611ff51c46346a7e1d2cb834ce76bc9fcbcd0efa3b65423c73fe2ba9f4359a2e58df056cd0454a1254a6368771e210495
+  data.tar.gz: 605229b6c2f71386d74b7930d23b80ab89e55e52d0eb35293348029c036923d71f196cf4c4bb60166d272607bed4cfa9c96a22d8d0fb5a3bb819603836e5a2a7

data/Gemfile CHANGED Viewed

@@ -6,6 +6,7 @@ gem 'logging', '~> 1.8', '>=1.8.2'
 gem 'git', '~> 1.2', '>=1.2.8'
 gem 'sinatra', '~>1.4.5', '>=1.4.5'
 gem 'nokogiri', '~>1.6.3', '>=1.6.3'
+gem 'slop', '~>4.0.0', '>=4.0.0'
 group :development do

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.2.1
1	+ 0.3.0

data/actors/main_interface/main_interface_bot.rb CHANGED Viewed

@@ -28,8 +28,14 @@ get '/' do
 end
+# Redirect if there is no slash after the run_id
+get '/:run_id' do
+  redirect "#{request.url}/"
+end
 # Renders the run template
-get '/:run_id/?' do
+get '/:run_id/' do
   # Parse the run_id from URL and extract the run path from runlist.json
   @run_id = params[:run_id]
@@ -53,6 +59,12 @@ get '/:run_id/?' do
 end
+# Redirect if there is a slash after the interface
+get '/:run_id/:interface/' do
+  redirect "#{request.url[0..-2]}"
+end
 # Serves the index.html file for each individual interface augmented with nutella query string parameters
 get '/:run_id/:interface' do
@@ -128,7 +140,7 @@ def extract_interface_info( interfaces_path, iface_dir )
   unless File.exist? index_path
     iface_props[:name] = iface_dir
-    iface_props[:description] = 'My designer was a lazy ass and didn\'t include an index.html file in the main interface directory'
+    iface_props[:description] = 'My designer was a bit lazy and didn\'t include an index.html file in the main interface directory :('
     return iface_props
   end
@@ -138,14 +150,14 @@ def extract_interface_info( interfaces_path, iface_dir )
   f.close
   iface_props[:name] = doc.css('title').empty? ? iface_dir : doc.css('title').text
   if doc.css("meta[name='description']").empty?
-    iface_props[:description] = 'My designer was a lazy ass and didn\'t include a &lt;meta name="description" content="Description of this interface"&gt; tag in the index.html file'
+    iface_props[:description] = 'My designer was a bit lazy and didn\'t include a &lt;meta name="description" content="Description of this interface"&gt; tag in the index.html file :('
   else
     if doc.css("meta[name='description']").attribute('content').nil?
-      iface_props[:description] = 'There was no attribute content in &lt;meta name="description" content="Description of this interface"&gt; tag in the index.html file'
+      iface_props[:description] = 'There was no attribute content in &lt;meta name="description" content="Description of this interface"&gt; tag in the index.html file :('
     else
       iface_props[:description] = doc.css("meta[name='description']").attribute('content').text
     end
   end
-  iface_props[:url] = "#{@run_id}/#{iface_dir}"
+  iface_props[:url] = "#{iface_dir}"
   iface_props
 end

data/actors/main_interface/public/index.html CHANGED Viewed

@@ -40,7 +40,11 @@
         <script>
 					el = document.getElementById('run_id_input');
 					el.addEventListener('change', function() {
-						window.location = '/' + this.value
+						url = location.href
+						if (url.substr(url.length - 1)=="/")
+							window.location = url + this.value + '/';
+						else
+							window.location = url + '/' + this.value + '/';
 					});
         </script>
     </body>

data/data/index.html ADDED Viewed

@@ -0,0 +1,21 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <!-- Your interface name here-->
+    <title></title>
+    <!-- The description of this interfaces here -->
+    <meta name="description" content="">
+    <!-- Your CSS here -->
+</head>
+<body>
+<!-- Your markup here -->
+<!-- Your scripts here -->
+</body>
+</html>

data/data/startup ADDED Viewed

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Extract the path of the current directory.
+# From now on you can refer to any file in the bot directory as:
+# $BASEDIR/<my_file>
+BASEDIR=$(dirname $0)
+# Remember that nutella passes the run_id and the broker name as
+# command line parameters that you can access via $1 and $2 respectively.
+# Start your bot here with something like (example in ruby):
+# ruby $BASEDIR/my_bot.rb $1 $2

data/lib/core/commands/compile.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'core/run_command'
+require 'core/tmux'
+module Nutella
+  class Compile < RunCommand
+    @description = 'Compiles all the actors that need compilation in the project'
+    def run(args=nil)
+      # If the current directory is not a nutella project, return
+      return unless Nutella.current_project.exist?
+      # Compile all actors
+      return unless prepare_bot( Nutella.current_project.dir, 'compile', 'Compiling' )
+      # Output success message
+      console.success "All actors compiled for #{Nutella.current_project.config['name']}"
+    end
+  end
+end

data/lib/core/commands/dependencies.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'core/run_command'
+require 'core/tmux'
+module Nutella
+  class Dependencies < RunCommand
+    @description = 'Installs the dependencies for all actors in the project'
+    def run(args=nil)
+      # If the current directory is not a nutella project, return
+      return unless Nutella.current_project.exist?
+      # Install all dependencies
+      return unless prepare_bot( Nutella.current_project.dir, 'dependencies', 'Installing dependencies for' )
+      # Output success message
+      console.success "All dependencies installed for #{Nutella.current_project.config['name']}"
+    end
+  end
+end

data/lib/core/commands/help.rb CHANGED Viewed

@@ -8,11 +8,17 @@ module Nutella
     def run(args=nil)
       message=''
       Dir["#{File.dirname(__FILE__)}/*.rb"].each do |file|
-        message += "#{File.basename(file, File.extname(file))}\t\t"
-        message += Object::const_get("Nutella::#{File.basename(file, File.extname(file)).capitalize}").description
+        command = File.basename(file, File.extname(file))
+        if command.length > 7
+          message += "#{command}\t"
+        else
+          message += "#{command}\t\t"
+        end
+        message += Object::const_get("Nutella::#{command.capitalize}").description
         message += "\n"
       end
-      console.info message, 200
+      console.info message
+      console.info 'For more details on individual commands, see https://github.com/nutella-framework/nutella_framework/wiki/Nutella-Command-Line-Interface'
     end
   end

data/lib/core/commands/install.rb CHANGED Viewed

@@ -1,11 +1,10 @@
-require 'core/command'
-require 'json'
+require 'core/template_command'
 require 'git'
 require 'net/http'
 module Nutella
-  class Install < Command
+  class Install < TemplateCommand
     @description = 'Copies an arbitrary template (from central DB, directory or URL) into the current project'
     def run(args=nil)
@@ -118,27 +117,6 @@ module Nutella
       Dir.mkdir Nutella.config['tmp_dir']  unless Dir.exists? Nutella.config['tmp_dir']
       Git.clone(template, dest_dir, :path => Nutella.config['tmp_dir'])
     end
-    def validate_template( dir )
-      # Parse the template's nutella.json file
-      begin
-        template_nutella_file_json = JSON.parse(IO.read("#{dir}/nutella.json"))
-      rescue
-        return false
-      end
-      # If template is a bot, perform the appropriate checks
-      if template_nutella_file_json['type']=='bot'
-        # Is there a mandatory 'startup' script and is it executable
-        return false unless File.executable? "#{dir}/startup"
-      end
-      # If template is an interface, perform the appropriate checks
-      if template_nutella_file_json['type']=='interface'
-        # Is there the mandatory index.html file
-        return false unless File.exist? "#{dir}/index.html"
-      end
-      true
-    end
     def extract_remote_repo_url( template_name )

data/lib/core/commands/runs.rb CHANGED Viewed

@@ -8,7 +8,7 @@ module Nutella
     def run(args=nil)
       # If invoked with "all" it will show all the runs under this instance of nutella
-      if args[0]=='all'
+      if args[0]=='--all' || args[0]=='-a'
         display_all_runs
       else
         # If current dir is not a nutella project, return
@@ -38,10 +38,10 @@ module Nutella
       runs.each do |run|
         run_id = run.dup
         run_id.slice! "#{project_name}_"
-        if run_id.empty?
-          console.info " #{project_name}"
+        if run==project_name
+          console.info " #{project_name} (default instance)"
         else
-          console.info " #{run}"
+          console.info " #{run_id}"
         end
       end
     end

data/lib/core/commands/start.rb CHANGED Viewed

@@ -12,9 +12,37 @@ module Nutella
       # Extract run (passed run name) and run_id
       run, run_id = extract_names args
-      # Extract project directory and run_id
+      # Check that the run name is different than the project name
+      if run==Nutella.current_project.config['name']
+        console.warn 'Your run name should be different than your project name'
+        return
+      end
+      # Extract parameters
+      begin
+        params = extract_parameters args
+      rescue
+        console.warn 'The only supported parameters are --with (-w) and --without (-wo)'
+        return
+      end
+      # Check that we are not using 'with' and 'without' options at the same time
+      unless params[:with].empty? || params[:without].empty?
+        console.warn 'You can\'t use both --with and --without at the same time'
+        return
+      end
+      # Extract project directory
       cur_prj_dir = Nutella.current_project.dir
+      # Check that there is at least a regular bot that will be started,
+      # otherwise it makes no sense to create a run
+      if run_bots_list_minus_project_bots(cur_prj_dir, params).empty? && project_bots_started?
+        console.warn "Run #{run} not created: your project bots are already started and you specified no regular bots exclusively for this run"
+        return
+      end
       # Check that the run_id is unique and add it to the list of runs
       # If it's not, return (without adding the run_id to the list of course)
       return unless add_to_run_list( run_id, cur_prj_dir )
@@ -27,24 +55,49 @@ module Nutella
       # Start all nutella internal actors, if needed
       return unless start_nutella_actors
-      # Install dependencies, compile and start all bots
-      return unless prepare_bot( cur_prj_dir, 'dependencies', 'Installing dependencies for' )
-      return unless prepare_bot( cur_prj_dir, 'compile', 'Compiling' )
-      return unless start_bots( cur_prj_dir, run_id )
+      # Start all project level actors, if any
+      return unless start_project_bots cur_prj_dir
+      # Start all bots
+      return unless start_bots( cur_prj_dir, run_id, params )
       # Output success message
       output_success_message( run_id, run, 'started' )
-      output_monitoring_details run_id
+      output_monitoring_details( run_id, cur_prj_dir, params)
     end
     private
+    def run_bots_list_minus_project_bots( cur_prj_dir, params )
+      # Fetch the list of project bots
+      project_bots_list = Nutella.current_project.config['project_bots']
+      run_bots_list = run_actors_list("#{cur_prj_dir}/bots/")
+      # Depending on the mode we are in we want to start only some bots, exclude only some bots, start all bots
+      unless params[:with].empty?
+        return project_bots_list.nil? ? params[:with] : params[:with] - project_bots_list
+      end
+      unless params[:without].empty?
+        return project_bots_list.nil? ? run_bots_list - params[:without] : run_bots_list - params[:without] - project_bots_list
+      end
+      if params[:with].empty? && params[:without].empty?
+        return project_bots_list.nil? ? run_bots_list : run_bots_list - project_bots_list
+      end
+    end
+    def project_bots_started?
+      project_name = Nutella.current_project.config['name']
+      tmux_session_name = "#{project_name}-project-bots"
+      return Tmux.session_exist? tmux_session_name
+    end
     def add_to_run_list(run_id, prj_dir)
       unless Nutella.runlist.add?( run_id, prj_dir )
         # If the run_id is already in the list, check that it's actually live
-        if Tmux.session_exists? run_id
+        if Tmux.session_exist? run_id
           console.error 'Impossible to start project: an instance of this project with the same run_id is already running!'
           console.error "You might want to kill it with 'nutella stop #{run_id}'"
           return false
@@ -126,6 +179,7 @@ module Nutella
       true
     end
     def start_nutella_actor( actor_dir )
       pid_file_path = "#{actor_dir}/.pid"
       return true if sanitize_pid_file pid_file_path
@@ -145,43 +199,69 @@ module Nutella
     end
-    def prepare_bot( cur_prj_dir, script, message )
-      for_each_actor_in_dir cur_prj_dir do |bot|
-        # Skip bot if there is no '' script
-        next unless File.exist? "#{cur_prj_dir}/bots/#{bot}/#{script}"
-        # Output message
-        console.info "#{message} bot #{bot}."
-        # Execute 'dependencies' script
-        cur_dir = Dir.pwd
-        Dir.chdir "#{cur_prj_dir}/bots/#{bot}"
-        system "./#{script}"
-        Dir.chdir cur_dir
+    def start_project_bots( cur_prj_dir )
+      project_bots_list = Nutella.current_project.config['project_bots']
+      project_name = Nutella.current_project.config['name']
+      tmux_session_name = "#{project_name}-project-bots"
+      bots_dir = "#{cur_prj_dir}/bots/"
+      # If project bots have been started already, then do nothing
+      unless Tmux.session_exist? tmux_session_name
+        # Start all project bots in the list into a new tmux session
+        tmux = Tmux.new tmux_session_name
+        for_each_actor_in_dir bots_dir do |bot|
+          unless project_bots_list.nil? || !project_bots_list.include?( bot )
+            # If there is no 'startup' script output a warning (because
+            # startup is mandatory) and skip the bot
+            unless File.exist?("#{bots_dir}#{bot}/startup")
+              console.warn "Impossible to start bot #{bot}. Couldn't locate 'startup' script."
+              next
+            end
+            # Create a new window in the session for this run
+            tmux.new_bot_window bot
+          end
+        end
       end
       true
     end
-    def start_bots( cur_prj_dir, run_id )
-      bots_dir = "#{cur_prj_dir}/bots/"
+    def start_bots( cur_prj_dir, run_id, params )
       # Create a new tmux instance for this run
       tmux = Tmux.new run_id
-      for_each_actor_in_dir bots_dir do |bot|
-        # If there is no 'startup' script output a warning (because
-        # startup is mandatory) and skip the bot
-        unless File.exist?("#{bots_dir}#{bot}/startup")
-          console.warn "Impossible to start bot #{bot}. Couldn't locate 'startup' script."
-          next
-        end
-        # Create a new window in the session for this run
-        tmux.new_bot_window bot
-      end
+      # Fetch bots dir
+      bots_dir = "#{cur_prj_dir}/bots/"
+      # Start the appropriate bots
+      run_bots_list_minus_project_bots( cur_prj_dir, params ).each { |bot| start_bot(bots_dir, bot, tmux) }
       true
     end
-    def output_monitoring_details( run_id )
-      console.success "Do `tmux attach-session -t #{run_id}` to monitor your bots."
+    def start_bot( bots_dir, bot, tmux )
+      # If there is no 'startup' script output a warning (because
+      # startup is mandatory) and skip the bot
+      unless File.exist?("#{bots_dir}#{bot}/startup")
+        console.warn "Impossible to start bot #{bot}. Couldn't locate 'startup' script."
+        return
+      end
+      # Create a new window in the session for this run
+      tmux.new_bot_window bot
+    end
+    def output_monitoring_details( run_id, cur_prj_dir, params )
+      project_bots_list = Nutella.current_project.config['project_bots']
+      project_name = Nutella.current_project.config['name']
+      tmux_session_name = "#{project_name}-project-bots"
+      unless project_bots_list.nil? || project_bots_list.empty?
+        console.success "Do `tmux attach-session -t #{tmux_session_name}` to monitor your project bots."
+      end
+      if run_bots_list_minus_project_bots(cur_prj_dir, params).empty?
+        console.success 'No tmux session was created for this run because you specified no regular bots exclusively for this run'
+      else
+        console.success "Do `tmux attach-session -t #{run_id}` to monitor your bots."
+      end
       console.success "Go to http://localhost:#{Nutella.config['main_interface_port']}/#{run_id} to access your interfaces"
     end

data/lib/core/commands/stop.rb CHANGED Viewed

@@ -20,6 +20,9 @@ module Nutella
       # Stops all the bots
       Tmux.kill_session run_id
+      # Stop all project level actors (if any) if needed
+      stop_project_bots
       # Stop all nutella internal actors, if needed
       if Nutella.runlist.empty?
         stop_nutella_actors
@@ -47,6 +50,19 @@ module Nutella
     end
+    def stop_project_bots
+      project_name = Nutella.current_project.config['name']
+      tmux_session_name = "#{project_name}-project-bots"
+      if Tmux.session_exist? tmux_session_name
+        # Are there any runs of this project hinging on the project bots?
+        if Nutella.runlist.runs_by_project(project_name).empty?
+          Tmux.kill_session tmux_session_name
+        end
+      end
+      true
+    end
     def stop_nutella_actors
       nutella_actors_dir = "#{Nutella.config['nutella_home']}actors"
       for_each_actor_in_dir nutella_actors_dir do |actor|

data/lib/core/commands/template.rb ADDED Viewed

@@ -0,0 +1,132 @@
+require 'core/template_command'
+module Nutella
+  class Template < TemplateCommand
+    @description = 'Helps create and validate templates'
+    def run(args=nil)
+      # If no argument then we just display info about the command
+      if args==nil || args.length < 2
+        display_help
+        return
+      end
+      # Extract sub command
+      sub_command = args[0]
+      param = args[1]
+      if sub_command == 'validate'
+        validate_template_sub_command param
+      end
+      if sub_command == 'create'
+        create_template_sub_command param
+      end
+    end
+    private
+    def display_help
+      console.info 'You need to specify a sub command.'
+      console.info 'create <template_name>    creates a template skeleton in the folder with the same name'
+      console.info 'validate  <temple_dir>    validates a template that already exists'
+    end
+    def validate_template_sub_command( dir )
+      if validate_template dir
+        console.success 'This directory appears to be a valid nutella template'
+      else
+        console.warn 'Looks like this directory is not a valid nutella template'
+      end
+    end
+    def create_template_sub_command( name_d )
+      ver_d = '0.1.0'
+      type_d = 'bot'
+      # Name
+      puts 'What is the name of your template?'
+      print "(#{name_d}) "
+      c = $stdin.gets.chomp!
+      name = c.empty? ? name_d : c
+      # Version
+      puts 'What is the version of your template?'
+      print "(#{ver_d}) "
+      c = $stdin.gets.chomp!
+      version = c.empty? ? ver_d : c
+      # Type
+      puts 'Are you creating a template for a "bot" or "interface"?'
+      print "(#{type_d}) "
+      c = $stdin.gets.chomp!
+      type = c.empty? ? type_d : c
+      # Description
+      puts "Do you want to provide a short description for your #{type} template?"
+      print '(optional, hit enter if no description) '
+      description = $stdin.gets.chomp!
+      # Repo
+      puts 'Do you want to provide a git repository for your template?'
+      print '(optional, hit enter if no repo) '
+      repo = $stdin.gets.chomp!
+      # Build JSON and show confirmation
+      puts 'Looks good?'
+      json = build_nutella_json( name, version, type, description, repo )
+      puts JSON.pretty_generate json
+      print '(yes/no) '
+      # If user confirms, create template
+      confirm = $stdin.gets.chomp!
+      if confirm=='yes'
+        create_template_files json
+      else
+        console.warn 'Template creation aborted'
+      end
+    end
+    def create_template_files( json )
+      # First validate the JSON
+      unless validate_nutella_file_json json
+        console.error 'Something was wrong with your nutella.json file. Template creation aborted'
+        return
+      end
+      # Assemble destination directory
+      template_dir = File.join( Dir.pwd, json['name'] )
+      # Check that the directory doesn't exist already
+      if File.directory?(template_dir)
+        console.error("The directory #{template_dir} already exists! Can't create template #{json[:name]}")
+        return
+      end
+      # Create directory
+      Dir.mkdir template_dir
+      # Create nutella.json file
+      File.open("#{template_dir}/nutella.json", 'w') { |f| f.write(JSON.pretty_generate json) }
+      # Add bot/interface specific files
+      bot_specific_file = nil
+      bot_specific_file = File.join( Nutella.config['nutella_home'], 'data/startup' ) if json['type']=='bot'
+      bot_specific_file = File.join( Nutella.config['nutella_home'], 'data/index.html' ) if json['type']=='interface'
+      FileUtils.copy( bot_specific_file, template_dir )
+      console.success "Template #{json['name']} created successfully!"
+    end
+    def build_nutella_json( name, version, type, description, repo )
+      json = { 'name' => name, 'version' => version, 'type' => type}
+      unless description.empty?
+        json['description'] = description
+      end
+      unless repo.empty?
+        json['repo'] = repo
+      end
+      json
+    end
+  end
+end

data/lib/core/run_command.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'core/command'
+require 'slop'
 module Nutella
   # This class describes a run command which can be either start or stop.
@@ -9,22 +10,59 @@ module Nutella
       console.error 'Running generic RunCommand!!! WAT?'
     end
     # Extracts run name and run_id
     # @param [Array<String>] args command line arguments passed to the command
     # @return [String, String ]  the run name (cleaned of nils) and the run_id
     def extract_names( args )
-      # Check that the run name passed as parameter is not nil
-      run = args.nil? ? nil : args[0]
-      # Extract run_id
-      run_id = args.nil? ? Nutella.runlist.extract_run_id( '' ) : Nutella.runlist.extract_run_id( args[0] )
+      # Simple `nutella start/stop`
+      if args.nil? || args.empty?
+        run = nil
+        run_id = Nutella.runlist.extract_run_id( '' )
+        return run, run_id
+      end
+      # Check if the first argument is a parameter or a run name
+      if args[0].start_with? '-'
+        run = nil
+        run_id = Nutella.runlist.extract_run_id( '' )
+      else
+        # If it's a run name, store the run name and shift so we are left with only
+        # the parameters in args
+        run = args[0]
+        run_id = Nutella.runlist.extract_run_id( args[0] )
+        args.shift
+      end
       return run, run_id
     end
+    # Extracts the command line parameters
+    # @param [Array<String>] args command line arguments passed to the command
+    # @return [Hash]  an hash containing the parameters
+    def extract_parameters( args )
+      opts = Slop::Options.new
+      opts.array '-wo', '--without', 'A list of actors NOT to start'
+      opts.array '-w', '--with', 'A list of actors that needs to be started'
+      parser = Slop::Parser.new(opts)
+      result = parser.parse(args)
+      result.to_hash
+    end
+    # Returns all the actors in a certain directory
+    def run_actors_list( actors_dir )
+      Dir.entries(actors_dir).select {|entry| File.directory?(File.join(actors_dir, entry)) && !(entry =='.' || entry == '..') }
+    end
     # Executes a code block for each actor in a certain directory
     # @param [String] actors_dir directory where we are iterating
     # @yield [actor_dir] Gives the actor directory to the block
     def for_each_actor_in_dir( actors_dir, &block )
-      Dir.entries(actors_dir).select {|entry| File.directory?(File.join(actors_dir, entry)) && !(entry =='.' || entry == '..') }.each do |actor_dir|
+      run_actors_list(actors_dir).each do |actor_dir|
         block.call actor_dir
       end
     end
@@ -37,6 +75,22 @@ module Nutella
         console.success "Project #{Nutella.current_project.config['name']}, run #{run} #{action}!"
       end
     end
+    def prepare_bot( cur_prj_dir, script, message )
+      for_each_actor_in_dir cur_prj_dir do |bot|
+        # Skip bot if there is no script
+        next unless File.exist? "#{cur_prj_dir}/bots/#{bot}/#{script}"
+        # Output message
+        console.info "#{message} bot #{bot}."
+        # Execute 'script' script
+        cur_dir = Dir.pwd
+        Dir.chdir "#{cur_prj_dir}/bots/#{bot}"
+        system "./#{script}"
+        Dir.chdir cur_dir
+      end
+      true
+    end
   end

data/lib/core/template_command.rb ADDED Viewed

@@ -0,0 +1,46 @@
+require 'core/command'
+require 'json'
+module Nutella
+  # This class describes a template command which can be either install or template
+  # It is mostly a commodity class for code reuse.
+  class TemplateCommand < Command
+    def run (args=nil)
+      console.error 'Running generic TemplateCommand!!! WAT?'
+    end
+    # Validates a template in a certain folder
+    # @param [String]  dir the directory where the template is stored
+    def validate_template( dir )
+      # Parse and validate the template's nutella.json file
+      begin
+        template_nutella_file_json = JSON.parse(IO.read("#{dir}/nutella.json"))
+      rescue
+        return false
+      end
+      return false unless validate_nutella_file_json template_nutella_file_json
+      # If template is a bot, perform the appropriate checks
+      if template_nutella_file_json['type']=='bot'
+        # Is there a mandatory 'startup' script and is it executable
+        return false unless File.executable? "#{dir}/startup"
+      end
+      # If template is an interface, perform the appropriate checks
+      if template_nutella_file_json['type']=='interface'
+        # Is there the mandatory index.html file
+        return false unless File.exist? "#{dir}/index.html"
+      end
+      true
+    end
+    def validate_nutella_file_json( json )
+      !json['name'].nil? && !json['version'].nil? && !json['type'].nil? && (json['type']=='bot' || json['type']=='interface')
+    end
+  end
+end

data/lib/core/tmux.rb CHANGED Viewed

@@ -29,7 +29,7 @@ module Nutella
       `tmux kill-session -t #{run_id} &> /dev/null`
     end
-    def self.session_exists?( run_id )
+    def self.session_exist?( run_id )
       system( "tmux has-session -t #{run_id} &> /dev/null" )
     end

data/nutella_framework.gemspec CHANGED Viewed

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: nutella_framework 0.2.1 ruby lib
+# stub: nutella_framework 0.3.0 ruby lib
 Gem::Specification.new do |s|
   s.name = "nutella_framework"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Alessandro Gnoli"]
-  s.date = "2015-01-20"
+  s.date = "2015-01-29"
   s.description = "Nutella is a framework to build and run \"Internet of Things\"-like learning applications"
   s.email = "tebemis@gmail.com"
   s.executables = ["nutella"]
@@ -33,6 +33,8 @@ Gem::Specification.new do |s|
     "actors/main_interface/views/index.erb",
     "actors/main_interface/views/not_found_404.erb",
     "bin/nutella",
+    "data/index.html",
+    "data/startup",
     "lib/cli/nutella_cli.rb",
     "lib/config/config.rb",
     "lib/config/current_project.rb",
@@ -41,14 +43,18 @@ Gem::Specification.new do |s|
     "lib/core/command.rb",
     "lib/core/commands/broker.rb",
     "lib/core/commands/checkup.rb",
+    "lib/core/commands/compile.rb",
+    "lib/core/commands/dependencies.rb",
     "lib/core/commands/help.rb",
     "lib/core/commands/install.rb",
     "lib/core/commands/new.rb",
     "lib/core/commands/runs.rb",
     "lib/core/commands/start.rb",
     "lib/core/commands/stop.rb",
+    "lib/core/commands/template.rb",
     "lib/core/nutella_core.rb",
     "lib/core/run_command.rb",
+    "lib/core/template_command.rb",
     "lib/core/tmux.rb",
     "lib/logging/nutella_logger-remote.rb",
     "lib/logging/nutella_logger.rb",
@@ -59,7 +65,8 @@ Gem::Specification.new do |s|
     "test/config/test_project.rb",
     "test/config/test_runlist.rb",
     "test/helper.rb",
-    "test/logging/test_logging.rb"
+    "test/logging/test_logging.rb",
+    "test/test_run_command.rb"
   ]
   s.homepage = "https://github.com/nutella-framework/nutella_framework"
   s.licenses = ["MIT"]
@@ -76,6 +83,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
       s.add_runtime_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
+      s.add_runtime_dependency(%q<slop>, [">= 4.0.0", "~> 4.0.0"])
       s.add_development_dependency(%q<shoulda>, [">= 3", "~> 3"])
       s.add_development_dependency(%q<yard>, [">= 0.8.7", "~> 0.8"])
       s.add_development_dependency(%q<rdoc>, [">= 4.0", "~> 4.0"])
@@ -89,6 +97,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
       s.add_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
       s.add_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
+      s.add_dependency(%q<slop>, [">= 4.0.0", "~> 4.0.0"])
       s.add_dependency(%q<shoulda>, [">= 3", "~> 3"])
       s.add_dependency(%q<yard>, [">= 0.8.7", "~> 0.8"])
       s.add_dependency(%q<rdoc>, [">= 4.0", "~> 4.0"])
@@ -103,6 +112,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<git>, [">= 1.2.8", "~> 1.2"])
     s.add_dependency(%q<sinatra>, [">= 1.4.5", "~> 1.4.5"])
     s.add_dependency(%q<nokogiri>, [">= 1.6.3", "~> 1.6.3"])
+    s.add_dependency(%q<slop>, [">= 4.0.0", "~> 4.0.0"])
     s.add_dependency(%q<shoulda>, [">= 3", "~> 3"])
     s.add_dependency(%q<yard>, [">= 0.8.7", "~> 0.8"])
     s.add_dependency(%q<rdoc>, [">= 4.0", "~> 4.0"])

data/test/test_run_command.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require 'helper'
+module Nutella
+  class TestRunCommand < MiniTest::Test
+    @@run_cmd = RunCommand.new
+    should 'parse app long argument' do
+      params =  @@run_cmd.send( :extract_parameters, ['--with=bot1,bot2,bot3'] )
+      assert_equal ['bot1', 'bot2', 'bot3'], params[:with]
+    end
+    should 'parse without long argument' do
+      params =  @@run_cmd.send( :extract_parameters, ['--without=botA,botB,botC'] )
+      assert_equal ['botA', 'botB', 'botC'], params[:without]
+    end
+    should 'parse with long argument' do
+      params =  @@run_cmd.send( :extract_parameters, ['--with=botX,botY,botZ'] )
+      assert_equal ['botX', 'botY', 'botZ'], params[:with]
+    end
+    should 'parse one short argument' do
+      params =  @@run_cmd.send( :extract_parameters, ['-w=bot1,bot2,bot3'] )
+      assert_equal ['bot1', 'bot2', 'bot3'], params[:with]
+    end
+    should 'parse two long arguments' do
+      params =  @@run_cmd.send( :extract_parameters, ['--with=bot1,bot2,bot3', '--without=botA,botB,botC'] )
+      assert_equal ['bot1', 'bot2', 'bot3'], params[:with]
+      assert_equal ['botA', 'botB', 'botC'], params[:without]
+    end
+    should 'parse two short arguments' do
+      params =  @@run_cmd.send( :extract_parameters, ['-wo=bot1,bot2,bot3', '-w=botA,botB,botC'] )
+      assert_equal ['bot1', 'bot2', 'bot3'], params[:without]
+      assert_equal ['botA', 'botB', 'botC'], params[:with]
+    end
+    should 'parse one short and one long argument' do
+      params =  @@run_cmd.send( :extract_parameters, ['--with=bot1,bot2,bot3', '-wo=botA,botB,botC'] )
+      assert_equal ['bot1', 'bot2', 'bot3'], params[:with]
+      assert_equal ['botA', 'botB', 'botC'], params[:without]
+    end
+    should 'raise an exception when trying to parse params that do not exist' do
+      assert_raises (Slop::UnknownOption) { @@run_cmd.send( :extract_parameters, ['--wit=bot1,bot2,bot3', '-o=botA,botB,botC'] ) }
+    end
+  end
+end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutella_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alessandro Gnoli
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -130,6 +130,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -273,6 +293,8 @@ files:
 - actors/main_interface/views/index.erb
 - actors/main_interface/views/not_found_404.erb
 - bin/nutella
+- data/index.html
+- data/startup
 - lib/cli/nutella_cli.rb
 - lib/config/config.rb
 - lib/config/current_project.rb
@@ -281,14 +303,18 @@ files:
 - lib/core/command.rb
 - lib/core/commands/broker.rb
 - lib/core/commands/checkup.rb
+- lib/core/commands/compile.rb
+- lib/core/commands/dependencies.rb
 - lib/core/commands/help.rb
 - lib/core/commands/install.rb
 - lib/core/commands/new.rb
 - lib/core/commands/runs.rb
 - lib/core/commands/start.rb
 - lib/core/commands/stop.rb
+- lib/core/commands/template.rb
 - lib/core/nutella_core.rb
 - lib/core/run_command.rb
+- lib/core/template_command.rb
 - lib/core/tmux.rb
 - lib/logging/nutella_logger-remote.rb
 - lib/logging/nutella_logger.rb
@@ -300,6 +326,7 @@ files:
 - test/config/test_runlist.rb
 - test/helper.rb
 - test/logging/test_logging.rb
+- test/test_run_command.rb
 homepage: https://github.com/nutella-framework/nutella_framework
 licenses:
 - MIT