beaker-hostgenerator 0.7.1 → 0.7.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDBkODc5ZGJjYmRmNjUxOTcxZWYzZWE5MjVhMDliMjFhMGI4ZWNhNg==
+    ZTY1ZGYyYjk3YjA3YWU4ZWQwNTIzMTVhNWFhMmNhMzYwOWY3MWQ4MA==
   data.tar.gz: !binary |-
-    YmNhNDhlYmJiN2I0Njc1NDIxNjQ0NjBmMjIwZDhkNjg0YjEyNzIxYg==
+    MjI3OGEyOTFhYmIxNWE4NDMwM2ZiYzkxZmRmYTM0NTBjNjg1NTNjNg==
 SHA512:
   metadata.gz: !binary |-
-    NWJlODExZjQwYWMwMTlhNDIwZjc5ZmRkNjY2NDA2ZTJmZjVlNjg0M2UwOTUz
-    OWE3NTUxMjYyODk0YjIwZGY2YWE0MjAyYTE2NGYxZjhmODI4Njc5NjY0YTg5
-    MGY4MGJiMzcyOTRmODYxM2M4YWE0MzlkYjVhZTMyZWI1ZTkyYWQ=
+    NjA1YzU1NTcxZDg2YjFlOGIzMGYzZWU4MWU4MTkwODRjZTcwYjE0Yzc1ZWQy
+    NWIwNzAwN2ExNDFiODJhNWE5ZWMxNjhhYmNiOWRlNjdlNzY4OGE5YWM1NzE2
+    ZmIzNWMzYzVjODBjZGNjNTc4ZGY4ZjJlNmE2ZmZhODcxM2EyNWM=
   data.tar.gz: !binary |-
-    Y2MyM2JhZTYzYTdkYTFjYjI4MTc0NjRmZmU3ZTVkZGVhYThkOGVhMjA2ZTQz
-    MDdiYjQzODMwODQ1MTBlNDM4YTZkMDA2NDg1NmRlYzE2MDUxNTgzOTA5MzM4
-    MTQzMTVmYzYwZTJmMGU5ZTQ4N2M4YjRjZTRiMDZmNmYzZDMyODU=
+    NzQ2NjczY2FmN2Q3ZjNlMGZiNmRlN2FjNjE0ZjMwNDE4Yjk2NDM0Y2UxZmM3
+    MzQ1NjIzODI4YWM4NDJhMDZjOGYyZWIzYWNkY2EyMmE5MTNiNTJkYzc4ZDRh
+    YWQ0YzFmNWJiOWNiNjhlNWQ1OTdhZTI5MGI1NDI4NDZhZWYyNzE=

data/CHANGELOG.md

@@ -7,6 +7,9 @@ Versioning](http://semver.org).
 ## [Unreleased][unreleased]
 ### Changed
 
+## [0.7.2] - 2016-7-13
+- Automatically URL-decode input to support usage in HTTP URLs, such as Jenkins.
+
 ## [0.7.1] - 2016-6-29
 - Add platforms:
   - Fedora 24 x86_64 and i386

data/HISTORY.md

@@ -1,6 +1,7 @@
 # default - History
 ## Tags
-* [LATEST - 29 Jun, 2016 (530baa09)](#LATEST)
+* [LATEST - 13 Jul, 2016 (edc8971b)](#LATEST)
+* [0.7.1 - 29 Jun, 2016 (be332325)](#0.7.1)
 * [0.7.0 - 13 Jun, 2016 (f0aafe8d)](#0.7.0)
 * [0.6.0 - 11 May, 2016 (c807eb0d)](#0.6.0)
 * [0.5.0 - 31 Mar, 2016 (fa3ae0c8)](#0.5.0)
@@ -14,7 +15,43 @@
 * [0.0.1 - 7 Oct, 2015 (d99251e6)](#0.0.1)
 
 ## Details
-### <a name = "LATEST">LATEST - 29 Jun, 2016 (530baa09)
+### <a name = "LATEST">LATEST - 13 Jul, 2016 (edc8971b)
+
+* (GEM) update beaker-hostgenerator version to 0.7.2 (edc8971b)
+
+* (MAINT) Update CHANGELOG for 0.7.2 release (f1270d44)
+
+* Merge pull request #44 from nwolfe/maint/master/prepare-for-release (eb45282f)
+
+
+```
+Merge pull request #44 from nwolfe/maint/master/prepare-for-release
+
+(MAINT) Update CHANGELOG for 0.7.2 release
+```
+* Merge pull request #43 from nwolfe/qeng4034/support-url-encoding (e4e55d3a)
+
+
+```
+Merge pull request #43 from nwolfe/qeng4034/support-url-encoding
+
+(QENG-4034) Automatically URL-decode raw input
+```
+* (QENG-4034) Automatically URL-decode raw input (e6d1c1dc)
+
+
+```
+(QENG-4034) Automatically URL-decode raw input
+
+This commit adds a "pre-processing" step to the Parser that will always
+attempt to URL-decode the input before parsing it. This behavior is
+necessary to support specifying arbitrary settings in the input string
+when the input ends up as part of an HTTP URL, such as almost every
+usage we currently have in Jenkins.
+```
+### <a name = "0.7.1">0.7.1 - 29 Jun, 2016 (be332325)
+
+* (HISTORY) update beaker-hostgenerator history for gem release 0.7.1 (be332325)
 
 * (GEM) update beaker-hostgenerator version to 0.7.1 (530baa09)
 

data/README.md

@@ -219,6 +219,59 @@ CONFIG:
   custom_api: http://api.custom.net
 ```
 
+### URL-encoded input
+
+It may be necessary to URL-encode the input in order for it to properly be used
+in certain contexts, such as Jenkins.
+
+In most cases it will only be necessary to escape the characters that support
+arbitrary settings, which means the following three characters: {,}
+
+```
+$ beaker-hostgenerator centos6-64mcd-aix53-POWERfa%7Bhypervisor=aix%2Cvmhostname=pe-aix-53-acceptance.delivery.puppetlabs.net%7D
+```
+
+Is equivalent to
+
+```
+$ beaker-hostgenerator centos6-64mcd-aix53-POWERfa{hypervisor=aix,vmhostname=pe-aix-53-acceptance.delivery.puppetlabs.net}
+```
+
+And will generate
+
+```yaml
+---
+HOSTS:
+  centos6-64-1:
+    pe_dir:
+    pe_ver:
+    pe_upgrade_dir:
+    pe_upgrade_ver:
+    hypervisor: vmpooler
+    platform: el-6-x86_64
+    template: centos-6-x86_64
+    roles:
+    - agent
+    - master
+    - dashboard
+    - database
+  aix53-POWER-1:
+    pe_dir:
+    pe_ver:
+    pe_upgrade_dir:
+    pe_upgrade_ver:
+    platform: aix-5.3-power
+    hypervisor: aix
+    vmhostname: pe-aix-53-acceptance.delivery.puppetlabs.net
+    roles:
+    - agent
+    - frictionless
+CONFIG:
+  nfs_server: none
+  consoleport: 443
+  pooling_api: http://vmpooler.delivery.puppetlabs.net/
+```
+
 ## Testing
 
 Beaker Host Generator currently uses both rspec and minitest tests. To run both

data/lib/beaker-hostgenerator/generator.rb

@@ -22,6 +22,7 @@ module BeakerHostGenerator
     # @returns [String] A complete YAML map as a string defining the HOSTS and
     #                   CONFIG sections as required by Beaker.
     def generate(layout, options)
+      layout = prepare_layout(layout)
       tokens = tokenize_layout(layout)
       config = {}.deep_merge(BASE_CONFIG)
       nodeid = Hash.new(1)

data/lib/beaker-hostgenerator/parser.rb

@@ -1,5 +1,6 @@
 require 'beaker-hostgenerator/data'
 require 'beaker-hostgenerator/exceptions'
+require 'uri'
 
 module BeakerHostGenerator
   # Functions for parsing the raw user input host layout string and turning
@@ -10,8 +11,9 @@ module BeakerHostGenerator
   # further by other functions in this module.
   #
   # For example, given the raw user input string that defines the host layout,
-  # you would first split it into tokens via `tokenize_layout`, and then for
-  # each token you would call `is_ostype_token?` and/or `parse_node_info_token`.
+  # you would first prepare it for tokenization via `prepare_layout`, then split
+  # it into tokens via `tokenize_layout`, and then for each token you would
+  # call `is_ostype_token?` and/or `parse_node_info_token`.
   module Parser
 
     # Parses a single node definition into the following components:
@@ -65,6 +67,17 @@ module BeakerHostGenerator
 
     module_function
 
+    # Prepares the host input string for tokenization, such as URL-decoding.
+    #
+    # @param layout_spec [String] Raw user input; well-formatted string
+    #                             specification of the hosts to generate.
+    #                             For example `"aix53-POWERfa%7Bhypervisor=aix%7D"`.
+    # @returns [String] Input string with transformations necessary for
+    #                   tokenization.
+    def prepare_layout(layout_spec)
+      URI.decode(layout_spec)
+    end
+
     # Breaks apart the host input string into chunks suitable for processing
     # by the generator. Returns an array of substrings of the input spec string.
     #

data/lib/beaker-hostgenerator/version.rb

@@ -1,5 +1,5 @@
 module BeakerHostGenerator
   module Version
-    STRING = '0.7.1'
+    STRING = '0.7.2'
   end
 end

data/spec/beaker-hostgenerator/parser_spec.rb

@@ -4,6 +4,13 @@ module BeakerHostGenerator
   describe Parser do
     include BeakerHostGenerator::Parser
 
+    describe 'prepare_layout' do
+      it 'Supports URL-encoded input' do
+        expect( prepare_layout('centos6-64m%7Bfoo=bar-baz,this=that%7D-32a') ).
+          to eq('centos6-64m{foo=bar-baz,this=that}-32a')
+      end
+    end
+
     describe 'parse_node_info_token' do
 
       it 'Raises InvalidNodeSpecError for invalid tokens.' do

data/test/fixtures/per-host-settings/url-encoded.yaml

@@ -0,0 +1,44 @@
+---
+arguments_string: centos6-64mcd-aix53-POWERfa%7Bhypervisor=aix%2Cvmhostname=pe-aix-53-acceptance.delivery.puppetlabs.net%7D-POWERa%7Bfoo=bar%7D
+environment_variables: {}
+expected_hash:
+  HOSTS:
+    centos6-64-1:
+      pe_dir:
+      pe_ver:
+      pe_upgrade_dir:
+      pe_upgrade_ver:
+      hypervisor: vmpooler
+      platform: el-6-x86_64
+      template: centos-6-x86_64
+      roles:
+      - agent
+      - master
+      - dashboard
+      - database
+    aix53-POWER-1:
+      pe_dir:
+      pe_ver:
+      pe_upgrade_dir:
+      pe_upgrade_ver:
+      platform: aix-5.3-power
+      hypervisor: aix
+      vmhostname: pe-aix-53-acceptance.delivery.puppetlabs.net
+      roles:
+      - agent
+      - frictionless
+    aix53-POWER-2:
+      pe_dir:
+      pe_ver:
+      pe_upgrade_dir:
+      pe_upgrade_ver:
+      hypervisor: vmpooler
+      platform: aix-5.3-power
+      foo: bar
+      roles:
+      - agent
+  CONFIG:
+    nfs_server: none
+    consoleport: 443
+    pooling_api: http://vmpooler.delivery.puppetlabs.net/
+expected_exception:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaker-hostgenerator
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Branan Purvine-Riley
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -641,6 +641,7 @@ files:
 - test/fixtures/per-host-settings/arbitrary-settings.yaml
 - test/fixtures/per-host-settings/every-hypervisor.yaml
 - test/fixtures/per-host-settings/malformed-input.yaml
+- test/fixtures/per-host-settings/url-encoded.yaml
 - test/fixtures/per-host-settings/with-global-settings.yaml
 - test/test_cli.rb
 - test/test_generator.rb