appscale-tools 1.6.0

data/lib/sshcopyid

@@ -0,0 +1,65 @@
+#!/usr/bin/env expect
+
+#############################
+#
+# Author : Kowshik Prakasam
+#
+# An expect script to automatically login to each host as a particular user and 
+# install the user's public key using ssh-copy-id
+#
+# If successful, exits with zero (0) status 
+# If unsuccessful, exits with non-zero status
+#
+# Usage : sshcopy.exp <user@host> <key_file> <password>
+# Example : sshcopy.exp root@128.111.55.234 /home/appscale/.appscale/appscale joe
+#
+#############################
+
+# Procedure to interact with ssh-copy-id command
+# Parameter : password 
+proc sshcopyid { password } {
+  expect {
+    # Send password at 'Password' prompt and tell expect to continue(i.e. exp_continue)
+    -re "\[P|p]assword:" { exp_send "$password\r"
+                           exp_continue }
+
+    #Returning 1 as ssh-copy-id has failed
+    -re "^\[P|p]ermission denied*" { return 1}
+                           
+    #Answering yes to ssh host 
+    -nocase  "are you sure you want to continue connecting (yes/no)?" { exp_send "yes\r"
+    	    	      	       	   	   	    	       		    exp_continue }
+            
+    # Tell expect stay in this 'expect' block and for each character that ssh-copy-id prints while doing the copy
+    # Reset the timeout counter back to 0
+    -re .                { exp_continue  }
+    timeout              { return 1      }
+    
+    #Returning 0 as ssh-copy-id was successful
+    eof                  { return 0      }
+  }
+}
+
+#Parsing command-line arguments
+set host [lrange $argv 0 0]
+set key_file [lrange $argv 1 1]
+set password [lrange $argv 2 2]
+
+#Setting timeout to an arbitrary value of 3 that works well for ssh-copy-id
+set timeout 3
+
+# Execute ssh-copy-id command
+eval spawn ssh-copy-id -i $key_file $host
+
+#Get the result of ssh-copy-id
+set sshcopyid_result [sshcopyid $password]
+
+# If ssh-copy-id was successful
+if { $sshcopyid_result == 0 } {
+  #Exit with zero status
+  exit 0
+}
+
+# Error attempting ssh-copy-id, so exit with non-zero status
+exit 1
+

data/lib/usage_text.rb

@@ -0,0 +1,144 @@
+# Programmer: Chris Bunch
+
+require 'common_functions'
+require 'custom_exceptions'
+
+module UsageText
+  def self.get_usage(file_name, flags)
+    preamble = "#{AS_VERSION}\n\nUsage: #{file_name} OPTIONS\n\nFlags:"
+    flag_text = ""
+    flags.each { |flag|
+      if !self.respond_to?(flag.to_sym)
+        raise BadCommandLineArgException.new(flag)
+      end
+
+      flag_text += "\n\t" + self.send(flag.to_sym)
+    }
+    return preamble + flag_text + "\n\n"
+  end
+
+  def self.appengine
+    "--appengine NUM: The number of application servers that should be spawned up for each Google App Engine app."
+  end
+
+  def self.appname
+    "--appname APPNAME: The name of the application to remove."
+  end
+
+  def self.auto
+    "--auto: Requests the SSH login password from the user once, and then automatically reuses the password on each machine."
+  end
+
+  def self.backup_neptune_info
+    "--backup_neptune_info FILE: Backs up Neptune job metadata to FILE."
+  end
+
+  def self.confirm
+    "--confirm: Skips the confirmation step when removing an application."
+  end
+
+  def self.email
+    "--email EMAIL: Uses EMAIL as the app administrator for the given application instead of prompting for it."
+  end
+
+  def self.file
+    "--file FILE: The app to upload. Must be a directory or file tar'ed up via 'tar -czf app.tar.gz .' in the application's top level directory."
+  end
+
+  def self.force
+    "--force: If the given keyname is already in use, remove it from the system and add a new key with the same name."
+  end
+
+  def self.group
+    "--group: The name of the security group to create when running over a cloud infrastructure."
+  end
+
+  def self.h
+    "-h: Displays this usage message."
+  end
+
+  def self.help
+    "--help: Displays this usage message."
+  end
+
+  def self.instance_type
+    "--instance_type: The instance type to use if using Eucalyptus. Defaults to m1.large if not provided. Supported values are m1.large, m1.xlarge, and c1.xlarge."
+  end
+
+  def self.iaas
+    "--iaas INFRASTRUCTURE: Same as --infrastructure, but if no value is provided, defaults to euca."
+  end
+
+  def self.infrastructure
+    "--infrastructure INFRASTRUCTURE: The cloud infrastructure that AppScale should utilize. Acceptable values are: #{VALID_CLOUD_TYPES.join(', ')}."
+  end
+
+  def self.ips
+    "--ips: The YAML file containing the IPs (and optionally, the service placement) of the machines to use."
+  end
+
+  def self.keyname
+    "--keyname KEYNAME: The name of the SSH key to use for Eucalyptus. Two AppScale instances can be run concurrently in one cloud if they have unique names, and they can conflict if they have the same name."
+  end
+
+  def self.machine
+    "--machine IMAGE_ID: The machine image to use in Amazon EC2 or Eucalyptus. Supercedes the contents of the environment variable APPSCALE_MACHINE, which is otherwise used if this flag is not present."
+  end
+
+  def self.min
+    "--min NUM: The minimum number of VMs to spawn for AppScale in cloud deployments."
+  end
+
+  def self.max
+    "--max NUM: The maximum number of VMs to spawn for AppScale in cloud deployments."
+  end
+
+  def self.n
+    "-n NUM: The replication factor that should be used with the underlying database."
+  end
+
+  def self.r
+    "-r NUM: The number of database nodes needed for a read to succeed. Not supported by all databases."
+  end
+
+  def self.restore_from_tar
+    "--restore_from_tar LOCATION: The location of the tar file that can be used to back up the state of a previously running AppScale deployment."
+  end
+
+  def self.restore_neptune_info
+    "--restore_neptune_info LOCATION: The location of a previously saved Neptune job metadata file, to be used when starting a new Appscale deployment."
+  end
+
+  def self.scp
+    "--scp LOCATION: A location on the local file system where a copy of the AppScale main branch is located. This flag instructs the tools to rsync this branch over to all nodes used. Useful for testing and debugging. If no value is provided, ~/appscale is used."
+  end
+
+  def self.table
+    "--table DATABASE: The database to use with AppScale. Acceptable values are: #{VALID_TABLE_TYPES.join(', ')} (default is #{DEFAULT_DATASTORE})."
+  end
+
+  def self.test
+    "--test: Uses a default username and password when uploading an application. Intended for testing only."
+  end
+
+  def self.usage
+    "--usage: Displays this usage message."
+  end
+
+  def self.v
+    "-v: Displays extra output. Useful for debugging."
+  end
+
+  def self.verbose
+    "--verbose: Displays extra output. Useful for debugging."
+  end
+
+  def self.version
+    "--version: Displays the version of the AppScale tools used."
+  end
+
+  def self.w
+    "-w NUM: The number of database nodes needed for a write to succeed. Not supported by all databases."
+  end
+
+end

data/lib/user_app_client.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/ruby -w
+# Programmer: Chris Bunch
+
+require 'base64'
+require 'openssl'
+require 'soap/rpc/driver'
+require 'timeout'
+
+ADMIN_CAPABILITIES = ["upload_app", "mr_api", "ec2_api", "neptune_api"].join(":")
+
+class UserAppClient
+  attr_reader :conn, :ip, :secret
+
+  def initialize(ip, secret)
+    @ip = ip
+    @secret = secret
+    
+    @conn = SOAP::RPC::Driver.new("https://#{@ip}:4343")
+    @conn.add_method("change_password", "user", "password", "secret")
+    @conn.add_method("commit_new_user", "user", "passwd", "utype", "secret")
+    @conn.add_method("commit_new_app", "user", "appname", "language", "secret")
+    @conn.add_method("commit_tar", "app_name", "tar", "secret")
+    @conn.add_method("delete_app", "appname", "secret")    
+    @conn.add_method("is_app_enabled", "appname", "secret")
+    @conn.add_method("does_user_exist", "username", "secret")
+    @conn.add_method("get_app_data", "appname", "secret")
+    @conn.add_method("delete_instance", "appname", "host", "port", "secret")
+    @conn.add_method("get_tar", "app_name", "secret")
+    @conn.add_method("add_instance", "appname", "host", "port", "secret")
+    @conn.add_method("set_cloud_admin_status", "username", "is_cloud_admin", "secret")
+    @conn.add_method("set_capabilities", "username", "capabilities", "secret")
+  end
+
+  def make_call(timeout, retry_on_except)
+    result = ""
+    begin
+      Timeout::timeout(timeout) do
+        begin
+          yield if block_given?
+        end
+      end
+    rescue OpenSSL::SSL::SSLError
+      retry
+    rescue Errno::ECONNREFUSED
+      if retry_on_except
+        sleep(1)
+        retry
+      else
+        abort("We were unable to establish a connection with the UserAppServer at the designated location. Is AppScale currently running?")
+      end 
+   rescue Exception => except
+      if except.class == Interrupt
+        abort
+      end
+
+      puts "An exception of type #{except.class} was thrown."
+      retry if retry_on_except
+    end
+  end
+  
+  def commit_new_user(user, encrypted_password, user_type="xmpp_user", retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) { 
+      result = @conn.commit_new_user(user, encrypted_password, user_type, @secret)
+    }
+
+    if result == "true"
+      puts "\nYour user account has been created successfully."
+    elsif result == "false"
+      abort("\nWe were unable to create your user account. Please contact your cloud administrator for further details.")
+    else
+      puts "\n[unexpected] Commit new user returned: [#{result}]"
+    end
+  end
+  
+  def commit_new_app(user, app_name, language, file_location)
+    commit_new_app_name(user, app_name, language)
+    commit_tar(app_name, file_location)
+  end
+  
+  def commit_new_app_name(user, app_name, language, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.commit_new_app(user, app_name, language, @secret)
+    }
+
+    if result == "true"
+      puts "We have reserved the name #{app_name} for your application."
+    elsif result == "Error: appname already exist"
+      puts "We are uploading a new version of the application #{app_name}."
+    elsif result == "Error: User not found"
+      abort("We were unable to reserve the name of your application. Please contact your cloud administrator for more information.")
+    else
+      puts "[unexpected] Commit new app says: [#{result}]"
+    end
+  end
+  
+  def commit_tar(app_name, file_location, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.commit_tar(app_name, file_location, @secret)
+ 
+      if result == "true"
+        puts "#{app_name} was uploaded successfully."
+      elsif result == "Error: app does not exist"
+        abort("We were unable to upload your application. Please contact your cloud administrator for more information.")
+      else
+        puts "[unexpected] Commit new tar says: [#{result}]"
+        retry
+      end
+    }
+  end
+  
+  def change_password(user, new_password, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.change_password(user, new_password, @secret)
+    }
+        
+    if result == "true"
+      puts "We successfully changed the password for the given user."
+    elsif result == "Error: user not found"
+      puts "We were unable to locate a user with the given username."
+    else
+      puts "[unexpected] Got this message back: [#{result}]"
+    end
+  end
+
+  def delete_app(app, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.delete_app(app, @secret)
+    }
+    
+    if result == "true"
+      return true
+    else
+      return result
+    end  
+  end
+
+  def does_app_exist?(app, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.get_app_data(app, @secret)
+    }
+
+    begin
+      num_hosts = Integer(result.scan(/num_ports:(\d+)/).flatten.to_s)
+    rescue Exception
+      num_hosts = 0
+    end
+
+    if num_hosts > 0
+      return true
+    else
+      return false
+    end  
+  end
+  
+  def does_user_exist?(user, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.does_user_exist(user, @secret)
+    }
+    
+    if result == "true"
+      return true
+    else
+      return false
+    end  
+  end
+
+  def get_app_data(appname, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.get_app_data(appname, @secret)
+    }
+
+    return result
+  end
+
+  def get_app_admin(appname, retry_on_except=true)
+    app_data = get_app_data(appname, retry_on_except)
+    return app_data.scan(/app_owner:(.*)/).flatten.to_s
+  end
+
+  def delete_instance(appname, host, port, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.delete_instance(appname, host, port, @secret)
+    }
+
+    return result
+  end
+
+  def get_all_apps(retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.get_all_apps(@secret)
+    }
+
+    return result
+  end
+
+  def get_tar(appname, retry_on_except=true)
+    result = ""
+    make_call(300, retry_on_except) {
+      result = @conn.get_tar(appname, @secret)
+    }
+
+    return result
+  end
+
+  def add_instance(appname, host, port, retry_on_except=true)
+    result = ""
+    make_call(10, retry_on_except) {
+      result = @conn.add_instance(appname, host, port, @secret)
+    }
+
+    return result
+  end
+
+  def set_cloud_admin_status(username, new_status)
+    result = ""
+    make_call(NO_TIMEOUT, RETRY_ON_FAIL) { 
+      result = @conn.set_cloud_admin_status(username, new_status, @secret) 
+    }
+
+    return result
+  end
+
+  def set_capabilities(username, capabilities)
+    result = ""
+    make_call(NO_TIMEOUT, RETRY_ON_FAIL) {
+      result = @conn.set_capabilities(username, capabilities, @secret)
+    }
+
+    return result
+  end
+
+  def set_cloud_admin_capabilities(username)
+    return set_capabilities(username, ADMIN_CAPABILITIES)
+  end
+end