startapp 0.1.6

data/lib/rhc/commands/git_clone.rb

@@ -0,0 +1,34 @@
+require 'rhc/commands/base'
+require 'rhc/git_helpers'
+
+module RHC::Commands
+  class GitClone < Base
+    summary "Clone and configure an application's repository locally"
+    description "This is a convenience wrapper for 'git clone' with the added",
+                "benefit of adding configuration data such as the application's",
+                "UUID to the local repository.  It also automatically",
+                "figures out the Git url from the application name so you don't",
+                "have to look it up."
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+    option ["-r", "--repo dir"], "Path to the Git repository (defaults to ./$app_name)"
+    alias_action 'app git-clone', :deprecated => true, :root_command => true
+    # TODO: Implement default values for arguments once ffranz has added context arguments
+    # argument :directory, "The name of a new directory to clone into", [], :default => nil
+    def run(app_name)
+      if has_git?
+        rest_app = find_app
+        dir = git_clone_application(rest_app)
+        success "Your application Git repository has been cloned to '#{system_path(dir)}'"
+
+        0
+      else
+        error "You do not have git installed. In order to fully interact with StartApp you will need to install and configure a git client."
+        2
+      end
+    end
+
+    private
+      include RHC::GitHelpers
+  end
+end

data/lib/rhc/commands/logout.rb

@@ -0,0 +1,51 @@
+module RHC::Commands
+  class Logout < Base
+    suppress_wizard
+
+    summary "End the current session"
+    description <<-DESC
+      Logout ends your current session on the server and then removes
+      all of the local session files.  If you are using multiple 
+      servers and configurations this will remove all of your local
+      session files.
+
+      The --all option will terminate all authorizations on your
+      account. Any previously generated authorizations will be
+      deleted and external tools that integrate with your account
+      will no longer be able to log in.
+      DESC
+    option '--all', "Remove all authorizations on your account."
+    alias_action 'account logout', :root_command => true
+    def run
+      if options.all
+        rest_client.user # force authentication
+        say "Deleting all authorizations associated with your account ... "
+        begin
+          rest_client.delete_authorizations
+          success "done"
+        rescue RHC::Rest::AuthorizationsNotSupported
+          info "not supported"
+        end
+      elsif token_for_user
+        options.noprompt = true
+        say "Ending session on server ... "
+        begin
+          rest_client.delete_authorization(token_for_user)
+          success "deleted"
+        rescue RHC::Rest::AuthorizationsNotSupported
+          info "not supported"
+        rescue RHC::Rest::TokenExpiredOrInvalid
+          info "already closed"
+        rescue => e
+          debug_error(e)
+          warn e.message
+        end
+      end
+
+      0
+    ensure
+      token_store.clear
+      success "All local sessions removed."
+    end
+  end
+end

data/lib/rhc/commands/logs.rb

@@ -0,0 +1,21 @@
+require 'rhc/commands/tail'
+
+module RHC::Commands
+  class Logs < Tail
+
+    summary "Tail the logs of an application"
+    syntax "<application>"
+    takes_application :argument => true
+    option ["-o", "--opts options"], "Options to pass to the server-side (linux based) tail command (applicable to tail command only) (-f is implicit.  See the linux tail man page full list of options.) (Ex: --opts '-n 100')"
+    option ["-f", "--files files"], "File glob relative to app (default <application_name>/logs/*) (optional)"
+    option ["-g", "--gear ID"], "Tail only a specific gear"
+    #option ["-c", "--cartridge name"], "Tail only a specific cartridge"
+    alias_action :"app tail", :root_command => true, :deprecated => true
+    def run(app_name)
+      super app_name
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/member.rb

@@ -0,0 +1,148 @@
+require 'rhc/commands/base'
+
+module RHC::Commands
+  class Member < Base
+    summary "Manage membership on domains"
+    syntax "<action>"
+    description <<-DESC
+      Teams of developers can collaborate on applications by adding people to
+      domains as members: each member has a role (admin, editor, or viewer),
+      and those roles determine what the user can do with the domain and the
+      applications contained within.
+
+      Roles:
+
+        view  - able to see information about the domain and its apps, but not make any changes
+        edit  - create, update, and delete applications, and has Git and SSH access
+        admin - can update membership of a domain
+
+      The default role granted to members when added is 'edit' - use the '--role'
+      argument to use another.  When adding and removing members, you can use their
+      'login' value (typically their email or a short unique name for them) or their
+      'id'.  Both login and ID are visible via the 'rhc account' command.
+
+      To see existing members of a domain or application, use:
+
+        rhc members -n <domain_name> [-a <app_name>]
+
+      To change the role for a user, simply call the add-member command with the new role. You
+      cannot change the role of the owner.
+      DESC
+    syntax "<action>"
+    default_action :help
+
+    summary "List members of a domain or application"
+    syntax "<domain_or_app_name> [-n DOMAIN_NAME] [-a APP_NAME]"
+    description <<-DESC
+      Show the existing members of a domain or application - you can pass the name
+      of your domain with '-n', the name of your application with '-a', or combine
+      them in the first argument to the command like:
+
+        rhc members <domain_name>/[<app_name>]
+
+      The owner is always listed first.  To see the unique ID of members, pass
+      '--ids'.
+      DESC
+    option ['--ids'], "Display the IDs of each member", :optional => true
+    takes_application_or_domain :argument => true
+    alias_action :members, :root_command => true
+    def list(path)
+      target = find_app_or_domain(path)
+      members = target.members.sort_by{ |m| [m.owner? ? 0 : 1, m.role_weight, m.name] }
+      show_name = members.any?{ |m| m.name && m.name != m.login }
+      members.map! do |m|
+        [
+          ((m.name || "") if show_name),
+          m.login || "",
+          m.owner? ? "#{m.role} (owner)" : m.role,
+          (m.id if options.ids)
+        ].compact
+      end
+      say table(members, :header => [('Name' if show_name), 'Login', 'Role', ("ID" if options.ids)].compact)
+
+      0
+    end
+
+    summary "Add or update a member on a domain"
+    syntax "<login> [<login>...] [-n DOMAIN_NAME] [--role view|edit|admin] [--ids]"
+    description <<-DESC
+      Adds or updates members on a domain by passing one or more login
+      or ids for other people on OpenShift.  The login and ID values for each
+      account are displayed in 'rhc account'. To change the role for a user, simply
+      call the add-member command with the new role. You cannot change the role of
+      the owner.
+
+      Roles
+        view  - able to see information about the domain and its apps,
+                but not make any changes
+        edit  - create, update, and delete applications, and has Git
+                and SSH access
+        admin - can update membership of a domain
+
+      The default role granted to members when added is 'edit' - use the '--role'
+      argument for 'view' or 'admin'.
+
+      Examples
+        rhc add-member sally joe -n mydomain
+          Gives the accounts with logins 'sally' and 'joe' edit access on mydomain
+
+        rhc add-member bob@example.com --role admin -n mydomain
+          Gives the account with login 'bob@example.com' admin access on mydomain
+
+      DESC
+    takes_domain
+    option ['--ids'], "Treat the arguments as a list of IDs", :optional => true
+    option ['-r', '--role ROLE'], "The role to give to each member - view, edit, or admin (default 'edit')", :type => Role, :optional => true
+    argument :members, "A list of members logins to add.  Pass --ids to treat this as a list of IDs.", [], :type => :list
+    def add(members)
+      target = find_domain
+      role = options.role || 'edit'
+      raise ArgumentError, 'You must pass one or more logins or ids to this command' unless members.present?
+      say "Adding #{pluralize(members.length, role_name(role))} to #{target.class.model_name.downcase} ... "
+      target.update_members(changes_for(members, role))
+      success "done"
+
+      0
+    end
+
+    summary "Remove a member from a domain"
+    syntax "<login> [<login>...] [-n DOMAIN_NAME] [--ids]"
+    description <<-DESC
+      Remove members on a domain by passing one or more login or ids for each
+      member you wish to remove.  View the list of existing members with
+      'rhc members <domain_name>'.
+
+      Pass '--all' to remove all but the owner from the domain.
+      DESC
+    takes_domain
+    option ['--ids'], "Treat the arguments as a list of IDs"
+    option ['--all'], "Remove all members from this domain."
+    argument :members, "Member logins to remove from the domain.  Pass --ids to treat this as a list of IDs.", [], :type => :list
+    def remove(members)
+      target = find_domain
+
+      if options.all
+        say "Removing all members from #{target.class.model_name.downcase} ... "
+        target.delete_members
+        success "done"
+
+      else
+        raise ArgumentError, 'You must pass one or more logins or ids to this command' unless members.present?
+        say "Removing #{pluralize(members.length, 'member')} from #{target.class.model_name.downcase} ... "
+        target.update_members(changes_for(members, 'none'))
+        success "done"
+      end
+
+      0
+    end
+
+    protected
+      def changes_for(members, role)
+        members.map do |m|
+          h = {:role => role}
+          h[options.ids ? :id : :login] = m
+          h
+        end
+      end
+  end
+end

data/lib/rhc/commands/port_forward.rb

@@ -0,0 +1,197 @@
+require 'uri'
+
+module RHC::Commands
+  class ForwardingSpec
+    include RHC::Helpers
+    include Enumerable
+    # class to represent how SSH port forwarding should be performed
+    attr_accessor :port_from
+    attr_reader :remote_host, :port_to, :host_from, :service
+    attr_writer :bound
+
+    def initialize(service, remote_host, port_to, port_from = nil)
+      @service     = service
+      @remote_host = remote_host
+      @port_to     = port_to
+      @host_from   = '127.0.0.1'
+      @port_from   = port_from || port_to # match ports if possible
+      @bound       = false
+    end
+
+    def to_cmd_arg
+      # string to be used in a direct SSH command
+      "-L #{port_from}:#{remote_host}:#{port_to}"
+    end
+
+    def to_fwd_args
+      # array of arguments to be passed to Net::SSH::Service::Forward#local
+      [port_from.to_i, remote_host, port_to.to_i]
+    end
+
+    def bound?
+      @bound
+    end
+
+    # :nocov: These are for sorting. No need to test for coverage.
+    def <=>(other)
+      if bound? && !other.bound?
+        -1
+      elsif !bound? && other.bound?
+        1
+      else
+        order_by_attrs(other, :service, :remote_host, :port_from)
+      end
+    end
+
+    def order_by_attrs(other, *attrs)
+      # compare self and "other" by examining their "attrs" in order
+      # attrs should be an array of symbols to which self and "other"
+      # respond when sent.
+      while attribute = attrs.shift do
+        if self.send(attribute) != other.send(attribute)
+          return self.send(attribute) <=> other.send(attribute)
+        end
+      end
+      0
+    end
+    # :nocov:
+
+    private :order_by_attrs
+  end
+
+  class PortForward < Base
+
+    UP_TO_256 = /25[0-5]|2[0-4][0-9]|[01]?(?:[0-9][0-9]?)/
+    UP_TO_65535 = /6553[0-5]|655[0-2][0-9]|65[0-4][0-9][0-9]|6[0-4][0-9][0-9][0-9]|[0-5]?(?:[0-9][0-9]{0,3})/
+    # 'host' part is a bit lax; we rely on 'rhc-list-ports' to hand us a reasonable output
+    # about the host information, be it numeric or FQDN in IPv4 or IPv6.
+    HOST_AND_PORT = /(.+):(#{UP_TO_65535})\b/
+
+    summary "Forward remote ports to the workstation"
+    syntax "<application>"
+    takes_application :argument => true
+    option ["-g", "--gear ID"], "Gear ID you are port forwarding to (optional)"
+    def run(app)
+      rest_app = find_app
+      ssh_uri = URI.parse(options.gear ? rest_app.gear_ssh_url(options.gear) : rest_app.ssh_url)
+
+      say "Using #{ssh_uri}..." if options.debug
+
+      forwarding_specs = []
+
+      begin
+        say "Checking available ports ... "
+
+        Net::SSH.start(ssh_uri.host, ssh_uri.user) do |ssh|
+          # If a specific gear is targeted, do not include remote (e.g. database) ports
+          list_ports_cmd = "rhc-list-ports#{options.gear ? ' --exclude-remote' : ''}"
+          ssh.exec! list_ports_cmd do |channel, stream, data|
+            if stream == :stderr
+              data.each_line do |line|
+                line.chomp!
+                # FIXME: This is really brittle; there must be a better way
+                # for the server to tell us that permission (what permission?)
+                # is denied.
+                raise RHC::PermissionDeniedException.new "Permission denied." if line =~ /permission denied/i
+                # ...and also which services are available for the application
+                # for us to forward ports for.
+                if line =~ /\A\s*(\S+) -> #{HOST_AND_PORT}\z/
+                  debug fs = ForwardingSpec.new($1, $2, $3.to_i)
+                  forwarding_specs << fs
+                else
+                  debug line
+                end
+
+              end
+            end
+          end
+
+          if forwarding_specs.length == 0
+            # check if the gears have been stopped
+            if rest_app.gear_groups.all?{ |gg| gg.gears.all?{ |g| g["state"] == "stopped" } }
+              warn "none"
+              error "The application is stopped. Please restart the application and try again."
+              return 1
+            else
+              warn "none"
+              raise RHC::NoPortsToForwardException.new "There are no available ports to forward for this application. Your application may be stopped or idled."
+            end
+          end
+
+          success "done"
+
+          begin
+            Net::SSH.start(ssh_uri.host, ssh_uri.user) do |ssh|
+              say "Forwarding ports ..."
+              forwarding_specs.each do |fs|
+                given_up = nil
+                while !fs.bound? && !given_up
+                  begin
+                    args = fs.to_fwd_args
+                    debug args.inspect
+                    ssh.forward.local(*args)
+                    fs.bound = true
+                  rescue Errno::EADDRINUSE, Errno::EACCES => e
+                    warn "#{e} while forwarding port #{fs.port_from}. Trying local port #{fs.port_from+1}"
+                    fs.port_from += 1
+                  rescue Timeout::Error, Errno::EADDRNOTAVAIL, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Net::SSH::AuthenticationFailed => e
+                    given_up = true
+                  end
+                end
+              end
+
+              bound_ports = forwarding_specs.select(&:bound?)
+              if bound_ports.length > 0
+                paragraph{ say "To connect to a service running on OpenShift, use the Local address" }
+                paragraph do
+                  say table(
+                        bound_ports.map do |fs|
+                          [fs.service, "#{fs.host_from}:#{fs.port_from}", " => ", "#{fs.remote_host}:#{fs.port_to.to_s}"]
+                        end,
+                        :header => ["Service", "Local", "    ", "OpenShift"]
+                      )
+                end
+              end
+
+              # for failed port forwarding attempts
+              failed_port_forwards = forwarding_specs.select { |fs| !fs.bound? }
+              if failed_port_forwards.length > 0
+                ssh_cmd_arg = failed_port_forwards.map { |fs| fs.to_cmd_arg }.join(" ")
+                ssh_cmd = "ssh -N #{ssh_cmd_arg} #{ssh_uri.user}@#{ssh_uri.host}"
+                warn "Error forwarding some port(s). You can try to forward manually by running:\n#{ssh_cmd}"
+              else
+                say "Press CTRL-C to terminate port forwarding"
+              end
+
+              unless forwarding_specs.any?(&:bound?)
+                warn "No ports have been bound"
+                return
+              end
+              ssh.loop { true }
+            end
+          rescue Interrupt
+            say " Ending port forward"
+            return 0
+          end
+
+        end
+
+      rescue Timeout::Error, Errno::EADDRNOTAVAIL, Errno::EADDRINUSE, Errno::EHOSTUNREACH, Errno::ECONNREFUSED, Net::SSH::AuthenticationFailed => e
+        ssh_cmd = ["ssh","-N"]
+        unbound_fs = forwarding_specs.select { |fs| !fs.bound? }
+        ssh_cmd += unbound_fs.map { |fs| fs.to_cmd_arg }
+        ssh_cmd += ["#{ssh_uri.user}@#{ssh_uri.host}"]
+        raise RHC::PortForwardFailedException.new("#{e.message + "\n" if options.debug}Error trying to forward ports. You can try to forward manually by running:\n" + ssh_cmd.join(" "))
+      end
+
+      0
+    rescue RHC::Rest::ConnectionException => e
+      error "Connection to #{openshift_server} failed: #{e.message}"
+      1
+    end
+  end
+end
+
+# mock for windows
+if defined?(UNIXServer) != 'constant' or UNIXServer.class != Class then class UNIXServer; end; end
+

data/lib/rhc/commands/reload.rb

@@ -0,0 +1,17 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class Reload < App
+
+    summary "Reload the application's configuration"
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+
+    def run(app)
+      self.class.superclass.instance_method(:reload).bind(self).call app
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/restart.rb

@@ -0,0 +1,17 @@
+require 'rhc/commands/app'
+
+module RHC::Commands
+  class Restart < App
+
+    summary "Restart the application"
+    syntax "<app> [--namespace NAME]"
+    takes_application :argument => true
+
+    def run(app)
+      self.class.superclass.instance_method(:restart).bind(self).call app
+
+      0
+    end
+
+  end
+end

data/lib/rhc/commands/scp.rb

@@ -0,0 +1,54 @@
+require 'rhc/commands/base'
+require 'rhc/scp_helpers'
+
+
+module RHC::Commands
+  class Scp < Base
+    suppress_wizard
+
+    summary "SCP a file to or from your application"
+    description <<-DESC
+      Transfer files to and from your applications using SCP.  This will transfer
+      files to and from your primary gear (the one with the Git repository and web
+      cartridge) by default.
+
+      Examples:
+        Uploading a file from your workding directory to your app-root/data directory
+          app scp myapp upload somefile.txt app-root/data
+
+        Downloading a file from your app-root/data directory to your working directory
+          app scp myapp download ./ app-root/data/somebigarchive.tar.gz
+    DESC
+    syntax "[<app> --] <action> <local_path> <remote_path>"
+    takes_application :argument => true
+    argument :action, "Transfer direction: upload|download", ["-t", "--transfer_direction upload|download"], :optional => false
+    argument :local_path, "Local filesystem path", ["-l", "--local_path file_path"], :optional => false
+    argument :remote_path, "Remote filesystem path", ["-r", "--remote_path file_path"], :optional => false
+    alias_action 'app scp', :root_command => true
+    def run(_, action, local_path, remote_path)
+      rest_app = find_app
+      ssh_opts = rest_app.ssh_url.gsub("ssh://","").split("@")
+
+      raise RHC::ArgumentNotValid.new("'#{action}' is not a valid argument for this command.  Please use upload or download.") unless action == 'download' || action == 'upload'
+      raise RHC::FileOrPathNotFound.new("Local file, file_path, or directory could not be found.") unless File.exist?(local_path)
+
+      begin
+          start_time = Time.now
+          Net::SCP.send("#{action}!".to_sym, ssh_opts[1], ssh_opts[0], (action == 'upload' ? local_path : remote_path), (action == 'upload' ? remote_path : local_path)) do |ch, name, sent, total|
+            #:nocov:
+            $stderr.print "\r #{action}ing #{name}: #{((sent.to_f/total.to_f)*100).to_i}% complete. #{sent}/#{total} bytes transferred " + (sent == total ? "in #{Time.now - start_time} seconds \n" : "")
+            #:nocov:
+          end
+      rescue Errno::ECONNREFUSED
+        raise RHC::SSHConnectionRefused.new(ssh_opts[0], ssh_opts[1])
+      rescue SocketError => e
+        raise RHC::ConnectionFailed, "The connection to #{ssh_opts[1]} failed: #{e.message}"
+      rescue Net::SCP::Error => e
+        raise RHC::RemoteFileOrPathNotFound.new("Remote file, file_path, or directory could not be found.")
+      end
+    end
+
+    protected
+    include RHC::SCPHelpers
+  end
+end

data/lib/rhc/commands/server.rb

@@ -0,0 +1,40 @@
+module RHC::Commands
+  class Server < Base
+    suppress_wizard
+
+    summary "Display information about the status of the OpenShift service"
+    description <<-DESC
+      Retrieves any open issues or notices about the operation of the
+      OpenShift service and displays them in the order they were opened.
+
+      When connected to an OpenShift Enterprise server, will only display
+      the version of the API that it is connecting to.
+      DESC
+    def run
+      say "Connected to #{openshift_server}"
+
+      if openshift_online_server?
+        #status = decode_json(get("#{openshift_url}/app/status/status.json").body)
+        status = rest_client.request(:method => :get, :url => "#{openshift_url}/app/status/status.json", :lazy_auth => true){ |res| decode_json(res.content) }
+        open = status['open']
+
+        (success 'All systems running fine' and return 0) if open.blank?
+
+        open.each do |i|
+          i = i['issue']
+          say color("%-3s %s" % ["##{i['id']}", i['title']], :bold)
+          items = i['updates'].map{ |u| [u['description'], date(u['created_at'])] }
+          items.unshift ['Opened', date(i['created_at'])]
+          table(items, :align => [nil,:right], :join => '  ').each{ |s| say "    #{s}" }
+        end
+        say "\n"
+        warn pluralize(open.length, "open issue")
+
+        open.length #exit with the count of open items
+      else
+        success "Using API version #{rest_client.api_version_negotiated}"
+        0
+      end
+    end
+  end
+end

data/lib/rhc/commands/setup.rb

@@ -0,0 +1,60 @@
+require 'rhc/commands/base'
+require 'rhc/wizard'
+require 'rhc/config'
+
+module RHC::Commands
+  class Setup < Base
+    suppress_wizard
+
+    summary "Connects to StartApp and sets up your keys and domain"
+    description <<-DESC
+      Connects to an StartApp server to get you started. Will help you
+      configure your SSH keys, set up a domain, and check for any potential
+      problems with Git or SSH.
+
+      Any options you pass to the setup command will be stored in a
+      .openshift/express.conf file in your home directory. If you run
+      setup at a later time, any previous configuration will be reused.
+
+      Pass the --clean option to ignore your saved configuration and only
+      use options you pass on the command line. Pass --config FILE to use
+      default values from another config (the values will still be written
+      to .startapp/express.conf).
+
+      If the server supports authorization tokens, you may pass the
+      --create-token option to instruct the wizard to generate a key for you.
+
+      If you would like to enable tab-completion in Bash shells, pass
+      --autocomplete for more information.
+      DESC
+    option ["--server NAME"], "Hostname of an OpenShift server", :default => :server_context, :required => true
+    option ['--clean'], "Ignore any saved configuration options"
+    option ['--[no-]create-token'], "Create an authorization token for this server"
+    option ['--autocomplete'], "Instructions for enabling tab-completion"
+    def run
+      if options.autocomplete
+        src = File.join(File.join(Gem.loaded_specs['app'].full_gem_path, "autocomplete"), "rhc_bash")
+        dest = File.join(RHC::Config.home_conf_dir, "bash_autocomplete")
+
+        FileUtils.mkdir_p(RHC::Config.home_conf_dir)
+        FileUtils.cp(src, dest)
+
+        say <<-LINE.strip_heredoc
+          To enable tab-completion for `app` under Bash shells, add the following command to
+          your .bashrc or .bash_profile file:
+
+            . #{dest}
+
+          Save your shell and then restart. Type "app" and then hit the TAB key twice to
+          trigger completion of your command.
+
+          Tab-completion is not available in the Windows terminal.
+          LINE
+        return 0
+      end
+
+      raise OptionParser::InvalidOption, "Setup can not be run with the --noprompt option" if options.noprompt
+      RHC::RerunWizard.new(config, options).run ?  0 : 1
+    end
+  end
+end