Basic supervisor working

tebemis · tebemis · commit f9ecc987a6e1 · 2019-10-26T16:15:51.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,8 @@ runlist.json
 broker/
 .tmp/
 .pid
+.mongo_pid
+stdout.log
 
 # Test app
 test_app/
diff --git a/Gemfile b/Gemfile
@@ -1,16 +1,16 @@
 source 'http://rubygems.org'
 
-gem 'semantic', '~> 1.4'
 gem "ansi", "~> 1.5"
+gem 'bson', '~> 3.0'
 gem 'git', '~> 1.2'
+gem 'nutella_lib','~>0.4', '>=0.4.24'
+gem 'nokogiri', '~>1.6'
+gem 'slop', '~>4.0'
+gem 'semantic', '~> 1.4'
 gem 'sinatra', '~>1.4'
 gem 'sinatra-cross_origin', '~> 0.3.2'
 gem 'thin', '~>1.6'
-gem 'nokogiri', '~>1.6'
-gem 'slop', '~>4.0'
-gem 'nutella_lib','~>0.4', '>=0.4.24'
-gem 'activesupport', '~>4.2'
-gem 'bson', '~> 3.0'
+gem "xmlrpc", "~> 0.3.0"
 
 group :development do
   gem 'yard', '~> 0.9.11'
@@ -24,5 +24,3 @@ group :test do
   gem 'rspec', '~> 3.8'
   gem 'fuubar', '~> 2.4'
 end
-
-
diff --git a/README.md b/README.md
@@ -7,19 +7,19 @@ nutella is a framework to build and run Macroworlds. The original prototype was
 # Installing
 nutella works on OSX and Linux (tested on Ubuntu) and it depends on a couple other things to work correctly. You will need:
 
-1. _ruby_ (version >= 2.1.0). Do yourself a favor and use [RVM](https://rvm.io/rvm/install) to install Ruby.
+1. _ruby_ (version >= 2.3.0). Do yourself a favor and use [RVM](https://rvm.io/rvm/install) to install Ruby.
 1. _git_ (version >= 1.8.0). Should come with the OS, yay!
-1. _tmux_ (version >= 1.8.0). Do yourself a favor and use [Homebrew](http://brew.sh/) to install tmux, if you are on OSX.
-1. _Docker_ (version >= 17.03.0). We use Docker to run the broker that handles all communications between all the pieces of the framework. Do yourself a favor and use [Docker for mac](https://store.docker.com/editions/community/docker-ce-desktop-mac), if you are on OSX.
+1. _supervisor_ (version >= 4.1.0). You can use [Homebrew](http://brew.sh/) to install supervisor on OSX.
+1. _docker_ (version >= 17.03.0). We use Docker to run the broker that handles all communications between all the pieces of the framework. Do yourself a favor and use [Docker for mac](https://store.docker.com/editions/community/docker-ce-desktop-mac), if you are on OSX.
 
-Once you have all of  installed, simply do:
+Once you have all of thi stuff installed you can do:
 ```
 gem install nutella_framework
 ```
 Once the installation is complete you should be able to type `nutella` in your shell and get a welcome message. 
 
 ## nutella checkup
-If you are reading this you probably already saw the warning: "Looks like this is a fresh installation of nutella. Please run `nutella checkup` to check all dependencies are installed".
+If you are reading this you probably already saw the warning: "Looks like this is a fresh installation of nutella. Please run `nutella checkup` to check all dependencies are installed correctly". **Please follow the prompt!**
 
 ```
 nutella checkup
diff --git a/lib/bots/binary-files-manager/startup b/lib/bots/binary-files-manager/startup
diff --git a/lib/bots/commands_server/commands_server.rb b/lib/bots/commands_server/commands_server.rb
@@ -0,0 +1,18 @@
+$stdout.sync = true ## nutella woudl do this
+# $stdout.sync = true 
+puts "Hi, I'm a basic ruby bot and all I do is idle and print stuff"
+$stderr.puts "certainly first param is set #{ARGV[0]}"
+
+
+begin
+  i = 0
+  while true
+    puts "#{i} A log line!"
+    i = i + 1
+    sleep 1
+  end
+rescue SignalException => e
+  puts "HEY I WAS KILLED!!!"
+  $stderr.puts "AND I COMPLAIN IN STDERR"
+  puts e
+end
diff --git a/lib/bots/commands_server/startup b/lib/bots/commands_server/startup
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+BASEDIR=$(dirname $0)
+ruby $BASEDIR/commands_server.rb
diff --git a/lib/bots/main_interface/main_interface_bot.rb b/lib/bots/main_interface/main_interface_bot.rb
@@ -2,16 +2,15 @@
 require 'sinatra'
 require 'nokogiri'
 
-require_relative '../../lib/config/runlist'
-require_relative '../../lib/config/config'
-require_relative '../../nutella_lib/framework_core'
+require_relative '../../config/config'
+require_relative '../../config/runlist'
 
 
 # Set Sinatra to run in production mode
 set :environment, :production
 
 # Set Sinatra's port to nutella's main_interface_port
-set :port, Nutella.config['main_interface_port']
+set :port, Nutella::Config.file['main_interface_port']
 # Disable X-Frame-Options header to allow iframes
 set :protection, :except => :frame_options
 
@@ -63,7 +62,7 @@
   # 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?broker=#{Nutella.config['broker']}&app_id=#{app_id}&run_id=#{run_id}"
+  index_with_query_url = "#{request.path}/index.html?broker=#{Nutella::Config.file['broker']}&app_id=#{app_id}&run_id=#{run_id}"
   redirect index_with_query_url
 end
 
diff --git a/lib/bots/main_interface/startup b/lib/bots/main_interface/startup
diff --git a/lib/bots/order.json b/lib/bots/order.json
diff --git a/lib/bots/runs_list_bot/startup b/lib/bots/runs_list_bot/startup
diff --git a/lib/cli/cli.rb b/lib/cli/cli.rb
@@ -71,7 +71,7 @@ def self.print_nutella_logo
       console.info("Welcome to nutella version #{nutella_version}! For a complete lists of available commands type 'nutella help'\n")
       # If nutella is not ready to be used (i.e. nobody has invoked the "nutella checkup" command yet),
       # append warning/reminder message
-      if  Nutella.config['ready'].nil?
+      if  Config.file['ready'].nil?
         console.warn 'Looks like this is a fresh installation of nutella. Please run \'nutella checkup\' to check all dependencies are installed.'
       end
     end
diff --git a/lib/cli/commands/checkup.rb b/lib/cli/commands/checkup.rb
@@ -22,6 +22,9 @@ def run( args=nil )
           return
         end
       end
+
+      # Check that supervisor is properly configured
+      return unless supervisor_configured_correctly?
           
       # Set ready flag in config.json
       Config.file['ready'] = true
@@ -74,8 +77,8 @@ def all_dependencies_installed?
         semver
       end
       # Immortal version lambda
-      immortal_semver = lambda do
-        out = `immortal -v`
+      supervisor_semver = lambda do
+        out = `supervisorctl version`
         out.gsub("\n",'')
         Semantic::Version.new out
       end
@@ -86,7 +89,7 @@ def all_dependencies_installed?
         Semantic::Version.new out[0..4]
       end
       # Check versions
-      return true if check_version?('docker', '17.0.0', docker_semver) && check_version?('git', '1.8.0', git_semver) && check_version?('immortal', '0.23.0', immortal_semver) && check_version?('mongodb', '2.6.9', mongo_semver)
+      return true if check_version?('docker', '17.0.0', docker_semver) && check_version?('git', '1.8.0', git_semver) && check_version?('supervisor', '4.1.0', supervisor_semver) && check_version?('mongodb', '2.6.9', mongo_semver)
       # If even one of the checks fails, return false
       false
     end
@@ -110,6 +113,14 @@ def check_version?(dep, req_version, lambda)
       end
     end
 
+
+    def supervisor_configured_correctly?
+      # TODO Check that supervisor's MAC_CONFIG_DIR exists, if not create 
+      # TODO Make sure the MAC_CONFIG_DIR is inluded in supervisor's MAC_CONFIG_FILE, if not include
+      # TODO Make sure that [inet_http_server] (rpc server) is enabled in MAC_CONFIG_FILE
+      true
+    end
+
   end
 
 end
diff --git a/lib/nutella_framework.rb b/lib/nutella_framework.rb
@@ -1,11 +1,5 @@
-# This is the entry point to the gem. The code here gets executed BEFORE
-# anything else. For this reason, this is a great place to import all the
-# nutella modules.
-require 'config_files_management/config'
-require 'cli/nutella_cli'
-# require 'logging/nutella_logging'
-# require 'config/runlist'
-# require 'config/current_app_utils'
+require 'config/config'
+require 'cli/cli'
 
 module Nutella
 
diff --git a/lib/util/components_list.rb b/lib/util/components_list.rb
@@ -1,3 +1,6 @@
+module Nutella
+  
+end
 # Utility methods to list components
 class ComponentsList
 
diff --git a/lib/util/framework_components_starter.rb b/lib/util/framework_components_starter.rb
@@ -1,34 +1,35 @@
-# require_relative 'components_list'
+require 'util/supervisor'
 
 module Nutella
   # Utility functions to start components
   class FrameworkComponentsStarter
-    include PidFile
 
     def self.start
-      FrameworkComponentsStarter.new.start_framework_components
+      FrameworkComponentsStarter.new.start
     end
 
-    # Starts all framework components. If order.json is present, components are started
-    # in that order.
+    # Starts all framework components. 
     # @return [boolean] true if all components are started correctly, false otherwise
-    def start_framework_components
-      nutella_components_dir = "#{NUTELLA_HOME}framework_components"
-      if File.exist? "#{nutella_components_dir}/order.json"
-        components_list = JSON.parse IO.read "#{nutella_components_dir}/order.json"
-      else
-        components_list = ComponentsList.components_in_dir nutella_components_dir
-      end
-      components_list.each do |component|
-        if File.exist? "#{nutella_components_dir}/#{component}/startup"
-          unless start_framework_component "#{nutella_components_dir}/#{component}"
-            return false
-          end
+    def start
+      supervisor = Supervisor.new
+      nutella_components_dir = "#{Nutella::NUTELLA_HOME}lib/bots"
+      framework_components.each do |c|
+        if File.exist? "#{nutella_components_dir}/#{c}/startup"
+          supervisor.add("nutella_f_#{c}", "#{nutella_components_dir}/#{c}/startup")
         end
       end
+      framework_components.each do |c|
+        supervisor.start("nutella_f_#{c}")
+      end
       true
     end
 
+    # Finds the framework level components that need to be started
+    def framework_components
+      d = "#{Nutella::NUTELLA_HOME}lib/bots"
+      Dir.entries(d).select {|entry| File.directory?(File.join(d, entry)) && !(entry =='.' || entry == '..') }
+    end
+
 
     # Starts the application level bots
     # @return [boolean] true if all bots are started correctly, false otherwise
@@ -69,28 +70,6 @@ def self.start_run_bots( bots_list, app_path, app_id, run_id )
 
     #--- Private class methods --------------
 
-
-    # Starts a single framework component
-    # @return [boolean] true if the component has been started successfully, false otherwise
-    def self.start_framework_component( component_dir )
-      pid_file_path = "#{component_dir}/.pid"
-      return true if sanitize_pid_file pid_file_path
-      # Component is not running and there is no pid file so we try to start it
-      # and create a new pid file. Note that the pid file is created by
-      # the startup script!
-      # Framework components are started without any parameters passed to them because they have
-      # full access to config, runlist and framework APIs using 'require_relative'
-      command = "#{component_dir}/startup"
-      pid = fork
-      exec(command) if pid.nil?
-      # Give it a second so they can start properly
-      sleep 1
-      # All went well so we return true
-      true
-    end
-    private_class_method :start_framework_component
-
-
     # Starts a run level bot
     def self.start_run_level_bot( bots_dir, bot, tmux )
       # If there is no 'startup' script output a warning (because
diff --git a/lib/util/immortal.rb b/lib/util/immortal.rb
diff --git a/lib/util/supervisor.rb b/lib/util/supervisor.rb
@@ -0,0 +1,69 @@
+require 'xmlrpc/client'
+
+module Nutella
+  MAC_CONFIG_FILE="/usr/local/etc/supervisord.ini"
+  MAC_CONFIG_DIR="/usr/local/etc/supervisor.d"
+
+  # This class wraps supervisor and makes it easier to interact with
+  class Supervisor
+
+    def initialize
+      @rpc = XMLRPC::Client.new2("http://localhost:9001/RPC2")
+    end
+
+    # Adds a process to supervision
+    def add(name, command)
+      write_config_file(name, command)
+      # TODO validate that the reload config RPC actually does a reread operation...
+      @rpc.call("supervisor.reloadConfig")
+      # TODO Validate what was removed based on returned value?
+    end
+
+    # Adds a group of process to supervision
+    def add_group(processes)
+      processes.each { |name, command| write_config_file(name, command) }
+      @rpc.call("supervisor.reloadConfig")
+    end
+
+    # Removes a process from supervision
+    def remove(name)
+      delete_config_file(name)
+      @rpc.call("supervisor.reloadConfig")
+    end
+
+    # Removes a group of processes from supervision
+    def remove_group(processes)
+      processes.each { |name| delete_config_file(name) }
+      @rpc.call("supervisor.reloadConfig")
+    end
+
+    # Starts a process, retuns false if error
+    def start(name)
+      res = @rpc.call("supervisor.startProcess", name)
+      puts res
+    end
+
+    # Stops a process, retuns false if error
+    def stop(name)
+      @rpc.call("supervisor.stopProcess", name)
+    end
+
+
+    private
+
+    def write_config_file(name, command)
+      File.open("#{MAC_CONFIG_DIR}/#{name}.ini", 'w') do |f|
+        f.puts "[program:#{name}]"
+        f.puts "command=#{command}"
+        f.puts "stdout_logfile=#{command[0..-8]+'stdout.log'}"
+        f.puts "autostart=false"
+        f.puts "redirect_stderr=true"
+      end
+    end
+
+    def delete_config_file(name)
+      File.delete("#{MAC_CONFIG_DIR}/#{name}.ini")
+    end
+    
+  end
+end
diff --git a/spec/cli/commands/server_spec.rb b/spec/cli/commands/server_spec.rb
@@ -1,12 +1,10 @@
 require 'spec_helper'
-require 'cli/cli'
+require 'nutella_framework'
 
 module Nutella
   describe Server do
     skip 'Starts the MQTT broker' do
       NutellaCLI.execute_command('server')
-      # TODO resume from here... need to implement
-      # framework components start using immortal...
     end
   end
 end
