nutella_framework 0.1.0

data/lib/core/commands/checkup.rb

@@ -0,0 +1,91 @@
+require 'core/command'
+require 'semantic'
+
+module Nutella
+  class Checkup < Command
+    @description = "Checks that all the dependencies are installed and prepares nutella to run"
+  
+    def run(args=nil)
+      # First check that we have all the tools we need to run nutella
+      if !allDependenciesInstalled?
+        return
+      end
+      
+      # Check if we have a broker and install one if not
+      if !File.directory? Nutella.config["broker_dir"]
+        console.warn "You don't seem to have a local broker installed so we are going to go ahead and install one for you. This might take some time..."
+        if !installBroker
+          console.error "Whoops...something went wrong while installing the broker. "
+          return
+        end
+      else
+        console.info "You have a local broker installed. Yay!"
+      end
+          
+      # Set config and output message
+      Nutella.config["ready"] = true
+      console.success("All systems go! You are ready to use nutella!")
+    end
+    
+  
+    private 
+    
+  
+    def installBroker    
+      # Clone, cd and npm install
+      out1 = system "git clone git://github.com/mcollina/mosca.git #{Nutella.config["broker_dir"]} > /dev/null 2>&1"
+      Dir.chdir(Nutella.config["broker_dir"])
+      out2 = system "npm install > /dev/null 2>&1"
+    
+      # Add startup script
+      File.open("startup", 'w') { |file| file.write("#!/bin/sh\n\nBASEDIR=$(dirname $0)\n$BASEDIR/bin/mosca --http-port 1884 &\necho $! > $BASEDIR/bin/.pid\n") }
+      File.chmod(0755, "startup")
+    
+      # Add configuration
+      Nutella.config["broker"] = "localhost"
+      return out1 && out2
+    end
+    
+    def allDependenciesInstalled?
+      # Node version lambda
+      node_semver = lambda do
+        out = `node --version`
+        out[0] = ''
+        Semantic::Version.new out
+      end
+      # Git version lambda
+      git_semver = lambda do
+        out = `git --version`
+        out.slice!(0,12)
+        Semantic::Version.new out[0..4]
+      end
+      # Check versions
+      if checkVersion?("node", "0.10.0", node_semver) && checkVersion?("git", "1.8.0", git_semver)
+        return true
+      end
+      false
+    end
+    
+    
+    def checkVersion?(dep, req_version, lambda)
+      begin
+        actual_version = lambda.call
+      rescue
+        console.warn "Doesn't look like #{dep} is installed in your system. " + 
+          "Unfotunately nutella can't do much unless all the dependencies are installed :("
+          return
+      end
+      required_version = Semantic::Version.new req_version 
+      if actual_version < required_version
+        console.warn "Your version of #{dep} is a little old (#{actual_version}). Nutella requires #{required_version}. Please upgrade!"
+        return
+      else
+        console.info "Your #{dep} version is #{actual_version}. Yay!"
+        true
+      end
+    end
+    
+    
+  end
+end
+

data/lib/core/commands/help.rb

@@ -0,0 +1,22 @@
+require 'core/command'
+
+module Nutella
+    
+  class Help < Command
+    @description = "Displays what every command does and how to use it"
+  
+    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
+        message += "\n"
+      end
+      console.info message, 200
+    end
+    
+  end
+  
+end
+
+

data/lib/core/commands/install.rb

@@ -0,0 +1,153 @@
+require 'core/command'
+require 'json'
+require 'git'
+require 'net/http'
+
+module Nutella
+  
+  class Install < Command
+    @description = "Copies an arbitrary template (from central DB, directory or URL) into the current project"
+  
+    def run(args=nil)
+      # Is current directory a nutella prj?
+      if !Nutella.currentProject.exist?
+        return
+      end
+    
+      # Check args
+      if args.empty?
+        console.warn "You need to specify a template name, directory or URL"
+        return
+      end
+      @template = args[0]
+      if args.length==2
+        @destinationFolder = args[1]
+      end
+      
+      # Extract project directory
+      @prj_dir = Nutella.currentProject.dir
+    
+      # What kind of template are we handling?
+      if isTemplateALocalDir?
+        addLocalTemplate
+      elsif isTemplateAGitRepo?
+        addRemoteTemplate
+      elsif isTemplateInCentralDB?
+        addCentralTemplate
+      else
+        console.warn "The specified template is not a valid nutella template"
+      end
+      
+    end
+    
+    
+    private
+  
+  
+    def isTemplateALocalDir?
+      # Does the specified directory exist?
+      if !File.directory?(@template)
+        return false
+      end
+      return validateTemplate @template
+    end
+  
+  
+    def isTemplateAGitRepo?
+      begin
+        dest_dir = @template[@template.rindex("/")+1 .. @template.length-5]
+        cloneTemplateFromRemoteTo(dest_dir)
+        return validateTemplate("#{Nutella.config["tmp_dir"]}/#{dest_dir}")
+      rescue
+        return false 
+      end
+      false
+    end
+  
+  
+    def isTemplateInCentralDB?
+      uri = URI.parse("https://raw.githubusercontent.com/ltg-uic/nutella/templates-database/" + @template + ".json")
+      begin
+        nutella_json = JSON.parse(Net::HTTP.get(uri))
+        if nutella_json["name"]==@template
+          @template = nutella_json["repo"]
+          return isTemplateAGitRepo?
+        end
+      rescue
+        return false
+      end
+      false
+    end  
+  
+
+    def addLocalTemplate
+      templateNutellaFileJson = JSON.parse(IO.read("#{@template}/nutella.json"))
+    
+      # If destination is not specified, set it to the template name
+      if @destinationFolder==nil
+        @destinationFolder = templateNutellaFileJson["name"]
+      end
+    
+      # Am I trying to copy onto a template that already exists?
+      if templateNutellaFileJson["type"]=="bot"
+        # Look into bots folder
+        dest_dir = "#{@prj_dir}/bots/#{@destinationFolder}"
+      else
+        # Look into interfaces folder
+        dest_dir = "#{@prj_dir}/interfaces/#{@destinationFolder}"
+      end
+      if File.directory?(dest_dir)
+        console.error("Folder #{dest_dir} aready exists! Can't add template #{@template}")
+        return
+      end
+      FileUtils.copy_entry @template, dest_dir
+      console.success("Installed template: #{@template} as #{dest_dir}")
+    end
+  
+  
+    def addRemoteTemplate
+      templ_name = @template[@template.rindex("/")+1 .. @template.length-5]
+      addLocalTemplate "#{Nutella.config["tmp_dir"]}/#{templ_name}"
+    end
+  
+  
+    def addCentralTemplate
+      return addRemoteTemplate
+    end
+  
+  
+    def cloneTemplateFromRemoteTo(dest_dir)
+      cleanTmpDir
+      if !Dir.exists?(Nutella.config["tmp_dir"])
+        Dir.mkdir(Nutella.config["tmp_dir"])
+      end
+      Git.clone(@template, dest_dir, :path => Nutella.config["tmp_dir"])
+    end
+    
+    
+    def validateTemplate(dir)
+      # Parse the template's nutella.json file
+      begin
+        templateNutellaFileJson = JSON.parse(IO.read("#{dir}/nutella.json"))
+      rescue
+        return false
+      end
+      # If template is a bot, perform additional checks
+      if templateNutellaFileJson["type"]=="bot"
+        # Is there a andatory 'startup' script and is it executable
+        if !File.executable?("#{dir}/startup")
+          return false
+        end
+      end 
+      true
+    end
+  
+  
+    def cleanTmpDir
+      FileUtils.rm_rf Nutella.config["tmp_dir"]
+    end
+  
+  end
+  
+end
+

data/lib/core/commands/new.rb

@@ -0,0 +1,62 @@
+require 'core/command'
+require 'fileutils'
+
+module Nutella
+  class New < Command
+    @description = "Creates a new project"
+  
+    def run(args=nil)
+      @prj_dir = args[0]
+    
+      # If no other arguments, show help and quit here
+      if args.empty?
+        console.warn "You need to specify a name for your new project. Can't create project."
+        return
+      end
+    
+      # Does a project/directory with the same name exist already?
+      if File.directory?(@prj_dir)
+        if File.exist?("#{@prj_dir}/conf/project.json")
+          console.warn "A project named #{@prj_dir} already exists. Can't create project."
+          return
+        else
+          console.warn "A directory named #{@prj_dir} already exists. Can't create project."
+          return
+        end
+      end
+    
+      # Generate project structure
+      @cur_dir = Dir.pwd  # Store current directory
+      createDirStructure  # Create project directory structure
+      Dir.chdir @prj_dir  # CD into the project
+      # Display a nice success message and return
+      console.success "Your new project #{@prj_dir} is ready!" 
+    end
+    
+    
+    private 
+  
+  
+    def createDirStructure
+      FileUtils.mkdir_p("#{@prj_dir}/bots")       # bots dir
+      FileUtils.mkdir_p("#{@prj_dir}/interfaces") # interfaces dir
+      FileUtils.mkdir_p("#{@prj_dir}/conf")       # conf dir
+      # create base configuration file
+      config_file_hash = {
+        "nutella_version" => File.open(NUTELLA_HOME+"VERSION", "rb").read,
+        "name" => @prj_dir,
+        "version" => "0.1.0-SNAPSHOT"
+      }
+      File.open("#{@prj_dir}/conf/project.json","w") do |f|
+        f.write(JSON.pretty_generate(config_file_hash))
+      end
+    end
+  
+    def removeDirStructure
+      Dir.chdir @cur_dir
+      console.info "Removing project #{@prj_dir}"
+      FileUtils.rm_rf(@prj_dir)
+    end
+  
+  end
+end

data/lib/core/commands/runs.rb

@@ -0,0 +1,42 @@
+require 'core/command'
+
+
+module Nutella
+  class Runs < Command
+    @description = "Displays list of all the runs, you can filter by passing a project id"
+  
+    def run(args=nil)
+      # If invoked with "--all" it will show all the runs under this instance of nutella
+      if args[0]=="--all"
+        if Nutella.runlist.empty?
+          console.info "You are not running any projects"
+        else
+          console.info "Currently running:"
+          Nutella.runlist.to_a.each { |run| console.info " #{run}" }   
+        end
+      else # Just show the runs associated with this project
+        # Is current directory a nutella prj?
+        if !Nutella.currentProject.exist?
+          return
+        end
+        project_name = Nutella.currentProject.config["name"]
+        runs = Nutella.runlist.to_a project_name
+        if runs.empty?
+          console.info "Currently running #{runs.length} instances of project #{project_name}"
+          return
+        end
+        console.info "Currently running #{runs.length} instances of project #{project_name}:"
+        runs.to_a.each { |run| 
+          run.slice! "#{project_name}_"
+          if run.empty? 
+            console.info "progetto (default)"
+          else
+            console.info " #{run}" 
+          end
+        }   
+      end
+    end
+  end
+  
+end
+

data/lib/core/commands/start.rb

@@ -0,0 +1,101 @@
+require 'core/command'
+require 'core/tmux'
+
+module Nutella
+  class Start < Command
+    @description = "Starts all or some of the bots in the current project"
+  
+    def run(args=nil)
+      # Is current directory a nutella prj?
+      if !Nutella.currentProject.exist?
+        return
+      end
+    
+      # Extract runid
+      runid = args[0].to_s.empty? ? Nutella.currentProject.config["name"] : Nutella.currentProject.config["name"] + "_" + args[0]
+    
+      # Add to the list of runs and check the runId is unique
+      if !Nutella.runlist.add?(runid)
+        console.error "Impossible to start project: an instance of this project with the same name is already running!"
+        console.error "You might want to kill it with 'nutella stop "+ runid + "'"
+        return;
+      end
+      
+      # Extract project directory
+      @prj_dir = Nutella.currentProject.dir
+    
+      # If running on internal broker, start it
+      if Nutella.config["broker"] == "localhost" # Are we using the internal broker
+        startBroker
+      end
+    
+      # Create .botsconfig file
+      deleteBotsConfig
+      createBotsConfig
+    
+    
+      # Start all the bots
+      tmux = Tmux.new(runid)
+      Dir.entries("#{@prj_dir}/bots").select {|entry| File.directory?(File.join("#{@prj_dir}/bots",entry)) and !(entry =='.' || entry == '..') }.each do |bot|
+        if !File.exist?("#{@prj_dir}/bots/#{bot}/startup")
+          console.warn "Impossible to start bot #{bot}. Couldn't locate 'startup' script."
+          next
+        end
+        tmux.newWindow(bot)
+      end
+    
+      # Output success message
+      if runid == Nutella.currentProject.config["name"]
+        console.success "Project " + Nutella.currentProject.config["name"] + " started"
+      else
+        console.success "Project " + Nutella.currentProject.config["name"] + ", run " + args[0] + " started"
+      end
+    end
+    
+    
+    private
+  
+  
+    def startBroker
+      pidFile = "#{Nutella.config["broker_dir"]}/bin/.pid"
+      if File.exist?(pidFile) # Does the broker pid file exist?
+        pidF = File.open(pidFile, "rb")
+        pid = pidF.read.to_i
+        pidF.close()
+        begin
+          Process.getpgid(pid) #PID is still alive
+          # broker is already started and I do nothing
+        rescue
+          # broker is dead but we have a stale pid file
+          File.delete(pidFile)
+          startAndCreatePid()
+        end
+      else
+        # Broker is not running and there is no file
+        startAndCreatePid()
+      end 
+    end
+  
+    def startAndCreatePid()
+      pid = fork
+      exec("#{Nutella.config["broker_dir"]}/startup") if pid.nil?  
+    end
+  
+    def createBotsConfig
+      botsconfig = Nutella.config.to_h
+      botsconfig.delete(:runs)
+      botsconfig[:prj_name] = Nutella.currentProject.config["name"]
+      File.open("#{@prj_dir}/.botsconfig.json", "w") do |f|
+        f.write(JSON.pretty_generate(botsconfig))
+      end
+    end
+  
+    def deleteBotsConfig
+      File.delete("#{@prj_dir}/.botsconfig.json") if File.exist?("#{@prj_dir}/.botsconfig.json")
+    end
+  
+   
+  end
+  
+end
+