rhc 0.92.11 → 0.93.18

data/lib/rhc/wizard.rb

@@ -0,0 +1,579 @@
+require 'rhc-common'
+require 'rhc/helpers'
+require 'highline/system_extensions'
+require 'net/ssh'
+
+# ruby 1.8 -> 1.9 magic
+begin
+  require 'ftools'
+rescue LoadError
+  require 'fileutils'
+end
+
+module RHC
+  class Wizard
+    include HighLine::SystemExtensions
+    include RHC::Helpers
+
+    @@stages = [:greeting_stage,
+                :login_stage,
+                :create_config_stage,
+                :config_ssh_key_stage,
+                :upload_ssh_key_stage,
+                :install_client_tools_stage,
+                :config_namespace_stage,
+                :show_app_info_stage,
+                :finalize_stage]
+
+    def initialize(config_path)
+      @config_path = config_path
+    end
+
+    # Public: Runs the setup wizard to make sure ~/.openshift and ~/.ssh are correct
+    #
+    # Examples
+    #
+    #  wizard.run()
+    #  # => true
+    #
+    # Returns nil on failure or true on success
+    def run
+      @@stages.each do |stage|
+        # FIXME: cleanup if we fail
+        if (self.send stage).nil?
+          return nil
+        end
+      end
+      true
+    end
+
+    private
+
+    def stages
+      @@stages
+    end
+
+    def greeting_stage
+      paragraph do
+        say "Starting Interactive Setup for OpenShift's command line interface"
+      end
+
+      paragraph do
+        say "It looks like you have not configured or used OpenShift " \
+            "client tools on this computer. " \
+            "We'll help you configure the client tools with a few quick questions. " \
+            "You can skip this in the future by copying your configuration files to other machines you use to manage your OpenShift account:"
+      end
+
+      paragraph do
+        say "#{@config_path}"
+        say "#{RHC::Config.home_dir}/.ssh/"
+      end
+
+      true
+    end
+
+    def login_stage
+      if @libra_server.nil?
+        @libra_server = get_var('libra_server')
+        # if not set, set to default
+        @libra_server = @libra_server ?  @libra_server : "openshift.redhat.com"
+      end
+
+      # get_password adds an extra untracked newline so set :bottom to -1
+      section(:top => 1, :bottom => -1) do
+        @username = ask("To connect to #{@libra_server} enter your OpenShift login (email or Red Hat login id): ")
+        @password = RHC::get_password
+      end
+
+      # Confirm username / password works:
+      user_info = RHC::get_user_info(@libra_server, @username, @password, RHC::Config.default_proxy, true)
+
+      # instantiate a REST client that stages can use
+      # TODO: use only REST calls in the wizard
+      end_point = "https://#{@libra_server}/broker/rest/api"
+      @rest_client = Rhc::Rest::Client.new(end_point, @username, @password)
+
+      true
+    end
+
+    def create_config_stage
+      if !File.exists? @config_path
+        FileUtils.mkdir_p File.dirname(@config_path)
+        File.open(@config_path, 'w') do |file|
+          file.puts <<EOF
+# Default user login
+default_rhlogin='#{@username}'
+
+# Server API
+libra_server = '#{@libra_server}'
+EOF
+
+        end
+
+        paragraph do
+          say "Created local config file: " + @config_path
+          say "The express.conf file contains user configuration, and can be transferred to different computers."
+        end
+
+        true
+      end
+
+      # Read in @config_path now that it exists (was skipped before because it did
+      # not exist
+      RHC::Config.set_local_config(@config_path)
+    end
+
+    def config_ssh_key_stage
+      @ssh_priv_key_file_path = "#{RHC::Config.home_dir}/.ssh/id_rsa"
+      @ssh_pub_key_file_path = "#{RHC::Config.home_dir}/.ssh/id_rsa.pub"
+      unless File.exists? @ssh_priv_key_file_path
+        paragraph do
+          say "No SSH keys were found. We will generate a pair of keys for you."
+        end
+        @ssh_pub_key_file_path = generate_ssh_key_ruby()
+        paragraph do
+          say "    Created: #{@ssh_pub_key_file_path}\n\n"
+        end
+      end
+      true
+    end
+
+    def ssh_key_uploaded?
+      @ssh_keys = RHC::get_ssh_keys(@libra_server, @username, @password, RHC::Config.default_proxy)
+      additional_ssh_keys = @ssh_keys['keys']
+
+      local_fingerprint = nil
+      begin
+        local_fingerprint = Net::SSH::KeyFactory.load_public_key(@ssh_pub_key_file_path).fingerprint
+      rescue NoMethodError #older net/ssh (mac for example)
+        local_fingerprint = `ssh-keygen -lf #{@ssh_pub_key_file_path}`.split(' ')[1]
+      end
+
+      return true if @ssh_keys['fingerprint'] == local_fingerprint
+      additional_ssh_keys.each do |name, keyval|
+        return true if keyval['fingerprint'] == local_fingerprint
+      end
+
+      false
+    end
+
+    def upload_ssh_key
+      additional_ssh_keys = @ssh_keys['keys']
+      known_keys = []
+
+      paragraph do
+        say "You can enter a name for your key, or leave it blank to use the default name. " \
+            "Using the same name as an existing key will overwrite the old key."
+      end
+
+      section(:top => 1) { say 'Current Keys:' }
+      if @ssh_keys['fingerprint'].nil?
+        section(:bottom => 1) { say "    None" }
+      else
+        known_keys << 'default'
+        section do
+          say "    default - #{@ssh_keys['fingerprint']}"
+        end
+      end
+
+      if additional_ssh_keys && additional_ssh_keys.kind_of?(Hash)
+        section(:bottom => 1) do
+          additional_ssh_keys.each do |name, keyval|
+            say "    #{name} - #{keyval['fingerprint']}"
+            known_keys.push(name)
+          end
+        end
+      end
+
+      if @ssh_keys['fingerprint'].nil?
+        key_name = "default"
+        paragraph do
+          say "Since you do not have any keys associated with your OpenShift account, " \
+              "your new key will be uploaded as the default key"
+        end
+      else
+        key_fingerprint = nil
+        key_valid = true
+        begin
+          key_fingerprint = Net::SSH::KeyFactory.load_public_key(@ssh_pub_key_file_path).fingerprint
+        rescue NoMethodError #older net/ssh (mac for example)
+          key_fingerprint = `ssh-keygen -lf #{@ssh_pub_key_file_path}`.split(' ')[1]
+          if $?.exitstatus != 0
+            key_valid = false
+          end
+        rescue Net::SSH::Exception
+        rescue NotImplementedError
+          key_valid = false
+        end
+
+        if ! key_valid
+          paragraph do
+            say "Your ssh public key at #{@ssh_pub_key_file_path} can not be read. " \
+                "The setup can not continue until you manually remove or fix both of your " \
+                "public and private keys id_rsa keys."
+            end
+          return false
+        end
+
+        pubkey_default_name = key_fingerprint[0, 12].gsub(/[^0-9a-zA-Z]/,'')
+        paragraph do
+          key_name =  ask("Provide a name for this key: ") do |q|
+            q.default = pubkey_default_name
+            q.validate = lambda { |p| RHC::check_key(p) }
+          end
+        end
+      end
+
+      if known_keys.include?(key_name)
+        section do
+          say "Key already exists!  Updating key #{key_name} .. "
+          add_or_update_key('update', key_name, @ssh_pub_key_file_path, @username, @password)
+        end
+      else
+        section do
+          say "Sending new key #{key_name} .. "
+          add_or_update_key('add', key_name, @ssh_pub_key_file_path, @username, @password)
+        end
+      end
+      true
+    end
+
+    def upload_ssh_key_stage
+      unless ssh_key_uploaded?
+        upload = false
+        section do
+          upload = agree "Your public ssh key must be uploaded to the OpenShift server.  Would you like us to upload it for you? (yes/no) "
+        end
+
+        if upload
+          upload_ssh_key
+        else
+          paragraph do
+            say "You can upload your ssh key at a later time using the 'rhc sshkey' command"
+          end
+        end
+      end
+      true
+    end
+
+    ##
+    # Attempts install various tools if they aren't currently installed on the
+    # users system.  If we can't automate the install, alert the user that they
+    # should manually install them
+    #
+    # On Unix we rely on PackageKit (which mostly just covers modern Linux flavors
+    # such as Fedora, Suse, Debian and Ubuntu). On Windows we will give instructions
+    # and links for the tools they should install
+    #
+    # Unix Tools:
+    #  git
+    #
+    # Windows Tools:
+    #  msysgit (Git for Windows)
+    #  TortoiseGIT (Windows Explorer integration)
+    #
+    def install_client_tools_stage
+      if windows?
+        windows_install
+      else
+        # we use command line tools for dbus since the dbus gem is not cross
+        # platform and compiles itself on the host system when installed
+        paragraph do
+          say "We will now check to see if you have the necessary client tools installed."
+        end
+        if has_dbus_send?
+          package_kit_install
+        else
+          generic_unix_install_check
+        end
+      end
+      true
+    end
+
+    def config_namespace_stage
+      paragraph do
+        say "Checking for your namespace ... "
+        user_info = RHC::get_user_info(@libra_server, @username, @password, RHC::Config.default_proxy, true)
+        domains = user_info['user_info']['domains']
+        if domains.length == 0
+          say "not found"
+          ask_for_namespace
+        else
+          say "found namespace:"
+          domains.each { |d| say "    #{d['namespace']}" }
+        end
+      end
+
+      true
+    end
+
+    def show_app_info_stage
+      section do
+        say "Checking for applications ... "
+      end
+      user_info = RHC::get_user_info(@libra_server, @username, @password, RHC::Config.default_proxy, true)
+      apps = user_info['app_info']
+      if !apps.nil? and !apps.empty?
+        section(:bottom => 1) do
+          say "found"
+          apps.each do |app_name, app_info|
+            app_url = nil
+            unless user_info['user_info']['domains'].empty?
+              app_url = "http://#{app_name}-#{user_info['user_info']['domains'][0]['namespace']}.#{user_info['user_info']['rhc_domain']}/"
+            end
+
+            if app_url.nil?
+              say "    * #{app_name} - no public url (you need to add a namespace)"
+            else
+              say "    * #{app_name} - #{app_url}"
+            end
+          end
+        end
+      else
+        section(:bottom => 1) { say "none found" }
+        paragraph do
+          say "Below is a list of the types of application " \
+              "you can create: "
+
+          application_types = RHC::get_cartridges_list @libra_server, RHC::Config.default_proxy
+          application_types.each do |cart|
+            say "    * #{cart} - rhc app create -t #{cart} -a <app name>"
+          end
+        end
+      end
+
+      true
+    end
+
+    def finalize_stage
+      paragraph do
+        say "The OpenShift client tools have been configured on your computer.  " \
+            "You can run this setup wizard at any time by using the command 'rhc setup' " \
+            "We will now execute your original " \
+            "command (rhc #{ARGV.join(" ")})"
+      end
+      true
+    end
+
+    def config_namespace(namespace)
+      # skip if string is empty
+      paragraph do
+        if namespace.nil? or namespace.chomp.length == 0
+          say "Skipping! You may create a namespace using 'rhc domain create'"
+          return true
+        end
+
+
+        begin
+          domain = @rest_client.add_domain(namespace)
+
+          say "Your domain name '#{domain.id}' has been successfully created"
+        rescue Rhc::Rest::ValidationException => e
+          say "#{e.to_s}"
+          return false
+        end
+      end
+      true
+    end
+
+    def ask_for_namespace
+      paragraph do
+        say "Your namespace is unique to your account and is the suffix of the " \
+            "public URLs we assign to your applications. You may configure your " \
+            "namespace here or leave it blank and use 'rhc domain create' to " \
+            "create a namespace later.  You will not be able to create " \
+            "applications without first creating a namespace."
+      end
+
+      namespace = nil
+      paragraph do
+        namespace = ask "Please enter a namespace or leave this blank if you wish to skip this step:" do |q|
+          q.validate = lambda { |p| RHC::check_namespace p }
+        end
+      end
+
+      while !config_namespace namespace do
+        paragraph do
+          namespace = ask "Please enter a namespace or leave this blank if you wish to skip this step:" do |q|
+            q.validate = lambda { |p| RHC::check_namespace p }
+          end
+        end
+      end
+    end
+
+    def dbus_send_session_method(name, service, obj_path, iface, stringafied_params, wait_for_reply=true)
+      method = "#{iface}.#{name}"
+      print_reply = ""
+      print_reply = "--print-reply" if wait_for_reply
+      cmd = "dbus-send --session #{print_reply} --type=method_call \
+            --dest=#{service} #{obj_path} #{method} #{stringafied_params}"
+      output = `#{cmd} 2>&1`
+
+      throw output if output.start_with?('Error') and !$?.success?
+
+      # parse the output
+      results = []
+      output.each_with_index do |line, i|
+        if i != 0 # discard first line
+          param_type, value = line.chomp.split(" ", 2)
+
+          case param_type
+          when "boolean"
+            results << (value == 'true')
+          when "string"
+            results << value
+          else
+            puts "unknown type #{param_type} - treating as string"
+            results << value
+          end
+        end
+      end
+
+      if results.length == 0
+        return nil
+      elsif results.length == 1
+        return results[0]
+      else
+        return results
+      end
+    end
+
+    ##
+    # calls package kit methods using dbus_send
+    #
+    # name - method name
+    # iface - either 'Query' or 'Modify'
+    # stringafied_params - string of params in the format of dbus-send
+    #  e.g. "int32:10 string:'hello world'"
+    #
+    def package_kit_method(name, iface, stringafied_params, wait_for_reply=true)
+      service = "org.freedesktop.PackageKit"
+      obj_path = "/org/freedesktop/PackageKit"
+      full_iface = "org.freedesktop.PackageKit.#{iface}"
+      dbus_send_session_method name, service, obj_path, full_iface, stringafied_params, wait_for_reply
+    end
+
+    def package_kit_install
+      section(:top => 1) do
+        say "Checking for git ... "
+      end
+
+      begin
+        git_installed = package_kit_method('IsInstalled', 'Query', 'string:git string:')
+        if git_installed
+          section(:bottom => 1) { say "found" }
+        else
+          section(:bottom => 1) { say "needs to be installed" }
+          install = false
+          section do
+            install = agree "Would you like to install git with the system installer? (yes/no) "
+          end
+          if install
+            package_kit_method('InstallPackageNames', 'Modify', 'uint32:0 array:string:"git" string:', false)
+            paragraph do
+              say "You may safely continue while the installer is running or " \
+                  "you can wait until it has finished.  Press any key to continue:"
+              get_character
+            end
+          end
+        end
+      rescue
+        generic_unix_install_check false
+      end
+    end
+
+    def generic_unix_install_check(show_action=true)
+      section(:top => 1) { say "Checking for git ... " } if show_action
+      if has_git?
+        section(:bottom => 1) { say "found" }
+      else
+        section(:bottom => 1) { say "needs to be installed" }
+        paragraph do
+          say "Automated installation of client tools is not supported for " \
+              "your platform. You will need to manually install git for full " \
+              "OpenShift functionality."
+        end
+      end
+    end
+
+    def windows_install
+      # Finding windows executables is hard since they can get installed
+      # in non standard directories.  Punt on this for now and simply
+      # print out urls and some instructions
+      say <<EOF
+In order to fully interact with OpenShift you will need to install and configure a git client if you have not already done so.
+
+Documentation for installing other tools you will need for OpenShift can be found at https://#{@libra_server}/app/getting_started#install_client_tools
+
+We recommend these free applications:
+
+  * Git for Windows - a basic git command line and GUI client https://github.com/msysgit/msysgit/wiki/InstallMSysGit
+  * TortoiseGit - git client that integrates into the file explorer http://code.google.com/p/tortoisegit/
+
+EOF
+    end
+
+    def exe?(executable)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
+        File.executable?(File.join(directory, executable.to_s))
+      end
+    end
+
+    def has_git?
+      %x{ git --version }
+      $?.success?
+    end
+
+    def has_dbus_send?
+      bus = ENV['DBUS_SESSION_BUS_ADDRESS']
+      exe? 'dbus-send' and !bus.nil? and bus.length > 0
+    end
+  end
+
+  class RerunWizard < Wizard
+    def initialize(config_path)
+      super
+    end
+
+    def greeting_stage
+      paragraph do
+        say "Starting Interactive Setup for OpenShift's command line interface"
+      end
+
+      paragraph do
+        say "We'll help get you setup with just a couple of questions. " \
+            "You can skip this in the future by copying your config's around:"
+      end
+
+      paragraph do
+        say "    #{@config_path}"
+        say "    #{RHC::Config.home_dir}/.ssh/"
+      end
+
+      true
+    end
+
+    def create_config_stage
+      if File.exists? @config_path
+        backup = "#{@config_path}.bak"
+        paragraph do
+          say "Configuration file #{@config_path} already exists, " \
+              "backing up to #{backup}"
+        end
+        File.cp(@config_path, backup)
+        File.delete(@config_path)
+      end
+      super
+      true
+    end
+
+    def finalize_stage
+      paragraph do
+        say "Thank you for setting up your system.  You can rerun this at any time " \
+            "by calling 'rhc setup'."
+      end
+      true
+    end
+  end
+end