CloudyScripts 0.0.9 → 0.0.10

data/Rakefile

@@ -12,7 +12,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'CloudyScripts'
-  s.version = '0.0.9'
+  s.version = '0.0.10'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
   s.summary = 'Scripts to facilitate programming for infrastructure clouds.'

data/lib/help/dm_crypt_helper.rb

@@ -159,8 +159,8 @@ class DmCryptHelper < RemoteCommandHandler
   # * device: device to be encrypted
   # * path: path to which the encrypted device is mounted
   def encrypt_storage(name, password, device, path)
-    if !remote_execute("cryptsetup isLuks #{device}")
-      raise Exception.new("device #{device} is already used differently")
+    if remote_execute("cryptsetup isLuks #{device}")
+      raise Exception.new("device #{device} is already a configured device")
     end
     if file_exists?(device)
       if !file_exists?("/dev/mapper/#{name}")

data/lib/help/progress_message_listener.rb

@@ -0,0 +1,14 @@
+# Defines a template for a class that allows to be notified
+# about messages during script execution.A listener must be
+# registered via #Ec2Script::register_state_change_listener.
+# New messages are passed via the method #new_message.
+
+class ProgressMessageListener
+  # Method called when a state changes. Note: calls are synchronous, the
+  # listener should return quickly and handle more complicated routines
+  # in a different thread. The level corresponds to the logger.LEVEL and
+  # allows to signal the importance of a message
+  def new_message(message, level = Logger::INFO)
+    raise Exception.new("ProgressMessageListener: new message notification not implemented")
+  end
+end

data/lib/scripts/ec2/ami2_ebs_conversion.rb

@@ -58,6 +58,7 @@ class Ami2EbsConversion < Ec2Script
       if @input_params[:root_device_name] == nil
         @input_params[:root_device_name] = "/dev/sda1"
       end
+      @input_params[:script] = self
       # start state machine
       current_state = Ami2EbsConversionState.load_state(@input_params)
       @state_change_listeners.each() {|listener|
@@ -106,6 +107,7 @@ class Ami2EbsConversion < Ec2Script
     end
 
     def connect
+      @context[:script].post_message("connecting to #{@context[:dns_name]}...")
       if @context[:remote_command_handler] == nil
         @context[:remote_command_handler] = RemoteCommandHandler.new
       end
@@ -140,6 +142,7 @@ class Ami2EbsConversion < Ec2Script
         raise Exception.new("connection attempts stopped")
       end
       @context[:result][:os] = @context[:remote_command_handler].retrieve_os()
+      @context[:script].post_message("connected to #{@context[:dns_name]}. OS installed is #{@context[:result][:os]}")
       @logger.info "connected to #{@context[:dns_name]}"
     end
 
@@ -155,28 +158,34 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def startup_ami()
+      @context[:script].post_message("starting up a new instance for AMI #{@context[:ami_id]}...")
       @logger.debug "start up AMI #{@context[:ami_id]}"
       res = @context[:ec2_api_handler].run_instances(:image_id => @context[:ami_id], 
         :security_group => @context[:security_group_name], :key_name => @context[:key_name])
       instance_id = res['instancesSet']['item'][0]['instanceId']
       @context[:instance_id] = instance_id
       @logger.info "started instance #{instance_id}"
+      @context[:script].post_message("started instance #{instance_id}. wait until it is ready...")
       #availability_zone , key_name/group_name
       started = false
       while started == false
         sleep(5)
         res = @context[:ec2_api_handler].describe_instances(:instance_id => @context[:instance_id])
         state = res['reservationSet']['item'][0]['instancesSet']['item'][0]['instanceState']
-        @logger.info "instance in state #{state['name']} (#{state['code']})"
+        @logger.info "instance is in state #{state['name']} (#{state['code']})"
         if state['code'].to_i == 16
           started = true
+          @context[:script].post_message("instance is up and running")
           @context[:dns_name] = res['reservationSet']['item'][0]['instancesSet']['item'][0]['dnsName']
           @context[:availability_zone] = res['reservationSet']['item'][0]['instancesSet']['item'][0]['placement']['availabilityZone']
           @context[:kernel_id] = res['reservationSet']['item'][0]['instancesSet']['item'][0]['kernelId']
           @context[:ramdisk_id] = res['reservationSet']['item'][0]['instancesSet']['item'][0]['ramdiskId']
           @context[:architecture] = res['reservationSet']['item'][0]['instancesSet']['item'][0]['architecture']
         elsif state['code'].to_i != 0
+          @context[:script].post_message("instance in state #{state['name']}")
           raise Exception.new('instance failed to start up')
+        else
+          @context[:script].post_message("instance still starting up...")
         end
       end
       AmiStarted.new(@context)
@@ -192,6 +201,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def create_storage()
+      @context[:script].post_message("going to create a new EBS volume...")
       @logger.debug "create volume in zone #{@context[:availability_zone]}"
       res = @context[:ec2_api_handler].create_volume(:availability_zone => @context[:availability_zone], :size => "10")
       @context[:volume_id] = res['volumeId']
@@ -206,6 +216,7 @@ class Ami2EbsConversion < Ec2Script
           started = true
         end
       end
+      @context[:script].post_message("EBS volume #{@context[:volume_id]} is ready")
       StorageCreated.new(@context)
     end
 
@@ -220,6 +231,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def attach_storage()
+      @context[:script].post_message("going to attach volume #{@context[:volume_id]} to instance #{@context[:instance_id]} on device #{@context[:temp_device_name]}...")
       @logger.debug "attach volume #{@context[:volume_id]} to instance #{@context[:instance_id]} on device #{@context[:temp_device_name]}"
       @context[:ec2_api_handler].attach_volume(:volume_id => @context[:volume_id],
         :instance_id => @context[:instance_id],
@@ -236,6 +248,7 @@ class Ami2EbsConversion < Ec2Script
           done = true
         end
       end
+      @context[:script].post_message("volume successfully attached")
       StorageAttached.new(@context)
     end
 
@@ -250,9 +263,11 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def create_fs()
+      @context[:script].post_message("going to create filesystem on #{@context[:dns_name]} to #{@context[:temp_device_name]}...")
       @logger.debug "create filesystem on #{@context[:dns_name]} to #{@context[:temp_device_name]}"
       connect()
       @context[:remote_command_handler].create_filesystem("ext3", @context[:temp_device_name])
+      @context[:script].post_message("filesystem system successfully created")
       FileSystemCreated.new(@context)
     end
   end
@@ -267,6 +282,7 @@ class Ami2EbsConversion < Ec2Script
 
     def mount_fs()
       @context[:path] = "/mnt/tmp_#{@context[:volume_id]}"
+      @context[:script].post_message("going to mount #{@context[:temp_device_name]} on #{@context[:path]}...")
       @logger.debug "mount #{@context[:temp_device_name]} on #{@context[:path]}"
       @context[:remote_command_handler].mkdir(@context[:path])
       @context[:remote_command_handler].mount(@context[:temp_device_name], @context[:path])
@@ -274,6 +290,7 @@ class Ami2EbsConversion < Ec2Script
       if !@context[:remote_command_handler].drive_mounted?(@context[:path])
         raise Exception.new("drive #{@context[:path]} not mounted")
       end
+      @context[:script].post_message("mount successful")
       FileSystemMounted.new(@context)
     end
   end
@@ -287,12 +304,14 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def copy()
+      @context[:script].post_message("going to start copying files to #{@context[:path]}. This may take quite a time...")
       @logger.debug "start copying to #{@context[:path]}"
       start = Time.new.to_i
       @context[:remote_command_handler].rsync("/", "#{@context[:path]}", "/mnt/")
       @context[:remote_command_handler].rsync("/dev/", "#{@context[:path]}/dev/")
       endtime = Time.new.to_i
       @logger.info "copy took #{(endtime-start)}s"
+      @context[:script].post_message("copying is done (took #{endtime-start})s")
       CopyDone.new(@context)
     end
   end
@@ -306,12 +325,14 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def unmount()
+      @context[:script].post_message("going to clean things up. Start with unmounting ...")
       @logger.debug "unmount #{@context[:path]}"
       @context[:remote_command_handler].umount(@context[:path])
       sleep(2) #give umount some time
       if @context[:remote_command_handler].drive_mounted?(@context[:path])
         raise Exception.new("drive #{@context[:path]} not unmounted")
       end
+      @context[:script].post_message("device unmounted")
       VolumeUnmounted.new(@context)
     end
   end
@@ -325,6 +346,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def detach()
+      @context[:script].post_message("going to detach volume #{@context[:volume_id]}...")
       @logger.debug "detach volume #{@context[:volume_id]}"
       @context[:ec2_api_handler].detach_volume(:volume_id => @context[:volume_id],
         :instance_id => @context[:instance_id]
@@ -339,6 +361,7 @@ class Ami2EbsConversion < Ec2Script
           done = true
         end
       end
+      @context[:script].post_message("volume #{@context[:volume_id]} detached.")
       VolumeDetached.new(@context)
     end
   end
@@ -353,6 +376,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def create_snapshot()
+      @context[:script].post_message("going to create a snapshot...")
       @logger.debug "create snapshot for volume #{@context[:volume_id]}"
       res = @context[:ec2_api_handler].create_snapshot(:volume_id => @context[:volume_id])
       @context[:snapshot_id] = res['snapshotId']
@@ -367,6 +391,7 @@ class Ami2EbsConversion < Ec2Script
           done = true
         end
       end
+      @context[:script].post_message("snapshot is done with ID=#{@context[:snapshot_id]}")
       SnapshotCreated.new(@context)      
     end
   end
@@ -380,8 +405,10 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def delete_volume
+      @context[:script].post_message("going to delete volume #{@context[:volume_id]} (no longer needed)...")
       @logger.debug "delete volume #{@context[:volume_id]}"
       res = @context[:ec2_api_handler].delete_volume(:volume_id => @context[:volume_id])
+      @context[:script].post_message("volume #{@context[:volume_id]} deleted")
       VolumeDeleted.new(@context)
     end
   end
@@ -395,6 +422,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def register()
+      @context[:script].post_message("going to register snapshot #{@context[:snapshot_id]}...")
       @logger.debug "register snapshot #{@context[:snapshot_id]} as #{@context[:name]}"
       res = @context[:ec2_api_handler].register_image_updated(:snapshot_id => @context[:snapshot_id],
         :kernel_id => @context[:kernel_id], :architecture => @context[:architecture], 
@@ -405,6 +433,7 @@ class Ami2EbsConversion < Ec2Script
       @logger.debug "result of registration = #{res.inspect}"
       @context[:result][:image_id] = res['imageId']
       @logger.info "resulting image_id = #{@context[:result][:image_id]}"
+      @context[:script].post_message("snapshot #{@context[:snapshot_id]} successfully registered as AMI #{@context[:result][:image_id]} ")
       SnapshotRegistered.new(@context)
     end
   end
@@ -418,6 +447,7 @@ class Ami2EbsConversion < Ec2Script
     private
 
     def shut_down()
+      @context[:script].post_message("going to shut down the temporary instance #{@context[:instance_id]}...")
       @logger.debug "shutdown instance #{@context[:instance_id]}"
       res = @context[:ec2_api_handler].terminate_instances(:instance_id => @context[:instance_id])
       done = false
@@ -432,6 +462,7 @@ class Ami2EbsConversion < Ec2Script
           raise Exception.new('instance failed to shut down')
         end
       end
+      @context[:script].post_message("instance #{@context[:instance_id]} is terminated")
       Done.new(@context)      
     end
   end

data/lib/scripts/ec2/dm_encrypt.rb

@@ -45,6 +45,7 @@ class DmEncrypt < Ec2Script
         @input_params[:ec2_api_handler] = AWS::EC2::Base.new(:access_key_id => @input_params[:aws_access_key],
         :secret_access_key => @input_params[:aws_secret_key], :server => @input_params[:ec2_api_server])
       end
+      @input_params[:script] = self
       # start state machine
       current_state = DmEncryptState.load_state(@input_params)
       @state_change_listeners.each() {|listener|
@@ -102,6 +103,7 @@ class DmEncrypt < Ec2Script
     private
 
     def connect()
+      @context[:script].post_message("going to connect to #{@context[:ip_address]}...")
       @logger.debug "InitialState.connect"
       if @context[:ssh_key_file] != nil
         @context[:remote_command_handler].connect_with_keyfile(@context[:ip_address], @context[:ssh_key_file])
@@ -111,6 +113,7 @@ class DmEncrypt < Ec2Script
         raise Exception.new("no key information specified")
       end
       @context[:result][:os] = @context[:remote_command_handler].retrieve_os()
+      @context[:script].post_message("connection successful, OS = #{@context[:result][:os]}")
       ConnectedState.new(@context)
     end
   end
@@ -123,8 +126,10 @@ class DmEncrypt < Ec2Script
 
     private
     def install_tools
+      @context[:script].post_message("check if the system has the cryptset-package installed")
       @logger.debug "ConnectedState.install_tools"
       if !tools_installed?
+        @context[:script].post_message("cryptset-package not installed. Going to install it...")
         TOOLS.each() {|tool|
           @context[:remote_command_handler].install(tool)
         }
@@ -133,6 +138,7 @@ class DmEncrypt < Ec2Script
         raise Exception.new("dm-crypt module missing")
       end
       if tools_installed?
+        @context[:script].post_message("cryptset-package is available")
         @logger.debug "system says that tools are installed"
         ToolInstalledState.new(@context)
       else
@@ -158,9 +164,12 @@ class DmEncrypt < Ec2Script
 
     private
     def create_encrypted_volume
+      @context[:script].post_message("going to encrypt device #{@context[:device]} "+
+        "named '#{@context[:device_name]}' and mount it as #{@context[:storage_path]}...")
       @logger.debug "ToolInstalledState.create_encrypted_volume"
       @context[:remote_command_handler].encrypt_storage(@context[:device_name],
       @context[:paraphrase], @context[:device], @context[:storage_path])
+      @context[:script].post_message("device #{@context[:device]} is encrypted and mounted")
       MountedAndActivatedState.new(@context)
     end
 
@@ -179,8 +188,10 @@ class DmEncrypt < Ec2Script
 
     private
     def cleanup()
+      @context[:script].post_message("disconnecting...")
       @logger.debug "MountedAndActivatedState.cleanup"
       @context[:remote_command_handler].disconnect()
+      @context[:script].post_message("done")
       DoneState.new(@context)
     end
 

data/lib/scripts/ec2/ec2_script.rb

@@ -9,6 +9,7 @@ class Ec2Script
   def initialize(input_params)
     @input_params = input_params
     @state_change_listeners = []
+    @progress_message_listeners = []
     if input_params[:logger] == nil
       @logger = Logger.new(STDOUT)
       @logger .level = Logger::WARN
@@ -22,6 +23,10 @@ class Ec2Script
     @state_change_listeners << listener
   end
 
+  def register_progress_message_listener(listener)
+    @progress_message_listeners << listener
+  end
+
   def start_script
     raise Exception.new("must be implemented")
   end
@@ -37,5 +42,11 @@ class Ec2Script
     raise Exception.new("must be implemented")
   end
 
+  def post_message(message, level = Logger::DEBUG)
+    @progress_message_listeners.each() {|listener|
+      listener.new_message(message, level)
+    }
+  end
+  
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: CloudyScripts
 version: !ruby/object:Gem::Version 
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors: 
 - Matthias Jung
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-29 00:00:00 +01:00
+date: 2010-02-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,7 @@ files:
 - lib/cloudyscripts.rb
 - lib/help/dm_crypt_helper.rb
 - lib/help/ec2_helper.rb
+- lib/help/progress_message_listener.rb
 - lib/help/remote_command_handler.rb
 - lib/help/script_execution_state.rb
 - lib/help/state_change_listener.rb