rhc 1.15.6 → 1.16.9

data/features/keys_feature.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'direct_execution_helper'
+
+describe "rhc sshkey scenarios" do
+  context "with an existing domain" do
+    before(:all) do
+      standard_config
+      @domain = has_a_domain
+    end
+
+    let(:domain){ @domain }
+
+    context "with an application" do
+      before{ has_an_application }
+
+      it "should add and remove kerberos keys on gear" do
+        app = @domain.applications.first
+        keyname = "key#{rand(1000000000000)}"
+        keycontent = "principal#{rand(1000000000000)}"
+        
+        r = rhc 'sshkey', 'add', keyname, '--type', 'krb5-principal', '--content', keycontent
+        r.status.should == 0
+
+        r = rhc 'ssh', app.name, '-n', domain.name, '--ssh', ssh_exec_for_env, '--', 'if [ -f .k5login ]; then cat .k5login; fi'
+        r.status.should == 0
+        r.stdout.should match(Regexp.new("#{keyname}\n#{keycontent}"))
+
+        r = rhc 'sshkey', 'remove', keyname
+        r.status.should == 0
+
+        r = rhc 'ssh', app.name, '-n', domain.name, '--ssh', ssh_exec_for_env, '--', 'if [ -f .k5login ]; then cat .k5login; fi'
+        r.status.should == 0
+        r.stdout.should_not match(Regexp.new("#{keyname}\n#{keycontent}"))
+      end
+    end
+  end
+end

data/features/members_feature.rb

@@ -113,7 +113,7 @@ describe "rhc member scenarios" do
 
       it "should reject a non-existent user" do
         r = rhc 'add-member', 'not-a-user', '-n', domain.name
-        r.status.should_not == 1
+        r.status.to_i.should == 256
         r.stdout.should match "There is no account with login not-a-user."
         client.find_domain(domain.name).members.length.should == 1
       end
@@ -127,5 +127,40 @@ describe "rhc member scenarios" do
         client.find_domain(domain.name).members.any?{ |m| m.id == user.id && m.editor? }.should be_true
       end
     end
+
+    context "with an application" do
+      let(:other_user){ other_users.values.first }
+      before{ has_an_application }
+      before{ has_local_ssh_key(other_user) }
+
+      it "should allow SSH only for admin and edit roles" do
+        user = other_user.login
+        name = @domain.applications.first.name
+
+        r = rhc 'add-member', user, '--role', 'admin', '-n', domain.name
+        r.status.should == 0
+
+        with_environment(other_user) do
+          r = rhc 'ssh', name, '-n', domain.name, '--ssh', ssh_exec_for_env
+          r.status.should == 0
+        end
+
+        r = rhc 'add-member', user, '--role', 'view', '-n', domain.name
+        r.status.should == 0
+
+        with_environment(other_user) do
+          r = rhc 'ssh', name, '-n', domain.name, '--ssh', ssh_exec_for_env
+          r.status.to_i.should_not == 0
+        end
+
+        r = rhc 'add-member', user, '--role', 'edit', '-n', domain.name
+        r.status.should == 0
+
+        with_environment(other_user) do
+          r = rhc 'ssh', name, '-n', domain.name, '--ssh', ssh_exec_for_env
+          r.status.should == 0
+        end
+      end
+    end
   end
 end

data/lib/rhc/commands/app.rb

@@ -2,6 +2,7 @@ require 'rhc/commands/base'
 require 'resolv'
 require 'rhc/git_helpers'
 require 'rhc/cartridge_helpers'
+require 'rhc/deployment_helpers'
 
 module RHC::Commands
   class App < Base
@@ -105,7 +106,7 @@ module RHC::Commands
         say "Creating application '#{name}' ... "
 
         # create the main app
-        rest_app = create_app(name, cartridges, rest_domain, options.gear_size, options.scaling, options.from_code, env)
+        rest_app = create_app(name, cartridges, rest_domain, options.gear_size, options.scaling, options.from_code, env, options.auto_deploy, options.keep_deployments, options.deployment_branch)
         success "done"
 
         paragraph{ indent{ success rest_app.messages.map(&:strip) } }
@@ -288,6 +289,9 @@ module RHC::Commands
       The '--state' option will retrieve information from each cartridge in
       the application, which may include cartridge specific text.
 
+      The '--configuration' option will display configuration values set in
+      the application. Use 'rhc configure-app' to configure.
+
       To see information about the individual gears within an application,
       use '--gears', including whether they are started or stopped and their
       SSH host strings.  Passing '--gears quota' will show the free and maximum
@@ -298,10 +302,12 @@ module RHC::Commands
         rhc ssh <app> --gears '<command>'
 
       to run and display the output from each gear.
+
       DESC
     syntax "<app> [--namespace NAME]"
     takes_application :argument => true
     option ["--state"], "Get the current state of the cartridges in this application"
+    option ["--configuration"], "Get the current configuration values set in this application"
     option ["--gears [quota|ssh]"], "Show information about the cartridges on each gear in this application. Pass 'quota' to see per gear disk usage and limits. Pass 'ssh' to print only the SSH connection strings of each gear."
     def show(app_name)
 
@@ -339,6 +345,11 @@ module RHC::Commands
         end.flatten(1)
 
         say table(gear_info, :header => ['ID', 'State', 'Cartridges', 'Size', 'SSH URL'])
+
+      elsif options.configuration
+        display_app_configurations(find_app)
+        paragraph { say "Use 'rhc configure-app' to change the configuration values of this application." }
+
       else
         app = find_app(:include => :cartridges)
         display_app(app, app.cartridges)
@@ -347,10 +358,72 @@ module RHC::Commands
       0
     end
 
+    summary "Deploy a git reference or binary file of an application"
+    syntax "<ref> --app NAME [--namespace NAME]"
+    description <<-DESC
+      By default OpenShift applications prepare, distribute, and activate deployments
+      on every git push. Alternatively, a user may choose to disable automatic
+      deployments and use 'rhc deploy' and 'rhc deployment' commands to fully control the
+      deployment lifecycle.
+
+      Use this command to prepare, distribute and deploy manually from a git reference
+      (commit id, tag or branch) or from a binary file. Check also 'rhc configure-app'
+      to configure your application to deploy manually and set the number of deployments
+      to keep in history.
+
+      DESC
+    takes_application
+    argument :ref, "Git tag, branch or commit id or path to binary file to be deployed", ["--ref REF"], :optional => false
+    option "--[no-]hot-deploy", "Perform hot deployment according to the specified argument rather than checking for the presence of the hot_deploy marker in the application git repo"
+    option "--[no-]force-clean-build", "Perform a clean build according to the specified argument rather than checking for the presence of the force_clean_build marker in the application git repo"
+    alias_action :"deploy", :root_command => true
+    def deploy(ref)
+      rest_app = find_app
+
+      raise RHC::DeploymentsNotSupportedException.new if !rest_app.supports? "DEPLOY"
+
+      deploy_artifact(rest_app, ref, options.hot_deploy, options.force_clean_build)
+
+      0
+    end
+
+    summary "Configure several properties that apply to an application"
+    syntax "<app> [--[no-]auto-deploy] [--keep-deployments INTEGER] [--deployment-branch BRANCH] [--deployment-type TYPE] [--namespace NAME]"
+    takes_application :argument => true
+    option ["--[no-]auto-deploy"], "Build and deploy automatically when pushing to the git repo. Defaults to true."
+    option ["--keep-deployments INTEGER", Integer], "Number of deployments to preserve. Defaults to 1."
+    option ["--deployment-branch BRANCH"], "Which branch should trigger an automatic deployment, if automatic deployment is enabled with --auto-deploy. Defaults to master."
+    option ["--deployment-type git|binary"], "Type of deployment the application accepts ('git' or 'binary'). Defaults to git."
+    def configure(app_name)
+      rest_app = find_app
+
+      app_options = {}
+      app_options[:auto_deploy] = options.auto_deploy if !options.auto_deploy.nil?
+      app_options[:keep_deployments] = options.keep_deployments if options.keep_deployments
+      app_options[:deployment_branch] = options.deployment_branch if options.deployment_branch
+      app_options[:deployment_type] = options.deployment_type if options.deployment_type
+
+      if app_options.present?
+        paragraph do
+          say "Configuring application '#{app_name}' ... "
+          rest_app.configure(app_options)
+          success "done"
+        end
+      end
+
+      paragraph { display_app(find_app, nil, [:auto_deploy, :keep_deployments, :deployment_type, :deployment_branch]) }
+
+      paragraph { say "Your application '#{rest_app.name}' is #{app_options.empty? ? '' : 'now '}configured as listed above." }
+      paragraph { say "Use 'rhc show-app #{rest_app.name} --configuration' to check your configuration values any time." } if app_options.present?
+
+      0
+    end
+
     private
       include RHC::GitHelpers
       include RHC::CartridgeHelpers
       include RHC::SSHHelpers
+      include RHC::DeploymentHelpers
 
       MAX_RETRIES = 7
       DEFAULT_DELAY_THROTTLE = 2.0
@@ -417,13 +490,17 @@ module RHC::Commands
         result
       end
 
-      def create_app(name, cartridges, rest_domain, gear_size=nil, scale=nil, from_code=nil, environment_variables=nil)
+      def create_app(name, cartridges, rest_domain, gear_size=nil, scale=nil, from_code=nil, environment_variables=nil, auto_deploy=nil, keep_deployments=nil, deployment_branch=nil)
         app_options = {:cartridges => Array(cartridges)}
         app_options[:gear_profile] = gear_size if gear_size
         app_options[:scale] = scale if scale
         app_options[:initial_git_url] = from_code if from_code
         app_options[:debug] = true if @debug
         app_options[:environment_variables] = environment_variables.map{ |item| item.to_hash } if environment_variables.present?
+        app_options[:auto_deploy] = auto_deploy if !auto_deploy.nil?
+        app_options[:keep_deployments] = keep_deployments if keep_deployments
+        app_options[:deployment_branch] = deployment_branch if deployment_branch
+        debug "Creating application '#{name}' with these options - #{app_options.inspect}"
         rest_app = rest_domain.add_application(name, app_options)
 
         rest_app

data/lib/rhc/commands/deployment.rb

@@ -0,0 +1,82 @@
+require 'rhc/commands/base'
+require 'rhc/deployment_helpers'
+
+module RHC::Commands
+  class Deployment < Base
+    include RHC::DeploymentHelpers
+
+    summary "Commands for deploying and managing deployments of an application"
+    description <<-DESC
+      By default OpenShift applications prepare, distribute, and activate deployments
+      on every git push. Alternatively, a user may choose to disable automatic
+      deployments and use this 'rhc deployment' set of commands to fully control the
+      deployment lifecycle. Use these commands to deploy manually from a git reference
+      or from a binary file, list and display deployments and also activate existing
+      deployments. Check also 'rhc configure-app' to configure your application to
+      deploy manually.
+
+      DESC
+    syntax "<action>"
+    default_action :help
+
+    summary "List the existing deployments of an application"
+    description <<-DESC
+      List all existing deployments of a given application. Check the 'rhc configure-app'
+      command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<application>"
+    takes_application :argument => true
+    alias_action :"deployments", :root_command => true
+    def list(app)
+      rest_app = find_app
+      deployment_activations = rest_app.deployment_activations
+
+      raise RHC::DeploymentNotFoundException, "No deployments found for application #{app}." if !deployment_activations.present?
+
+      pager
+
+      display_deployment_list(deployment_activations)
+      0
+    end
+
+    summary "Show details of the given deployment"
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    description <<-DESC
+      Display details of the given deployment id.
+
+      DESC
+    takes_application
+    argument :id, "The deployment ID to show", ["--id ID"], :optional => false
+    def show(id)
+      rest_app = find_app
+      item = rest_app.deployment_activations.reverse_each.detect{|item| item[:deployment].id == id}
+
+      raise RHC::DeploymentNotFoundException, "Deployment ID '#{id}' not found for application #{rest_app.name}." if !item.present?
+
+      display_deployment(item)
+      paragraph { say "Use 'rhc show-app #{rest_app.name} --configuration' to check your deployment configurations." }
+      0
+    end
+
+    summary "Activate an existing deployment"
+    description <<-DESC
+      Switch between existing deployments. This command allows you to rollback from one
+      deployment to a previous one or activate subsequent deployments. Check the 'rhc
+      configure-app' command to configure how many deployments are preserved in history.
+
+      DESC
+    syntax "<deployment_id> --app NAME [--namespace NAME]"
+    takes_application
+    argument :id, "The deployment ID to activate on the application", ["--id ID"], :optional => false
+    def activate(id)
+      rest_app = find_app
+
+      raise RHC::DeploymentsNotSupportedException.new if !rest_app.supports? "DEPLOY"
+
+      activate_deployment(rest_app, id)
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/snapshot.rb

@@ -21,15 +21,20 @@ module RHC::Commands
     syntax "<application> [--filepath FILE] [--ssh path_to_ssh_executable]"
     takes_application :argument => true
     option ["-f", "--filepath FILE"], "Local path to save tarball (default: ./$APPNAME.tar.gz)"
+    option ["--deployment"], "Snapshot as a deployable file which can be deployed with 'rhc deploy'"
     option ["--ssh PATH"], "Full path to your SSH executable with additional options"
     alias_action :"app snapshot save", :root_command => true, :deprecated => true
     def save(app)
       ssh = check_ssh_executable! options.ssh
       rest_app = find_app
+
+      raise RHC::DeploymentsNotSupportedException.new if options.deployment && !rest_app.supports?("DEPLOY")
+
       ssh_uri = URI.parse(rest_app.ssh_url)
       filename = options.filepath ? options.filepath : "#{rest_app.name}.tar.gz"
 
-      ssh_cmd = "#{ssh} #{ssh_uri.user}@#{ssh_uri.host} 'snapshot' > #{filename}"
+      snapshot_cmd = options.deployment ? 'gear archive-deployment' : 'snapshot'
+      ssh_cmd = "#{ssh} #{ssh_uri.user}@#{ssh_uri.host} '#{snapshot_cmd}' > #{filename}"
       debug ssh_cmd
 
       say "Pulling down a snapshot to #{filename}..."

data/lib/rhc/commands/sshkey.rb

@@ -43,25 +43,40 @@ module RHC::Commands
     summary 'Add SSH key to your account'
     syntax '<name> <path to SSH key file>'
     argument :name, 'Name for this key', []
-    argument :key, 'SSH public key filepath', []
+    argument :key, 'SSH public key filepath', [], :optional => true
     option ['--confirm'], 'Bypass key validation'
-    def add(name, key)
-      type, content, comment = ssh_key_triple_for(key)
-
-      # validate the user input before sending it to the server
-      begin
-        Net::SSH::KeyFactory.load_data_public_key "#{type} #{content}"
-      rescue NotImplementedError, OpenSSL::PKey::PKeyError, Net::SSH::Exception => e
-        debug e.inspect
-        if options.confirm
-          warn 'The key you are uploading is not recognized.  You may not be able to authenticate to your application through Git or SSH.'
-        else
-          raise ::RHC::KeyDataInvalidException.new("File '#{key}' does not appear to be a recognizable key file (#{e}). You may specify the '--confirm' flag to add the key anyway.")
+    option ['--type TYPE'], 'Provide the key type directly if no key file is given'
+    option ['--content CONTENT'], 'Provide the key content directly if no key file is given'
+    def add(name, key_path=nil)
+
+      if key_path
+        type, content, comment = ssh_key_triple_for(key_path)
+      elsif options[:type].present? and options[:content].present?
+        type = options[:type]
+        content = options[:content]
+      else
+       raise ArgumentError, "You must either provide a key file, or the key type and content"
+      end
+
+      if type == 'krb5-principal'
+        # TODO: validate krb5?
+      else
+        # validate the user input before sending it to the server
+        begin
+          Net::SSH::KeyFactory.load_data_public_key "#{type} #{content}"
+        rescue NotImplementedError, OpenSSL::PKey::PKeyError, Net::SSH::Exception => e
+          debug e.inspect
+          if options.confirm
+            warn 'The key you are uploading is not recognized.  You may not be able to authenticate to your application through Git or SSH.'
+          else
+            raise ::RHC::KeyDataInvalidException.new("File '#{key_path}' does not appear to be a recognizable key file (#{e}). You may specify the '--confirm' flag to add the key anyway.") if key_path
+            raise ::RHC::KeyDataInvalidException.new("The provided type and content does not appear to be a recognizable key (#{e}). You may specify the '--confirm' flag to add the key anyway.")
+          end
         end
       end
 
       rest_client.add_key(name, content, type)
-      results { say "SSH key #{key} has been added as '#{name}'" }
+      results { say key_path ? "SSH key #{key_path} has been added as '#{name}'" : "SSH key '#{name}' has been added" }
 
       0
     end

data/lib/rhc/commands/tail.rb

@@ -37,7 +37,7 @@ module RHC::Commands
         begin
           #Use ssh -t to tail the logs
           debug ssh_cmd
-          ssh_ruby(host, uuid, remote_cmd)
+          ssh_ruby(host, uuid, remote_cmd, false, true)
         rescue
           warn "You can tail this application directly with:\n#{ssh_cmd}"
           raise

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