pantry 0.0.0 → 0.1.0

data/dist/upstart/pantry-client.conf

@@ -0,0 +1,12 @@
+# /etc/init/pantry-client.conf
+# Upstart script for the Pantry Client
+
+description "Pantry Client"
+
+start on runlevel [2345]
+stop on runlevel [06]
+
+respawn
+respawn limit 5 10
+
+exec pantry-client -c /etc/pantry/client.yml

data/dist/upstart/pantry-server.conf

@@ -0,0 +1,12 @@
+# /etc/init/pantry-server.conf
+# Upstart script for the Pantry Server
+
+description "Pantry Server"
+
+start on runlevel [2345]
+stop on runlevel [06]
+
+respawn
+respawn limit 5 10
+
+exec pantry-server -c /etc/pantry/server.yml

data/doc/message_packet.dot

@@ -0,0 +1,19 @@
+digraph message {
+  node [shape=record];
+  rankdir = LR;
+
+  subgraph cluster_zmq {
+    label = "ZMQ";
+    labeljust = right;
+    body [shape=record width=2 label="Stream |<metadata> Metadata | body[0] | body[1] | ..."];
+  }
+
+  subgraph cluster_metadata {
+    label = "JSON Metadata";
+    labeljust = right;
+
+    metadata [shape=record width=2 label="<top> Type | Source | Response\nRequired?"];
+  }
+
+  body:metadata -> metadata:top;
+}

data/doc/network_topology.dot

@@ -0,0 +1,42 @@
+digraph pantry {
+  rankdir = LR;
+  color = black;
+  splines = ortho;
+  node [shape=rectangle];
+
+  subgraph cluster_server {
+    label = "Pantry Server";
+    labeljust = left;
+    edge [style=dashed];
+
+    server     [label="Server"];
+    publish    [label="PUB"];
+
+    server_dealer [label="ROUTER"];
+
+    server -> publish;
+    server -> server_dealer [dir=back];
+  }
+
+  subgraph cluster_client {
+    label = "Pantry Client";
+    labeljust = right;
+    edge [style=dashed];
+
+    client        [label="Client"];
+    subscribe     [label="SUB"];
+    provisioning  [label="Chef"];
+    shell         [label="Shell"];
+
+    client_dealer [label="DEALER"];
+
+    client     -> provisioning [dir=both];
+    client     -> shell        [dir=both];
+
+    subscribe     -> client;
+    client_dealer -> client [dir=back];
+  }
+
+  server_dealer -> client_dealer [dir=back];
+  publish       -> subscribe;
+}

data/lib/celluloid_zmq_patches.rb

@@ -0,0 +1,16 @@
+# Monkey Patch Celluloid::ZMQ to allow pass through
+# of direct setsockopt calls, so we can configure sockets
+# as we need to
+
+module Celluloid
+  module ZMQ
+    class Socket
+      def set(*args)
+        unless ::ZMQ::Util.resultcode_ok? @socket.setsockopt(*args)
+          raise IOError, "couldn't set value: #{::ZMQ::Util.error_string}"
+        end
+      end
+    end
+  end
+end
+

data/lib/opt_parse_plus.rb

@@ -0,0 +1,184 @@
+require 'optparse'
+
+class OptParsePlus
+
+  attr_reader :options, :summary
+
+  class OptionsFound < Hash
+    attr_accessor :command_found
+
+    # Let these options be queried by a string key or symbol
+    # key equally.
+    def [](key)
+      super ||
+        (key.is_a?(Symbol) && super(key.to_s)) ||
+        (key.is_a?(String) && super(key.to_sym))
+    end
+  end
+
+  def initialize(parent = nil)
+    @parent = parent || self
+    @parser = OptionParser.new
+    @options = OptionsFound.new
+    @commands = {}
+    @summary = ""
+
+    add_default_help
+  end
+
+  def add_options(&block)
+    instance_exec(&block)
+  end
+
+  def add_command(command_name, &block)
+    command_parser = OptParsePlus.new(self)
+
+    base_command = base_command_name(command_name.to_s)
+    rest = command_name.gsub(base_command, '')
+
+    command_parser.banner "Usage: #$0 #{base_command} [options]#{rest}"
+    command_parser.add_options(&block) if block_given?
+    @commands[base_command] = command_parser
+  end
+
+  def option(*arguments)
+    argument_name = parse_argument_name(arguments)
+    @parser.on(*arguments) do |arg|
+      @options[argument_name] = arg
+    end
+  end
+
+  def banner(message)
+    @parser.banner = message
+  end
+
+  def group(group_name = nil)
+    if group_name
+      @group = group_name
+    else
+      @group
+    end
+  end
+
+  def description(message)
+    @summary = clean_up_white_space(message)
+    @parser.separator("")
+    @parser.separator(@summary)
+    @parser.separator("")
+  end
+
+  def set(key, value)
+    @options[key] = value
+  end
+
+  def parse!(command_line)
+    @parser.order!(command_line)
+    final = @options
+
+    next_token = command_line.first
+
+    if command_parser = @commands[next_token]
+      command_line.shift
+      command_parser.parse!(command_line)
+
+      final.command_found = next_token
+      final.merge!({
+        next_token => command_parser.options
+      })
+    end
+
+    final
+  end
+
+  def help
+    help_parts   = []
+    help_parts << @parser.to_s
+
+    if @commands.any?
+      help_parts << ["Known Commands", ""]
+      command_list = group_and_sort_command_help
+
+      command_list.each do |cmd_line|
+        help_parts << cmd_line
+      end
+
+      help_parts << ""
+    end
+
+    help_parts << ""
+    help_parts.flatten.join("\n")
+  end
+
+  protected
+
+  def clean_up_white_space(message)
+    message.split("\n").map(&:strip).join("\n")
+  end
+
+  def add_default_help
+    @parser.on_tail('-h', '--help', 'Show this help message') do
+      puts help
+      @parent.set('help', true)
+    end
+  end
+
+  def base_command_name(command_string)
+    command_string.split(/\s/).first
+  end
+
+  def parse_argument_name(arguments)
+    full_name_arg = arguments.select {|a| a =~ /\A--/ }.first
+    full_name_arg.split(/\s/).first.gsub("--", "")
+  end
+
+  def group_and_sort_command_help
+    grouped_commands = Hash.new {|hash, key| hash[key] = []}
+
+    @commands.each do |command_name, parser|
+      grouped_commands[parser.group] << [command_name, parser]
+    end
+
+    command_list = []
+    sorted_group_names = grouped_commands.keys.sort {|a, b| a.to_s <=> b.to_s }
+    sorted_group_names.each do |group_name|
+      command_list << build_help_for_command_group(group_name, grouped_commands[group_name])
+    end
+
+    command_list.flatten(1)
+  end
+
+  def build_help_for_command_group(group_name, group_commands)
+    command_list = []
+
+    if group_name
+      command_list << nil
+      command_list << "#{group_name} commands"
+      command_list << nil
+    end
+
+    command_list + generate_short_help_for_commands(group_commands)
+  end
+
+  def generate_short_help_for_commands(group_commands)
+    longest_command_length = 0
+    group_commands.each do |(command_name, _)|
+      longest_command_length = command_name.length if command_name.length > longest_command_length
+    end
+    # Give ourselves a small buffer between command and summary
+    longest_command_length += 3
+
+    sorted_group_commands = group_commands.sort {|a, b| a[0] <=> b[0]}
+    sorted_group_commands.map do |(command_name, parser)|
+      sprintf(
+        "%-#{longest_command_length}s %s",
+        command_name,
+        first_line_of_summary(parser)
+      )
+    end
+  end
+
+  def first_line_of_summary(parser)
+    parser.summary.split("\n").first
+  end
+
+end

data/lib/pantry.rb

@@ -0,0 +1,197 @@
+require 'celluloid'
+require 'celluloid/zmq'
+require 'json'
+require 'logger'
+require 'pathname'
+require 'rubygems'
+require 'safe_yaml/load'
+require 'securerandom'
+require 'socket'
+require 'syslog/logger'
+require 'tempfile'
+require 'open3'
+require 'yaml'
+
+require 'opt_parse_plus'
+require 'celluloid_zmq_patches'
+
+require 'pantry/version'
+require 'pantry/ui'
+require 'pantry/config'
+require 'pantry/logger'
+require 'pantry/message'
+require 'pantry/command_line'
+require 'pantry/file_editor'
+
+require 'pantry/command'
+require 'pantry/multi_command'
+require 'pantry/command_handler'
+
+require 'pantry/commands/echo'
+require 'pantry/commands/edit_application'
+require 'pantry/commands/update_application'
+require 'pantry/commands/status'
+require 'pantry/commands/register_client'
+require 'pantry/commands/upload_file'
+require 'pantry/commands/sync_directory'
+require 'pantry/commands/download_directory'
+require 'pantry/commands/create_client'
+
+require 'pantry/communication'
+require 'pantry/communication/serialize_message'
+require 'pantry/communication/server'
+require 'pantry/communication/client'
+require 'pantry/communication/client_filter'
+require 'pantry/communication/wait_list'
+
+require 'pantry/communication/security/null_security'
+require 'pantry/communication/security/curve_security'
+require 'pantry/communication/security/curve_key_store'
+require 'pantry/communication/security/authentication'
+require 'pantry/communication/security'
+
+require 'pantry/communication/reading_socket'
+require 'pantry/communication/writing_socket'
+require 'pantry/communication/publish_socket'
+require 'pantry/communication/subscribe_socket'
+require 'pantry/communication/receive_socket'
+require 'pantry/communication/send_socket'
+
+require 'pantry/communication/file_service'
+require 'pantry/communication/file_service/file_progress'
+require 'pantry/communication/file_service/receive_file'
+require 'pantry/communication/file_service/send_file'
+
+require 'pantry/client_info'
+require 'pantry/client_registry'
+
+require 'pantry/client'
+require 'pantry/server'
+require 'pantry/cli'
+
+module Pantry
+
+  # Default identity of a Server, so as to help differentiate where
+  # messages are coming from.
+  SERVER_IDENTITY = ""
+
+  ##
+  # Various exceptions Pantry can raise
+  ##
+
+  # A command is expecting a certain option
+  class MissingOption < Exception; end
+
+  # Thrown when trying to add a non Pantry::Command class as a Pantry command
+  class InvalidCommandError < Exception; end
+
+  # Thrown when trying to add a Command that has the same message_type
+  # as a Command already registered
+  class DuplicateCommandError < Exception; end
+
+  # The root of all stored Pantry data for this Server/Client
+  # Uses Pantry.config.root_dir
+  def root(config = Pantry.config)
+    Pathname.new(config.root_dir)
+  end
+
+  # Update the process's proc title with the given string
+  def set_proc_title(title)
+    $0 = title
+  end
+
+  # Calculate the checksum of a file at the given path
+  def file_checksum(file_path)
+    Digest::SHA256.file(file_path).hexdigest
+  end
+
+  # Register a command object class to be handled only by Clients
+  def add_client_command(command_class)
+    ensure_proper_command_class(command_class)
+    check_for_duplicates(client_commands, command_class)
+
+    client_commands << command_class
+  end
+
+  # Register a command object class to be handled only by the Server
+  def add_server_command(command_class)
+    ensure_proper_command_class(command_class)
+    check_for_duplicates(server_commands, command_class)
+
+    server_commands << command_class
+  end
+
+  # Return the list of known Client command classes
+  def client_commands
+    @client_commands ||= []
+  end
+
+  # Return the list of known Server command classes
+  def server_commands
+    @server_commands ||= []
+  end
+
+  # Return all known commands
+  def all_commands
+    [client_commands, server_commands].flatten
+  end
+
+  def ensure_proper_command_class(command_class)
+    unless command_class.is_a?(Class)
+      raise Pantry::InvalidCommandError.new("Expected a Class, got an #{command_class.class}")
+    end
+
+    unless command_class.ancestors.include?(Pantry::Command)
+      raise Pantry::InvalidCommandError.new("Expected a class that's a subclass of Pantry::Command")
+    end
+  end
+
+  def check_for_duplicates(command_list, command_class_to_add)
+    known_commands = command_list.map(&:message_type)
+    if known_commands.include?(command_class_to_add.message_type)
+      raise Pantry::DuplicateCommandError.new("Command with type #{command_class_to_add.message_type} already registered")
+    end
+  end
+
+  # Find all installed Pantry plugin gems.
+  # Plugins are defined as gems who contain a file named "pantry/init.rb".
+  def load_plugins
+    Gem.find_latest_files("pantry/init.rb").each do |path|
+      begin
+        gem_path = path.gsub("#{Gem.dir}/gems/", '')
+        Pantry.logger.debug("Installing plugin from #{gem_path}")
+        require path
+      rescue Exception => ex
+        Pantry.logger.warn("Unable to load plugin at #{gem_path}, #{ex.message}")
+      end
+    end
+  end
+
+  extend self
+end
+
+Celluloid.exception_handler do |exception|
+  Pantry.logger.error("Exception thrown: #{exception.inspect}")
+end
+
+SafeYAML::OPTIONS[:default_mode]        = :safe
+SafeYAML::OPTIONS[:deserialize_symbols] = false
+
+####################
+# Command Registry #
+####################
+
+## Client Commands
+
+Pantry.add_client_command(Pantry::Commands::Echo)
+
+## Server Commands
+
+Pantry.add_server_command(Pantry::Commands::EditApplication)
+Pantry.add_server_command(Pantry::Commands::UpdateApplication)
+Pantry.add_server_command(Pantry::Commands::Status)
+Pantry.add_server_command(Pantry::Commands::RegisterClient)
+Pantry.add_server_command(Pantry::Commands::DownloadDirectory)
+Pantry.add_server_command(Pantry::Commands::CreateClient)
+
+Pantry.load_plugins