scooter 3.2.19 → 4.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGQzZTkxYjgwMmE5MGU1MTAyOTg0MzEzZmIxMTY2Y2FlYTRlMjEyMQ==
+    Mzc0MmM3NmFhNTBhYTQ1MmQ3ODc0ODJlYjNkMjJlNWZiZDFjM2Q3Ng==
   data.tar.gz: !binary |-
-    YmZhZTU3YWNkNjE3YTljZDE2MGE1MTIzZDczMWE0ZDA1ZWE3YzliMQ==
+    NDUwNzBkMDAyOWVjNWI5M2NkYWNiZWJjYWQzY2FjMzg0M2UwNzUyZg==
 SHA512:
   metadata.gz: !binary |-
-    NTIwMWM4YTkwYjEzN2ZlOTJmNzk1MmI2MTMxNzIyMGMxMzIwY2JmYTEwNDk1
-    YjAzZmMyOTJjNDYyMzRhOTRlOWI2Mjk5ODc4NDVkNGQ2N2IxMzkyMjgyZDNm
-    N2NiNjA3NjhlZmViYjg5ZjVjYzk0ZDAxMDk5NmQxYTg4OTJlNjc=
+    MzU3YmQyNGYzYmUwMDEyODExZjU5YTg3ZTA0M2U0ZWNmNjU3ZTA4YzM4ZTU4
+    YjY5ZDAzMmM1NDUzYTI0NjIzNjE2NjQyM2QyYzI5NmM5OGQ0MWZkMGY0Nzkx
+    OWExY2Q1ZmU5YWUxMDlkMWIzZjNlNGJmMjAzNjAzY2M5NjE3YmE=
   data.tar.gz: !binary |-
-    MWNmNTQ4MDQ0YjYwZjUwNmJjNDhiM2QxNGZkODkwNTIyMjQ0NjdjMTM1ZTk2
-    MTcwNjg3ZTMwN2E0NjkwMzI3YzEzNWIwYTY4YTZjNzI3MzFmMTZjODU2YzA4
-    MzI0OGFmMWRiNGYxZjkxZWU2ZDVkMjZhZDRmNGQ2Y2FkNzk3M2Y=
+    YzRmMWViMWRkMzZmZTZiMDM3NDVjZDczYzg0ZDk0ZjZiYmQzMTVlMWJlNzMx
+    ZmEyMWE5MjNhODdiOGNjZTEwMmE1MmU4M2NiOWZjNTJiZWViNmUwYTJkZWMw
+    NzEwZTUwYWJlMzMxZTdhZjc3YjVmOTZhMmRlZDQ2YWRkOWJlNjQ=

data/HISTORY.md

@@ -1,6 +1,14 @@
-# default - History
+# worker - History
 ## Tags
-* [LATEST - 26 Oct, 2016 (9ecf11fe)](#LATEST)
+* [LATEST - 27 Mar, 2017 (57402d24)](#LATEST)
+* [4.0.6 - 9 Feb, 2017 (0f01ca39)](#4.0.6)
+* [4.0.5 - 8 Feb, 2017 (3405835b)](#4.0.5)
+* [4.0.4 - 8 Feb, 2017 (3f6b7263)](#4.0.4)
+* [4.0.3 - 6 Feb, 2017 (6698535d)](#4.0.3)
+* [4.0.2 - 19 Jan, 2017 (74790ad4)](#4.0.2)
+* [4.0.1 - 22 Dec, 2016 (58aef2e2)](#4.0.1)
+* [4.0.0 - 30 Nov, 2016 (e47d6d40)](#4.0.0)
+* [3.2.19 - 26 Oct, 2016 (0edc4754)](#3.2.19)
 * [3.2.18 - 17 Oct, 2016 (7f704a74)](#3.2.18)
 * [3.2.17 - 29 Sep, 2016 (532a4f4a)](#3.2.17)
 * [3.2.16 - 26 Sep, 2016 (febe204c)](#3.2.16)
@@ -44,7 +52,219 @@
 * [0.0.0 - 22 Dec, 2014 (9307ec38)](#0.0.0)
 
 ## Details
-### <a name = "LATEST">LATEST - 26 Oct, 2016 (9ecf11fe)
+### <a name = "LATEST">LATEST - 27 Mar, 2017 (57402d24)
+
+* (GEM) update scooter version to 4.1.0 (57402d24)
+
+* Merge pull request #102 from tvpartytonight/maint_fixup_readme (462fd57d)
+
+
+```
+Merge pull request #102 from tvpartytonight/maint_fixup_readme
+
+(maint) Fixup README for open source release
+```
+* (maint) Fixup README for open source release (408367f6)
+
+* Merge pull request #101 from tvpartytonight/maint_add_license (3fe662aa)
+
+
+```
+Merge pull request #101 from tvpartytonight/maint_add_license
+
+(maint) Add license file
+```
+* (maint) Add license file (62a12f3d)
+
+### <a name = "4.0.6">4.0.6 - 9 Feb, 2017 (0f01ca39)
+
+* (HISTORY) update scooter history for gem release 4.0.6 (0f01ca39)
+
+* (GEM) update scooter version to 4.0.6 (8d80e1de)
+
+* Merge pull request #100 from samwoods1/maint_ha_fix (9103716a)
+
+
+```
+Merge pull request #100 from samwoods1/maint_ha_fix
+
+(maint) Update HA validationvto take host instead of hostname
+```
+* (maint) Update HA validationvto take host instead of hostname (e46e66db)
+
+### <a name = "4.0.5">4.0.5 - 8 Feb, 2017 (3405835b)
+
+* (HISTORY) update scooter history for gem release 4.0.5 (3405835b)
+
+* (GEM) update scooter version to 4.0.5 (a926ff06)
+
+* Merge pull request #99 from samwoods1/maint_ha_fix (82f03c66)
+
+
+```
+Merge pull request #99 from samwoods1/maint_ha_fix
+
+(maint) Expect host instead of hostname: replica_db_synced_with_master_db
+```
+* (maint) Expect host instead of hostname for replica_db_synced_with_master_db (c96a4641)
+
+### <a name = "4.0.4">4.0.4 - 8 Feb, 2017 (3f6b7263)
+
+* (HISTORY) update scooter history for gem release 4.0.4 (3f6b7263)
+
+* (GEM) update scooter version to 4.0.4 (61ac5ebb)
+
+* Merge pull request #98 from samwoods1/maint_ha_fix (da1eee42)
+
+
+```
+Merge pull request #98 from samwoods1/maint_ha_fix
+
+(maint) Fix host_name var in replica_db_synced_with_master_db
+```
+* (maint) Fix host_name var in replica_db_synced_with_master_db (01e35d95)
+
+
+```
+(maint) Fix host_name var in replica_db_synced_with_master_db
+Also add spec test for replica_db_synced_with_master_db
+```
+### <a name = "4.0.3">4.0.3 - 6 Feb, 2017 (6698535d)
+
+* (HISTORY) update scooter history for gem release 4.0.3 (6698535d)
+
+* (GEM) update scooter version to 4.0.3 (2c10f65c)
+
+* Merge pull request #97 from zreichert/feature/master/add_more_query_params_to_jobs_endpoint (7f80e23a)
+
+
+```
+Merge pull request #97 from zreichert/feature/master/add_more_query_params_to_jobs_endpoint
+
+add query params to get_last_jobs
+```
+* (ORCH-1605) add query params to get_last_jobs (545be55a)
+
+### <a name = "4.0.2">4.0.2 - 19 Jan, 2017 (74790ad4)
+
+* (HISTORY) update scooter history for gem release 4.0.2 (74790ad4)
+
+* (GEM) update scooter version to 4.0.2 (b7a9554a)
+
+* Merge pull request #96 from zreichert/maint/master/fix_jobs_limit_request (c363d075)
+
+
+```
+Merge pull request #96 from zreichert/maint/master/fix_jobs_limit_request
+
+(MAINT) switch job limit to query param
+```
+* (MAINT) switch job limit to query param (840b75c5)
+
+### <a name = "4.0.1">4.0.1 - 22 Dec, 2016 (58aef2e2)
+
+* (HISTORY) update scooter history for gem release 4.0.1 (58aef2e2)
+
+* (GEM) update scooter version to 4.0.1 (c16ca347)
+
+* Merge pull request #95 from lucywyman/maint-fix-jobs-endpoint (98a5021e)
+
+
+```
+Merge pull request #95 from lucywyman/maint-fix-jobs-endpoint
+
+(maint) Fix undefined variable in jobs endpoint
+```
+* (maint) Fix undefined variable in jobs endpoint (7be068bc)
+
+* Merge pull request #94 from nicklewis/properly-limit-job-queries (268288df)
+
+
+```
+Merge pull request #94 from nicklewis/properly-limit-job-queries
+
+(maint) Properly limit jobs queries
+```
+* (maint) Properly limit jobs queries (00b1c8b4)
+
+
+```
+(maint) Properly limit jobs queries
+
+The limit parameter to /jobs is expected to be sent as a query parameter
+rather than as part of the body of the request.
+```
+* Merge pull request #93 from tvpartytonight/add_beaker-http (0e0ce731)
+
+
+```
+Merge pull request #93 from tvpartytonight/add_beaker-http
+
+(BKR-775) Replace httpdispatcher with beaker-http
+```
+* (BKR-775) Ensure httpdispatchers call set_url_prefix (03ec44d8)
+
+
+```
+(BKR-775) Ensure httpdispatchers call set_url_prefix
+
+This commit makes sure that the httpdispatcher initialize method calls
+set_url_prefix; without this behavior, subclasses couldn't rely on this
+method being called in super like the consoledispatcher class currently
+does.
+```
+* (maint) Remove nokogiri dependency (96aba484)
+
+
+```
+(maint) Remove nokogiri dependency
+
+The change to the signin method in merge 93357eb means that we can
+remove nokogiri, as that was the only section of scooter that utilized
+it to parse html.
+```
+* (BKR-775) Replace httpdispatcher with beaker-http (167e2c9f)
+
+
+```
+(BKR-775) Replace httpdispatcher with beaker-http
+
+This commit removes the base class HttpDispatcher implementation and
+replaces it with HttpDispatcher inheriting from beaker-http. This moves
+much of the useful functionality in that HttpDispatcher to a more
+generalized library.
+```
+### <a name = "4.0.0">4.0.0 - 30 Nov, 2016 (e47d6d40)
+
+* (HISTORY) update scooter history for gem release 4.0.0 (e47d6d40)
+
+* (GEM) update scooter version to 4.0.0 (a82821a0)
+
+* Merge pull request #92 from lucywyman/maint-refactor-auth (93357ebc)
+
+
+```
+Merge pull request #92 from lucywyman/maint-refactor-auth
+
+(maint) Fix how scooter authenticates with pe console
+```
+* Fix up for merge (86b55d1c)
+
+* Merge pull request #91 from lucywyman/ORCH-1556-add-environments-endpoint (c1ef8994)
+
+
+```
+Merge pull request #91 from lucywyman/ORCH-1556-add-environments-endpoint
+
+(ORCH-1556) Add /environments endpoint to scooter
+```
+* (maint) Fix how scooter authenticates with pe console (0884bbb1)
+
+* (ORCH-1556) add /environments endpoint (a92abcb5)
+
+### <a name = "3.2.19">3.2.19 - 26 Oct, 2016 (0edc4754)
+
+* (HISTORY) update scooter history for gem release 3.2.19 (0edc4754)
 
 * (GEM) update scooter version to 3.2.19 (9ecf11fe)
 

data/LICENSE

@@ -0,0 +1,17 @@
+Scooter - HTTP library for beaker
+
+Copyright (C) 2005-2017 Puppet, Inc.
+
+Puppet, Inc. can be contacted at: info@puppet.com
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -5,76 +5,38 @@
 1. [Overview](#overview)
 2. [Usage](#usage)
 3. [Versioning](#versioning)
-4. [Releasing](#releasing)
-  * [Pushing a new version to the internal rubygems mirror](#pushing-a-new-version-to-the-internal-rubygems-mirror)
-5. [Rdocs](#rdocs)
-6. [Contributing](#contributing)
+4. [Rdocs](#rdocs)
+5. [Contributing](#contributing)
 
 ## Overview
 
-Scooter is a ruby gem developed by QA to facilitate http traffic between the
-test runner and a Puppet Enterprise Installation–specifically the services
-available in the pe-console-services process: Classifier, RBAC, and Activity
-Service.
+Scooter is a ruby gem developed by Puppet to facilitate http traffic between the
+test runner and a Puppet Enterprise Installation. This includes the classifier, rbac,
+activity service, code manager, orchestrator, and puppetdb.
 
 ## Usage
 
-Scooter only supports versions of Puppet Enterprise 3.7 and higher. Scooter is only available on the internal server, rubygems.delivery.puppetlabs.net.
-
-To install Scooter, simply use the gem command with the source flag set to the internal rubygems mirror–remember that you will have to be on Puppet's DNS to see the mirrored gem server.
+To install Scooter, simply use the gem command:
 
 ```
-$ gem install scooter --source http://rubygems.delivery.puppetlabs.net
+$ gem install scooter
 ```
 
 Scooter is currently divvied into the following sections:
 
- - [HttpDispatchers](docs/http_dispatchers.md) – These are modules that can be mixed into classes that represent real users: whitelisted certificate users, local console users, or users connected through an LDAP directory. Currently, there is only one dispatcher currently defined--ConsoleDispatcher–but there could be new dispatchers created to facilitate traffic to other products, such as Puppet Server and PuppetDB.
+ - [HttpDispatchers](docs/http_dispatchers.md) – These are modules that can be mixed into classes that represent real users: whitelisted certificate users, local console users, or users connected through an LDAP directory. Check out [HttpDispatchers](lib/scooter/httpdispatchers) for a list of the modules currently supported. 
 
  - LDAPdispatcher – This class extends the Net::LDAP library, which is a requirement to for RBAC testing with LDAP fixtures.
  - Utilities – Currently, this houses random string generators and convenience methods to use beaker to acquire certificates to impersonate whitelisted certificate users.
 
 ## Versioning
 
-Scooter supports semantic versioning, with any 1.x release of scooter supporting all PE versions between 3.7.x and 4.0.
-
-If you are looking for scooter support for PE 4.0 aka shallow gravy, please use any scooter version that is 2.x. Routes to the services changed between PE 3.7 and PE 4.0, requiring a major version bump of scooter between those versions.
-
-## Releasing
-
-The plan is to release Scooter at a regular cadence, probably once a week. Early on, we will release more often, as the port from qatests is not totally complete. Early feedback may significantly change the structure, so be cautious about building any significant dependencies yet. Once the dust has settled, a 1.0 release will be cut and support normal semantic versioning.
-
-Discussion is still ongoing about whether this library will be publicly available on rubygems or not. Please feel free to email the the QA team for any further information regarding a public release.
-
- - One issue blocking a public release of Scooter is to avoid possibly leaking information about unreleased features/products that Scooter might have information on. This could be mitigated by careful version control of Scooter, releasing it to the public only periodically, but releasing internally at a more frequent basis for internal testing.
-
- - Should the gem accept PR's from the public? That seems to require significant overhead in terms of testing and stability of PR's. Perhaps make the gem public without accepting PR's from the public? Make the gem available on rubygems.org while the repo stays private?
-
-### Pushing a new version to the internal rubygems mirror
-
- 1. Log into jenkins-qe
-
- 2. Trigger the Scooter Release Pipeline
-
-   a. The pipeline is responsible for checking in the version bump, generating a new HISTORY.md file, creating and pushing the gem
-
-   b. Select an appropriate version number *** WARNING - whatever version number you select will be auto-created and pushed liver, BE CAREFUL ***
+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
 
-Much of the documentation of Scooter is embedded in the ruby code itself, using rdoc standards for documentation. Currently, Puppet does not have an internal server delivering yard documentation; if you wish to view the rdocs, you must build it out yourself after you have downloaded the gem.
-
-```
-prompt:~$ yard server --gems
-
-#>> YARD 0.8.7.4 documentation server at http://0.0.0.0:8808
-#Thin web server (v1.6.2 codename Doc Brown)
-#Maximum connections set to 1024
-#Listening on 0.0.0.0:8808, CTRL+C to stop
-#
-#goto: http://0.0.0.0:8808/docs/scooter/frames
-```
+Please view the [RubyDocs](http://rubydoc.info/github/puppetlabs/scooter) for further documentation. 
 
 ## Contributing
 
-You are encouraged to fork and submit PR's to Scooter. Sam Woods or Tony Vu are your best bet for getting a PR merged in; that list will grow as QA adds more regular contributors to the repo.
+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.

data/lib/scooter.rb

@@ -1,6 +1,7 @@
 require 'scooter/version'
 require 'beaker'
 require 'net/ldap'
+require 'beaker-http'
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday-cookie_jar'
@@ -10,4 +11,4 @@ module Scooter
   %w( utilities httpdispatchers ldap ).each do |lib|
     require "scooter/#{lib}"
   end
-end
+end

data/lib/scooter/httpdispatchers/activity.rb

@@ -14,17 +14,19 @@ module Scooter
       end
 
       # Used to compare replica activity to master. Raises exception if it does not match.
-      # @param [BeakerHost] host_name
-      def activity_database_matches_self?(host_name)
-        original_host_name = self.host
+      # @param [String] host_name
+      def activity_database_matches_self?(replica_host)
+        # Save a beaker host_hash[:vmhostname], set it to the supplied host_name param,
+        # and then set it back to the original at the end of the ensure. The :vmhostname
+        #overrides the host.hostname, and nothing should win out over it.
+        original_host_name = host.host_hash[:vmhostname]
         begin
-          self.host = host_name.to_s
-          initialize_connection
+          host.host_hash[:vmhostname] = replica_host.hostname
+
           other_rbac_events       = get_rbac_events.env.body
           other_classifier_events = get_classifier_events.env.body
         ensure
-          self.host = original_host_name
-          initialize_connection
+          host.host_hash[:vmhostname] = original_host_name
         end
 
         self_rbac_events       = get_rbac_events.env.body
@@ -37,7 +39,7 @@ module Scooter
         errors << "Rbac events do not match\r\n" unless rbac_events_match
         errors << "Classifier events do not match\r\n" unless classifier_events_match
 
-        @faraday_logger.warn(errors.chomp) unless errors.empty?
+        host.logger.warn(errors.chomp) unless errors.empty?
         errors.empty?
       end
 

data/lib/scooter/httpdispatchers/classifier.rb

@@ -300,19 +300,18 @@ module Scooter
       end
 
       # Used to compare replica classifier to master. Raises exception if it does not match.
-      # @param [BeakerHost] host_name
-      def classifier_database_matches_self?(host_name)
-        original_host_name = self.host
+      # @param [String] host_name
+      def classifier_database_matches_self?(replica_host)
+        original_host_name = host.host_hash[:vmhostname]
         begin
-          self.host = host_name.to_s
-          initialize_connection
+          host.host_hash[:vmhostname] = replica_host.hostname
+
           other_nodes        = get_list_of_nodes
           other_classes      = get_list_of_classes
           other_environments = get_list_of_environments
           other_groups       = get_list_of_node_groups
         ensure
-          self.host = original_host_name
-          initialize_connection
+          host.host_hash[:vmhostname] = original_host_name
         end
 
         self_nodes        = get_list_of_nodes
@@ -331,7 +330,7 @@ module Scooter
         errors << "Environments do not match\r\n" unless environments_match
         errors << "Groups do not match\r\n" unless groups_match
 
-        @faraday_logger.warn(errors.chomp) unless errors.empty?
+        host.logger.warn(errors.chomp) unless errors.empty?
         errors.empty?
       end