scooter 0.0.0 → 3.2.19

data/lib/scooter/ldap/ldap_fixtures.rb

@@ -0,0 +1,60 @@
+module Scooter
+  module LDAP
+    class LDAPFixtures
+      attr_reader :users
+
+
+      def self.users(test_uid=nil)
+        { 'howard'    =>
+              { :cn          => "howard#{test_uid}",
+                :sn          => "lovecraft",
+                :displayName => "Howard P. Lovecraft#{test_uid}",
+                :mail        => "howard@example.com"
+              },
+          'sylvia'    =>
+              { :cn          => "sylvia#{test_uid}",
+                :sn          => "plath",
+                :displayName => "Sylvia Plath#{test_uid}",
+                :mail        => "sylvia@example.com"
+              },
+          'guillermo' =>
+              { :cn          => "guillermo#{test_uid}",
+                :sn          => "del toro",
+                :displayName => "Guillermo del Toro#{test_uid}",
+                :mail        => "guillermo@example.com"
+              },
+          'jorge'     =>
+              { :cn          => "jorge#{test_uid}",
+                :sn          => "borges",
+                :displayName => "Jorge Borges#{test_uid}",
+                :mail        => "jorge@example.com"
+              },
+          'arthur'    =>
+              { :cn          => "arthur#{test_uid}",
+                :sn          => "doyle",
+                :displayName => "Sir Arthur Conan Doyle#{test_uid}",
+                :mail        => "arthur@example.com"
+              },
+          'oscar'     =>
+              { :cn          => "oscar#{test_uid}",
+                :sn          => 'wilde',
+                :displayName => "Oscar Fingal O'Flahertie Wills Wilde#{test_uid}",
+                :mail        => 'oscar@example.com'
+              },
+          'stephen'   =>
+              { :cn          => "stephen#{test_uid}",
+                :sn          => 'sondheim',
+                :displayName => "Stephen Sondheim#{test_uid}",
+                :mail        => 'stephen@example.com'
+              },
+          'tony'      =>
+              { :cn          => "tony#{test_uid}",
+                :sn          => "stark",
+                :displayName => "Tony Stark#{test_uid}",
+                :mail        => "tony@example.com"
+              }
+        }
+      end
+    end
+  end
+end

data/lib/scooter/middleware/rbac_auth_token.rb

@@ -0,0 +1,35 @@
+module Faraday
+  # This middleware checks for tokens and adds them to the request when found.
+  # To include this correctly, you will need to pass the dispatcher itself to
+  # the initialize method so it can read if the dispatcher has tokens or not.
+  # Beyond just the token itself, it also checks the dispatcher if the
+  # instance variable <i>send_auth_token_as_query_param</i> is set to true.
+  # Otherwise, it will always attach it as an X-Authentication header.
+  class RbacAuthToken < Faraday::Middleware
+    attr_reader :dispatcher
+
+
+    # @param app() Structural requirement for Faraday::Middleware initialization
+    # @param dispatcher(Scooter::HttpDispatchers::ConsoleDispatcher required)
+    #   Required param so that the middleware can check to see if there is a
+    #   token set in the implementing dispatcher class. Will work with
+    #   <i>ConsoleDispatcher</i>.
+    def initialize(app, dispatcher)
+      super(app)
+      @dispatcher = dispatcher
+    end
+
+    def call(env)
+      if dispatcher.token && dispatcher.send_auth_token_as_query_param
+        query_array = [['token', dispatcher.token]]
+        URI.decode_www_form(env.url.query).each {|tuple| query_array << tuple} if env.url.query
+        env.url.query = URI.encode_www_form(query_array)
+      elsif dispatcher.token
+        env.request_headers['X-Authentication'] = dispatcher.token
+      end
+      @app.call env
+    end
+  end
+end
+
+Faraday::Request.register_middleware :rbac_auth_token => lambda { Faraday::RbacAuthToken }

data/lib/scooter/utilities.rb

@@ -0,0 +1,9 @@
+%w( string_utilities beaker_utilities).each do |lib|
+  require "scooter/utilities/#{lib}"
+end
+
+module Scooter
+  module Utilities
+    include StringUtilities
+  end
+end

data/lib/scooter/utilities/beaker_utilities.rb

@@ -0,0 +1,41 @@
+module Scooter
+  module Utilities
+    module BeakerUtilities
+      extend Beaker::DSL
+
+      # Beaker and ec2 don't play nice with getting the public ip. It is only set during
+      # initial provision and can be over-ridden. If you also have to run the script several times,
+      # or are using an existing set of nodes for testing, beaker has no way to get the
+      # ec2 instanes public ip address, mostly because the box it self does not expose it anywhere.
+      # According to the docs, you can curl the below to get it
+      # http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html
+      def self.get_public_ip(host)
+        if host['hypervisor'] == 'ec2'
+          on(host, "curl http://169.254.169.254/latest/meta-data/public-ipv4").stdout
+        else
+          host.ip
+        end
+      end
+
+      def self.pe_ca_cert_file(master)
+        ca_cert = on(master, "cat `puppet agent --configprint localcacert`", :silent => true).stdout
+
+        cert_dir = Dir.mktmpdir("pe_certs")
+
+        ca_cert_file = File.join(cert_dir, "cacert.pem")
+        File.open(ca_cert_file, "w+") do |f|
+          f.write(ca_cert)
+        end
+        ca_cert_file
+      end
+
+      def self.pe_private_key(master)
+        on(master, "cat `puppet agent --configprint hostprivkey`", :silent => true).stdout
+      end
+
+      def self.pe_hostcert(master)
+        on(master, "cat `puppet agent --configprint hostcert`", :silent => true).stdout
+      end
+    end
+  end
+end

data/lib/scooter/utilities/string_utilities.rb

@@ -0,0 +1,32 @@
+module Scooter
+  module Utilities
+    module StringUtilities
+
+      class RandomString
+        def self.generate(length = 32)
+          characters = [('0'..'9'), ('a'..'z'), ('A'..'Z')]
+          characters = characters.map{ |i| i.to_a }.flatten
+          (0...length).map{ characters[rand(characters.length)] }.join
+        end
+      end
+
+      # Create a string of two-byte Cyrillic characters.
+      class RandomTwoByteUnicodeString
+        def self.generate(length = 32)
+          characters  = (0x0400..0x04FF).to_a.map {|e| e.chr(Encoding::UTF_8) }
+          (0...length).map{ characters[rand(characters.length)] }.join
+        end
+      end
+
+      # Create some single-byte characters outside the ASCII 7-bit range.
+      class RandomHighbitString
+        def self.generate(length = 32)
+          characters = (0x80..0xFF).to_a.map {|e| e.chr }
+          (0...length).map{ characters[rand(characters.length)] }.join
+        end
+      end
+
+    end
+  end
+end
+

data/lib/scooter/version.rb

@@ -1,3 +1,5 @@
 module Scooter
-  VERSION = "0.0.0"
+  module Version
+    STRING = '3.2.19'
+  end
 end

data/scooter.gemspec

@@ -5,19 +5,36 @@ require 'scooter/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "scooter"
-  spec.version       = Scooter::VERSION
+  spec.version       = Scooter::Version::STRING
   spec.authors       = ["Puppetlabs"]
   spec.email         = ["qa@puppetlabs.com"]
   spec.summary       = %q{Puppetlabs testing tool}
-  spec.description   = %q{Puppetlabs testing tool}
-  spec.homepage      = ""
-  spec.license       = "Apache2"
+  spec.description   = %q{Puppetlabs testing tool coupled with Beaker}
+  spec.homepage      = "https://github.com/puppetlabs/scooter"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  #Development dependencies
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'pry', '~> 0.9.12'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+
+  #Documentation dependencies
+  spec.add_development_dependency 'yard', '~> 0'
+  spec.add_development_dependency 'markdown', '~> 0'
+  spec.add_development_dependency 'activesupport', '4.2.6'
+
+  #Run time dependencies
+  spec.add_runtime_dependency 'json', '~> 1.8'
+  spec.add_runtime_dependency 'test-unit'
+  spec.add_runtime_dependency 'net-ldap', '~> 0.6', '>= 0.6.1', '<= 0.12.1'
+  spec.add_runtime_dependency 'beaker', '>= 2.1.0'
+  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.1'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0', '>= 0.0.6'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.5', '>= 1.5.10'
 end

data/spec/scooter/beaker_utilities_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module Scooter
+
+  describe Utilities::BeakerUtilities do
+
+    let(:result)          { instance_double(Beaker::Result)}
+    let(:master)          { instance_double(Beaker::Host) }
+
+    context 'with correct argument' do
+
+      it 'gets the pe ca certfile' do
+        cmd = "cat `puppet agent --configprint localcacert`"
+        expect_any_instance_of(Beaker::DSL).to receive(:on).with(master, cmd, any_args).and_return(result)
+        expect(result).to receive(:stdout).and_return('foobar')
+        expect(subject.pe_ca_cert_file(master)).to match(/\/.*pe_certs.*\/cacert.pem/)
+      end
+
+      it 'gets the pe hostprivkey' do
+        cmd = "cat `puppet agent --configprint hostprivkey`"
+        expect_any_instance_of(Beaker::DSL).to receive(:on).with(master, cmd, any_args).and_return(result)
+        expect(result).to receive(:stdout).and_return('foobar')
+        expect(subject.pe_private_key(master)).to eq('foobar')
+      end
+
+      it 'gets the pe hostcert' do
+        cmd = "cat `puppet agent --configprint hostcert`"
+        expect_any_instance_of(Beaker::DSL).to receive(:on).with(master, cmd, any_args).and_return(result)
+        expect(result).to receive(:stdout).and_return('foobar')
+        expect(subject.pe_hostcert(master)).to eq('foobar')
+      end
+
+    end
+
+    context 'without correct arguments' do
+
+      it 'getting the pe ca certificate fails with no arguments' do
+        expect{ subject.pe_ca_cert_file }.to raise_error(ArgumentError)
+      end
+
+      it 'getting the pe hostprivkey fails with no arguments' do
+        expect{ subject.pe_private_key }.to raise_error(ArgumentError)
+      end
+
+      it 'getting the pe hostcert fails with no arguments' do
+        expect{ subject.pe_hostcert }.to raise_error(ArgumentError)
+      end
+
+    end
+
+  end
+
+end

data/spec/scooter/httpdispatchers/activity/activity_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+
+module Scooter
+
+  describe Scooter::HttpDispatchers::Activity do
+
+    let(:host) { double('host') }
+    let(:credentials) { double('credentials') }
+    let(:classifier_events) {
+      {
+          "commits" => [
+              {
+                  "object"    => {
+                      "id"   => "da180809-36b1-4049-ab7b-29188dd6e255",
+                      "name" => "Agent-specified environment"
+                  },
+                  "subject"   => {
+                      "id"   => "af94921f-bd76-4b58-b5ce-e17c029a2790",
+                      "name" => "api_user"
+                  },
+                  "timestamp" => "2016-06-09T18:08:13Z",
+                  "events"    => [
+                      {
+                          "message" => "Changed the environment override setting to true"
+                      },
+                      {
+                          "message" => "Changed the environment to \"agent-specified\""
+                      },
+                      {
+                          "message" => "Changed the parent to 395ad98e-c536-4dfc-9f5f-b00d5ee2454f"
+                      },
+                      {
+                          "message" => "Created the \"Agent-specified environment\" group with id da180809-36b1-4049-ab7b-29188dd6e255"
+                      }
+                  ]
+              },
+              {
+                  "object"    => {
+                      "id"   => "395ad98e-c536-4dfc-9f5f-b00d5ee2454f",
+                      "name" => "Production environment"
+                  },
+                  "subject"   => {
+                      "id"   => "af94921f-bd76-4b58-b5ce-e17c029a2790",
+                      "name" => "api_user"
+                  },
+                  "timestamp" => "2016-06-09T18:08:13Z",
+                  "events"    => [
+                      {
+                          "message" => "Changed the environment override setting to true"
+                      },
+                      {
+                          "message" => "Changed the environment to \"production\""
+                      },
+                      {
+                          "message" => "Changed the parent to 00000000-0000-4000-8000-000000000000"
+                      },
+                      {
+                          "message" => "Changed the rule to [\"and\" [\"~\" \"name\" \".*\"]]"
+                      },
+                      {
+                          "message" => "Created the \"Production environment\" group with id 395ad98e-c536-4dfc-9f5f-b00d5ee2454f"
+                      }
+                  ]
+              }
+          ]
+      }
+    }
+    let(:rbac_events) {
+      {
+          "commits"    => [
+              {
+                  "object"    => {
+                      "id"   => "42bf351c-f9ec-40af-84ad-e976fec7f4bd",
+                      "name" => "admin"
+                  },
+                  "subject"   => {
+                      "id"   => "42bf351c-f9ec-40af-84ad-e976fec7f4bd",
+                      "name" => "admin"
+                  },
+                  "timestamp" => "2016-06-09T19:14:26Z",
+                  "events"    => [
+                      {
+                          "message" => "User Administrator (42bf351c-f9ec-40af-84ad-e976fec7f4bd) logged in."
+                      }
+                  ]
+              },
+              {
+                  "object"    => {
+                      "id"   => "42bf351c-f9ec-40af-84ad-e976fec7f4bd",
+                      "name" => "admin"
+                  },
+                  "subject"   => {
+                      "id"   => "42bf351c-f9ec-40af-84ad-e976fec7f4bd",
+                      "name" => "admin"
+                  },
+                  "timestamp" => "2016-06-09T18:08:14Z",
+                  "events"    => [
+                      {
+                          "message" => "Password reset for user Administrator (42bf351c-f9ec-40af-84ad-e976fec7f4bd)."
+                      }
+                  ]
+              },
+              {
+                  "object"    => {
+                      "id"   => "42bf351c-f9ec-40af-84ad-e976fec7f4bd",
+                      "name" => "admin"
+                  },
+                  "subject"   => {
+                      "id"   => "af94921f-bd76-4b58-b5ce-e17c029a2790",
+                      "name" => "api_user"
+                  },
+                  "timestamp" => "2016-06-09T18:08:14Z",
+                  "events"    => [
+                      {
+                          "message" => "A password reset token was generated for user Administrator (42bf351c-f9ec-40af-84ad-e976fec7f4bd)."
+                      }
+                  ]
+              }
+          ],
+          "offset"     => 0,
+          "limit"      => 3,
+          "total-rows" => 3
+      }
+    }
+
+    subject { HttpDispatchers::ConsoleDispatcher.new(host, credentials) }
+
+    context 'with a beaker host passed in' do
+
+      unixhost = { roles:     ['test_role'],
+                   'platform' => 'debian-7-x86_64' }
+      let(:host) { Beaker::Host.create('test.com', unixhost, {}) }
+      let(:credentials) { { login: 'Ziggy', password: 'Stardust' } }
+
+      before do
+        expect(Scooter::Utilities::BeakerUtilities).to receive(:pe_ca_cert_file).and_return('cert file')
+        expect(Scooter::Utilities::BeakerUtilities).to receive(:get_public_ip).and_return('public_ip')
+        expect(subject).not_to be_nil
+      end
+
+      describe '.get_classifier_events' do
+        before do
+          # find the index of the default Faraday::Adapter::NetHttp handler
+          # and replace it with the Test adapter
+          index = subject.connection.builder.handlers.index(Faraday::Adapter::NetHttp)
+          subject.connection.builder.swap(index, Faraday::Adapter::Test) do |stub|
+            stub.get('activity-api/v1/events?service_id=classifier') { [200, {}] }
+          end
+        end
+        it 'gets classifier events' do
+          expect { subject.get_classifier_events }.not_to raise_error
+          response = subject.get_classifier_events
+          expect(response.status).to eq(200)
+          hashed_query = CGI.parse(response.env.url.query)
+          expect(hashed_query).to eq('service_id' => ['classifier'])
+        end
+        it 'appends additional query string parameters' do
+          expect { subject.get_classifier_events }.not_to raise_error
+          response     = subject.get_classifier_events({ 'subject_type' => 'users', 'subject_id' => 'dfgdfc145-545dfg54f-fdg45s5s' })
+          hashed_query = CGI.parse(response.env.url.query)
+          expect(hashed_query).to eq({ 'service_id' => ['classifier'], 'subject_type' => ['users'], 'subject_id' => ['dfgdfc145-545dfg54f-fdg45s5s'] })
+        end
+      end
+
+      describe '.get_rbac_events' do
+        before do
+          # find the index of the default Faraday::Adapter::NetHttp handler
+          # and replace it with the Test adapter
+          index = subject.connection.builder.handlers.index(Faraday::Adapter::NetHttp)
+          subject.connection.builder.swap(index, Faraday::Adapter::Test) do |stub|
+            stub.get('activity-api/v1/events?service_id=rbac') { [200, {}] }
+          end
+        end
+        it 'gets rbac events' do
+          expect { subject.get_rbac_events }.not_to raise_error
+          response = subject.get_rbac_events
+          expect(response.status).to eq(200)
+          hashed_query = CGI.parse(response.env.url.query)
+          expect(hashed_query).to eq('service_id' => ['rbac'])
+        end
+        it 'appends additional query string parameters' do
+          expect { subject.get_rbac_events }.not_to raise_error
+          response = subject.get_rbac_events({ 'subject_type' => 'users', 'subject_id' => 'dfgdfc145-545dfg54f-fdg45s5s' })
+          expect(response.status).to eq(200)
+          hashed_query = CGI.parse(response.env.url.query)
+          expect(hashed_query).to eq({ 'service_id' => ['rbac'], 'subject_type' => ['users'], 'subject_id' => ['dfgdfc145-545dfg54f-fdg45s5s'] })
+        end
+      end
+
+      describe '.activity_database_matches_self?' do
+        before do
+          # find the index of the default Faraday::Adapter::NetHttp handler
+          # and replace it with the Test adapter
+          index = subject.connection.builder.handlers.index(Faraday::Adapter::NetHttp)
+          subject.connection.builder.swap(index, Faraday::Adapter::Test) do |stub|
+            stub.get('activity-api/v1/events?service_id=rbac') { |env| env[:url].to_s == "https://test.com:4433/activity-api/v1/events?service_id=rbac" ?
+                [200, [], rbac_events] :
+                [200, [], rbac_events.dup["commits"].push('another_array_item')] }
+            stub.get('activity-api/v1/events?service_id=classifier') { |env| env[:url].to_s == "https://test.com:4433/activity-api/v1/events?service_id=classifier" ?
+                [200, [], classifier_events] :
+                [200, [], classifier_events.dup["commits"].push('another_array_item')] }
+          end
+          expect(subject).to receive(:create_default_connection).with(any_args).twice.and_return(subject.connection)
+          expect(Scooter::Utilities::BeakerUtilities).to receive(:get_public_ip).and_return('public_ip')
+        end
+
+        it 'compare with self' do
+          expect(subject.activity_database_matches_self?('test.com')).to be_truthy
+        end
+
+        it 'compare with different' do
+          expect(subject.faraday_logger).to receive(:warn).with /Rbac events do not match/
+          expect(subject.activity_database_matches_self?('test2.com')).to be_falsey
+        end
+      end
+    end
+  end
+end