scooter 4.3.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ca54fada5ece86c1fe113fa7f0c25bacd1ebc62
-  data.tar.gz: 1ce08824ac9b30cf1dc06521dd4f0902bc3e7236
+SHA256:
+  metadata.gz: f71907b52f6d00c4a5c3922bad60f2c1bea0a39556959f9ce678bdbdfdcdd63f
+  data.tar.gz: '07956a1b0006f9c680f8e54ff80f77d2d1fcad5359af6304e50d9ba4f19a7cd8'
 SHA512:
-  metadata.gz: f599a2cc0544ba20572986a9f40e42a586a2c34c14cb455d6c04ea98848abf7f28a6d9458f05dd546b13f7dec8b3f43feeea7b9b86e2c54ef7d1050318bcc0fd
-  data.tar.gz: d1a8bca420de1f93d34758efe72ab55cdd7b96dc74cc502b2dbe829a44307081d86c0dd5c94e50ca04d9d26c3440165392b8e2ba45638e076c025c8e56e45327
+  metadata.gz: ea079fd367c468e76f8cfd84503c912a63727a0c6877aa86d0cd7fea239a3687b78f2dcaf369b81a8ea830b3e8ef34fd30534c539cf2fe9cff1748cb79e381ab
+  data.tar.gz: 45d3dc393431935218e795bd83b4df78c075c0e801a25ae9763a4886f0128a963735e92a940c23d20ed268d6bd1d9ad08aa61d3d882565863673a59047f4eddf

data/.github/workflows/unit-tests.yaml

@@ -0,0 +1,33 @@
+name: Unit
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  unit:
+    name: Unit
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: "2.7"
+          - ruby: "3.1"
+          - ruby: "3.2"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install bundler
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+      - name: Install gems
+        run: bundle install
+      - name: Run unit tests
+        run: bundle exec rspec

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppetlabs/dumpling

data/README.md

@@ -32,17 +32,14 @@ Scooter is currently divvied into the following sections:
 ## Running the tests
 
 ```
-bundle exec rake test
+bundle exec rake spec
 ```
 
 ## Versioning
 
 Scooter's development began with Puppet Enterprise 3.7, but that was only available for internal testing at that time; Scooter is open-sourced and available on [rubygems.org](https://rubygems.org) at version 4.x to support the LTS version of Puppet Enterprise, 2016.4.0.
 
-## Rdocs
-
-Please view the [RubyDocs](http://rubydoc.info/github/puppetlabs/scooter) for further documentation.
 
 ## Contributing
 
-Scooter is very closely related to [Beaker](https://github.com/puppetlabs/beaker); if you wish to contribute to this project, please follow the [outline](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) there for contributing to this repo.
+Scooter is very closely related to [Beaker](https://github.com/voxpupuli/beaker); if you wish to contribute to this project, please follow the [outline](https://github.com/voxpupuli/beaker/blob/master/CONTRIBUTING.md) there for contributing to this repo.

data/lib/beaker-http/dsl/web_helpers.rb

@@ -0,0 +1,62 @@
+module Beaker::DSL::Helpers::WebHelpers
+
+  # Generates a new http connection object, using the ever-present options hash to
+  # configure the connection.
+  #
+  # @param host [Beaker::Host optional] supply a SUT host object; will use puppet on host
+  #    to configure certs, and use the options in the host object instead of the global.
+  # @return [Beaker::Http::Connection] an object wrapping the Faraday::Connection object.
+  def generate_new_http_connection(host = nil)
+    if host
+      raise ArgumentError.new "host must be Beaker::Host, not #{host.class}" if !host.is_a?(Beaker::Host)
+      connection = Beaker::Http::Connection.new(host.options)
+      connection.configure_private_key_and_cert_with_puppet(host)
+      connection
+    else
+      Beaker::Http::Connection.new(options)
+    end
+  end
+
+  # Make a single http request and discard the http connection object. Returns a Faraday::Response
+  # object that can be introspected for all response information.
+  #
+  # @param url [String] String that will be parsed into a URI object.
+  # @param request_method [Symbol] Represents any valid http verb.
+  # @param cert [OpenSSL::X509::Certificate] Certifcate for authentication.
+  # @param key [OpenSSL::PKey::RSA] Private Key for authentication.
+  # @param body [String, Hash] For requests that can send a body. Strings are sent unformatted and
+  #    Hashes are JSON.parsed by the Faraday Middleware.
+  # @param [Hash] options Hash of options extra options for the request
+  # @option options [Boolean] :read_timeout How long to wait before closing the connection.
+  # @return [Faraday::Response]
+  def http_request(url, request_method, cert=nil, key=nil, body=nil, options={})
+    connection = generate_new_http_connection
+
+
+    connection.url_prefix = URI.parse(url)
+
+    if cert
+      if cert.is_a?(OpenSSL::X509::Certificate)
+        connection.ssl['client_cert'] = cert
+      else
+        raise TypeError, "cert must be an OpenSSL::X509::Certificate object, not #{cert.class}"
+      end
+    end
+
+    if key
+      if key.is_a?(OpenSSL::PKey::RSA)
+        connection.ssl['client_key'] = key
+      else
+        raise TypeError, "key must be an OpenSSL::PKey:RSA object, not #{key.class}"
+      end
+    end
+
+    # ewwww
+    connection.ssl[:verify] = false
+
+    connection.connection.options.timeout = options[:read_timeout] if options[:read_timeout]
+
+    response = connection.send(request_method) { |conn| conn.body = body }
+    response
+  end
+end

data/lib/beaker-http/helpers/puppet_helpers.rb

@@ -0,0 +1,49 @@
+module Beaker
+  module Http
+    module Helpers
+
+      # Given a Beaker::Host object, introspect the host for the CA cert and save it to
+      # the coordinator's filesystem.
+      # @param host[Beaker::Host] host to ssh into and find the CA cert
+      # @return [String] File path to the CA cert saved on the coordinator
+      def get_host_cacert(host)
+        cacert_on_host= host.puppet['localcacert']
+        # puppet may not have laid down the cacert yet, so check to make sure
+        # the file exists
+        host.execute("test -f #{cacert_on_host}")
+        ca_cert = host.execute("cat #{cacert_on_host}", :silent => true)
+        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
+
+      # Given a Beaker::Host object, introspect the host for the private key and save it to
+      # the coordinator's filesystem.
+      # @param host[Beaker::Host] host to ssh into and find the private key
+      # @return [String] A String of the private key
+      def get_host_private_key(host)
+        private_key = host.puppet['hostprivkey']
+        # puppet may not have laid down the private_key yet, so check to make sure
+        # the file exists
+        host.execute("test -f #{private_key}")
+        host.execute("cat #{private_key}", :silent => true)
+      end
+
+      # Given a Beaker::Host object, introspect the host for the host cert and save it to
+      # the coordinator's filesystem.
+      # @param host[Beaker::Host] host to ssh into and find the host cert
+      # @return [String] A String of the host cert
+      def get_host_cert(host)
+        hostcert = host.puppet['hostcert']
+        # puppet may not have laid down the hostcert yet, so check to make sure
+        # the file exists
+        host.execute("test -f #{hostcert}")
+        host.execute("cat #{hostcert}", :silent => true)
+      end
+
+    end
+  end
+end

data/lib/beaker-http/http.rb

@@ -0,0 +1,93 @@
+module Beaker
+  module Http
+
+    # == Beaker::Http::Connection object instantiation examples
+    # These examples are for using the Connection object directly. If you are trying to use
+    # this from within a test, consider using the
+    # {Beaker::DSL::Helpers::WebHelpers DSL constructors} instead.
+    # @see Beaker::DSL::Helpers::WebHelpers
+    class Connection
+      include Beaker::Http::Helpers
+      extend Forwardable
+
+      attr_reader :connection
+
+      # Beaker::Http::Connection objects can be instantiated with object that
+      # utilizes a  object for easier setup during testing.
+      #
+      # @param [Hash] options Typically the global options provided by Beaker.
+      # @option options [Beaker::Logger] :logger
+      # @option options [Boolean] :log_http_bodies
+      def initialize(options)
+        @connection = create_default_connection(options)
+      end
+
+      def_delegators :connection, :get, :post, :put, :delete, :head, :patch, :url_prefix, :url_prefix=, :ssl
+
+      def create_default_connection(options)
+        Faraday.new do |conn|
+          conn.request :json
+
+          conn.response :follow_redirects
+          conn.response :raise_error
+          conn.response :json, :content_type => /\bjson$/
+
+          # We can supply a third argument, a Hash with key of :bodies set to true or false,
+          # to configure whether or not to log http bodies in requests and responses.
+          # However, to uncomplicate things, we will just use the default
+          # set in the middleware and not allow the http log level to be set
+          # independently of the beaker log level. If we find that we should allow setting
+          # of http bodies independent of the beaker log level, we should expose that setting
+          # here.
+          conn.response :faraday_beaker_logger, options[:logger]
+
+          conn.adapter :net_http
+        end
+      end
+
+      # If you would like to run tests that expect 400 or even 500 responses,
+      # apply this method to remove the <tt>:raise_error</tt> middleware.
+      def remove_error_checking
+        connection.builder.delete(Faraday::Response::RaiseError)
+        nil
+      end
+
+      def set_cacert(ca_file)
+        ssl['ca_file'] = ca_file
+        url_prefix.scheme = 'https'
+      end
+
+      def set_client_key(client_key)
+        ssl['client_key'] = client_key
+      end
+
+      def set_client_cert(client_cert)
+        ssl['client_cert'] = client_cert
+      end
+
+      # Use this method if you are connecting as a user to the system; it will
+      # provide the correct SSL context but not provide authentication.
+      def configure_cacert_with_puppet(host)
+        set_cacert(get_host_cacert(host))
+        connection.host = host.hostname
+        nil
+      end
+
+      # Use this method if you want to connect to the system using certificate
+      # based authentication. This method will provide the ssl context and use
+      # the private key and cert from the host provided for authentication.
+      def configure_private_key_and_cert_with_puppet(host)
+        configure_cacert_with_puppet(host)
+
+        client_key_raw = get_host_private_key(host)
+        client_cert_raw = get_host_cert(host)
+
+        ssl['client_key'] = OpenSSL::PKey.read(client_key_raw)
+        ssl['client_cert'] = OpenSSL::X509::Certificate.new(client_cert_raw)
+
+        nil
+      end
+
+    end
+  end
+end

data/lib/beaker-http/middleware/response/faraday_beaker_logger.rb

@@ -0,0 +1,60 @@
+module Beaker
+  module Http
+    class FaradayBeakerLogger < Faraday::Response::Middleware
+      extend Forwardable
+
+      DEFAULT_OPTIONS = { :bodies => true }
+
+      def initialize(app, logger, options = {} )
+        super(app)
+        @logger = logger
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def_delegators :@logger, :trace, :debug, :info, :notify, :warn
+
+      def call(env)
+        @start_time = Time.now
+        info "#{env.method.upcase}: #{env.url.to_s}"
+        debug "REQUEST HEADERS:\n#{dump_headers env.request_headers}"
+        debug "REQUEST BODY:\n#{dump_body env[:body]}" if env[:body] && log_body?(:request)
+        super
+      end
+
+      def on_complete(env)
+        info "RESPONSE CODE: #{env.status.to_s}"
+        debug "ELAPSED TIME: #{Time.now - @start_time}"
+        debug "RESPONSE HEADERS:\n#{dump_headers env.response_headers}"
+        debug "RESPONSE BODY:\n#{dump_body env[:body]}" if env[:body] && log_body?(:response)
+      end
+      private
+
+      def dump_headers(headers)
+        headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+      end
+
+      def pretty_inspect(body)
+        require 'pp' unless body.respond_to?(:pretty_inspect)
+        body.pretty_inspect
+      end
+
+      def dump_body(body)
+        if body.respond_to?(:to_str)
+          body.to_str
+        else
+          pretty_inspect(body)
+        end
+      end
+
+      def log_body?(type)
+        case @options[:bodies]
+        when Hash then @options[:bodies][type]
+        else @options[:bodies]
+      end
+    end
+
+    end
+  end
+end
+
+Faraday::Response.register_middleware :faraday_beaker_logger => lambda { Beaker::Http::FaradayBeakerLogger }

data/lib/beaker-http/version.rb

@@ -0,0 +1,7 @@
+module Beaker
+  module Http
+    module Version
+      STRING = '0.2.0'
+    end
+  end
+end

data/lib/scooter/httpdispatchers/orchestrator/v1/v1.rb

@@ -9,7 +9,7 @@ module Scooter
           @version = 'v1'
         end
 
-        #jobs endpoints
+        # jobs endpoints
         def get_last_jobs(limit=nil, offset=nil, order_by=nil, order=nil)
           path = "#{@version}/jobs"
           @connection.get(path) do |request|
@@ -20,6 +20,16 @@ module Scooter
           end
         end
 
+        # plan_jobs endpoints
+        def get_last_plan_jobs(limit=nil, offset=nil, results=nil)
+          path = "#{@version}/plan_jobs"
+          @connection.get(path) do |request|
+            request.params['limit'] = limit if limit
+            request.params['offset'] = offset if offset
+            request.params['results'] = results if results
+          end
+        end
+
         def get_job(job_id)
           @connection.get("#{@version}/jobs/#{job_id}")
         end
@@ -78,6 +88,12 @@ module Scooter
           end
         end
 
+        def post_schedule_plan(payload)
+          @connection.post("#{@version}/command/schedule_plan") do |req|
+            req.body = payload
+          end
+        end
+
         #inventory endpoints
         def get_inventory(node=nil)
           url = "#{@version}/inventory"

data/lib/scooter/httpdispatchers/orchestratordispatcher.rb

@@ -19,6 +19,11 @@ module Scooter
         get_last_jobs(n_jobs)
       end
 
+      # @return [Faraday::Response] response object from Faraday http client
+      def list_plan_jobs(n_jobs=nil)
+        get_last_plan_jobs(n_jobs)
+      end
+
       # @return [Faraday::Response] response object from Faraday http client
       def list_job_details(job_id)
         get_job(job_id)
@@ -84,9 +89,14 @@ module Scooter
         post_dumpling(dumpling)
       end
 
+      # Schedule a task or plan
       # @return [Faraday::Response] response object from Faraday http client
       def create_scheduled_job(payload)
-        post_schedule_task(payload)
+        if payload.include?('task')
+          post_schedule_task(payload)
+        else
+          post_schedule_plan(payload)
+        end
       end
 
       # @return [Faraday::Response] response object from Faraday http client

data/lib/scooter/version.rb

@@ -1,5 +1,5 @@
 module Scooter
   module Version
-    STRING = '4.3.2'
+    STRING = '4.5.0'
   end
 end

data/lib/scooter.rb

@@ -1,10 +1,14 @@
 require 'scooter/version'
 require 'beaker'
 require 'net/ldap'
-require 'beaker-http'
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday-cookie_jar'
+require 'forwardable'
+require 'beaker-http/helpers/puppet_helpers'
+require 'beaker-http/dsl/web_helpers'
+require "beaker-http/http"
+require 'beaker-http/middleware/response/faraday_beaker_logger'
 
 module Scooter
   %w( utilities httpdispatchers ldap ).each do |lib|

data/scooter.gemspec

@@ -18,24 +18,24 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   #Development dependencies
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'pry', '~> 0.9.12'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.0.0'
-  spec.add_development_dependency 'beaker-abs', '~>0.3.0'
+  spec.add_development_dependency 'beaker-abs'
+  spec.add_development_dependency 'webmock', '~> 3.13'
 
   #Documentation dependencies
   spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'markdown', '~> 0'
-  spec.add_development_dependency 'activesupport', '4.2.6'
+  spec.add_development_dependency 'activesupport', '4.2.8'
 
   #Run time dependencies
-  spec.add_runtime_dependency 'beaker', '>= 3.0', '< 5.0' # known support for beaker 3.x and 4.x
-  spec.add_runtime_dependency 'beaker-http', '~> 0.0'
-  spec.add_runtime_dependency 'json', '~> 1.8'
+  spec.add_runtime_dependency 'beaker'
+  spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'test-unit'
-  spec.add_runtime_dependency 'net-ldap', '~> 0.6', '>= 0.6.1', '<= 0.12.1'
-  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 'net-ldap', '~> 0.16'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.2'
+  spec.add_runtime_dependency 'faraday-cookie_jar', '>= 0.0.7'
 end

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

@@ -147,12 +147,8 @@ module Scooter
 
       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
+          stub_request(:get, /service_id=classifier/).
+            to_return(status: 200, body: {}.to_json, headers: {"Content-Type"=> "application/json"})
         end
         it 'gets classifier events' do
           expect { subject.get_classifier_events }.not_to raise_error
@@ -171,12 +167,8 @@ module Scooter
 
       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
+          stub_request(:get, /service_id=rbac/).
+            to_return(status: 200, body: {}.to_json, headers: {"Content-Type"=> "application/json"})
         end
         it 'gets rbac events' do
           expect { subject.get_rbac_events }.not_to raise_error
@@ -196,20 +188,17 @@ module Scooter
 
       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['commits'].dup.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
+          stub_request(:get, 'https://test.com:4433/activity-api/v1/events?service_id=rbac').
+            to_return(status: 200, body: rbac_events.to_json, headers: {"Content-Type"=> "application/json"})
+          stub_request(:get, 'https://test2.com:4433/activity-api/v1/events?service_id=rbac').
+            to_return(status: 200, body: rbac_events.dup["commits"].push('another_array_item').to_json, headers: {"Content-Type"=> "application/json"})
+
+          stub_request(:get, 'https://test.com:4433/activity-api/v1/events?service_id=classifier').
+            to_return(status: 200, body: classifier_events.to_json, headers: {"Content-Type"=> "application/json"})
+          stub_request(:get, 'https://test2.com:4433/activity-api/v1/events?service_id=classifier').
+            to_return(status: 200, body: classifier_events.dup["commits"].push('another_array_item').to_json, headers: {"Content-Type"=> "application/json"})
+
           expect(subject).to receive(:is_resolvable).exactly(4).times.and_return(true)
-          # 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