rundeck 0.0.3.pre → 0.0.3

data/spec/rundeck/client/job_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe Rundeck::Client do
+  describe '.jobs', vcr: { cassette_name: 'jobs' } do
+    before do
+      @jobs = Rundeck.jobs('anvils')
+    end
+    subject { @jobs }
+
+    it { is_expected.to be_an Array }
+    its(:length) { is_expected.to eq(6) }
+
+    # Only tests the first element, but it's just a sanity check
+    its('first') { is_expected.to respond_to(:name) }
+    its('first') { is_expected.to respond_to(:group) }
+    its('first') { is_expected.to respond_to(:project) }
+    its('first') { is_expected.to respond_to(:description) }
+
+    it 'expects a get to have been made' do
+      expect(a_get('/project/anvils/jobs')).to have_been_made
+    end
+  end
+
+  describe '.job', vcr: { cassette_name: 'job' }  do
+    before do
+      @job = Rundeck.job('2')
+    end
+    subject { @job }
+
+    it { is_expected.to be_a Rundeck::ObjectifiedHash }
+    it { is_expected.to respond_to(:id) }
+    it { is_expected.to respond_to(:name) }
+    it { is_expected.to respond_to(:description) }
+    it { is_expected.to respond_to(:loglevel) }
+    it { is_expected.to respond_to(:sequence) }
+    its(:sequence) { is_expected.to respond_to(:command) }
+
+    it 'expects a get to have been made' do
+      expect(a_get('/job/2')).to have_been_made
+    end
+  end
+
+  describe '.delete_job' do
+    context 'when a job exists',
+            vcr: { cassette_name: 'delete_job_valid' } do
+      before do
+        @job = Rundeck.delete_job(job_id)
+      end
+      let(:job_id) { '3' }
+      subject { @job }
+
+      it { is_expected.to be_nil }
+
+      it 'expects a delete to have been made' do
+        expect(a_delete('/job/3')).to have_been_made
+      end
+    end
+
+    context 'when a job does not exist',
+            vcr: { cassette_name: 'delete_job_invalid' } do
+      specify do
+        expect do
+          Rundeck.delete_job('123456')
+        end.to raise_error(Rundeck::Error::NotFound,
+                           /Job ID does not exist: 123456/)
+      end
+    end
+  end
+
+  describe '.import_job' do
+    context 'with valid format' do
+      before do
+        @import = Rundeck.import_jobs(content, format)
+      end
+      subject { @import }
+
+      context 'yaml', vcr: { cassette_name: 'import_job_yaml' } do
+        let(:format) { 'yaml' }
+        let(:content) { job_yaml }
+
+        it { is_expected.to be_a Rundeck::ObjectifiedHash }
+        its('succeeded.count') { is_expected.to eq('1') }
+        its('failed.count') { is_expected.to eq('0') }
+
+        its('succeeded') { is_expected.to respond_to(:job) }
+        its('succeeded.job') { is_expected.to respond_to(:id) }
+        its('succeeded.job') { is_expected.to respond_to(:name) }
+        its('succeeded.job') { is_expected.to respond_to(:group) }
+        its('succeeded.job') { is_expected.to respond_to(:project) }
+        its('succeeded.job') { is_expected.to respond_to(:url) }
+
+        it 'expects a post to have been made' do
+          expect(a_post('/jobs/import?format=yaml')).to have_been_made
+        end
+      end
+
+      context 'xml', vcr: { cassette_name: 'import_job_xml' } do
+        let(:format) { 'xml' }
+        let(:content) { job_xml }
+
+        it { is_expected.to be_a Rundeck::ObjectifiedHash }
+        its('succeeded.count') { is_expected.to eq('1') }
+        its('failed.count') { is_expected.to eq('0') }
+
+        its('succeeded') { is_expected.to respond_to(:job) }
+        its('succeeded.job') { is_expected.to respond_to(:id) }
+        its('succeeded.job') { is_expected.to respond_to(:name) }
+        its('succeeded.job') { is_expected.to respond_to(:group) }
+        its('succeeded.job') { is_expected.to respond_to(:project) }
+        its('succeeded.job') { is_expected.to respond_to(:url) }
+
+        it 'expects a post to have been made' do
+          expect(a_post('/jobs/import?format=xml')).to have_been_made
+        end
+      end
+    end
+
+    context 'with invalid format', vcr: { cassette_name: 'import_job_invalid' } do
+      specify do
+        expect do
+          Rundeck.import_jobs('content', 'invalid_format')
+        end.to raise_error(Rundeck::Error::InvalidAttributes,
+                           'format must be yaml or xml')
+      end
+    end
+  end
+
+  describe '.export_job' do
+    context 'with valid format' do
+      before do
+        @jobs = Rundeck.export_jobs('anvils', format)
+      end
+      subject { @jobs }
+
+      context 'yaml', vcr: { cassette_name: 'export_job_yaml' } do
+        let(:format) { 'yaml' }
+
+        it { is_expected.to be_a String }
+        it { is_expected.to include 'project: anvils' }
+        it { is_expected.to include 'loglevel: INFO' }
+        it { is_expected.to include 'sequence:' }
+
+        it 'expects a get to have been made' do
+          expect(
+              a_get('/jobs/export?project=anvils&format=yaml')
+          ).to have_been_made
+        end
+      end
+
+      context 'xml', vcr: { cassette_name: 'export_job_xml' } do
+        let(:format) { 'xml' }
+
+        it { is_expected.to be_a String }
+        it { is_expected.to include '<project>anvils</project>' }
+        it { is_expected.to include '<loglevel>INFO</loglevel>' }
+        it { is_expected.to include '<sequence' }
+
+        it 'expects a get to have been made' do
+          expect(
+              a_get('/jobs/export?project=anvils&format=xml')
+          ).to have_been_made
+        end
+      end
+    end
+
+    context 'with invalid format', vcr: { cassette_name: 'export_job_invalid' } do
+      specify do
+        expect do
+          Rundeck.export_jobs('anvils', 'invalid_format')
+        end.to raise_error(Rundeck::Error::InvalidAttributes,
+                           'format must be yaml or xml')
+      end
+    end
+  end
+end

data/spec/rundeck/client/key_spec.rb

@@ -0,0 +1,223 @@
+require 'spec_helper'
+
+describe Rundeck::Client do
+  describe '.keys' do
+    # The anvils demo doesn't have any keys by default.
+    # Create a public key at path /path/to/key and a private key
+    # at /path/to/private_key using the data from the helper methods.
+    # Create the public key first.
+    context 'with a path containing multiple keys',
+            vcr: { cassette_name: 'keys_multiple' } do
+      before do
+        @keys = Rundeck.keys('path/to')
+      end
+      subject { @keys }
+
+      it { is_expected.to be_an Array }
+      its('first.name') { is_expected.to eq('key') }
+      its('first.resource_meta.rundeck_content_type') { is_expected.to eq('application/pgp-key') }
+
+      it 'expects a get to have been made' do
+        expect(a_get('/storage/keys/path/to')).to have_been_made
+      end
+    end
+
+    context 'with a path containing no keys',
+            vcr: { cassette_name: 'keys_none' } do
+      specify do
+        expect do
+          Rundeck.keys('path/to/nowhere')
+        end.to raise_error Rundeck::Error::NotFound
+      end
+    end
+
+    context 'with a direct path to a key',
+            vcr: { cassette_name: 'keys_direct' } do
+      specify do
+        expect do
+          Rundeck.keys('path/to/key')
+        end.to raise_error(Rundeck::Error::InvalidAttributes,
+                           'Please provide a key storage path that ' \
+                           'isn\'t a direct path to a key')
+      end
+    end
+  end
+
+  describe '.key_metadata' do
+    context 'with a direct path to a key',
+            vcr: { cassette_name: 'key_metadata_direct' } do
+      before do
+        @key = Rundeck.key_metadata('path/to/key')
+      end
+      subject { @key }
+
+      it { is_expected.to be_a Rundeck::ObjectifiedHash }
+      its(:rundeck_content_type) { is_expected.to eq('application/pgp-key') }
+
+      it 'expects a get to have been made' do
+        expect(a_get('/storage/keys/path/to/key')).to have_been_made
+      end
+    end
+
+    context 'with a path containing multiple keys',
+            vcr: { cassette_name: 'key_metadata_multiple' } do
+      specify do
+        expect do
+          Rundeck.key_metadata('path/to')
+        end.to raise_error(Rundeck::Error::InvalidAttributes,
+                           'Please provide a key storage path that ' \
+                           'is a direct path to a key')
+      end
+    end
+  end
+
+  describe '.key_contents' do
+    context 'with a direct path to a key',
+            vcr: { cassette_name: 'key_contents_direct' } do
+      before do
+        @key = Rundeck.key_contents('path/to/key')
+      end
+      subject { @key }
+
+      it { is_expected.to be_a Rundeck::ObjectifiedHash }
+      its(:public_key) { is_expected.to include('ssh-rsa') }
+
+      it 'expects a get to have been made' do
+        expect(a_get('/storage/keys/path/to/key')).to have_been_made
+      end
+      it 'expects a get to have been made' do
+        expect(a_get('/storage/keys/path/to/key', 'pgp-keys')).to have_been_made
+      end
+    end
+
+    context 'with a path containing multiple keys',
+            vcr: { cassette_name: 'key_contents_multiple' } do
+      specify do
+        expect do
+          Rundeck.key_contents('path/to')
+        end.to raise_error(Rundeck::Error::InvalidAttributes,
+                           'Please provide a key storage path that ' \
+                           'is a direct path to a key')
+      end
+    end
+
+    context 'with a path to a private key',
+            vcr: { cassette_name: 'key_contents_private' } do
+      specify do
+        expect do
+          Rundeck.key_contents('path/to/private_key')
+        end.to raise_error(Rundeck::Error::Unauthorized,
+                           'You are not allowed to retrieve the contents ' \
+                           'of a private key')
+      end
+    end
+  end
+
+  describe '.create_private_key',
+           vcr: { cassette_name: 'create_private_key' } do
+    before do
+      @key = Rundeck.create_private_key('path/to/private_key2', private_key)
+    end
+    subject { @key }
+
+    it { is_expected.to be_a Rundeck::ObjectifiedHash }
+    its(:rundeck_key_type) { is_expected.to eq('private') }
+
+    it 'expects a post to have been made' do
+      expect(
+        a_post('/storage/keys/path/to/private_key2')
+      ).to have_been_made
+    end
+  end
+
+  describe '.update_private_key',
+           vcr: { cassette_name: 'update_private_key' } do
+    before do
+      @key = Rundeck.update_private_key('path/to/private_key2', private_key)
+    end
+    subject { @key }
+
+    it { is_expected.to be_a Rundeck::ObjectifiedHash }
+    its(:rundeck_key_type) { is_expected.to eq('private') }
+
+    it 'expects a get to have been made' do
+      expect(a_get('/storage/keys/path/to/private_key2')).to have_been_made
+    end
+    it 'expects a put to have been made' do
+      expect(a_put('/storage/keys/path/to/private_key2')).to have_been_made
+    end
+  end
+
+  describe '.create_public_key',
+           vcr: { cassette_name: 'create_public_key' } do
+    before do
+      @key = Rundeck.create_public_key('path/to/public_key2', public_key)
+    end
+    subject { @key }
+
+    it { is_expected.to be_a Rundeck::ObjectifiedHash }
+    its(:rundeck_content_type) { is_expected.to eq('application/pgp-key') }
+
+    it 'expects a post to have been made' do
+      expect(
+          a_post('/storage/keys/path/to/public_key2')
+      ).to have_been_made
+    end
+  end
+
+  describe '.update_public_key',
+           vcr: { cassette_name: 'update_public_key' } do
+    before do
+      @key = Rundeck.update_public_key('path/to/public_key2', public_key)
+    end
+    subject { @key }
+
+    it { is_expected.to be_a Rundeck::ObjectifiedHash }
+    its(:rundeck_content_type) { is_expected.to eq('application/pgp-key') }
+
+    it 'expects a get to have been made' do
+      expect(a_get('/storage/keys/path/to/public_key2')).to have_been_made
+    end
+    it 'expects a put to have been made' do
+      expect(a_put('/storage/keys/path/to/public_key2')).to have_been_made
+    end
+  end
+
+  describe '.delete_key' do
+    context 'with a valid' do
+      before do
+        @key = Rundeck.delete_key(path)
+      end
+      subject { @key }
+
+      context 'public key path',
+              vcr: { cassette_name: 'delete_key_public' } do
+        let(:path) { 'path/to/public_key2' }
+
+        it { is_expected.to be_nil }
+        it 'expects a delete to have been made' do
+          expect(a_delete('/storage/keys/path/to/public_key2')).to have_been_made
+        end
+      end
+
+      context 'private key path',
+              vcr: { cassette_name: 'delete_key_private' } do
+        let(:path) { 'path/to/private_key2' }
+
+        it { is_expected.to be_nil }
+        it 'expects a delete to have been made' do
+          expect(a_delete('/storage/keys/path/to/private_key2')).to have_been_made
+        end
+      end
+    end
+
+    context 'with a bad path',
+            vcr: { cassette_name: 'delete_key_invalid' } do
+      specify do
+        expect do
+          Rundeck.delete_key('path/to/nowhere')
+        end.to raise_error Rundeck::Error::NotFound
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,77 +1,32 @@
 require 'rspec'
 require 'rspec/its'
 require 'webmock/rspec'
+require 'vcr'
 require 'codeclimate-test-reporter'
 
+# Must be called before code is included/required!
 CodeClimate::TestReporter.start
 
-WebMock.disable_net_connect!(allow: 'codeclimate.com')
+require 'support/helpers'
 
 require File.expand_path('../../lib/rundeck', __FILE__)
 
-def load_fixture(name)
-  File.new(File.dirname(__FILE__) + "/fixtures/#{name}.xml")
-end
+WebMock.disable_net_connect!(allow: 'codeclimate.com')
 
 RSpec.configure do |config|
+  config.include Helpers
+
   config.before(:each) do
-    Rundeck.endpoint = 'https://api.example.com'
-    Rundeck.api_token = 'secret'
+    # Configuration for Anvils Demo Vagrant Box. API token might change.
+    Rundeck.endpoint = 'http://192.168.50.2:4440'
+    Rundeck.api_token = 'cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd'
+    WebMock.reset!
   end
 end
 
-# GET
-def stub_get(path, fixture, accept = 'xml')
-  stub_request(:get, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-      .to_return(body: load_fixture(fixture))
-end
-
-def a_get(path, accept = 'xml')
-  a_request(:get, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-end
-
-# POST
-def stub_post(path, fixture, status_code = 200, accept = 'xml')
-  stub_request(:post, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-      .to_return(body: load_fixture(fixture), status: status_code)
-end
-
-def a_post(path, accept = 'xml')
-  a_request(:post, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-end
-
-# PUT
-def stub_put(path, fixture, accept = 'xml')
-  stub_request(:put, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-      .to_return(body: load_fixture(fixture))
-end
-
-def a_put(path, accept = 'xml')
-  a_request(:put, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-end
-
-# DELETE
-def stub_delete(path, fixture, accept = 'xml')
-  stub_request(:delete, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
-      .to_return(body: load_fixture(fixture))
-end
-
-def a_delete(path, accept = 'xml')
-  a_request(:delete, "#{Rundeck.endpoint}#{path}")
-      .with(headers: { 'Accept' => "application/#{accept}",
-                       'X-Rundeck-Auth-Token' => Rundeck.api_token })
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes/#{Rundeck.api_version}"
+  config.hook_into :webmock
+  config.allow_http_connections_when_no_cassette = true
+  config.configure_rspec_metadata!
 end