appforce-spawn 0.5.1

data/lib/appforce/spawn/api.rb

@@ -0,0 +1,4 @@
+require 'appforce/config'
+require 'appforce/logger'
+require 'appforce/spawn/exceptions'
+require 'appforce/spawn/api/call'

data/lib/appforce/spawn/api/call.rb

@@ -0,0 +1,217 @@
+module Appforce
+  module Spawn
+    module Api
+      class Call
+        require 'highline/import'
+
+        def self.get_clients
+          url = "#{base_api_url}client/list?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+        
+        def self.get_hosts(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+
+          url = "#{client_url(opts[:client_api_name])}/hosts?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_active_users(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+
+          url = "#{client_url(opts[:client_api_name])}/users/active.yml?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_inactive_users(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+
+          url = "#{client_url(opts[:client_api_name])}/users/inactive.yml?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_vars(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+          
+          url = "#{client_url(opts[:client_api_name])}/vars.yml?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_main_scout(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+          
+          url = "#{client_url(opts[:client_api_name])}/scout.yml?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_private_key(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+
+          url = "#{client_url(opts[:client_api_name])}/private_key.pem?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)   
+        end
+
+        def self.get_host_scout_vars(*args)
+          opts = args[1]
+          unless opts[:host_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Host API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Host API Name"
+          end
+          
+          url = "#{host_url(opts[:host_api_name])}/scout.yml?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.get_all_host_data(*args)
+          opts = args[1]
+          unless opts[:client_api_name]
+            logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+            raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+          end
+          
+          url = "#{client_url(opts[:client_api_name])}/all_host_data.json?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call(url)
+        end
+
+        def self.list_clients
+          resp = get_clients
+          puts Appforce::Logger.header("Client List")
+          resp.each do |item|
+            printf " Client: %-16s API Name: %s\n", item['name'], item['api_name']
+          end
+          puts Appforce::Logger.footer
+        end
+
+        def self.list_hosts(*args)
+          resp = get_all_host_data(*args)
+          puts Appforce::Logger.header("Host List")
+          i = 1
+          resp.each do |item|
+            printf " #{i} - '%s' host: %s ip: %s\n", item['desc'], item['hostname'], item['ip']
+            i += 1
+          end
+          puts Appforce::Logger.footer
+          resp
+        end
+
+        def self.ssh_to_host(*args)
+          hosts   = list_hosts(*args)
+          input   = HighLine.ask("\nWhich host to ssh to? ", Integer) { |q| q.in = 1..hosts.count }
+          machine = hosts[input - 1]
+          
+          $stderr.print "\n"
+          logger.info "Establishing SSH seesion as '#{machine['username']}' to #{machine['desc']}"
+          logger.debug "SSH command: #{ssh_cmd(machine)}"
+
+          pid = fork {
+            exec ssh_cmd(machine)
+          }
+          Process.wait pid
+          
+          $stderr.print "\n"
+          logger.info "SSH session terminated."
+        end
+
+        def self.ping(*args)
+          url = "#{base_api_url}ping?#{token_param}"
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          make_api_call("#{base_api_url}ping?#{token_param}")
+        end
+
+        def self.latest_version(*args)
+          url = rubygem_latest_version_url
+          logger.debug "[#{self.name}##{__method__.to_s}] URL: #{url}"
+          resp = make_api_call(url)
+          resp['version']
+        end
+        
+        private
+
+        def self.ssh_cmd(info)
+          "ssh #{info['username']}@#{info[info['method']]}"
+        end
+
+        def self.base_api_url
+          "#{Appforce::Config.config.api_host}/#{Appforce::Config.config.api_version}/"
+        end
+
+        def self.client_url(client_api_name)
+          "#{base_api_url}client/#{client_api_name}"
+        end
+
+        def self.host_url(host_api_name)
+          "#{base_api_url}host/#{host_api_name}"
+        end
+
+        def self.token_param
+          "token=#{Appforce::Config.config.api_token}"
+        end
+
+        def self.rubygem_latest_version_url
+          "https://rubygems.org/api/v1/versions/appforce-spawn/latest.json"
+        end
+        
+        def self.make_api_call(url)
+          begin
+            resp = HTTParty.get(url)
+          rescue
+            logger.fatal "[#{self.name}##{__method__.to_s}] Appforce::Spawn::API::CallFailure - API Failed to Return for URL: #{url}"
+            raise Appforce::Spawn::API::CallFailure, "API Failed to Return."
+          end
+
+          case resp.code
+            when 200
+              resp
+            when 401
+              logger.fatal "[#{self.name}##{__method__.to_s}] Appforce::Spawn::API::UnauthorizedAccess -- Invalid API Access Token -- URL: #{url}"
+              raise Appforce::Spawn::API::UnauthorizedAccess, "Invalid API Access Token"
+            when 404
+              logger.fatal "[#{self.name}##{__method__.to_s}] -- Appforce::Spawn::API::NotFound -- API Route Not Found -- URL: #{url}"
+              raise Appforce::Spawn::API::NotFound, "API Route Not Found"
+            when 500...600
+              logger.fatal "[#{self.name}##{__method__.to_s}] -- Appforce::Spawn::API::Unavailable -- API Service Unavailable -- URL: #{url}"
+              raise Appforce::Spawn::API::Unavailable, "API Service Unavailable"
+          end
+        end
+
+        def self.logger
+          Appforce::Logger.logger
+        end
+
+      end
+    end
+  end
+end

data/lib/appforce/spawn/exceptions.rb

@@ -0,0 +1,30 @@
+module Appforce
+  module Spawn
+
+    class Error < StandardError; end
+
+    class UnknownClient < Error; end
+
+    class ConfigFileParseError < Error; end
+
+    class MissingParameters < Error; end
+
+    class MissingFile < Error; end
+
+    class MissingDependency < Error; end
+
+    class NotYetImplemented < Error; end
+
+    module API
+      class CallFailure < Error; end
+
+      class UnauthorizedAccess < Error; end
+
+      class NotFound < Error; end
+
+      class Unavailable < Error; end
+
+      class NotYetImplemented < Error; end
+    end
+  end
+end

data/lib/appforce/spawn/runner.rb

@@ -0,0 +1,143 @@
+module Appforce
+  module Spawn
+    class Runner
+      require 'open3'
+
+      MINIMUM_ANSIBLE_VERSION = "1.8.3"
+
+      def self.run_playbook
+        logger.info "[#{self.name}##{__method__.to_s}] Start running playbook."
+        logger.debug "[#{self.name}##{__method__.to_s}] ansible_command: #{ansible_command}"
+        system "#{ansible_command}"
+        logger.info "[#{self.name}##{__method__.to_s}] Playbook run complete."
+      end
+
+      def self.run_dryrun
+        logger.info "[#{self.name}##{__method__.to_s}] Start running dry-run of playbook."
+        logger.debug "[#{self.name}##{__method__.to_s}] ansible_dryrun_command: #{ansible_command} --check --diff"
+        system "#{ansible_command} --check --diff"
+        logger.info "[#{self.name}##{__method__.to_s}] Playbook dry-run complete."
+      end
+
+      def self.display_ansible_command
+        logger.info "[#{self.name}##{__method__.to_s}] Ansible command to run playbook for this Client is:\n -- #{ansible_command}"
+      end
+
+      def self.ansible_ping
+        logger.info "[#{self.name}##{__method__.to_s}] Start running ansible ping."
+        logger.debug "[#{self.name}##{__method__.to_s}] ansible_ping_command: #{ansible_ping_command} --check --diff"
+        system "#{ansible_ping_command}"
+        logger.info "[#{self.name}##{__method__.to_s}] Ansible ping complete."
+      end
+
+      def self.display_ansible_ping_command
+        logger.info "[#{self.name}##{__method__.to_s}] Ansible command to ping this Client is:\n -- #{ansible_ping_command}"
+      end
+
+      def self.can_run?
+        # validate stuff first
+        check_dependencies
+        unless File.exist?('./vars.yml')
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingFile -- Missing 'vars.yml' file"
+          raise Appforce::Spawn::MissingFile, "Missing 'vars.yml' file"
+        end
+        unless File.exist?('./hosts')
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingFile -- Missing 'hosts' file"
+          raise Appforce::Spawn::MissingFile, "Missing 'hosts' file"
+        end
+        unless File.exist?('./active_users.yml')
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingFile -- Missing 'active_users.yml' file"
+          raise Appforce::Spawn::MissingFile, "Missing 'active_users.yml' file"
+        end
+        unless File.exist?('./inactive_users.yml')
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingFile -- Missing 'inactive_users.yml' file"
+          raise Appforce::Spawn::MissingFile, "Missing 'inactive_users.yml' file"
+        end
+        true
+      end
+
+      def self.check_dependencies
+        # ansible install
+        unless ansible_installed?
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingDependency -- Missing 'ansible' executable."
+          raise Appforce::Spawn::Dependency, "Missing 'ansible' executable"
+        end
+
+        # ansible version
+        unless good_ansible_version?
+          str = `ansible --version`
+          version_str = /^ansible\s(\d+\.\d+\.\d+)$/.match(str)[1].tr('.','')
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingDependency -- Insufficient 'ansible' version: #{version_str} < #{MINIMUM_ANSIBLE_VERSION}"
+          raise Appforce::Spawn::Dependency, "Insufficient 'ansible' version: #{version_str} < #{MINIMUM_ANSIBLE_VERSION}"
+        end
+
+        # ansible rvm_io.rvm1-ruby galaxy install
+        unless rvm_galaxy_installed?
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingDependency -- Missing 'rvm_io.rvm1-ruby' galaxy role."
+          logger.info "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingDependency -- Run 'ansible-galaxy install rvm_io.rvm1-ruby' to install role"
+          raise Appforce::Spawn::Dependency, "Missing 'rvm_io.rvm1-ruby' galaxy role"
+        end
+
+        true
+      end
+
+      private
+
+      def self.ansible_installed?
+        ansible = `which ansible`
+        /ansible$/.match(ansible)
+      end
+
+      def self.good_ansible_version?
+        str = `ansible --version`
+        version_str = /^ansible\s(\d+\.\d+\.\d+)$/.match(str)[1].tr('.','')
+        return true if version_str.to_i >= MINIMUM_ANSIBLE_VERSION.tr('.','').to_i
+        nil
+      end
+
+      def self.rvm_galaxy_installed?
+        galaxy = `ansible-galaxy list`
+        /^-\srvm_io.rvm1-ruby,\sv1\.3/.match(galaxy)
+      end
+
+      def self.ansible_command
+        # ansible-playbook -i hosts site.yml --extra-vars="ansible_user={{ ansible_user }} users_file=./users.yml"
+        begin
+          vars = YAML::load(File.open('./vars.yml'))
+        rescue Exception => e
+          logger.fatal "[#{self.name}##{__method__.to_s}] Appforce::Spawn::Runner::VarsFileError"\
+            " -- 'vars.yml' file appears to be malformed -- #{e}"
+          raise e
+        end
+
+        if vars['ansible_private_key']
+          "ansible-playbook -i hosts site.yml --private-key=./private_key.pem --extra-vars='ansible_user=#{vars['ansible_user']} active_users_file=./active_users.yml inactive_users_file=./inactive_users.yml'"
+        else
+          "ansible-playbook -i hosts site.yml --extra-vars='ansible_user=#{vars['ansible_user']} active_users_file=./active_users.yml inactive_users_file=./inactive_users.yml'"
+        end
+      end
+
+      def self.ansible_ping_command
+        # ansible all -m ping -i hosts -u ansible
+        begin
+          vars = YAML::load(File.open('./vars.yml'))
+        rescue Exception => e
+          logger.fatal "[#{self.name}##{__method__.to_s}] Appforce::Spawn::Runner::VarsFileError"\
+            " -- 'vars.yml' file appears to be malformed -- #{e}"
+          raise e
+        end
+
+        if vars['ansible_private_key']
+          "ansible all -m ping -i hosts --private-key=./private_key.pem -u #{vars['ansible_user']}"
+        else
+          "ansible all -m ping -i hosts -u #{vars['ansible_user']}"
+        end
+      end
+
+      def self.logger
+        Appforce::Logger.logger
+      end
+
+    end
+  end
+end

data/lib/appforce/spawn/template.rb

@@ -0,0 +1,102 @@
+module Appforce
+  module Spawn
+    class Template
+      require 'fileutils'
+
+      def self.create_dirs(*args)
+        opts = args[1]
+        unless opts[:client_api_name]
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+          raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+        end
+        dir = "#{ansible_dest_path(opts[:client_api_name])}"
+        logger.info "[#{self.name}##{__method__.to_s}] Creating directory: #{dir}"
+        begin
+          FileUtils.mkdir(dir)
+        rescue Errno::EEXIST
+          logger.warn "[#{self.name}##{__method__.to_s}] Directory (#{dir}) already exists."
+        end
+      end
+
+      def self.copy_template(*args)
+        opts = args[1]
+        unless opts[:client_api_name]
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+          raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+        end
+        logger.info "[#{self.name}##{__method__.to_s}] Copying files from Template..."
+        FileUtils.cp_r("#{ansible_source_path}/.", "#{ansible_dest_path(opts[:client_api_name])}")
+      end
+
+      def self.download_files(*args)
+        opts = args[1]
+        unless opts[:client_api_name]
+          logger.error "[#{self.name}##{__method__.to_s}] Appforce::Spawn::MissingParameters -- Missing Client API Name"
+          raise Appforce::Spawn::MissingParameters, "Missing Client API Name"
+        end
+
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Hosts file for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_hosts(*args), "#{ansible_dest_path(opts[:client_api_name])}/hosts")
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Active Users file for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_active_users(*args), "#{ansible_dest_path(opts[:client_api_name])}/active_users.yml")
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Inactive Users file for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_inactive_users(*args), "#{ansible_dest_path(opts[:client_api_name])}/inactive_users.yml")
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Vars file for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_vars(*args), "#{ansible_dest_path(opts[:client_api_name])}/vars.yml")        
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Main Scout file for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_main_scout(*args), "#{ansible_dest_path(opts[:client_api_name])}/roles/scout/vars/main.yml")
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Scout Host Data for Client '#{opts[:client_api_name]}'"
+        write_to_file(Appforce::Spawn::Api::Call.get_private_key(*args), "#{ansible_dest_path(opts[:client_api_name])}/private_key.pem")
+        logger.info "[#{self.name}##{__method__.to_s}] Pulling Private Key Data for Client '#{opts[:client_api_name]}'"
+        File.chmod(0600, "#{ansible_dest_path(opts[:client_api_name])}/private_key.pem")
+
+        host_data = Appforce::Spawn::Api::Call.get_all_host_data(*args)
+        host_data.each do |host|
+          if host['scout'] == 'true'
+            filename = "#{host[host['method']]}.yml"
+            logger.info "[#{self.name}##{__method__.to_s}] Pulling Scout Host Data for Host '#{host[host['method']]}'"
+            args[1][:host_api_name] = host['id']
+            write_to_file(Appforce::Spawn::Api::Call.get_host_scout_vars(*args), "#{ansible_dest_path(opts[:client_api_name])}/roles/scout/vars/#{filename}")
+            args[1].delete(:host_api_name)
+          end
+        end
+
+      end
+
+      def self.run_path
+        Dir.pwd
+      end
+
+      def self.gem_path
+        File.expand_path(File.dirname(__FILE__))
+      end
+
+      def self.ansible_source_path
+        File.join(gem_path, '../../../ansible')
+      end
+
+      def self.ansible_dest_path(client_api_name)
+        "#{run_path}/#{client_api_name}"
+      end
+
+      def self.write_to_file(data, path)
+        begin
+          file = File.open(path, "w")
+          file.write(data) 
+        rescue IOError => e
+          logger.fatal "[#{self.name}##{__method__.to_s}] Exception writing to file '#{path}' -- #{e}"
+          raise e
+        ensure
+          file.close unless file == nil
+        end
+      end
+
+      private
+
+      def self.logger
+        Appforce::Logger.logger
+      end
+
+    end
+  end
+end