rhc 1.12.4 → 1.13.6

data/lib/rhc/commands/cartridge.rb

@@ -17,10 +17,10 @@ module RHC::Commands
       (like Jenkins) or provide environment variables.
 
       Use the 'cartridges' command to see a list of all available cartridges.
-      Add a new cartridge to your application with 'add-cartridge'. OpenShift 
-      also supports downloading cartridges - pass a URL in place of the cartridge 
-      name and we'll download and install that cartridge into your app.  Keep 
-      in mind that these cartridges receive no security updates.  Note that 
+      Add a new cartridge to your application with 'add-cartridge'. OpenShift
+      also supports downloading cartridges - pass a URL in place of the cartridge
+      name and we'll download and install that cartridge into your app.  Keep
+      in mind that these cartridges receive no security updates.  Note that
       not all OpenShift servers allow downloaded cartridges.
 
       For scalable applications, use the 'cartridge-scale' command on the web
@@ -29,8 +29,6 @@ module RHC::Commands
       Commands that affect a cartridge within an application will affect all
       gears the cartridge is installed to.
       DESC
-    alias_action :"app cartridge", :root_command => true, :deprecated => true
-    default_action :list
 
     summary "List available cartridges"
     syntax ''
@@ -73,6 +71,7 @@ module RHC::Commands
     syntax "<cartridge_type> [--namespace NAME] [--app NAME]"
     option ["-n", "--namespace NAME"], "Namespace of the application you are adding the cartridge to", :context => :namespace_context, :required => true
     option ["-a", "--app NAME"], "Application you are adding the cartridge to", :context => :app_context, :required => true
+    option ["-e", "--env VARIABLE=VALUE"], "Environment variable(s) to be set on this cartridge, or path to a file containing environment variables", :option_type => :list
     argument :cart_type, "The type of the cartridge you are adding (run 'rhc cartridge list' to obtain a list of available cartridges)", ["-c", "--cartridge cart_type"]
     alias_action :"app cartridge add", :root_command => true, :deprecated => true
     def add(cart_type)
@@ -83,13 +82,19 @@ module RHC::Commands
       say format_usage_message(cart) if cart.usage_rate?
 
       rest_app = rest_client.find_application(options.namespace, options.app, :include => :cartridges)
+
+      cart.environment_variables = collect_env_vars(options.env).map { |item| item.to_hash } if options.env
+
       rest_cartridge = rest_app.add_cartridge(cart)
 
       success "done"
 
+      rest_cartridge.environment_variables = cart.environment_variables if cart.environment_variables.present?
+
       paragraph{ display_cart(rest_cartridge) }
+      paragraph{ say "Use 'rhc env --help' to manage environment variable(s) on this cartridge and application." }
       paragraph{ rest_cartridge.messages.each { |msg| success msg } }
-      
+
       0
     end
 
@@ -188,10 +193,10 @@ module RHC::Commands
 
     summary "Set the scale range for a cartridge"
     description <<-DESC
-      Each cartridge capable of scaling may have a minimum and a maximum set, although within that range 
+      Each cartridge capable of scaling may have a minimum and a maximum set, although within that range
       each type of cartridge may make decisions to autoscale.  Web cartridges will scale based on incoming
       request traffic - see https://www.openshift.com/developers/scaling for more information. Non web
-      cartridges such as databases may require specific increments of scaling (1, 3, 5) in order to 
+      cartridges such as databases may require specific increments of scaling (1, 3, 5) in order to
       properly function.  Please consult the cartridge documentation for more on specifics of scaling.
 
       Set both values the same to guarantee a scale value.  You may pecify both values with the argument

data/lib/rhc/commands/env.rb

@@ -0,0 +1,146 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Env < Base
+    summary "Manages user-defined environment variables set on a given application"
+    syntax "<action>"
+    description <<-DESC
+      Manages the user-defined environment variables set on a given
+      application. To see a list of all environment variables use the command
+      'rhc list-env <application>'. Note that some predefined
+      cartridge-level environment variables can also be overriden,
+      but most variables provided by gears are read-only.
+
+      Type 'rhc set-env --help' for more details.
+
+      DESC
+    default_action :help
+    alias_action :"app env", :root_command => true
+
+    summary "Set one or more environment variable(s) to your application"
+    description <<-DESC
+      Set one or more environment variable(s) to your application.
+      Operands of the form 'VARIABLE=VALUE' set the environment
+      variable VARIABLE to value VALUE. Example:
+
+      rhc set-env VARIABLE1=VALUE1 VARIABLE2=VALUE2 -a myapp
+
+      Environment variables can also be set from a file containing one
+      or more VARIABLE=VALUE pairs (one per line). Example:
+
+      rhc set-env /path/to/file -a myapp
+
+      VALUE may be empty, in that case 'VARIABLE='. Setting a
+      variable to an empty value is different from unsetting it.
+
+      Some default cartridge-level variables can be overriden, but
+      variables provided by gears are read-only.
+
+      DESC
+    syntax "<VARIABLE=VALUE> [... <VARIABLE=VALUE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Environment variable name and value pair separated by an equal (=) sign, e.g. VARIABLE=VALUE", ["-e", "--env VARIABLE=VALUE"], :optional => false, :arg_type => :list
+    option ["-a", "--app NAME"], "Application name (required)", :context => :app_context, :required => true
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
+    option ["--confirm"], "Pass to confirm setting the environment variable(s)"
+    alias_action :add
+    def set(env)
+      rest_app = rest_client.find_application(options.namespace, options.app)
+
+      with_file = env.index {|item| File.file? item}
+
+      env_vars = []
+      env.each {|item| env_vars.concat(collect_env_vars(item))}
+      raise RHC::EnvironmentVariableNotProvidedException.new(
+        (with_file ?
+          "Environment variable(s) not found in the provided file(s).\n" :
+          "Environment variable(s) not provided.\n") <<
+          "Please provide at least one environment variable using the syntax VARIABLE=VALUE. VARIABLE can only contain letters, digits and underscore ('_') and can't begin with a digit.") if env_vars.empty?
+
+      if with_file
+        env_vars.each {|item| default_display_env_var(item.name, item.value)}
+        confirm_action "Do you want to set these environment variables on '#{rest_app.name}?"
+      end
+
+      say 'Setting environment variable(s) ... '
+      rest_app.set_environment_variables(env_vars)
+      success 'done'
+
+      0
+    end
+
+    summary "Remove one or more environment variable(s) currently set to your application"
+    description <<-DESC
+      Remove one or more environment variable(s) currently set to your
+      application. Setting a variable to an empty value is
+      different from unsetting it. When unsetting a default cartridge-
+      level variable previously overriden, the variable will be set
+      back to its default value.
+
+      DESC
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :arg_type => :list
+    option ["-a", "--app NAME"], "Application name (required)", :context => :app_context, :required => true
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
+    option ["--confirm"], "Pass to confirm removing the environment variable"
+    alias_action :remove
+    def unset(env)
+      rest_app = rest_client.find_application(options.namespace, options.app)
+
+      warn 'Removing environment variables is a destructive operation that may result in loss of data.'
+
+      env.each do |e|
+        default_display_env_var(e)
+      end
+
+      confirm_action "Are you sure you wish to remove the environment variable(s) above from application '#{rest_app.name}'?"
+      say 'Removing environment variable(s) ... '
+      rest_app.unset_environment_variables(env)
+      success 'removed'
+
+      0
+    end
+
+    summary "List all environment variables set on the application"
+    description <<-DESC
+      List all user-defined environment variables set on the application.
+      Gear-level variables overriden by the 'rhc set-env' command
+      will also be listed.
+
+      DESC
+    syntax "<app> [--namespace NAME]"
+    argument :app, "Application name (required)", ["-a", "--app name"], :context => :app_context, :required => true
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
+    option ["--table"], "Format the output list as a table"
+    option ["--quotes"], "Format the output list with double quotes for env var values"
+    def list(app)
+      rest_app = rest_client.find_application(options.namespace, app)
+      rest_env_vars = rest_app.environment_variables
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+    summary "Show the value of one or more environment variable(s) currently set to your application"
+    syntax "<VARIABLE> [... <VARIABLE>] [--namespace NAME] [--app NAME]"
+    argument :env, "Name of the environment variable(s), e.g. VARIABLE", ["-e", "--env VARIABLE"], :optional => false, :arg_type => :list
+    option ["-a", "--app NAME"], "Application name (required)", :context => :app_context, :required => true
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
+    option ["--table"], "Format the output list as a table"
+    option ["--quotes"], "Format the output list with double quotes for env var values"
+    def show(env)
+      rest_app = rest_client.find_application(options.namespace, options.app)
+      rest_env_vars = rest_app.find_environment_variables(env)
+
+      pager
+
+      display_env_var_list(rest_env_vars, { :table => options.table, :quotes => options.quotes })
+
+      0
+    end
+
+  end
+
+end

data/lib/rhc/commands.rb

@@ -15,16 +15,24 @@ module Commander
 
     #
     # Force proxy_option_struct to default to nil for values,
-    # backported for Commander 4.0.3 
+    # backported for Commander 4.0.3
     #
     def proxy_option_struct
       proxy_options.inject Options.new do |options, (option, value)|
         # options that are present will evaluate to true
         value = true if value.nil?
-        options.__send__ :"#{option}=", value
+        if proxy_options.select{ |item| item[0] == option }.length > 1
+          if options[option]
+            options[option] << value
+          else
+          options.__send__ :"#{option}=", [value]
+          end
+        else
+          options.__send__ :"#{option}=", value
+        end
         options
       end
-    end    
+    end
 
     def deprecated(as_alias=nil)
       return false unless info
@@ -234,16 +242,16 @@ module RHC
 
           c.when_called do |args, options|
             deprecated!
-            
+
             config = c.instance_variable_get(:@config)
-            
+
             cmd = opts[:class].new
             cmd.options = options
             cmd.config = config
-            
+
             args = fill_arguments(cmd, options, args_metadata, options_metadata, args)
             needs_configuration!(cmd, options, config)
-            
+
             return execute(cmd, :help, args) unless opts[:method]
             execute(cmd, opts[:method], args)
           end
@@ -269,6 +277,10 @@ module RHC
         options_metadata.each do |option_meta|
           arg = option_meta[:arg]
 
+          if arg && option_meta[:option_type] != :list && options[arg].is_a?(Array)
+            options[arg] = options[arg].last
+          end
+
           # Check to see if we've provided a value for an option tagged as deprecated
           if (!(val = options.__hash__[arg]).nil? && dep_info = option_meta[:deprecated])
             # Get the arg for the correct option and what the value should be

data/lib/rhc/exceptions.rb

@@ -31,6 +31,30 @@ module RHC
     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
@@ -144,7 +168,7 @@ module RHC
     def initialize
       super "The server does not support operations on individual gears."
     end
-  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})."

data/lib/rhc/help_formatter.rb

@@ -33,9 +33,9 @@ module RHC
 
     def initialize(command, instance_commands, runner)
       @command = command
-      @actions = 
+      @actions =
         if command.root?
-          instance_commands.collect do |command_name, command_class|
+          instance_commands.sort_by{ |c| c[0] }.collect do |command_name, command_class|
             next if command_class.summary.nil?
             m = /^#{command.name}[\-]([^ ]+)/.match(command_name)
             # if we have a match and it is not an alias then we can use it

data/lib/rhc/helpers.rb

@@ -49,7 +49,7 @@ module RHC
         s /= 1000
       end
       ((s > 9 || s.modulo(1) < 0.1 ? '%d' : '%.1f') % s) + ' ' + PREFIX[i]
-    end    
+    end
 
     def date(s)
       return nil unless s.present?
@@ -189,6 +189,7 @@ module RHC
           :url => openshift_rest_endpoint.to_s,
           :debug => options.debug,
           :timeout => options.timeout,
+          :warn => self.class.instance_method(:warn).bind(self),
         }.merge!(ssl_options).merge!(opts))
     end
 
@@ -248,7 +249,7 @@ module RHC
     #
     def agree(*args, &block)
       #args.push(interactive?.presence) if args.length == 1
-      block = lambda do |q| 
+      block = lambda do |q|
         q.validate = /\A(?:y|yes|n|no)\Z/i
       end unless block_given?
       super *args, &block
@@ -424,5 +425,31 @@ module RHC
 
       [status, stdout, stderr]
     end
+
+    def collect_env_vars(item)
+      return nil if item.blank?
+
+      env_vars = []
+
+      [item].flatten.each do |item|
+        if match = item.match(env_var_regex_pattern)
+          name, value = match.captures
+          env_vars << RHC::Rest::EnvironmentVariable.new({ :name => name, :value => value })
+        elsif File.file? item
+          File.readlines(item).each do |line|
+            if match = line.match(env_var_regex_pattern)
+              name, value = match.captures
+              env_vars << RHC::Rest::EnvironmentVariable.new({ :name => name, :value => value })
+            end
+          end
+        end
+      end
+      env_vars
+    end
+
+    def env_var_regex_pattern
+      /^([a-zA-Z_][\w]*)=(.*)$/
+    end
+
   end
 end

data/lib/rhc/output_helpers.rb

@@ -84,9 +84,10 @@ module RHC
         get_properties(cart, *properties).
           concat([[:downloaded_cartridge_url, cart.url]]).
           concat([[cart.scalable? ? :scaling : :gears, format_cart_gears(cart)]]).
-          concat(cart.properties.map{ |p| ["#{table_heading(p['name'])}:", p['value']] }.sort{ |a,b| a[0] <=> b[0] }),
+          concat(cart.properties.map{ |p| ["#{table_heading(p['name'])}:", p['value']] }.sort{ |a,b| a[0] <=> b[0] }).
+          concat(cart.environment_variables.present? ? [[:environment_variables, cart.environment_variables.map{|item| "#{item[:name]}=#{item[:value]}" }.sort.join(', ')]] : []),
         :delete => true
-      
+
       say format_usage_message(cart) if cart.usage_rate?
     end
 
@@ -134,6 +135,22 @@ module RHC
       "This gear costs an additional $#{cart.usage_rate} per gear after the first 3 gears."
     end
 
+    def default_display_env_var(env_var_name, env_var_value=nil)
+      info "#{env_var_name}#{env_var_value.nil? ? '' : '=' + env_var_value}"
+    end
+
+    def display_env_var_list(env_vars, opts={})
+      if env_vars.present?
+        if opts[:table]
+          say table(env_vars.collect{ |item| [item.name, opts[:quotes] ? "\"#{item.value}\"" : item.value] }, :header => ['Name', 'Value'])
+        else
+          env_vars.sort.each do |env_var|
+            default_display_env_var(env_var.name, opts[:quotes] ? "\"#{env_var.value}\"" : env_var.value)
+          end
+        end
+      end
+    end
+
     private
       def format_table(heading,values,opts = {})
         values = values.to_a if values.is_a? Hash

data/lib/rhc/rest/application.rb

@@ -24,13 +24,17 @@ module RHC
       def add_cartridge(cart, options={})
         debug "Adding cartridge #{name}"
         clear_attribute :cartridges
-        cart = 
-          if cart.is_a? String 
+        cart =
+          if cart.is_a? String
             {:name => cart}
           elsif cart.respond_to? :[]
             cart
           else
-            cart.url ? {:url => cart.url} : {:name => cart.name}
+            c = cart.url ? {:url => cart.url} : {:name => cart.name}
+            if cart.respond_to?(:environment_variables) && cart.environment_variables.present?
+              c[:environment_variables] = cart.environment_variables
+            end
+            cart = c
           end
 
         if cart.respond_to?(:[]) and cart[:url] and !has_param?('ADD_CARTRIDGE', 'url')
@@ -121,6 +125,48 @@ module RHC
         rest_method "THREAD_DUMP", :event => "thread-dump"
       end
 
+      def environment_variables
+        debug "Getting all environment variables for application #{name}"
+        if supports? "LIST_ENVIRONMENT_VARIABLES"
+          rest_method "LIST_ENVIRONMENT_VARIABLES"
+        else
+          raise RHC::EnvironmentVariablesNotSupportedException.new
+        end
+      end
+
+      def find_environment_variable(env_var_name)
+        find_environment_variables(env_var_name).first
+      end
+
+      def find_environment_variables(env_var_names=nil)
+        return environment_variables if env_var_names.nil?
+        env_var_names = [env_var_names].flatten
+        debug "Finding environment variable(s) #{env_var_names.inspect} in app #{@name}"
+        env_vars = environment_variables.select { |item| env_var_names.include? item.name }
+        raise RHC::EnvironmentVariableNotFoundException.new("Environment variable(s) #{env_var_names.join(', ')} can't be found in application #{name}.") if env_vars.empty?
+        env_vars
+      end
+
+      # @param [Array<RHC::Rest::EnvironmentVariable>] Array of RHC::Rest::EnvironmentVariable to be set
+      def set_environment_variables(env_vars=[])
+        debug "Adding environment variable(s) #{env_vars.inspect} for #{name}"
+        if supports? "SET_UNSET_ENVIRONMENT_VARIABLES"
+          rest_method "SET_UNSET_ENVIRONMENT_VARIABLES", :environment_variables => env_vars.map{|item| item.to_hash}
+        else
+          raise RHC::EnvironmentVariablesNotSupportedException.new
+        end
+      end
+
+      # @param [Array<String>] Array of env var names like ['FOO', 'BAR']
+      def unset_environment_variables(env_vars=[])
+        debug "Removing environment variable(s) #{env_vars.inspect} for #{name}"
+        if supports? "SET_UNSET_ENVIRONMENT_VARIABLES"
+          rest_method "SET_UNSET_ENVIRONMENT_VARIABLES", :environment_variables => env_vars.map{|item| {:name => item}}
+        else
+          raise RHC::EnvironmentVariablesNotSupportedException.new
+        end
+      end
+
       def add_alias(app_alias)
         debug "Running add_alias for #{name}"
         rest_method "ADD_ALIAS", :event => "add-alias", :alias => app_alias

data/lib/rhc/rest/cartridge.rb

@@ -3,9 +3,9 @@ module RHC
     class Cartridge < Base
       HIDDEN_TAGS = [:framework, :web_framework, :cartridge].map(&:to_s)
 
-      define_attr :type, :name, :display_name, :properties, :gear_profile, :status_messages, :scales_to, :scales_from, :scales_with, 
-                  :current_scale, :supported_scales_to, :supported_scales_from, :tags, :description, :collocated_with, :base_gear_storage, 
-                  :additional_gear_storage, :url
+      define_attr :type, :name, :display_name, :properties, :gear_profile, :status_messages, :scales_to, :scales_from, :scales_with,
+                  :current_scale, :supported_scales_to, :supported_scales_from, :tags, :description, :collocated_with, :base_gear_storage,
+                  :additional_gear_storage, :url, :environment_variables
 
       def scalable?
         supported_scales_to != supported_scales_from
@@ -138,7 +138,7 @@ module RHC
         name = Rack::Utils.parse_nested_query(uri.query)['name'] if name.blank? && uri.query
         name = File.basename(uri.path) if name.blank? && uri.path.present? && uri.path != '/'
         name.presence || url
-      rescue 
+      rescue
         url
       end
 

data/lib/rhc/rest/client.rb

@@ -4,6 +4,7 @@ require 'uri'
 require 'logger'
 require 'httpclient'
 require 'benchmark'
+require 'set'
 
 module RHC
   module Rest
@@ -464,12 +465,7 @@ module RHC
           type = result['type']
           data = result['data'] || {}
 
-          # Copy messages to each object
-          messages = Array(result['messages']).map do |m|
-            m['text'] if (m['field'] == 'result' || m['severity'] == 'result') && (m['severity'] != 'debug' || debug?)
-          end.compact.map!(&:chomp)
-          data.each{ |d| d['messages'] = messages } if data.is_a?(Array)
-          data['messages'] = messages if data.is_a?(Hash)
+          parse_messages result, data
 
           case type
           when 'domains'
@@ -498,11 +494,50 @@ module RHC
             data.map{ |json| GearGroup.new(json, self) }
           when 'aliases'
             data.map{ |json| Alias.new(json, self) }
+          when 'environment-variables'
+            data.map{ |json| EnvironmentVariable.new(json, self) }
           else
             data
           end
         end
 
+        def parse_messages(result, data)
+          warnings, messages = Array(result['messages']).inject([[],[]]) do |a, m|
+            severity, field, text = m.values_at('severity', 'field', 'text')
+            text = text.chomp
+            case severity
+            when 'warning'
+              a[0] << text
+            when 'debug'
+              a[1] << text if debug?
+            when 'info'
+              a[1] << text if debug? || field == 'result'
+            else
+              a[1] << text
+            end
+            a
+          end
+
+          if data.is_a?(Array)
+            data.each do |d|
+              d['messages'] = messages
+              d['warnings'] = warnings
+            end
+          elsif data.is_a?(Hash)
+            data['messages'] = messages
+            data['warnings'] = warnings  
+          end
+
+          warnings.each do |warning|
+            # Prevent repeated warnings during the same client session
+            if !defined?(@warning_map) || !@warning_map.include?(warning)
+              @warning_map ||= Set.new
+              @warning_map << warning
+              warn warning
+            end
+          end if respond_to? :warn
+        end
+
         def raise_generic_error(url, client)
           raise ServerErrorException.new(generic_error_message(url, client), 129)
         end

data/lib/rhc/rest/environment_variable.rb

@@ -0,0 +1,15 @@
+module RHC
+  module Rest
+    class EnvironmentVariable < Base
+      define_attr :name, :value
+
+      def to_hash
+        { :name => name, :value => value }
+      end
+
+      def <=>(other)
+        name <=> other.name
+      end
+    end
+  end
+end