fleet-api 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc67d53034f0f63cc50eb450214eb215f3a8066a
-  data.tar.gz: fa261735dc741aee77142943541075964e1b08d5
+  metadata.gz: a3632dd50614806a6d05b70c954da24146cebf83
+  data.tar.gz: 94458c2c48317cab5e2e7e18c8ea1ea0aae1c9c6
 SHA512:
-  metadata.gz: 7830f480923b8f7a1c6c854afe89483f02d7fd611e66c1a9d757aa26e37696c50726512720388e1b9887caa54298d0ff1360543d99cc4867c0209b6eaff60a23
-  data.tar.gz: 781530a7570c4389ecf4fe8966a33933d89d1f3fcb7300b0f98c3c5af4a8d64a8676a80e219665efd73e919ddc36cdaa906d7a8a20f765845599dcbed298b7bf
+  metadata.gz: c55fa3e17aa13c9167d048196d373295ad39dfeb334567299b9f1b9e4a54a92c02dc4d9d695ded62aee0f173d1bd312925eb76fba5cf66197dc615f6f9be0e54
+  data.tar.gz: e82ec57fd09b71077a5b48e8f74d8daf053f4519ec263da0f3b729f728a1e445c60459eb07ea92188080ed7877276ffa061eabff9391edfd83eb01addaa38b49

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+0.6.1 - 2014-09-20
+------------------
+
+### Fixed
+- Default to async operations to address performance issues
+
 0.6.0 - 2014-09-05
 ------------------
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fleet-api (0.6.0)
+    fleet-api (0.6.1)
       faraday (= 0.8.9)
       faraday_middleware (= 0.9.0)
 

data/README.md

@@ -10,7 +10,7 @@ The client allows programmatic access to most of the *fleetctl* commands includi
 
 At this point, there is no official Fleet API (though one is [in the works](https://github.com/coreos/fleet/blob/master/Documentation/api-v1-alpha.md)) so this library mimcs the behavior of the *fleetctl* command line tool and simply writes data to the [etcd]() key-value-store. The Fleet daemon reads data out of specific keys in etcd and processes it as appropiate.
 
-As work on the actual Fleet API progresses, this library will be refactored to use the real API.
+As work on the actual Fleet API progresses, this library will be refactored to use the real API. An initial pass at implementing a client for the official Fleet API can be found on the [feature/official-api](https://github.com/CenturyLinkLabs/fleet-api/tree/feature/official-api) branch.
 
 An alternative implementation is available in the [cloudspace/ruby-fleetctl](https://github.com/cloudspace/ruby-fleetctl) gem. The *ruby-fleetctl* gem takes a different approach and uses SSH to interact directly with the *fleetctl* binary to send commands. Our approach of writing directly to etcd cuts out the *fleetctl* middleman but is in more danger of being broken by future releases since we're effectively using a "private API".
 

data/lib/fleet/client.rb

@@ -32,7 +32,7 @@ module Fleet
     include Fleet::Client::State
     include Fleet::Client::Unit
 
-    def load(name, service_def=nil)
+    def load(name, service_def=nil, sync=false)
 
       if service_def
         unless service_def.is_a?(ServiceDefinition)
@@ -51,26 +51,26 @@ module Fleet
       end
 
       update_job_target_state(name, :loaded)
-      wait_for_load_state(name, 'loaded')
+      wait_for_load_state(name, 'loaded') if sync
     end
 
     def start(service_name)
       update_job_target_state(service_name, :launched)
     end
 
-    def stop(service_name)
+    def stop(service_name, sync=false)
       update_job_target_state(service_name, :loaded)
-      wait_for_load_state(service_name, 'loaded')
+      wait_for_load_state(service_name, 'loaded') if sync
     end
 
-    def unload(service_name)
+    def unload(service_name, sync=false)
       update_job_target_state(service_name, :inactive)
-      wait_for_load_state(service_name, :no_state)
+      wait_for_load_state(service_name, :no_state) if sync
     end
 
-    def destroy(service_name)
+    def destroy(service_name, sync=false)
       delete_job(service_name)
-      wait_for_load_state(service_name, :no_state)
+      wait_for_load_state(service_name, :no_state) if sync
     end
 
     def status(service_name)

data/lib/fleet/version.rb

@@ -1,3 +1,3 @@
 module Fleet
-  VERSION = '0.6.0'.freeze unless defined?(Fleet::VERSION)
+  VERSION = '0.6.1'.freeze unless defined?(Fleet::VERSION)
 end

data/spec/fleet/client_spec.rb

@@ -28,16 +28,12 @@ describe Fleet::Client do
     let(:name) { 'foo.service' }
     let(:service_def) { { 'Unit' => { 'Description' => 'bar' } } }
     let(:sd) { Fleet::ServiceDefinition.new(name, service_def) }
-    let(:fleet_state) do
-      { 'node' => { 'value' => '{ "loadState": "loaded" }' } }
-    end
 
     context 'when a service definition is provided' do
       before do
         allow(subject).to receive(:create_unit).and_return(nil)
         allow(subject).to receive(:create_job).and_return(nil)
         allow(subject).to receive(:update_job_target_state).and_return(nil)
-        allow(subject).to receive(:get_state).and_return(fleet_state)
         allow(Fleet::ServiceDefinition).to receive(:new).and_return(sd)
       end
 
@@ -62,9 +58,20 @@ describe Fleet::Client do
         subject.load(name, service_def)
       end
 
-      it 'checks the job state' do
-        expect(subject).to receive(:get_state).with(sd.name)
-        subject.load(name, service_def)
+      context 'when sync=true is set' do
+
+        let(:fleet_state) do
+          { 'node' => { 'value' => '{ "loadState": "loaded" }' } }
+        end
+
+        before do
+          allow(subject).to receive(:get_state).and_return(fleet_state)
+        end
+
+        it 'checks the job state' do
+          expect(subject).to receive(:get_state).with(sd.name)
+          subject.load(name, service_def, sync=true)
+        end
       end
 
       context 'when #create_unit raises PreconditionFailed' do
@@ -120,7 +127,6 @@ describe Fleet::Client do
 
       before do
         allow(subject).to receive(:update_job_target_state).and_return(nil)
-        allow(subject).to receive(:get_state).and_return(fleet_state)
       end
 
       it 'does NOT invoke #create_unit' do
@@ -140,9 +146,20 @@ describe Fleet::Client do
         subject.load(name)
       end
 
-      it 'checks the job state' do
-        expect(subject).to receive(:get_state).with(sd.name)
-        subject.load(name)
+      context 'when sync=true is set' do
+
+        let(:fleet_state) do
+          { 'node' => { 'value' => '{ "loadState": "loaded" }' } }
+        end
+
+        before do
+          allow(subject).to receive(:get_state).and_return(fleet_state)
+        end
+
+        it 'checks the job state' do
+          expect(subject).to receive(:get_state).with(sd.name)
+          subject.load(name, nil, sync=true)
+        end
       end
     end
   end
@@ -165,13 +182,8 @@ describe Fleet::Client do
   describe '#stop' do
     let(:service_name) { 'foo.service' }
 
-    let(:fleet_state) do
-      { 'node' => { 'value' => '{ "load_state": "loaded" }' } }
-    end
-
     before do
       allow(subject).to receive(:update_job_target_state)
-      allow(subject).to receive(:get_state).and_return(fleet_state)
     end
 
     it 'invokes #update_job_target_state' do
@@ -181,9 +193,20 @@ describe Fleet::Client do
       subject.stop(service_name)
     end
 
-    it 'checks the job state' do
-      expect(subject).to receive(:get_state).with(service_name)
-      subject.stop(service_name)
+    context 'when sync=true is set' do
+
+      let(:fleet_state) do
+        { 'node' => { 'value' => '{ "load_state": "loaded" }' } }
+      end
+
+      before do
+        allow(subject).to receive(:get_state).and_return(fleet_state)
+      end
+
+      it 'checks the job state' do
+        expect(subject).to receive(:get_state).with(service_name)
+        subject.stop(service_name, sync=true)
+      end
     end
   end
 
@@ -192,7 +215,6 @@ describe Fleet::Client do
 
     before do
       allow(subject).to receive(:update_job_target_state)
-      allow(subject).to receive(:get_state).and_raise(Fleet::NotFound, 'boom')
     end
 
     it 'invokes #update_job_target_state' do
@@ -202,33 +224,40 @@ describe Fleet::Client do
       subject.unload(service_name)
     end
 
-    it 'checks the job state' do
-      expect(subject).to receive(:get_state).with(service_name)
-      subject.unload(service_name)
-    end
-
-    context 'when the unload state cannot be achieved' do
-
-      let(:fleet_state) do
-        { 'node' => { 'value' => '{ "load_state": "loaded" }' } }
-      end
+    context 'when sync=true is set' do
 
       before do
-        allow(subject).to receive(:get_state).and_return(fleet_state)
-        allow(subject).to receive(:sleep)
+        allow(subject).to receive(:get_state).and_raise(Fleet::NotFound, 'boom')
       end
 
-      it 're-checks the state 20 times' do
-        expect(subject).to receive(:get_state).exactly(20).times
-        subject.unload(service_name) rescue nil
+      it 'checks the job state' do
+        expect(subject).to receive(:get_state).with(service_name)
+        subject.unload(service_name, sync=true)
       end
 
-      it 'raises an error' do
-        expect do
-          subject.unload(service_name)
-        end.to raise_error(Fleet::Error)
-      end
+      context 'when the unload state cannot be achieved' do
+
+        let(:fleet_state) do
+          { 'node' => { 'value' => '{ "load_state": "loaded" }' } }
+        end
 
+        before do
+          allow(subject).to receive(:get_state).and_return(fleet_state)
+          allow(subject).to receive(:sleep)
+        end
+
+        it 're-checks the state 20 times' do
+          expect(subject).to receive(:get_state).exactly(20).times
+          subject.unload(service_name, sync=true) rescue nil
+        end
+
+        it 'raises an error' do
+          expect do
+            subject.unload(service_name, sync=true)
+          end.to raise_error(Fleet::Error)
+        end
+
+      end
     end
   end
 
@@ -237,7 +266,6 @@ describe Fleet::Client do
 
     before do
       allow(subject).to receive(:delete_job).and_return(nil)
-      allow(subject).to receive(:get_state).and_raise(Fleet::NotFound, 'boom')
     end
 
     it 'invokes #delete_job' do
@@ -249,9 +277,16 @@ describe Fleet::Client do
       subject.destroy(service_name)
     end
 
-    it 'checks the job state' do
-      expect(subject).to receive(:get_state).with(service_name)
-      subject.destroy(service_name)
+    context 'when sync=true is set' do
+
+      before do
+        allow(subject).to receive(:get_state).and_raise(Fleet::NotFound, 'boom')
+      end
+
+      it 'checks the job state' do
+        expect(subject).to receive(:get_state).with(service_name)
+        subject.destroy(service_name, sync=true)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fleet-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - CenturyLink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the CoreOS Fleet API