proctor 0.0.3 → 0.0.4

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format progress
+--fail-fast

data/TODO

@@ -0,0 +1,28 @@
+Next Steps:
+
+- Finish use cases
+- Refactor
+
+Use Cases:
+- Manager: upstart, monit, foreman
+- Services: showtime, showlog
+- Pid files to shared/pid
+- Logging to log directory
+
+Features:
+- Multi-level template import
+- Add 'generate' command [-p (proctorfile) -t (templates)]
+- Enforce unique asset names
+- Global option '-d EXPORT_DIRECTORY'
+- Global option '-t TEMPLATE_DIRECTORY'
+
+- Full-screen status demon
+- Asset inheritance "extends: XXX"
+- Asset override:   "manager.setting: YYY"
+- Tab completion / 1st level / 2nd level / 3rd level
+- Check should deep-check all Proctorfiles
+- Better ERB error messages
+
+Docco:
+- intro video
+- github website

data/bin/proctor

@@ -10,171 +10,141 @@ require 'proctor'
 include GLI
 include Proctor
 
-APP_CONFIG=
-
 # ---- global options ----------------------------------------------------
 
 version Proctor::VERSION
 program_desc 'proctor - an application process manager'
 
 desc 'Select Proctorfile'
-default_value 'Proctorfile'
 arg_name 'PROCTORFILE'
 flag [:f,:proctorfile]
 
 # ----- commands ---------------------------------------------------------
 
-desc 'Validates your application Proctorfile'
-command :check do |c|
+desc 'Lists handles, names and paths for proctor assets'
+long_desc <<-EOF
+Lists the name or path of each Proctor asset.  Asset types include Templates,
+AppFiles, Managers, Services, and Nodes.  Managers, Services and Nodes are
+defined within an AppFile.  AppFile values from multiple files are merged
+together.  When there is a conflict, the last value take precedence.
+EOF
+command :asset_list do |c|
   c.action do |global,options,args|
-    puts "OK"
+    Command::AssetListCmd.new(global, options, args).list
   end
 end
 
-desc 'Removes exported proctor assets'
+desc 'Shows content of a proctor asset'
 long_desc <<-EOF
-Requires a NODE and a MANAGER name.  To see
-all NODEs and MANAGERs, use 'proctor list'.
+Displays a raw asset (Template, AppFile, Manager, Service, Node)
+to the console.  View asset handles using 'proctor list'.  (asset
+handles are three character strings at the start of each line)
 EOF
-arg_name "NODE MANAGER"
-command :cleanup do |c|
+arg_name 'HANDLE'
+command :asset_show do |c|
   c.action do |global,options,args|
-    puts "CLEANUP"
+    Command::AssetShowCmd.new(global, options, args).show
   end
 end
 
-desc 'Exports assets to a management tool'
+desc 'Removes exported proctor assets'
 long_desc <<-EOF
-Requires a NODE and a MANAGER name.  To see
-all NODEs and MANAGERs, use 'proctor list'.
+Requires a MANAGER and a NODE name.  To see
+all MANAGERs and NODEs , use 'proctor list'.
 EOF
-arg_name "NODE MANAGER"
-command :export do |c|
+arg_name "MANAGER NODE"
+command :file_cleanup do |c|
   c.action do |global,options,args|
-    puts "EXPORT"
+    Command::FileCleanupCmd.new(global, options, args).cleanup
   end
 end
 
-desc 'Lists handles, names and paths for proctor assets'
+desc 'Exports assets to a management tool'
 long_desc <<-EOF
-Lists the name or path of each Proctor asset.  Asset types include Templates,
-AppFiles, Managers, Services, and Nodes.  Managers, Services and Nodes are
-defined within an AppFile.
-
-AppFile values from multiple files are merged together.  When there is a conflict,
-the last value take precedence.
+Requires a MANAGER and a NODE name.  To see
+all MANAGERs and NODEs , use 'proctor list'.
 EOF
-command :list do |c|
-  opt_arr = %w(templates appfiles managers services manifest all)
-  opt_str = opt_arr.join('|')
-  c.desc "One of: [#{opt_str}]"
-  c.default_value 'all'
-  c.arg_name 'ASSET_TYPE'
-  c.flag [:t, :type]
+arg_name "MANAGER NODE"
+command :file_export do |c|
   c.action do |global,options,args|
-    unless opt_arr.include?(options[:type])
-      raise "unrecognized type (#{options[:type]}) must be one of [#{opt_str}]"
-    end
-    Presenter::List.new(global, options, args).render
+    Command::FileExportCmd.new(global, options, args).export
   end
 end
 
-desc 'Renders an ERB template to the console'
-arg_name 'MANAGER SERVICE'
+desc 'Renders a Group-ERB template to the console'
+arg_name 'MANAGER NODE'
 long_desc <<-EOF
-Requires a MANAGER and a SERVICE.  To see all
-MANAGERs and SERVICEs, use 'proctor list'.
+Requires a MANAGER and a NODE.  To see all
+MANAGERs and NODEs, use 'proctor asset_list'.
 EOF
-command :render do |c|
+command :render_group do |c|
   c.action do |global,options,args|
-    raise "usage 'render ROLE MANAGER'" unless args.length == 2
-
-    Presenter::Render.new(global, options, args).render
+    Command::RenderGroupCmd.new(global, options, args).render
   end
 end
 
-desc 'Shows content of a proctor asset'
+desc 'Renders a Service-ERB template to the console'
+arg_name 'MANAGER SERVICE'
 long_desc <<-EOF
-Displays a raw asset (Template, AppFile, Manager, Service, Node)
-to the console.  View asset handles using 'proctor list'.  (asset
-handles are three character strings at the start of each line)
+Requires a MANAGER and a SERVICE.  To see all
+MANAGERs and SERVICEs, use 'proctor asset_list'.
 EOF
-arg_name 'HANDLE'
-command :show do |c|
+command :render_service do |c|
   c.action do |global,options,args|
-    raise "need a handle!" if args.length != 1
-    Presenter::Show.new(global, options, args).show
+    Command::RenderServiceCmd.new(global, options, args).render
   end
 end
 
 desc 'Starts the application'
-arg_name "NODE MANAGER"
+arg_name 'MANAGER NODE'
 long_desc <<-EOF
 Requires a NODE and a MANAGER name.  To see
-all NODEs and MANAGERs, use 'proctor list'.
+all NODEs and MANAGERs, use 'proctor asset_list'.
 EOF
 command :start do |c|
-
   c.action do |global_options,options,args|
-    puts "START"
+    Command::StartCmd.new(global_options, options, args).start
   end
 end
 
 desc 'Stops the application'
-arg_name "NODE MANAGER"
+arg_name 'MANAGER NODE'
 long_desc <<-EOF
-Requires a NODE and a MANAGER name.  To see
-all NODEs and MANAGERs, use 'proctor list'.
+Requires a MANAGER and a NODE name.  To see
+all MANAGERs and NODEs, use 'proctor asset_list'.
 EOF
 command :stop do |c|
-  c.desc 'Describe a switch to start'
-  c.switch :s
-
-  c.desc 'Describe a flag to start'
-  c.default_value 'default'
-  c.flag :f
   c.action do |global_options,options,args|
-    puts "I AM IN STOP"
-    # raise "that command made no sense"
+    raise "Usage 'stop MANAGER NODE'" unless args.length == 2
+    puts "STOP"
   end
 end
 
 desc 'Displays the application status'
-arg_name "NODE MANAGER"
+arg_name 'MANAGER NODE'
 long_desc <<-EOF
-Requires a NODE and a MANAGER name.  To see
-all NODEs and MANAGERs, use 'proctor list'.
+Requires a MANAGER and a NODE name.  To see
+all MANAGERs and NODEs, use 'proctor asset_list'.
 EOF
 command :status do |c|
-  c.desc 'Describe a switch to start'
-  c.switch :s
-
-  c.desc 'Describe a flag to start'
-  c.default_value 'default'
-  c.flag :f
   c.action do |global,options,args|
-    puts "I AM IN STATUS"
+    raise "Usage 'status MANAGER NODE'" unless args.length == 2
+    puts "STATUS"
   end
 end
 
-
 # ----- pre/post --------------------------------------------------------------
 
 pre do |global,command,options,args|
-  options[:app_config] = AppConfig.load(global)      unless command.nil? || command.name == :help
-  options[:templates]  = TemplateConfig.load(global) unless command.nil? || command.name == :help
-
-  # Return true to proceed; false to abort and not call the chosen command
-  # Use skips_pre before a command to skip this block on that command only
+  params = [global, options, args]
+  options['env'] = Proctor::Config::Env.new(params)
   true
 end
 
 post do |global,command,options,args|
-  # Use skips_post before a command to skip this block on that command only
 end
 
 on_error do |exception|
-  # return false to skip default error handling
   true
 end
 

data/bin/showlog

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+cmd = "tail -f /var/log/syslog"
+
+system cmd

data/bin/showtime

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+cmd = "while [ true ] ; do date ; sleep 5 ; done"
+
+system cmd

data/lib/proctor/command/asset_list_cmd.rb

@@ -0,0 +1,56 @@
+module Proctor
+  module Command
+    class AssetListCmd
+
+      def initialize(global, options, args)
+        @global  = global
+        @options = options
+        @args    = args
+        @env     = @options['env']
+      end
+
+      def gen_list
+        list_all
+      end
+
+      def list
+        puts gen_list
+      end
+
+      private
+
+      def format_list(list)
+        list.map {|item| "#{item.handle}: #{item.name}\n"}.join
+      end
+
+      def list_templates
+        "[Templates]\n" + format_list(@env.template_files.all)
+      end
+
+      def list_appfiles
+        "[AppFiles]\n" + format_list(@env.app_files.all)
+      end
+
+      def list_managers
+        "[Managers]\n" + format_list(@env.managers.all)
+      end
+
+      def list_services
+        "[Services]\n" + format_list(@env.services.all)
+      end
+
+      def list_nodes
+        "[Nodes]\n" + format_list(@env.nodes.all)
+      end
+
+      def list_all
+        list_templates +
+        list_appfiles +
+        list_managers +
+        list_services +
+        list_nodes
+      end
+
+    end
+  end
+end

data/lib/proctor/{presenter/show.rb → command/asset_show_cmd.rb}

@@ -1,11 +1,16 @@
+require_relative './helpers/command'
+
 module Proctor
-  module Presenter
-    class Show
+  module Command
+    class AssetShowCmd
+
+      include Helpers::Command
 
       def initialize(global, options, args)
         @global  = global
         @options = options
         @args    = args
+        check_number_of_args(args, 1, 'show HANDLE')
         validate_handle(args[0])
       end
 

data/lib/proctor/command/file_cleanup_cmd.rb

@@ -0,0 +1,81 @@
+require_relative "./helpers/command"
+require_relative "../resource/erb"
+require_relative "../resource/lookup"
+
+module Proctor
+  module Command
+    class FileCleanupCmd
+
+      include Helpers::Command
+      include Proctor::Resource::Erb
+      include Proctor::Resource::Lookup
+
+      def initialize(global, options, args)
+        @env       = options['env']
+        @manager   = args[0]
+        @node      = args[1]
+        opts = {'MANAGERS' => @env.managers.names, 'NODES' => @env.nodes.names}
+        check_number_of_args(args, 2, 'cleanup MANAGER NODE', opts)
+      end
+
+      def cleanup
+        manager = lookup_valid_manager(@manager, @env)
+        #update_manager_with_cl_options(manager)
+        use_node = manager.data["use_node_template"] # default = false
+        use_service = manager.data["use_service_template"]
+        use_service = true if use_service.nil?
+        node    = lookup_valid_node(@node, @env)
+        env = @env
+        manager.data.each_pair do |k,v|
+          manager.data[k] = ERB.new(v).result(binding) if v.class == String
+        end
+        if use_node
+          services = lookup_valid_services_hash(node.name, @env)
+          template = lookup_valid_group_template(manager.name, node.name, @env)
+          remove_node_text_from_disk(manager, node, @env)
+        end
+        if use_service
+          node.services.each do |service_name|
+            service  = lookup_valid_service(service_name, @env)
+            template = lookup_valid_service_template(manager.name, service.name, @env)
+            remove_service_text_from_disk(manager, service, @env)
+          end
+        end
+      end
+
+      private
+
+      def remove_service_text_from_disk(manager, service, env)
+        export_dir  = manager.data["export_directory"]
+        export_file = manager.data["service_filename"] || env.app['name']
+        export_path = "#{export_dir}/#{export_file}"
+        begin
+          system "rm -f #{export_path}" if File.exist?(export_path)
+        rescue
+          msg = "couldn't remove service file (#{export_path})"
+          raise FileRemoveError, msg
+        end
+        puts "Removed service template for #{manager.name}/#{service.name} from #{export_path}"
+      end
+
+      def remove_node_text_from_disk(manager, node, env)
+        export_dir  = manager.data["export_directory"]
+        export_file = manager.data["node_filename"] || env.app['name']
+        export_path = "#{export_dir}/#{export_file}"
+        begin
+          system "rm -f #{export_path}" if File.exist?(export_path)
+        rescue
+          msg = "couldn't remove node file (#{export_path})"
+          raise FileRemoveError, msg
+        end
+        puts "Removed group template for #{manager.name}/#{node.name} from #{export_path}"
+      end
+
+    end
+
+    class FileRemoveError < RuntimeError
+    end
+
+  end
+end
+

data/lib/proctor/command/file_export_cmd.rb

@@ -0,0 +1,79 @@
+require_relative "./helpers/command"
+require_relative "../resource/erb"
+require_relative "../resource/lookup"
+
+module Proctor
+  module Command
+    class FileExportCmd
+
+      include Helpers::Command
+      include Proctor::Resource::Erb
+      include Proctor::Resource::Lookup
+
+      def initialize(global, options, args)
+        @env       = options['env']
+        @manager   = args[0]
+        @node      = args[1]
+        opts = {'MANAGERS' => @env.managers.names, 'NODES' => @env.nodes.names}
+        check_number_of_args(args, 2, 'file_export MANAGER NODE', opts)
+      end
+
+      def export
+        manager = lookup_valid_manager(@manager, @env)
+        #update_manager_with_cl_options(manager)
+        node = lookup_valid_node(@node, @env)
+        if manager.data["group_data"]
+          services = lookup_valid_services_hash(node.name, @env)
+          template = lookup_valid_group_template(manager.name, node.name, @env)
+          text = render_group_template(manager, node, services, template, @env)
+          write_group_text_to_disk(manager, node, text, @env)
+        end
+        if manager.data["service_data"]
+          node.services.each do |service_name|
+            service  = lookup_valid_service(service_name, @env)
+            template = lookup_valid_service_template(manager.name, service.name, @env)
+            text = render_service_template(manager, service, template, @env)
+            write_service_text_to_disk(manager, service, text, @env)
+          end
+        end
+        nil
+      end
+
+      private
+
+      def write_service_text_to_disk(manager, service, text, env)
+        export_dir  = manager.data["export_directory"]
+        export_file = manager.data["service_filename"] || env.app['name']
+        export_path = "#{export_dir}/#{export_file}"
+        begin
+          system "mkdir -p #{export_dir}"
+          File.open("#{export_dir}/#{export_file}", 'w') {|f| f.puts text}
+        rescue
+          msg = "couldn't open export file (#{export_dir}/#{export_file})"
+          raise FileWriteError, msg
+        end
+        #puts "Exported service template for #{manager.name}/#{service.name} to #{export_path}"
+      end
+
+      def write_group_text_to_disk(manager, node, text, env)
+        export_dir  = manager.data["export_directory"]
+        export_file = manager.data["group_data"]["conf_filename"] || env.app['name']
+        export_path = "#{export_dir}/#{export_file}"
+        begin
+          system "mkdir -p #{export_dir}"
+          File.open("#{export_dir}/#{export_file}", 'w') {|f| f.puts text}
+        rescue
+          msg = "couldn't open export file (#{export_dir}/#{export_file})"
+          raise FileWriteError, msg
+        end
+        #puts "Exported group template for #{manager.name}/#{node.name} to #{export_path}"
+      end
+
+    end
+
+    class FileWriteError < RuntimeError
+    end
+
+  end
+end
+