imagefactory-console 0.4.0

data/Rakefile

@@ -0,0 +1,77 @@
+#
+# Copyright (C) 2011 Red Hat, Inc.
+# Written by Jason Guiditta <jguiditt@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+require 'rake/rpmtask'
+
+RPMBUILD_DIR = "#{File.expand_path('~')}/rpmbuild"
+RPM_SPEC = "rubygem-imagefactory-console.spec"
+
+spec = Gem::Specification.new do |s|
+  s.name = 'imagefactory-console'
+  s.version = '0.4.0'
+  s.has_rdoc = true
+  #s.extra_rdoc_files = ['README', 'COPYING']
+  s.summary = 'QMF Console for Aeolus Image Factory'
+  s.description = s.summary
+  s.author = 'Jason Guiditta'
+  s.email = 'jguiditt@redhat.com'
+  # s.executables = ['your_executable_here']
+  s.files = %w(Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['lib/**/*.rb'] #'README', 'COPYING',
+  rdoc.rdoc_files.add(files)
+  #rdoc.main = "README" # page to start on
+  rdoc.title = "console Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.libs << 'lib'
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ['--color', '--format nested']
+end
+
+Rake::RpmTask.new(RPM_SPEC) do |rpm|
+  rpm.need_tar = true
+  rpm.package_files.include("lib/*")
+  rpm.topdir = "#{RPMBUILD_DIR}"
+end

data/lib/imagefactory.rb

@@ -0,0 +1,2 @@
+require 'imagefactory/console'
+require 'imagefactory/base_handler'

data/lib/imagefactory/base_handler.rb

@@ -0,0 +1,56 @@
+#
+# Copyright (C) 2011 Red Hat, Inc.
+# Written by Jason Guiditta <jguiditt@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+require 'logger'
+
+class BaseHandler
+
+  def initialize(logger=nil)
+    logger(logger)
+  end
+
+  def handle(data)
+    logger.debug "====== Type of event: #{data.event}"
+    if data.event == 'STATUS'
+      logger.debug "calling handle status in base handler"
+      handle_status(data)
+    elsif data.event == 'FAILURE'
+      handle_failed(data)
+    end
+  end
+
+  def handle_status(data)
+    logger.debug "{data.event}, #{data.new_status}"
+  end
+
+  def handle_failed(data)
+    logger.error "#{data.to_s}"
+  end
+
+  protected
+  def logger(logger=nil)
+    @logger ||= logger
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::ERROR
+      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+    end
+    return @logger
+  end
+end

data/lib/imagefactory/console.rb

@@ -0,0 +1,251 @@
+#
+# Copyright (C) 2011 Red Hat, Inc.
+# Written by Jason Guiditta <jguiditt@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# TODO: figure out what I am doing wrong here that I need this line
+$: << File.expand_path(File.join(File.dirname(__FILE__), "."))
+require 'cqpid'
+require 'qmf2'
+require 'logger'
+require 'base_handler'
+
+class ImageFactoryConsole < Qmf2::ConsoleHandler
+
+  attr_accessor :q, :handler
+
+  def initialize(args={})
+#    @retry_limit = args.include?(:retry_limit) ? args[:retry_limit] : 20
+#    @delay = args.include?(:delay) ? args[:delay] : 15
+    host = args.include?(:host) ? args[:host] : "localhost"
+    port = args.include?(:port) ? args[:port] : 5672
+#   url = "amqp://#{host}:#{port}" <- the amqp part here doesnt work yet
+    url = "#{host}:#{port}"
+    opts = {"reconnect"=>"true"}
+    @connection = Cqpid::Connection.new(url, opts)
+    @connection.open
+    @session = Qmf2::ConsoleSession.new(@connection)
+    @session.open
+    @session.set_agent_filter("[and, [eq, _vendor, [quote, 'redhat.com']], [eq, _product, [quote, 'imagefactory']]]")
+
+    if args.include?(:logger)
+      @logger = args[:logger]
+    else
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::ERROR
+      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+    end
+    @handler = args.include?(:handler)? args[:handler]: BaseHandler.new(@logger)
+    super(@session)
+  end
+
+  # Call this method to initiate a build, and get back an
+  # array of BuildAdaptor objects.
+  # * template => String
+  # Description of what to build. Can be xml, uuid, or url
+  # * targets => Array
+  # Represents the names of the clouds to target (ec2, mock, rackspace, etc)
+  # * image_id => String
+  # The UUID of an image previously built
+  # * build_id => String
+  # The UUID of a previous build of the image
+  # * Returns => an array of BuildAdaptor objects
+  #
+  def build(template, targets, image='', build='')
+    targets = [targets] unless targets.instance_of?(Array)
+    # TODO: return error if there is a problem calling this method or getting
+    # a factory instance
+    begin
+      response = factory.build_image(image, build, template, targets)
+      build_adaptors(response)
+    rescue Exception => e
+      @logger.debug "Encountered error in build_image: #{e}"
+      return e
+    end
+  end
+
+  # Call this method to push an image to a provider, and get back an
+  # array of BuildAdaptor objects.
+  # * providers => Array
+  # Represents the target providers to build for (ec2-us-east, mock1, etc)
+  # * credentials => String
+  # XML block to be used for registration, upload, etc
+  # * image_id => String
+  # The UUID of an image previously built
+  # * build_id => String
+  # The UUID of a previous build of the image
+  # * Returns => an array of BuildAdaptor objects
+  #
+  def push(providers, credentials, image_id, build_id='')
+    providers = [providers] unless providers.instance_of?(Array)
+    # TODO: return error if there is a problem calling this method or getting
+    # a factory instance
+    begin
+      response = factory.push_image(image_id, build_id, providers, credentials)
+      build_adaptors(response)
+    rescue Exception => e
+      @logger.debug "Encountered error in push_image: #{e}"
+      return e
+    end
+  end
+
+# Call this method to import an image
+# array of BuildAdaptor objects.
+# * image => string
+# The uuid of an existing image
+# * build => string
+# the uuid of an existing build, or the empty string
+# * target_identifier => string
+# the target specific image ID
+# * image_desc => string
+# an xml string description of the image
+# * target => string
+# name of the cloud to target
+# * provider => string
+# the name of the cloud provider, often a region
+# Returns => a map including UUIDs as strings for 'target_image', 'build', 'image', 'provider_image'
+
+  def import_image(image, build, target_identifier, image_description, target, provider)
+    # TODO: return error if there is a problem calling this method or getting
+    # a factory instance
+    begin
+      factory.import_image(image, build, target_identifier, image_description, target, provider)
+    rescue Exception => e
+      @logger.debug "Encountered error in import_image: #{e}"
+      return e
+    end
+  end
+
+  # <b>DEPRECATED:</b> Please use <tt>build</tt> instead.
+  # Call this method to initiate a build, and get back an
+  # BuildAdaptor object.
+  # * descriptor => String
+  # This can be either xml or a url pointing to the xml
+  # * target => String
+  # Represents the target provider type to build for (ec2, mock, etc)
+  # * Returns => a BuildAdaptor object
+  #
+  def build_image(descriptor, target)
+    @logger.warn "[DEPRECATION] 'build_image' is deprecated.  Please use 'build' instead."
+    # TODO: return error if there is a problem calling this method or getting
+    # a factory instance
+    begin
+      response = factory.image(descriptor, target)
+      build_adaptor(response)
+    rescue Exception => e
+      @logger.debug "Encountered error in build_image: #{e}"
+      return e
+    end
+  end
+
+  # <b>DEPRECATED:</b> Please use <tt>push</tt> instead.
+  # Call this method to push an image to a provider, and get back an
+  # BuildAdaptor object.
+  # * image_id => String (uuid)
+  # * provider => String
+  # Represents the target provider to build for (ec2-us-east, mock, etc)
+  # * credentials => String
+  # XML block to be used for registration, upload, etc
+  # * Returns => a BuildAdaptor object
+  #
+  def push_image(image_id, provider, credentials)
+    @logger.warn "[DEPRECATION] 'push_image' is deprecated.  Please use 'push' instead."
+    # TODO: return error if there is a problem calling this method or getting
+    # a factory instance
+    begin
+      response = factory.provider_image(image_id, provider, credentials)
+      build_adaptor(response)
+    rescue Exception => e
+      @logger.debug "Encountered error in push_image: #{e}"
+      return e
+    end
+  end
+
+  #TODO: enhance both of these methods to handle multiple agents
+  def agent_added(agent)
+    @logger.debug "GOT AN AGENT:  #{agent} at #{Time.now.utc}"
+    @q = agent if agent.product == "imagefactory"
+  end
+
+  def agent_deleted(agent, reason)
+    @logger.debug "AGENT GONE:  #{agent} at #{Time.now.utc}, because #{reason}"
+    unless @q==nil
+      @q = nil if (@q.product == agent.product && @q.name.eql?(agent.name))
+    end
+  end
+
+  # TODO: handle agent restart events (this will be more useful when
+  # restarted agent can recover an in-process build
+  def agent_restarted(agent)
+    @logger.debug "AGENT RESTARTED:  #{agent.product}"
+  end
+
+  # TODO: handle schema updates.  This will be more useful when/if
+  # we make this a more generic console to talk to different agents.
+  def agent_schema_updated(agent)
+    @logger.debug "AGENT SCHEMA UPDATED:  #{agent.product}"
+  end
+
+  def event_raised(agent, data, timestamp, severity)
+    @logger.debug "GOT AN EVENT:  #{agent}, #{data} at #{timestamp}"
+    @handler.handle(data)
+  end
+
+  def shutdown
+    @logger.debug "Closing connections.."
+    if @session
+      @session.close
+    end
+    @connection.close
+
+    #TODO Replace this with some control flow to manage the cancelling of the console handler, atm
+    #     this code swallows error message generated by closing connection, then cancelling console.
+    begin
+      self.cancel
+    rescue QmfError
+      # TODO We should be logging to a file rather than STDOUT, uncomment this code when logging is configured properly
+      # Commented out to clean up user output
+      #@logger.error "Issue Closing Console Handler"
+    end
+  end
+
+  private
+
+  def factory
+    @factory ||= @q.query("{class:ImageFactory, package:'com.redhat.imagefactory'}").first
+  end
+
+  def build_adaptors(response)
+    ret = []
+    response['build_adaptors'].each do |imgfacaddr|
+      query = Qmf2::Query.new(Qmf2::DataAddr.new(imgfacaddr))
+      ret << @q.query(query,5).first
+    end
+    ret
+  end
+
+  def build_adaptor(response)
+    @logger.warn "[DEPRECATION] 'build_adaptor' is deprecated.  Please use 'build_adaptors' instead."
+    imgfacaddr = Qmf2::DataAddr.new(response['build_adaptor'])
+    query = Qmf2::Query.new(imgfacaddr)
+    @q.query(query,5).first
+  end
+
+  def make_array(a)
+    return a ||= [a] unless a.instance_of?(Array)
+  end
+end

data/spec/image_factory/console_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+
+module ImageFactory
+  describe ImageFactoryConsole do
+    context "needs a real agent running" do
+      # for now, these all require an actual agent on the bus
+      before(:all) do
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::DEBUG
+        @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+        @i = ImageFactoryConsole.new() # Pass this in for more logging: (:logger => @logger)
+        @i.start
+        # Sadly, this is needed so we wait for an agent to appear.
+        # We might be able to extract this somewhere to hold off
+        # on tests until we get an agent_added notification
+        sleep(5)
+        #TODO: take this snippet and make a fixture of some sort to use in tests
+        #tmpl = '<template> <name>tmpl1</name> <description>foo</description> <os> <name>Fedora</name>
+        # <arch>x86_64</arch> <version>14</version> <install type="url">
+        # <url>http://download.fedoraproject.org/pub/fedora/linux/releases/14/Fedora/x86_64/os/</url> </install>
+        # </os> <repositories> <repository name="custom"> <url>http://repos.fedorapeople.org/repos/aeolus/demo/webapp/</url>
+        # <signed>false</signed> </repository> </repositories> </template>'
+      end
+
+      describe "#q" do
+        it "should get an agent set" do
+          @i.q.should_not be_nil
+        end
+      end
+
+      describe "#build_image" do
+        it "should return a build-adaptor with uuid" do
+          @i.build_image("<template></template>", "mock").image_id.should_not be_nil
+        end
+      end
+
+      describe "#push_image" do
+        it "should return a build-adaptor with uuid" do
+          @image = @i.build_image("<template></template>", "mock")
+          #@i.handler = BaseHandler.new(@logger)
+          @i.handler.should_not_receive(:handle_failed)
+          @i.push_image(@image.image_id, "mock", "some creds").image_id.should_not be_nil
+        end
+      end
+
+      describe "#import_image" do
+        it "should return a build-adaptor with uuid" do
+          @import = @i.import_image("", "", "ami-test", "<image><name>Test Image</name></image>", "ec2", "ec2-us-east-1")
+          is_uuid?(@import['image']).should == true
+          is_uuid?(@import['target_image']).should == true
+          is_uuid?(@import['build']).should == true
+          is_uuid?(@import['provider_image']).should == true
+        end
+      end
+
+      describe "#build" do
+        it "should return an array of build-adaptors with uuids" do
+          @i.build("<template></template>", ["mock"]).each do |adaptor|
+            adaptor.image_id.should_not be_nil
+            adaptor.image.should_not be_nil
+            adaptor.build.should_not be_nil
+          end
+        end
+
+        it "should work with single target as string" do
+          @i.build("<template></template>", "mock").each do |adaptor|
+            adaptor.image_id.should_not be_nil
+            adaptor.image.should_not be_nil
+            adaptor.build.should_not be_nil
+          end
+        end
+      end
+
+      describe "#push" do
+        it "should return an array of build-adaptors with uuids" do
+          @i.build("<template></template>", ["mock"]).each do |adaptor|
+            #@i.handler = BaseHandler.new(@logger)
+            @i.handler.should_not_receive(:handle_failed)
+            @i.push(["mock"], "<provider_credentials/>", adaptor.image).each do |a|
+              a.image_id.should_not be_nil
+              a.image.should_not be_nil
+              a.build.should_not be_nil
+            end
+          end
+        end
+
+        it "should work with single provider as string" do
+          @i.build("<template></template>", "mock").each do |adaptor|
+            #@i.handler = BaseHandler.new(@logger)
+            @i.handler.should_not_receive(:handle_failed)
+            @i.push("mock1", "<provider_credentials/>", adaptor.image).each do |a|
+              a.image_id.should_not be_nil
+              a.image.should_not be_nil
+              a.build.should_not be_nil
+            end
+          end
+        end
+      end
+
+      after(:all) do
+        @i.shutdown
+      end
+    end
+
+    context "agent is stubbed" do
+      before(:each) do
+         @agent = mock('agent', :null_object => true)
+         @agent.stub(:product).and_return("imagefactory")
+         @agent.stub(:name).and_return("redhat.com:imagefactory:b9e131c7-7905-409e-bfb5-dd4848a776a7")
+         @output = double('output')
+         @i2 = ImageFactoryConsole.new(:logger => @output)
+      end
+
+      describe "#agent_added" do
+        it "logs when a new agent appears" do
+          @output.should_receive(:debug).with(/GOT AN AGENT/).as_null_object
+          @i2.agent_added(@agent)
+        end
+
+        it "stores a reference to that agent if it is a factory" do
+          @output.should_receive(:debug).with(/GOT AN AGENT/)
+          @i2.agent_added(@agent)
+          @i2.q.should respond_to(:product)
+        end
+      end
+
+      describe "#agent_deleted" do
+        before(:each) do
+          @old_agent = mock('agent', :null_object => true)
+          @old_agent.stub(:product).and_return("imagefactory")
+          @old_agent.stub(:name).and_return("redhat.com:imagefactory:4eb3776e-d91e-4239-9a73-3ab43ecc7e15")
+          @output.should_receive(:debug).with(/GOT AN AGENT/)
+          @i2.agent_added(@agent)
+        end
+
+        it "logs when an agent is removed" do
+          @output.should_receive(:debug).with(/AGENT GONE/).as_null_object
+          @i2.agent_deleted(@agent, "aged")
+        end
+
+        it "removes the agent reference if removed agent is the same as console reference" do
+          @output.should_receive(:debug).with(/AGENT GONE/).as_null_object
+          @i2.agent_deleted(@agent, "aged")
+          @i2.q.should be_nil
+        end
+
+         it "does not remove the agent reference if removed agent is the not same as console reference" do
+          @output.should_receive(:debug).with(/AGENT GONE/).as_null_object
+          @i2.agent_deleted(@old_agent, "aged")
+          @i2.q.should_not be_nil
+        end
+      end
+
+      describe "#event_raised" do
+        before(:each) do
+          @data = mock('data', :null_object => true)
+          @data.stub(:event).and_return("STATUS")
+        end
+
+        it "should call handle on an event" do
+          @output.should_receive(:debug).with(/GOT AN EVENT/)
+
+          @i2.handler.should_receive(:handle).once
+          @i2.event_raised(@agent, @data, Time.now, "horrid")
+        end
+      end
+
+      describe "#build_image" do
+        it "should gracefully handle errors" do
+          @output.should_receive(:debug).with(/Encountered error in build_image/)
+          @output.should_receive(:warn).with("[DEPRECATION] 'build_image' is deprecated.  Please use 'build' instead.")
+          @i2.q=nil
+          error = @i2.build_image("<template></template>", "mock")
+          error.to_s.should include("undefined method")
+        end
+      end
+
+       describe "#push_image" do
+        it "should gracefully handle errors" do
+          @output.should_receive(:debug).with(/Encountered error in push_image/)
+          @output.should_receive(:warn).with("[DEPRECATION] 'push_image' is deprecated.  Please use 'push' instead.")
+          @i2.q=nil
+          error = @i2.push_image(123, "mock", "some creds")
+          error.to_s.should include("undefined method")
+        end
+      end
+
+      describe "#build" do
+        it "should gracefully handle errors" do
+          @output.should_receive(:debug).with(/Encountered error in build_image/)
+          @i2.q=nil
+          error = @i2.build("<template></template>", "mock")
+          error.to_s.should include("undefined method")
+        end
+      end
+
+       describe "#push" do
+        it "should gracefully handle errors" do
+          @output.should_receive(:debug).with(/Encountered error in push_image/)
+          @i2.q=nil
+          error = @i2.push(123, "mock", "some creds")
+          error.to_s.should include("undefined method")
+        end
+      end
+
+      after(:each) do
+         @output.should_receive(:debug).with(/Closing/)
+         @i2.shutdown
+      end
+    end
+
+    def is_uuid?(test_string)
+      regexp = Regexp.new('^[\w]{8}[-][\w]{4}[-][\w]{4}[-][\w]{4}[-][\w]{12}')
+      regexp.match(test_string) ? true : false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+require 'rubygems'
+require 'imagefactory'

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: imagefactory-console
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Jason Guiditta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-22 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: QMF Console for Aeolus Image Factory
+email: jguiditt@redhat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/imagefactory.rb
+- lib/imagefactory/base_handler.rb
+- lib/imagefactory/console.rb
+- spec/spec_helper.rb
+- spec/image_factory/console_spec.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: QMF Console for Aeolus Image Factory
+test_files: []
+