nutella_framework 0.3.1 → 0.4.0

data/test/config/test_persisted_hash.rb

@@ -0,0 +1,48 @@
+require 'helper'
+
+module Nutella
+  
+  class TestNutellaConfig < MiniTest::Test
+
+    def setup
+      @config = PersistedHash.new( 'runlist.json' )
+    end
+
+
+    should 'set a key value' do
+      assert_equal 'value1', @config['key1']='value1'
+    end
+
+    should 'return \'nil\' if a key doesn\'t exist' do
+      assert_nil @config['fakekey']
+    end
+
+    should 'return the value associated with a key whenever that key exists' do
+      @config['key2']='value2'
+      assert_equal 'value2', @config['key2']
+    end
+
+    should 'return true if a key exists' do
+      @config['key3']='value3'
+      assert @config.has_key?('key3')
+    end
+
+    should 'return false if a key doesn\'t exist' do
+      refute @config.has_key?('key4')
+    end
+
+    should 'access nested hashes' do
+      @config['key5']={'k55' => 'v55'}
+      assert_equal 'v55', @config['key5']['k55']
+    end
+
+
+    def teardown
+      @config.send(:remove_file)
+    end
+  
+  end
+
+end
+
+

data/test/config/test_runlist.rb

@@ -5,49 +5,41 @@ module Nutella
   class TestRunList < MiniTest::Test
 
     def setup
-      Nutella.runlist.send(:remove_file)
+      @runlist = RunListHash.new( 'runlist.json' )
     end
-    
+
     should 'return true if the list is empty' do
-      assert Nutella.runlist.empty?
+      assert @runlist.empty?
     end
 
     should 'return false if the list is not empty' do
-      refute_nil Nutella.runlist.add?( 'run1', '/path/to/my/run1')
-      refute Nutella.runlist.empty?
+      assert @runlist.add?('app_id_a', 'run_id_1', '/just/a/random/path')
+      refute @runlist.empty?
     end
 
     should 'return empty array if the list is empty' do
-      assert_empty Nutella.runlist.runs_by_project
+      assert_empty @runlist.all_runs
     end
 
     should 'return an array of runs in the list if not empty' do
-      refute_nil Nutella.runlist.add?( 'run1', '/path/to/my/run1' )
-      refute_nil Nutella.runlist.add?( 'run2', '/path/to/my/run2' )
-      assert_equal %w{run1 run2}, Nutella.runlist.runs_by_project
+      refute_nil @runlist.add?( 'app_a', 'run1', '/path/to/my/run1' )
+      refute_nil @runlist.add?( 'app_a', 'run2', '/path/to/my/run2' )
+      assert_equal %w{run1 run2}, @runlist.runs_for_app('app_a')
     end
 
     should 'return false if trying to add the same element twice' do
-      assert Nutella.runlist.add?( 'run1', '/path/to/my/run1' )
-      refute Nutella.runlist.add?( 'run1', '/path/to/my/run1' )
+      assert @runlist.add?( 'app_a', 'run1', '/path/to/my/run1' )
+      refute @runlist.add?( 'app_a', 'run1', '/path/to/my/run1' )
     end
 
     should 'return properly when deleting an item' do
-      assert Nutella.runlist.add?( 'run1', '/path/to/my/run1' )
-      assert Nutella.runlist.delete? 'run1'
-      refute Nutella.runlist.delete? 'run1'
+      assert @runlist.add?('app_a', 'run1', '/path/to/my/run1' )
+      assert @runlist.delete?('app_a', 'run1')
+      refute @runlist.delete?('app_a', 'run1')
     end
 
-    should 'properly indicate if an item is in the list' do
-      refute Nutella.runlist.include? 'run1'
-      assert Nutella.runlist.add?( 'run1', '/path/to/my/run1' )
-      assert Nutella.runlist.include? 'run1'
-      assert Nutella.runlist.delete? 'run1'
-      refute Nutella.runlist.include? 'run1'
-    end
-    
     def teardown
-      Nutella.runlist.send(:remove_file)
+      @runlist.remove_file
     end
 
   end

data/test/framework_apis/test_framework_api.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+require_relative '../../lib/nutella_lib_framework/api'
+
+
+
+module Nutella
+  class TestFrameworkApi < MiniTest::Test
+
+    # nutella.init_as_f_component('localhost', 'my_component_id')
+
+
+    # should 'pub_sub_on_framework_channels' do
+    #   cb_executed = false
+    #   cb = lambda do |message, from|
+    #     cb_executed = true
+    #     puts "Received message from #{from['component_id']}/#{from['resource_id']}. Message: #{message}"
+    #   end
+    #   nutella.net.f.subscribe('demo0', cb)
+    #   sleep 1
+    #   nutella.net.f.publish('demo0', 'test_message')
+    #   # Make sure we wait for the message to be delivered
+    #   sleep 1
+    #   assert cb_executed
+    # end
+    #
+    #
+    # should 'request_response_on_framework_channel' do
+    #   nutella.set_resource_id 'my_resource_id_3'
+    #   nutella.net.f.handle_requests('demo3', lambda do |message, from|
+    #     puts "We received a request: message #{message}, from #{from['component_id']}/#{from['resource_id']}."
+    #     #Then we are going to return some random JSON
+    #     {my:'json'}
+    #   end)
+    #   response = nutella.net.f.sync_request('demo3', 'my request is a string')
+    #   assert_equal({'my' => 'json'}, response)
+    #   nutella.net.f.async_request( 'demo3', 'my request is a string', lambda do |response|
+    #       assert_equal({'my' => 'json'}, response)
+    #   end)
+    #   sleep 2
+    # end
+
+
+    # Framework-to-run (broadcasting)
+
+    # should 'test_app_run_pub_sub_all' do
+    #   nutella.set_resource_id 'my_resource_id_5'
+    #   cb = lambda do |message, app_id, run_id, from|
+    #     puts "Received message from run_id #{from['run_id']} on #{app_id}/#{run_id}. Message: #{message}"
+    #     # nutella.net.f.unsubscribe_from_all_runs 'demo5'
+    #   end
+    #   nutella.net.f.subscribe_to_all_runs('demo5', cb)
+    #   sleep 1
+    #   nutella.net.f.publish_to_all_runs('demo5', 'test_message')
+    #   # Make sure we wait for the message to be delivered
+    #   sleep 2
+    # end
+
+    # def test_app_run_req_res_all
+    #   nutella.set_resource_id 'my_resource_id_6'
+    #   nutella.net.f.handle_requests_on_all_runs('demo6', lambda do |message, app_id, run_id, from|
+    #     puts "We received a request: message '#{message}', on app_id/run_id #{app_id}/#{run_id} from #{from}."
+    #     'response' # Return something
+    #   end)
+    #   sleep 1
+    #   nutella.net.f.async_request_to_all_runs('demo6', 'my request is a string', lambda do |response|
+    #      puts response
+    #   end)
+    #   sleep 2
+    # end
+    
+  end
+end  
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutella_framework
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Gnoli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -110,6 +110,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +170,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: nutella_lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -286,46 +326,53 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- actors/main_interface/main_interface_bot.rb
-- actors/main_interface/public/index.html
-- actors/main_interface/startup
-- 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
+- framework_components/example_framework_interface/dandelion-flowers-card.jpg
+- framework_components/example_framework_interface/index.html
+- framework_components/main_interface/main_interface_bot.rb
+- framework_components/main_interface/public/index.html
+- framework_components/main_interface/startup
+- framework_components/main_interface/views/index.erb
+- framework_components/main_interface/views/not_found_404.erb
+- framework_components/order.json.example
+- framework_components/runs_list_bot/app_runs_list_bot.rb
+- lib/commands/broker.rb
+- lib/commands/checkup.rb
+- lib/commands/compile.rb
+- lib/commands/dependencies.rb
+- lib/commands/help.rb
+- lib/commands/install.rb
+- lib/commands/meta/command.rb
+- lib/commands/meta/run_command.rb
+- lib/commands/meta/template_command.rb
+- lib/commands/new.rb
+- lib/commands/runs.rb
+- lib/commands/start.rb
+- lib/commands/stop.rb
+- lib/commands/template.rb
 - lib/config/config.rb
-- lib/config/current_project.rb
+- lib/config/current_app_utils.rb
 - lib/config/persisted_hash.rb
 - lib/config/runlist.rb
-- 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_cli.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
 - lib/logging/nutella_logging.rb
 - lib/nutella_framework.rb
+- lib/nutella_lib_framework/api.rb
+- lib/tmux/tmux.rb
 - nutella_framework.gemspec
-- test/config/test_config.rb
-- test/config/test_project.rb
+- test/commands/test_cmd_cli_params_parsing.rb
+- test/commands/test_command_template.rb
+- test/config/test_current_app_utils.rb
+- test/config/test_persisted_hash.rb
 - test/config/test_runlist.rb
+- test/framework_apis/test_framework_api.rb
 - test/helper.rb
 - test/logging/test_logging.rb
-- test/test_run_command.rb
 homepage: https://github.com/nutella-framework/nutella_framework
 licenses:
 - MIT

data/actors/main_interface/main_interface_bot.rb

@@ -1,163 +0,0 @@
-require 'json'
-require 'sinatra'
-require 'nokogiri'
-
-# Configuration file and runlist (runlist as global)
-config_file = ARGV[0]
-$runlist_file = ARGV[1]
-
-# Try to parse the both config file and runlist and terminate if we can't
-begin
-  config_h = JSON.parse(IO.read(config_file))
-  JSON.parse(IO.read($runlist_file))
-rescue
-  # something went wrong
-  abort 'Impossible to parse configuration and/or runlist files!'
-end
-
-# Set Sinatra to run in production mode
-set :environment, :production
-
-# Set Sinatra's port to nutella's main_interface_port
-set :port, config_h['main_interface_port']
-
-
-# Display the form to input the run_id
-get '/' do
-  send_file File.join("#{config_h['nutella_home']}/actors/main_interface/public", 'index.html')
-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
-
-  # Parse the run_id from URL and extract the run path from runlist.json
-  @run_id = params[:run_id]
-  @run_path = get_run_path @run_id
-  @project_name = @run_path[@run_path.rindex('/')+1..@run_path.length] unless @run_path.nil?
-
-  # If there is no run with this name, render error page
-  return erb( :not_found_404, :locals => {:not_found_type => 'run'} ) if @run_path.nil?
-
-  # If there is an 'index.erb' file inside the 'interfaces' folder, render it
-  custom_index_file = "#{@run_path}/interfaces/index.erb"
-  return erb(File.read( custom_index_file )) if File.exist? custom_index_file
-
-  # If no 'index.erb' is provided we need to generate one
-  # In order to do so we need to load a bunch of details
-  # (folder, title/name, description) for each interface
-  @interfaces = load_interfaces_details
-
-  # Finally render the interfaces summary page
-  erb :index
-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
-
-  # Parse the run_id and the interface name from URL
-  run_id = params[:run_id]
-  interface = params[:interface]
-
-  # Extract the run path from runlist.json
-  run_path = get_run_path run_id
-
-  # Compose the path of interface index file
-  index_file_path = "#{run_path}/interfaces/#{interface}/index.html"
-
-  # If the index file doesn't exist, render error page
-  return erb( :not_found_404, :locals => {:not_found_type => 'idx'} ) unless File.exist? index_file_path
-
-  # If the index file exists, compose query string and redirect
-  index_with_query_url = "#{request.path}/index.html?run_id=#{run_id}&broker=#{config_h['broker']}"
-  redirect index_with_query_url
-end
-
-
-# Serves the files contained in each interface folder
-get '/:run_id/:interface/*' do
-
-  # Parse the run_id, the interface name and the file_path from URL
-  run_id = params[:run_id]
-  interface = params[:interface]
-  relative_file_path = params[:splat][0]
-
-  # Extract the run path from runlist.json
-  run_path = get_run_path run_id
-
-  # Compose the path of the file we are trying to serve
-  file_path = "#{run_path}/interfaces/#{interface}/#{relative_file_path}"
-
-  # If the file we are trying to serve doesn't exist, render error page
-  return erb( :not_found_404, :locals => {:not_found_type => 'file'} ) unless File.exist? file_path
-
-  # If the file exists, render it
-  send_file file_path
-end
-
-
-# Utility function:
-# Gets the path associated with a certain run
-def get_run_path (run_id)
-  begin
-    runs_h = JSON.parse(IO.read($runlist_file))
-    runs_h[run_id]
-  rescue
-    nil
-  end
-end
-
-# Utility function:
-# Loads all the details for all interfaces and stores them into an array of hashes
-def load_interfaces_details
-  interfaces = Array.new
-  interfaces_path = "#{@run_path}/interfaces/"
-  Dir.entries(interfaces_path).select {|entry| File.directory?(File.join(interfaces_path, entry)) && !(entry =='.' || entry == '..') }.each do |iface_dir|
-    interfaces.push extract_interface_info( interfaces_path, iface_dir )
-  end
-  interfaces
-end
-
-# Utility function:
-# Extracts name, description and folder for a single interface
-def extract_interface_info( interfaces_path, iface_dir )
-  iface_props = Hash.new
-
-  index_path = "#{interfaces_path}#{iface_dir}/index.html"
-
-  unless File.exist? index_path
-    iface_props[:name] = iface_dir
-    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
-
-  # If file exists, parse it and extract info
-  f = File.open index_path
-  doc = Nokogiri::HTML f
-  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 bit lazy and didn\'t include a <meta name="description" content="Description of this interface"> 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 <meta name="description" content="Description of this interface"> tag in the index.html file :('
-    else
-      iface_props[:description] = doc.css("meta[name='description']").attribute('content').text
-    end
-  end
-  iface_props[:url] = "#{iface_dir}"
-  iface_props
-end

data/actors/main_interface/public/index.html

@@ -1,51 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title>Welcome to nutella</title>
-    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
-    
-		<style type="text/css">
-				div {		
-					margin-top: 4em;
-					text-align: center;
-					font-size: 3em;
-				}
-				.form-control {
-					height: 50px;
-					width: 40%;
-					text-align: center;
-					font-size: .7em;
-					display: inline-block;
-				}
-				.center {
-				    text-align:center;
-				}
-				.center form {
-				    display:inline-block;
-				}
-		</style>
-    </head>
-    <body>
-			
-<!-- Content -->
-			<div>
-        <p>What is your run id?</p>
-				<input id="run_id_input" type="text" value="" class="form-control" autofocus>
-			</div>
-			
-<!-- Scripts -->
-        <script>
-					el = document.getElementById('run_id_input');
-					el.addEventListener('change', function() {
-						url = location.href
-						if (url.substr(url.length - 1)=="/")
-							window.location = url + this.value + '/';
-						else
-							window.location = url + '/' + this.value + '/';
-					});
-        </script>
-    </body>
-</html>

data/actors/main_interface/views/index.erb

@@ -1,45 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <title><%= @run_id %> interfaces</title>
-    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
-    
-		<style type="text/css">
-			.row {
-				margin-bottom: 20px;
-			}
-		</style>
-    </head>
-    <body>
-			
-<!-- Content -->
-			<div class="container">
-				<div class="page-header">
-				  <% if @run_id == @project_name %>
-					  <h1>Welcome to <em><%= @project_name %></em></h1>
-				  <% else %>
-					  <h1>Welcome to <em><%= @project_name %></em>, run <em><%= @run_id %></em></h1>
-				  <% end %>
-				  <p class="lead">Click on the buttons to launch the intereface</p>
-				</div>
-				
-				<% @interfaces.each do |i| %>
-				<div class="row">
-					<div class="col-xs-1 col-sm-1 col-lg-1"><a href="<%= i[:url] %>" target="_blank" type="button" class="btn btn-danger">Launch!</a></div>
-					<div class="col-xs-2 col-sm-2 col-lg-2 text-center"><strong><%= i[:name] %></strong></div>
-					<div class="col-xs-9 col-sm-9 col-lg-9"><%= i[:description] %></div>
-				</div>
-				
-				<% end %>
-						
-			</div>
-			
-<!-- Scripts -->
-        <script>
-					
-        </script>
-    </body>
-</html>

data/lib/config/current_project.rb

@@ -1,58 +0,0 @@
-# handles current project files
-require 'json'
-
-module Nutella
-  
-  module CurrentProjectUtils
-    
-    # Checks that the current directory is actually a nutella project
-    # @return [Boolean] true if the current directory is a nutella project, false otherwise
-    def CurrentProjectUtils.exist?
-      cur_prj_dir = Dir.pwd
-      nutella_json_file = "#{cur_prj_dir}/nutella.json"
-      # Check that there is a nutella.json file in the main directory of the project
-      if File.exist? nutella_json_file
-        conf = JSON.parse( IO.read(nutella_json_file) )
-        if conf['nutella_version'].nil?
-          console.warn 'The current directory is not a nutella project: nutella_version unspecified in nutella.json file'
-          return false
-        end
-      else
-        console.warn 'The current directory is not a nutella project: impossible to read nutella.json file'
-        return false
-      end
-      true
-    end
-
-    # Builds a PersistedHash of the project nutella.json file and returns it.
-    # This method is used to ease access to the project nutella.json file.
-    # @return [PersistedHash] the PersistedHash of the project nutella.json file
-    def CurrentProjectUtils.config
-      cur_prj_dir = Dir.pwd
-      nutella_json_file = "#{cur_prj_dir}/nutella.json"
-      if File.exist? nutella_json_file
-        return PersistedHash.new nutella_json_file
-        else
-          console.error 'The current directory is not a nutella project: impossible to read nutella.json file'
-        end
-    end
-
-    # Retrieves the current project directory
-    # @return [String] the current project home
-    def CurrentProjectUtils.dir
-      Dir.pwd
-    end
-    
-  end
-
-
-  # Calling this method (Nutella.current_project) simply returns
-  # a reference to the CurrentProjectUtils module
-  def Nutella.current_project
-    CurrentProjectUtils
-  end
-  
-end
-
-
-

data/lib/core/command.rb

@@ -1,12 +0,0 @@
-# CLI command
-
-module Nutella  
-  class Command 
-    class << self; attr_accessor :description end
-  
-    # Commands overload this method to execute
-    def run( args=nil )
-      console.error 'Running the generic command!!! WAT?'
-    end
-  end
-end