fog_tracker 0.1.5 → 0.2.0

data/README.md

@@ -75,7 +75,7 @@ How is it [done]? (Usage)
 
         tracker.query("*::*::*::*"){|r| puts "Found #{r.class} #{r.identity}"}
 
-* You can also pass a Proc to the Tracker at initialization, which will be invoked whenever an account's Resources have been updated. It should accept an Array containing the updated Resources as its first argument:
+* You can pass a callback Proc to the Tracker at initialization, which will be invoked whenever all an account's Resources have been updated. It should accept an Array containing the updated Resources as its first parameter:
 
         FogTracker::Tracker.new(YAML::load(File.read 'accounts.yml'),
           :callback => Proc.new do |resources|
@@ -84,13 +84,14 @@ How is it [done]? (Usage)
           end
         ).start
 
-* The resources returned from a query are all Fog::Model objects, but they are "decorated" with some extra methods for your convenience. This simplifies the code that consumes the resources, because it does not have to know anything about the tracker. Here are the methods added:
-  1. To get a Resource's Hash of account information, call its `tracker_account` method _(credentials are removed)_.
-  2. To query for more resources, you can call `resource.tracker_query(query_string)`, though you cannot yet pass a block to this method.
-  3. To get a collection of resources from the same account, call `resource.account_resources(collection_name)`.
+* The resources returned from a query are all Fog::Model objects, but they are "decorated" with some extra methods for fetching the account information, or for fetching more resources. This simplifies the code that consumes the query results, because it does not have to know anything about the tracker. Here are the methods added by {FogTracker::Extensions::FogModel}:
+  1. `tracker_account` returns a Hash of the Resource's account information _(:name is added; :credentials are removed)_.
+  2. `tracker_query(query_string)` queries the tracker for more resources.
+  3. `account_resources(collection_query)` returns an Array of resources from the same account. (This is essentially shorthand for `tracker.query("account::service::provider::#{collection_query}")`)
 
-* Any Exceptions that occur in the Tracker's polling threads are rescued and logged. If you want to take further action, you can initialize the Tracker with an `:error_callback` Proc, similar to the Account update `:callback` -- except that the `:error_callback` should accept an Exception instead of an Array of Resources.
+* Any Exceptions that occur in the Tracker's polling threads are rescued and logged. If you want to take further action, you can initialize the Tracker with an `:error_callback` Proc. This is similar to the Account update `:callback` above, except that the parameter for `:error_callback` should be an Exception instead of an Array of Resources.
 
+* The Tracker can also be used synchronously. Its `update` method polls all accounts immediately, and waits for the result (the updated Array of resource objects) in the current thread.
 
 ----------------
 Who is it? (Contribution)

data/lib/fog_tracker/account_tracker.rb

@@ -15,6 +15,7 @@ module FogTracker
 
     # Creates an object for tracking all collections in a single Fog account
     # @param [String] account_name a human-readable name for the account
+    # @param [Hash] account a Hash of account configuration data
     # @param [Hash] options optional additional parameters:
     #  - :delay (Integer) - Default time between polling of accounts
     #  - :callback (Proc) - A Method or Proc to call each time an account is polled.
@@ -29,7 +30,7 @@ module FogTracker
       @log      = options[:logger] || FogTracker.default_logger
       @delay    = options[:delay]  || account[:polling_time] ||
                               FogTracker::DEFAULT_POLLING_TIME
-      @account[:polling_time] = @delay  # TODO - test this
+      @account[:polling_time] = @delay
       @error_proc = options[:error_callback]
       @log.debug "Creating tracker for account #{@name}."
       create_collection_trackers
@@ -42,18 +43,11 @@ module FogTracker
       @log.debug "Starting tracking for account #{@name}..."
         @timer = Thread.new do
           begin
-            while true do
-              @log.info "Polling account #{@name}..."
-              @collection_trackers.each {|tracker| tracker.update}
-              @callback.call(all_resources) if @callback
-              sleep @delay
+            while true
+              update ; sleep @delay
             end
           rescue Exception => e
-            @log.error "Exception polling account #{name}: #{e.message}"
-            e.backtrace.each {|line| @log.debug line}
-            @error_proc.call(e) if @error_proc
-            sleep @delay
-            retry
+            sleep @delay ; retry
           end
         end
       else
@@ -72,6 +66,20 @@ module FogTracker
       end
     end
 
+    # Polls once for all the resource collections for this tracker's account
+    def update
+      begin
+        @log.info "Polling account #{@name}..."
+        @collection_trackers.each {|tracker| tracker.update}
+        @callback.call(all_resources) if @callback
+      rescue Exception => e
+        @log.error "Exception polling account #{name}: #{e.message}"
+        e.backtrace.each {|line| @log.debug line}
+        @error_proc.call(e) if @error_proc
+        raise e
+      end
+    end
+
     # Returns true or false depending on whether this tracker is polling
     def running? ; @timer != nil end
 

data/lib/fog_tracker/extensions/fog_model.rb

@@ -3,14 +3,12 @@ module FogTracker
     # Adds convenience methods to Fog::Model instances for gathering
     # information about its account, and about other Fog::Model resources
     module FogModel
-      extend Forwardable        # Resources need to be queriable
 
       # a FogTracker::CollectionTracker - *do not modify* - used for {#tracker_account}
       attr_accessor :_fog_collection_tracker
 
       # a FogTracker::QueryParser - *do not modify* - used for tracker_query
       attr_accessor :_query_processor
-      def_delegator :@_query_processor, :execute, :tracker_query
 
       # Returns a cleaned copy of the resource's account information
       # from the its collection tracker (credentials are removed).
@@ -20,21 +18,40 @@ module FogTracker
         _fog_collection_tracker.clean_account_data
       end
 
-      # Returns Fog::Model resources from this Resource's account only
+      # Returns Fog::Model resources from this Resource's account only.
       # @param [String] collection_name a String which is converted to
       #   a RegEx, and used to match collection names for resources
       #   in the same account as the current resource.
       # @return [Array <Fog::Model>] an Array of resources from this Model's
       #   accout, whose collection matches collection_name.
       def account_resources(collection_name)
-        (not @_query_processor) ? Array.new :
-        @_query_processor.execute(
-          "#{tracker_account[:name]}::"+
-          "#{tracker_account[:service]}::"+
-          "#{tracker_account[:provider]}::"+
-          "#{collection_name}"
-        )
+        results = Array.new
+        if @_query_processor
+          results = @_query_processor.execute(
+            "#{tracker_account[:name]}::"+
+            "#{tracker_account[:service]}::"+
+            "#{tracker_account[:provider]}::"+
+            "#{collection_name}"
+          )
+          (results.each {|r| yield r}) if block_given?
+        end
+        results
       end
+
+      # Runs a query across all accounts using a 
+      # {FogTracker::Query::QueryProcessor}. Any code block parameter will
+      # be executed once for (and with) each resulting resource.
+      # @param [String] query a string used to filter for matching resources
+      # @return [Array <Fog::Model>] an Array of Resources, filtered by query
+      def tracker_query(query_string)
+        results = Array.new
+        if @_query_processor
+          results = @_query_processor.execute(query_string)
+          (results.each {|r| yield r}) if block_given?
+        end
+        results
+      end
+
     end
   end
 end

data/lib/fog_tracker/tracker.rb

@@ -17,14 +17,14 @@ module FogTracker
     #    (should take a single Exception as its only required parameter)
     #  - :logger - a Ruby Logger-compatible object
     def initialize(accounts = {}, options = {})
-      @accounts = accounts
-      @delay    = options[:delay]
-      @callback = options[:callback]
-      @log      = options[:logger] || FogTracker.default_logger
+      @accounts   = accounts
+      @delay      = options[:delay]
+      @callback   = options[:callback]
+      @log        = options[:logger] || FogTracker.default_logger
       @error_proc = options[:error_callback]
+      @running    = false
       # Create a Hash that maps account names to AccountTrackers
       create_trackers
-      @running  = false
     end
 
     # Starts periodically polling all this tracker's accounts
@@ -50,6 +50,15 @@ module FogTracker
       end
     end
 
+    # Polls all accounts once in the calling thread (synchronously)
+    # @return [Array <Fog::Model>] an Array of all discovered resources
+    def update
+      @trackers.each_value {|tracker| tracker.update}
+      results = all
+      (results.each {|r| yield r}) if block_given?
+      results
+    end
+
     # Returns true or false, depending on whether this tracker is polling
     # @return [true, false]
     def running? ; @running end
@@ -75,11 +84,17 @@ module FogTracker
     end
     alias :[] :query
 
-    # Returns this tracker's logger, for changing logging dynamically
-    def logger
-      @log
+    # Returns an Array of all Resources currenty tracked
+    # @return [Array <Fog::Model>] an Array of Resources
+    def all
+      results = query '*::*::*::*'
+      (results.each {|r| yield r}) if block_given?
+      results
     end
 
+    # Returns this tracker's logger, for changing logging dynamically
+    def logger ; @log end
+
     private
 
     # Creates a Hash of AccountTracker objects, indexed by account name

data/lib/fog_tracker/version.rb

@@ -1,3 +1,3 @@
 module FogTracker
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/spec/lib/fog_tracker/account_tracker_spec.rb

@@ -30,19 +30,11 @@ module FogTracker
       it "exposes the connection to its logger" do
         @tracker.log.should_not == nil
       end
-
-      context "when it encounters an Exception while updating" do
-        context "when initialized with an error callback" do
-          it "should fire the callback" do
-            CollectionTracker.any_instance.stub(:update).and_raise
-            @error_receiver.should_receive(:callback).exactly(:once)
-            @tracker.start
-            sleep THREAD_STARTUP_DELAY
-          end
-        end
+      it "always sets a polling time" do
+        @tracker.account[:polling_time].should be_an_instance_of(Fixnum)
       end
 
-      describe '#start' do
+      describe '#update' do
         it "sends update() to its CollectionTrackers" do
           update_catcher = double "mock for catching CollectionTracker::update"
           update_catcher.stub(:update)
@@ -50,14 +42,31 @@ module FogTracker
             update_catcher.update
           end
           update_catcher.should_receive(:update)
-          @tracker.start
-          sleep THREAD_STARTUP_DELAY # wait for background thread to start
+          @tracker.update
         end
         it "invokes its callback Proc when its account is updated" do
           @account_receiver.should_receive(:callback).
             exactly(FAKE_ACCOUNTS.size).times
-          @tracker.start
-          sleep THREAD_STARTUP_DELAY
+          @tracker.update
+        end
+        context "when it encounters an Exception" do
+          it "raises the Exception" do
+            CollectionTracker.any_instance.stub(:update).and_raise
+            (Proc.new { @tracker.update }).should raise_error
+          end
+        end
+      end
+
+      describe '#start' do
+        context "when initialized with an error callback" do
+          context "when it encounters an Exception" do
+            it "should fire the callback" do
+              CollectionTracker.any_instance.stub(:update).and_raise
+              @error_receiver.should_receive(:callback).exactly(:once)
+              @tracker.start
+              sleep THREAD_STARTUP_DELAY
+            end
+          end
         end
       end
 

data/spec/lib/fog_tracker/extensions/fog_model_spec.rb

@@ -31,24 +31,67 @@ module FogTracker
 
       describe '#tracker_query' do
         context "with no query processor assigned" do
-          it "raises a NoMethodError" do
-            q = Proc.new { @model.tracker_query('XXX') }
-            q.should raise_error
+          it "returns an empty Array" do
+            @model.tracker_query('XXX').should == []
           end
         end
         context "with a query processor assigned" do
           before(:each) do
             @fake_processor = double "mock query processor"
-            @fake_processor.stub(:query).and_return(Array.new)
             @model._query_processor = @fake_processor
           end
           it "forwards the query to its query processor" do
             @fake_processor.should_receive(:execute).with('XXX')
             @model.tracker_query('XXX')
           end
+          context "when invoked with a block" do
+            it "calls the block once with each resulting resource" do
+              receiver = double "tracker_query callback receiver"
+              @fake_processor.stub(:execute).and_return(['A', 'B', 'C'])
+              receiver.should_receive(:callback).exactly(3).times
+              @model.tracker_query('*::*::*::*') do |resource|
+                receiver.callback(resource)
+              end
+            end
+          end
         end
       end
 
+      describe '#account_resources' do
+        context "with no query processor assigned" do
+          it "returns an empty Array" do
+            @model.account_resources('XXX').should == []
+          end
+        end
+        context "with a query processor assigned" do
+          before(:each) do
+            collection_tracker = double("fake collection tracker")
+            collection_tracker.stub(:clean_account_data).and_return({
+              :name => 'fake account', :service => 'service',
+              :provider => 'provider'
+            })
+            @fake_processor = double "mock query processor"
+            @model._fog_collection_tracker = collection_tracker
+            @model._query_processor = @fake_processor
+          end
+          it "forwards the scoped collection query to its query processor" do
+            @fake_processor.should_receive(:execute).with(
+              'fake account::service::provider::collection_query'
+            )
+            @model.account_resources('collection_query')
+          end
+          context "when invoked with a block" do
+            it "calls the block once with each resulting resource" do
+              receiver = double "tracker_query callback receiver"
+              @fake_processor.stub(:execute).and_return(['A', 'B', 'C'])
+              receiver.should_receive(:callback).exactly(3).times
+              @model.tracker_query('*::*::*::*') do |resource|
+                receiver.callback(resource)
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/fog_tracker/tracker_spec.rb

@@ -2,7 +2,15 @@ module FogTracker
   describe Tracker do
 
     ACCOUNTS = {
-      "fake account" => {
+      "fake account 1" => {
+        :provider                 => 'AWS',
+        :service                  => 'Compute',
+        :credentials => {
+          :aws_access_key_id      => 'X',
+          :aws_secret_access_key  => 'X'
+        }, :exclude_resources     => [ :spot_requests ]
+      },
+      "fake account 2" => {
         :provider                 => 'AWS',
         :service                  => 'Compute',
         :credentials => {
@@ -14,6 +22,8 @@ module FogTracker
 
     before(:each) do
       @tracker = Tracker.new(ACCOUNTS, :logger => LOG)
+      @execute_receiver = double "Query::execute receiver"
+      @execute_receiver.stub(:execute)
     end
 
     it "exposes a Hash of account information" do
@@ -27,21 +37,62 @@ module FogTracker
       it "returns an array of collection names for the given account" do
         [ "addresses", "flavors", "images", "key_pairs", "security_groups",
           "servers", "snapshots", "tags", "volumes"].each do |collection|
-            @tracker.types_for_account("fake account").should include(collection)
+            @tracker.types_for_account("fake account 1").should include(collection)
+        end
+      end
+    end
+
+    describe '#update' do
+      it "calls update on all its AccountTrackers" do
+        receiver = double('AccountTracker::update receiver')
+        receiver.stub(:update)
+        AccountTracker.any_instance.stub(:update) {receiver.update}
+        receiver.should_receive(:update).exactly(ACCOUNTS.keys.size).times
+        @tracker.update
+      end
+      it "invokes any passed code block once per resulting Resource" do
+        receiver = double "resource callback object"
+        @tracker.update # (NOT the call we're testing -- just getting the count)
+        receiver.should_receive(:callback).exactly(@tracker.all.count).times
+        @tracker.update {|resource| receiver.callback resource}
+      end
+    end
+
+    describe '#all' do
+      WILDCARD_QUERY = '*::*::*::*'
+      before(:each) do
+        Query::QueryProcessor.any_instance.stub(:execute) do |query|
+          @execute_receiver.execute(query)
+          ['A', 'B', 'C']
         end
       end
+      it "returns the result of the wildcard query: #{WILDCARD_QUERY}" do
+        @execute_receiver.should_receive(:execute).with(WILDCARD_QUERY)
+        @tracker.all.should == ['A', 'B', 'C']
+      end
+      it "invokes any passed code block once per resulting Resource" do
+        receiver = double "resource callback object"
+        receiver.should_receive(:callback).exactly(@tracker.update.size).times
+        @tracker.all {|resource| receiver.callback resource}
+      end
     end
 
     describe '#query' do
       it "invokes any passed code block once per resulting Resource" do
-        receiver = double "resrouce callback object"
+        receiver = double "resource callback object"
         receiver.stub(:callback)
-        @tracker.start
-        sleep THREAD_STARTUP_DELAY
+        @tracker.update
         res_count = @tracker.query('*::*::*::*').count
         receiver.should_receive(:callback).exactly(res_count).times
         @tracker.query('*::*::*::*') {|r| receiver.callback(r)}
       end
+      it "passes the query request to its QueryProcessor" do
+        Query::QueryProcessor.any_instance.stub(:execute) do |query|
+          @execute_receiver.execute(query)
+        end
+        @execute_receiver.should_receive(:execute).with("query_string")
+        @tracker.query('query_string')
+      end
     end
 
     describe '#start' do
@@ -52,8 +103,7 @@ module FogTracker
           :callback => Proc.new {|resources| receiver.callback(resources)}
         )
         receiver.should_receive(:callback).exactly(ACCOUNTS.size).times
-        tracker.start
-        sleep THREAD_STARTUP_DELAY
+        tracker.update
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000Z
+date: 2012-02-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70122132638240 !ruby/object:Gem::Requirement
+  requirement: &70231856253280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70122132638240
+  version_requirements: *70231856253280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70122132637400 !ruby/object:Gem::Requirement
+  requirement: &70231856252300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132637400
+  version_requirements: *70231856252300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70122132636520 !ruby/object:Gem::Requirement
+  requirement: &70231856251120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132636520
+  version_requirements: *70231856251120
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70122132635680 !ruby/object:Gem::Requirement
+  requirement: &70231856250360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132635680
+  version_requirements: *70231856250360
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70122132634960 !ruby/object:Gem::Requirement
+  requirement: &70231856249440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132634960
+  version_requirements: *70231856249440
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70122132634360 !ruby/object:Gem::Requirement
+  requirement: &70231856248880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132634360
+  version_requirements: *70231856248880
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
-  requirement: &70122132633680 !ruby/object:Gem::Requirement
+  requirement: &70231856248060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122132633680
+  version_requirements: *70231856248060
 description: This gem peridically polls mutiple cloud computing services using the
   fog gem, asynchronously updating the state of the resulting collections of Fog Resources.
 email:
@@ -138,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3623635241096457723
+      hash: -4330503374287036490
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3623635241096457723
+      hash: -4330503374287036490
 requirements: []
 rubyforge_project: fog_tracker
 rubygems_version: 1.8.10