pbox 1.17.2

data/lib/rhc/context_helper.rb

@@ -0,0 +1,121 @@
+require 'rhc/git_helpers'
+
+module RHC
+  #
+  # Methods in this module should not attempt to read from the options hash
+  # in a recursive manner (server_context can't read options.server).
+  #
+  module ContextHelpers
+    include RHC::GitHelpers
+
+    def self.included(other)
+      other.module_eval do
+        def self.takes_domain(opts={})
+          if opts[:argument]
+            argument :namespace, "Name of a domain", ["-n", "--namespace NAME"], :allow_nil => true, :default => :from_local_git
+          else
+            option ["-n", "--namespace NAME"], "Name of a domain", :default => :from_local_git
+          end
+        end
+        # Does not take defaults to avoid conflicts
+        def self.takes_application_or_domain(opts={})
+          option ["-n", "--namespace NAME"], "Name of a domain"
+          option ["-a", "--app NAME"], "Name of an application"
+          if opts[:argument]
+            argument :target, "The name of a domain, or an application name with domain (domain or domain/application)", ["-t", "--target NAME_OR_PATH"], :allow_nil => true, :covered_by => [:application_id, :namespace, :app]
+          end
+        end
+        def self.takes_application(opts={})
+          if opts[:argument]
+            argument :app, "Name of an application", ["-a", "--app NAME"], :allow_nil => true, :default => :from_local_git, :covered_by => :application_id
+          else
+            option ["-a", "--app NAME"], "Name of an application", :default => :from_local_git, :covered_by => :application_id
+          end
+          option ["-n", "--namespace NAME"], "Name of a domain", :default => :from_local_git
+          option ["--application-id ID"], "ID of an application", :hide => true, :default => :from_local_git, :covered_by => :app
+        end
+      end
+    end
+
+    def find_domain(opts={})
+      domain = options.namespace || options.target || namespace_context
+      if domain
+        rest_client.find_domain(domain)
+      else
+        raise ArgumentError, "You must specify a domain with -n."
+      end
+    end
+
+    def find_app_or_domain(opts={})
+      domain, app =
+        if options.target.present?
+          options.target.split(/\//)
+        elsif options.namespace || options.app
+          if options.app =~ /\//
+            options.app.split(/\//)
+          else
+            [options.namespace || namespace_context, options.app]
+          end
+        end
+      if app && domain
+        rest_client.find_application(domain, app)
+      elsif domain
+        rest_client.find_domain(domain)
+      else
+        raise ArgumentError, "You must specify a domain with -n, or an application with -a."
+      end
+    end
+
+    def find_app(opts={})
+      if id = options.application_id
+        if opts.delete(:with_gear_groups)
+          return rest_client.find_application_by_id_gear_groups(id, opts)
+        else
+          return rest_client.find_application_by_id(id, opts)
+        end
+      end
+      domain, app =
+        if options.app
+          if options.app =~ /\//
+            options.app.split(/\//)
+          else
+            [options.namespace || namespace_context, options.app]
+          end
+        end
+      if app && domain
+        if opts.delete(:with_gear_groups)
+          rest_client.find_application_gear_groups(domain, app, opts)
+        else
+          rest_client.find_application(domain, app, opts)
+        end
+      else
+        raise ArgumentError, "You must specify an application with -a, or run this command from within a Git directory cloned from ProtonBox."
+      end
+    end
+
+    def server_context(defaults=nil, arg=nil)
+      value = ENV['PROTONBOX_SERVER'] || (!options.clean && config['protonbox_server']) || "api.protonbox.com"
+      defaults[arg] = value if defaults && arg
+      value
+    end
+
+    def from_local_git(defaults, arg)
+      @local_git_config ||= {
+        :application_id => git_config_get('pbox.app-id').presence,
+        :app => git_config_get('pbox.app-name').presence,
+        :namespace => git_config_get('pbox.domain-name').presence,
+      }
+      defaults[arg] ||= @local_git_config[arg] unless @local_git_config[arg].nil?
+      @local_git_config
+    end
+
+    def namespace_context
+      # right now we don't have any logic since we only support one domain
+      # TODO: add domain lookup based on uuid
+      domain = rest_client.domains.first
+      raise RHC::NoDomainsForUser if domain.nil?
+
+      domain.name
+    end
+  end
+end

data/lib/rhc/core_ext.rb

@@ -0,0 +1,202 @@
+# From Rails core_ext/object.rb
+require 'rhc/json'
+require 'open-uri'
+require 'httpclient'
+
+class Object
+  def present?
+    !blank?
+  end
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def presence
+    present? ? self : nil
+  end
+
+  # Avoid a conflict if to_json is already defined
+  unless Object.new.respond_to? :to_json
+    def to_json(options=nil)
+      RHC::Json.encode(self)
+    end
+  end
+end
+
+class Array
+  # From rails
+  def split(value = nil)
+    using_block = block_given?
+
+    inject([[]]) do |results, element|
+      if (using_block && yield(element)) || (value == element)
+        results << []
+      else
+        results.last << element
+      end
+
+      results
+    end
+  end  
+end
+
+class File
+  def chunk(chunk_size=1024)
+    yield read(chunk_size) until eof?
+  end
+end
+
+class String
+  # Wrap string by the given length, and join it with the given character.
+  # The method doesn't distinguish between words, it will only work based on
+  # the length.
+  def wrap(wrap_length=80, char="\n")
+    scan(/.{#{wrap_length}}|.+/).join(char)
+  end
+
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '').
+      gsub(/(\b|\S)[^\S\n]*\n(\S)/m, '\1 \2').
+      gsub(/\n+\Z/, '').
+      gsub(/\n{3,}/, "\n\n")
+  end
+
+  ANSI_ESCAPE_SEQUENCE = /\e\[(\d{1,2}(?:;\d{1,2})*[@-~])/
+  ANSI_ESCAPE_MATCH = '\e\[\d+(?:;\d+)*[@-~]'
+  CHAR_SKIP_ANSI = "(?:(?:#{ANSI_ESCAPE_MATCH})+.?|.(?:#{ANSI_ESCAPE_MATCH})*)"
+
+  #
+  # Split the given string at limit, treating ANSI escape sequences as
+  # zero characters in length.  Will insert an ANSI reset code (\e[0m)
+  # at the end of each line containing an ANSI code, assuming that a
+  # reset was not in the wrapped segment.
+  #
+  # All newlines are preserved.
+  #
+  # Lines longer than limit without natural breaks will be forcibly 
+  # split at the exact limit boundary.
+  #
+  # Returns an Array
+  #
+  def textwrap_ansi(limit, breakword=true)
+    re = breakword ? /
+      ( 
+        # Match substrings that end in whitespace shorter than limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}} # up to limit
+        (?:\s+|$)                     # require the limit to end on whitespace
+        |
+        # Match substrings equal to the limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}} 
+      )
+      /x :
+      /
+      ( 
+        # Match substrings that end in whitespace shorter than limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}}
+        (?:\s|$)                     # require the limit to end on whitespace
+        |
+        # Match all continguous whitespace strings
+        #{CHAR_SKIP_ANSI}+?
+        (?:\s|$)
+        (?:\s+|$)?
+      )
+      /x
+    escapes = []
+
+    split("\n",-1).inject([]) do |a, line|
+      if line.length < limit
+        a << line 
+      else
+        line.scan(re) do |segment, other|
+          if escapes.present? 
+            a << escapes.map{ |s| "\e[#{s}"}.join
+            a[-1] << segment.rstrip   
+          else
+            a << segment.rstrip
+          end
+
+          segment.scan(ANSI_ESCAPE_SEQUENCE).map{ |e| e.first }.each do |e|
+            case e
+            when '0m' then escapes.clear
+            else escapes << e
+            end
+          end
+          a[-1] << "\e[0m" if escapes.present?
+        end
+      end
+      a
+    end
+  end
+
+  def strip_ansi
+    gsub(ANSI_ESCAPE_SEQUENCE, '')
+  end
+end
+
+unless HTTP::Message.method_defined? :ok?
+  #:nocov:
+  class HTTP::Message
+    def ok?
+      HTTP::Status.successful?(status)
+    end
+  end
+  #:nocov:
+end
+
+unless DateTime.method_defined? :to_time 
+  #:nocov:
+  class DateTime
+    def to_time
+      Time.parse(to_s)
+    end
+  end
+  #:nocov:
+end
+
+#
+# Allow http => https redirection, see 
+# http://bugs.ruby-lang.org/issues/859 to 1.8.7 for rough
+# outline of change.
+#
+module OpenURI
+  def self.redirectable?(uri1, uri2) # :nodoc:
+    # This test is intended to forbid a redirection from http://... to
+    # file:///etc/passwd.
+    # However this is ad hoc.  It should be extensible/configurable.
+    uri1.scheme.downcase == uri2.scheme.downcase ||
+    (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)
+  end
+end
+
+class Hash
+  def stringify_keys!
+    keys.each do |key|
+      v = delete(key)
+      if v.is_a? Hash
+        v.stringify_keys!
+      elsif v.is_a? Array
+        v.each{ |value| value.stringify_keys! if value.is_a? Hash }
+      end
+      self[(key.to_s rescue key) || key] = v
+    end
+    self
+  end
+  def slice!(*args)
+    s = []
+    args.inject([]) do |a, k|
+      s << [k, delete(k)] if has_key?(k)
+    end
+    s
+  end
+  def slice(*args)
+    args.inject({}) do |h, k|
+      h[k] = self[k] if has_key?(k)
+      h
+    end
+  end
+  def reverse_merge!(other_hash)
+    # right wins if there is no left
+    merge!( other_hash ){|key,left,right| left }
+  end
+end

data/lib/rhc/coverage_helper.rb

@@ -0,0 +1,33 @@
+# Must be the first module imported at entry points (executables that run
+# in seperate processes from the test harness) otherwise coverage will be
+# incomplete
+
+if RUBY_VERSION >= '1.9' and ENV['PROTONBOX_FEATURE_COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    coverage_dir 'coverage/features/'
+    command_name 'Integration Tests'
+
+    # Filters - these files will be ignored.
+    add_filter 'lib/rhc/vendor/'   # vendored files should be taken directly and only
+                                   # namespaces changed
+    add_filter 'features/'         # Don't report on the files that run the cucumber tests
+    add_filter 'lib/rhc-feature-coverage-helper.rb'
+    add_filter 'spec/'             # Don't report on the files that run the spec tests
+
+    # Groups - general categories of test areas
+    add_group('Commands') { |src_file| src_file.filename.include?(File.join(%w[lib rhc commands])) }
+    add_group('RHC Lib')  { |src_file| src_file.filename.include?(File.join(%w[lib rhc])) }
+    add_group('REST')     { |src_file| src_file.filename.include?(File.join(%w[lib rhc/rest])) }
+    add_group('Test')     { |src_file| src_file.filename.include?(File.join(%w[features])) or
+                                       src_file.filename.include?(File.join(%w[spec])) }
+
+    use_merging = true
+    # Note, the #:nocov: coverage exclusion  should only be used on external functions
+    #  that cannot be nondestructively tested in a developer environment.
+  end
+
+  # suppress output
+  SimpleCov.at_exit do
+  end
+end

data/lib/rhc/deployment_helpers.rb

@@ -0,0 +1,88 @@
+require 'rhc/ssh_helpers'
+
+module RHC
+  module DeploymentHelpers
+
+    extend self
+
+    include RHC::SSHHelpers
+
+    protected
+
+      def deploy_artifact(rest_app, artifact, hot_deploy, force_clean_build)
+        File.file?(artifact) ?
+          deploy_local_file(rest_app, artifact, hot_deploy, force_clean_build) :
+        artifact =~ /^#{URI::regexp}$/ ?
+          deploy_file_from_url(rest_app, artifact, hot_deploy, force_clean_build) :
+        deploy_git_ref(rest_app, artifact, hot_deploy, force_clean_build)
+      end
+
+      def deploy_git_ref(rest_app, ref, hot_deploy, force_clean_build)
+        say "Deployment of git ref '#{ref}' in progress for application #{rest_app.name} ..."
+
+        ssh_url = URI(rest_app.ssh_url)
+        remote_cmd = "gear deploy #{ref}#{hot_deploy ? ' --hot-deploy' : ''}#{force_clean_build ? ' --force-clean-build' : ''}"
+
+        begin
+          ssh_ruby(ssh_url.host, ssh_url.user, remote_cmd)
+          success "Success"
+        rescue
+          ssh_cmd = "ssh -t #{ssh_url.user}@#{ssh_url.host} '#{remote_cmd}'"
+          warn "Error deploying git ref. You can try to deploy manually with:\n#{ssh_cmd}"
+          raise
+        end
+      end
+
+      def deploy_local_file(rest_app, filename, hot_deploy, force_clean_build)
+        filename = File.expand_path(filename)
+        say "Deployment of file '#{filename}' in progress for application #{rest_app.name} ..."
+
+        ssh_url = URI(rest_app.ssh_url)
+        remote_cmd = "oo-binary-deploy#{hot_deploy ? ' --hot-deploy' : ''}#{force_clean_build ? ' --force-clean-build' : ''}"
+
+        begin
+          ssh_send_file_ruby(ssh_url.host, ssh_url.user, remote_cmd, filename)
+          success "Success"
+        rescue
+          ssh_cmd = "ssh -t #{ssh_url.user}@#{ssh_url.host} '#{remote_cmd}'"
+          warn "Error deploying local file. You can try to deploy manually with:\n#{ssh_cmd}"
+          raise
+        end
+      end
+
+      def deploy_file_from_url(rest_app, file_url, hot_deploy, force_clean_build)
+        say "Deployment of file '#{file_url}' in progress for application #{rest_app.name} ..."
+
+        ssh_url = URI(rest_app.ssh_url)
+        file_url = URI(file_url)
+
+        remote_cmd = "oo-binary-deploy#{hot_deploy ? ' --hot-deploy' : ''}#{force_clean_build ? ' --force-clean-build' : ''}"
+
+        begin
+          ssh_send_url_ruby(ssh_url.host, ssh_url.user, remote_cmd, file_url)
+          success "Success"
+        rescue
+          ssh_cmd = "ssh -t #{ssh_url.user}@#{ssh_url.host} '#{remote_cmd}'"
+          warn "Error deploying file from url. You can try to deploy manually with:\n#{ssh_cmd}"
+          raise
+        end
+      end
+
+      def activate_deployment(rest_app, deployment_id)
+        say "Activating deployment '#{deployment_id}' on application #{rest_app.name} ..."
+
+        ssh_url = URI(rest_app.ssh_url)
+        remote_cmd = "gear activate #{deployment_id}"
+
+        begin
+          ssh_ruby(ssh_url.host, ssh_url.user, remote_cmd)
+          success "Success"
+        rescue
+          ssh_cmd = "ssh -t #{ssh_url.user}@#{ssh_url.host} '#{remote_cmd}'"
+          warn "Error activating deployment. You can try to activate manually with:\n#{ssh_cmd}"
+          raise
+        end
+      end
+
+  end
+end

data/lib/rhc/exceptions.rb

@@ -0,0 +1,232 @@
+module RHC
+  class Exception < StandardError
+    attr_reader :code
+    def initialize(message=nil, code=1)
+      super(message)
+      @code = code
+    end
+  end
+
+  class ConfirmationError < Exception
+    def initialize(message="This action requires the --confirm option (or entering 'yes' at a prompt) to run.", code=1)
+      super(message, code)
+    end
+  end
+
+  class CartridgeNotFoundException < Exception
+    def initialize(message="Cartridge not found")
+      super message, 154
+    end
+  end
+
+  class AliasNotFoundException < Exception
+    def initialize(message="Alias not found")
+      super message, 156
+    end
+  end
+
+  class MultipleCartridgesException < Exception
+    def initialize(message="Multiple cartridge found")
+      super message, 155
+    end
+  end
+
+  class EnvironmentVariableNotFoundException < Exception
+    def initialize(message="Environment variable not found")
+      super message, 157
+    end
+  end
+
+  class EnvironmentVariablesNotSupportedException < Exception
+    def initialize(message="Server does not support environment variables")
+      super message, 158
+    end
+  end
+
+  class EnvironmentVariableNotProvidedException < Exception
+    def initialize(message="Environment variable not provided")
+      super message, 159
+    end
+  end
+
+  class JenkinsNotInstalledOnServer < Exception
+    def initialize(message="There is no installed cartridge that exposes Jenkins")
+      super message, 160
+    end
+  end
+
+  class KeyNotFoundException < Exception
+    def initialize(message="SSHKey not found")
+      super message, 118
+    end
+  end
+
+  class GitException < Exception
+    def initialize(message="Git returned an error")
+      super message, 216
+    end
+  end
+
+  class GitPermissionDenied < GitException; end
+  class GitDirectoryExists < GitException; end
+
+  class DeprecatedError < RuntimeError; end
+
+  class KeyFileNotExistentException < Exception
+    def initialize(message="SSH Key file not found")
+      super message, 128
+    end
+  end
+
+  class KeyFileAccessDeniedException < Exception
+    def initialize(message = "Insufficient acces to SSH Key file")
+      super message, 128
+    end
+  end
+
+  class KeyDataInvalidException < Exception
+    def initialize(message = "SSH Key file contains invalid data")
+      super message, 128
+    end
+  end
+
+  class PermissionDeniedException < Exception
+    def initialize(message="Permission denied")
+      super message, 129
+    end
+  end
+
+  class NoPortsToForwardException < Exception
+    def initialize(message="No available ports to forward")
+      super message, 102
+    end
+  end
+
+  class PortForwardFailedException < Exception
+    def initialize(message="Port forward failed")
+      super message, 1
+    end
+  end
+
+  class SnapshotSaveException < Exception
+    def initialize(message="Error trying to save snapshot")
+      super message, 130
+    end
+  end
+
+  class SnapshotRestoreException < Exception
+    def initialize(message="Error trying to restore snapshot")
+      super message, 130
+    end
+  end
+
+  class DeploymentNotFoundException < Exception
+    def initialize(message="Deployment not found")
+      super message, 131
+    end
+  end
+
+  class DeploymentsNotSupportedException < Exception
+    def initialize(message="The server does not support deployments")
+      super message, 132
+    end
+  end
+
+  class MissingScalingValueException < Exception
+    def initialize(message="Must provide either a min or max value for scaling")
+      super message
+    end
+  end
+
+  class CartridgeNotScalableException < Exception
+    def initialize(message="Cartridge is not scalable")
+      super message
+    end
+  end
+
+  class ConnectionFailed < Exception
+  end
+
+  class SSHAuthenticationFailed < Exception
+    def initialize(host, user)
+      super "Authentication to server #{host} with user #{user} failed"
+    end
+  end
+
+  class SSHConnectionRefused < ConnectionFailed
+    def initialize(host, user)
+      super "The server #{host} refused a connection with user #{user}.  The application may be unavailable.", 1
+    end
+  end
+
+  class SSHCommandFailed < Exception
+    def initialize(exit_status, message=nil)
+      super message || "SSH command finished with exit status = #{exit_status}", 133
+    end
+  end
+
+  class AdditionalStorageArgumentsException < Exception
+    def initialize(message="Only one storage action can be performed at a time.")
+      super message, 1
+    end
+  end
+
+  class AdditionalStorageValueException < Exception
+    def initialize(message="The amount format must be a number, optionally followed by 'GB' (ex.: 5GB)")
+      super message, 1
+    end
+  end
+
+  class AdditionalStorageRemoveException < Exception
+    def initialize(message="The amount of additional storage to be removed exceeds the total amount in use. Add the -f flag to override.")
+      super message, 1
+    end
+  end
+
+  class ChangeMembersOnResourceNotSupported < Exception
+    def initialize(message="You can only add or remove members on a domain.")
+      super message, 1
+    end
+  end
+
+  class MembersNotSupported < Exception
+    def initialize(message="The server does not support adding or removing members.")
+      super message, 1
+    end
+  end
+
+  class UnsupportedError < Exception
+    def initialize(message="This operation is not supported by the server.")
+      super message, 1
+    end
+  end
+  class NoPerGearOperations < UnsupportedError
+    def initialize
+      super "The server does not support operations on individual gears."
+    end
+  end
+  class ServerAPINotSupportedException < UnsupportedError
+    def initialize(min_version, current_version)
+      super "The server does not support this command (requires #{min_version}, found #{current_version})."
+    end
+  end
+  class OperationNotSupportedException < UnsupportedError; end
+
+  class InvalidURIException < Exception
+    def initialize(uri)
+      super "Invalid URI specified: #{uri}"
+    end
+  end
+
+  class InvalidSSHExecutableException < Exception
+    def initialize(message="Invalid or missing SSH executable")
+      super message
+    end
+  end
+
+  class NoDomainsForUser < Exception
+    def initialize(message="In order to deploy applications, you must create a domain with 'pbox setup' or 'pbox create-domain'.")
+      super message, 1
+    end
+  end
+end