beaker-hostgenerator 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTE2MGFlYTY5NGNkZjk1MDQ1NTI1NmQ2NGRjM2U0ZmM0NWNjMDVhMA==
+    MmQ0NmI3NGFiYjQ2YjQxYzI3YTBhZTZhNzY5YzdhZjM5NjU0MmZjZQ==
   data.tar.gz: !binary |-
-    YjkxOTdhNTg0NTg4NTllNDhlYjJlODE4ODk3ODBiNmFjYTI5NTgyOQ==
+    ZWExY2JjZTI3MTBlYzc5Nzk2NjdhYjZhZTg2YjE4ZTMwYmEzZGRjYw==
 SHA512:
   metadata.gz: !binary |-
-    OGFmY2YyYzI2ZWZiNWQyOTRhNTUyNTU4ZjQxMmNmZTBlOTBiMjQ3M2YwMjQw
-    ZTM5N2ZiODY2NTg0MDgyNDVkNzIzNDZiN2QwNDE2ZWRkODBjMjVmOTZmYTBh
-    ZDMxNWM3NjUwZmE5MTg5ODJiZGJiZmQzYjg4MzM1MDM5ZmVmMmU=
+    ZjY5N2NiNDc2OGM3NGVmNDhmM2Q4N2YzY2JlOWM4MWZlMDQxZjVmODU5MmRj
+    Y2EwNmFlMjM3NmFkMzk4NTI5MjRkMGFiYjAyZTVlYTk0OWU3N2ExNmVlNjYx
+    MTNjZjcyOWI4ZmY2ZDc4NzFhYjliOGFhOTc5YTU2MTgxZmM3YzQ=
   data.tar.gz: !binary |-
-    ZWFiOTBmM2UwYTllZTAwOWFlMGZiOTQzOTg2Y2ZkMjQxNzZhMDA3ODc0NTM1
-    Zjc2ZGVlZDg0MGYzNDI4NTJjYWU1MjYwNTY1OTE1ZDQwOGIxNzc1NTNhY2Vh
-    ZDQ4MjcxNGQ2NGYxMDI5Y2M5MjkwNjJmZTI2MDE4YWY5NjQwMTA=
+    ODNkYmRmY2RkNWIyNmRjZmE4ZDAwNjVhMTZhZmI0YzBkNDRmZTk4ZDE4NTE3
+    NWYxMmI4ODZlYzMxMWQ4ZWFhMjIzYmY0MmJkMmUxMDA4YTJiYTU0M2QxODc4
+    Mjc2YThkODhjMGRkYzEzZjQ1YTJiYTQwNmZiYjEwNDk5YTFkYmE=

data/CHANGELOG.md

@@ -7,6 +7,10 @@ Versioning](http://semver.org).
 ## [Unreleased][unreleased]
 ### Changed
 
+## [0.6.0] - 2016-05-11
+- Add new 'none' hypervisor implementation to support static, non-provisioned hosts.
+- Add support for arbitrary, per-host key=value settings.
+
 ## [0.5.0] - 2016-03-30
 - Add platforms:
  - Ubuntu 16.06 x86 and x86_64

data/HISTORY.md

@@ -1,6 +1,7 @@
 # default - History
 ## Tags
-* [LATEST - 31 Mar, 2016 (36291ea6)](#LATEST)
+* [LATEST - 11 May, 2016 (4a8ee90e)](#LATEST)
+* [0.5.0 - 31 Mar, 2016 (fa3ae0c8)](#0.5.0)
 * [0.4.0 - 10 Feb, 2016 (dc333b1c)](#0.4.0)
 * [0.3.3 - 3 Feb, 2016 (41051da9)](#0.3.3)
 * [0.3.2 - 28 Jan, 2016 (299df8ec)](#0.3.2)
@@ -11,7 +12,237 @@
 * [0.0.1 - 7 Oct, 2015 (d99251e6)](#0.0.1)
 
 ## Details
-### <a name = "LATEST">LATEST - 31 Mar, 2016 (36291ea6)
+### <a name = "LATEST">LATEST - 11 May, 2016 (4a8ee90e)
+
+* (GEM) update beaker-hostgenerator version to 0.6.0 (4a8ee90e)
+
+* Merge pull request #29 from nwolfe/maint/master/prepare-for-release (7e0decc0)
+
+
+```
+Merge pull request #29 from nwolfe/maint/master/prepare-for-release
+
+(maint) Prepare for 0.6.0 release
+```
+* (maint) Prepare for 0.6.0 release (c15c1bf6)
+
+* Merge pull request #28 from nwolfe/qeng3276/none-hypervisor-and-host-settings (d105e4bd)
+
+
+```
+Merge pull request #28 from nwolfe/qeng3276/none-hypervisor-and-host-settings
+
+(QENG-3276) Add None hypervisor and per-host settings support
+```
+* (QENG-3276) Minor refactorings; failing test fixture (b0926b22)
+
+
+```
+(QENG-3276) Minor refactorings; failing test fixture
+
+This commit includes the following minor refactorings based on feedback:
+* Inline if block surrounding arbitrary_settings['hostname']
+* Strip the `__` name prefix from `__generate_host_roles!` and make
+  private; adjust spec test accordingly
+* Change test fixture `expected_exception` support to not use the
+  dangerous `eval`, and added `per-host-settings/malformed-input.yaml`
+  test fixture to exercise the support
+```
+* (QENG-3276) Update CHANGELOG (0a170d42)
+
+
+```
+(QENG-3276) Update CHANGELOG
+
+This commit adds notes for the next release regarding the 'none'
+hypervisor and arbitrary key-value host settings support.
+```
+* (QENG-3276) Add more parser tests for failures (b80d94ab)
+
+
+```
+(QENG-3276) Add more parser tests for failures
+
+This commit adds tests that validate the proper exceptions are thrown
+when invalid arbitrary host settings are provided.
+
+This also expands host-setting support to include arbitrary whitespace
+to allow for more human-readable input.
+```
+* (MAINT) Wire up expected_excpetion test fitxure support (78cccb14)
+
+
+```
+(MAINT) Wire up expected_excpetion test fitxure support
+
+This commits finishes the work necessary to support expected exceptions
+defined in the test fixture YAML files.
+```
+* (QENG-3276) Move host role code into Roles module (78a2679e)
+
+
+```
+(QENG-3276) Move host role code into Roles module
+
+This commit moves the ROLES map and custom role config map out of the
+Data and Generator classes and into the Roles class.
+This also changes the implementation of custom role configuration from
+being a meta-programming method call into a standard map index.
+```
+* (QENG-3276) Extract code into new Parser module (9764fd7e)
+
+
+```
+(QENG-3276) Extract code into new Parser module
+
+This commit moves the NODE_REGEX constant and handful of methods tightly
+coupled to it into a new module called Parser. This module is
+responsible for dealing with the raw user input string and turning it
+into data structures that the Generator and hypervisors can operate on.
+```
+* (QENG-3276) Minor method refactoring (ce763dc0)
+
+
+```
+(QENG-3276) Minor method refactoring
+
+This commit renames a method, marks some methods as private, and
+extracts some logic into its own method.
+```
+* (QENG-3276) Update README (fd99cc9f)
+
+
+```
+(QENG-3276) Update README
+
+This commit updates the README to include an example of the new 'none'
+hypervisor and per-host settings.
+
+Also rename "Puppet Labs" references to just "Puppet".
+```
+* (QENG-3276) Update CLI help/usage text (7d85dff4)
+
+
+```
+(QENG-3276) Update CLI help/usage text
+
+This commit updates the CLI help text to mention the new arbitrary host
+settings support, and include the list of valid hypervisors when the
+`--list` option is given.
+```
+* (QENG-3276) Test fixtures for hypervisor and settings (34d4e649)
+
+
+```
+(QENG-3276) Test fixtures for hypervisor and settings
+
+This commit adds a couple hand-made test fixtures that exercise the new
+"none" hypervisor and arbitrary host settings support.
+```
+* Merge pull request #27 from nwolfe/maint/master/decouple-generator-and-hypervisors (52293374)
+
+
+```
+Merge pull request #27 from nwolfe/maint/master/decouple-generator-and-hypervisors
+
+(maint) Decouple hypervisors from generator
+```
+* (QENG-3276) Add None hypervisor and per-host settings support (ab38abef)
+
+
+```
+(QENG-3276) Add None hypervisor and per-host settings support
+
+This commit adds a new "none" hypervisor to support non-provisioned
+hosts. Non-provisioned hosts require a handful of other host settings to
+be specified in order for Beaker to use it properly, so this commit also
+adds support for arbitrary key-value host settings.
+
+For example:
+
+ $ .. centos6-64m{hypervisor=none,hostname=my-host,vmhostname=othername}
+ ---
+ HOSTS:
+   my-host:
+     pe_dir:
+     pe_ver:
+     pe_upgrade_dir:
+     pe_upgrade_ver:
+     platform: el-6-x86_64
+     hypervisor: none
+     vmhostname: othername
+     roles:
+     - agent
+     - master
+ CONFIG:
+   nfs_server: none
+   consoleport: 443
+```
+* (maint) Docstrings for new hypervisor architecture (9c35595f)
+
+
+```
+(maint) Docstrings for new hypervisor architecture
+
+This commit adds docstrings to modules and methods, specifically the
+BeakerHostGenerator::Hypervisor and BeakerHostGenerator::Data modules.
+```
+* (maint) Generate multi-platform test fixtures (996578cb)
+
+
+```
+(maint) Generate multi-platform test fixtures
+
+To help with test coverage, this adds a directory full of generated
+test fixtures with multi-platform hosts in a form similar to
+"centos6-64m-debian8-32-sles12-64a". Two of the three hosts have a
+random role assigned.
+```
+* (maint) New generated windows test fixtures (2591347e)
+
+
+```
+(maint) New generated windows test fixtures
+
+The rake task 'generate:fixtures' produced several new Windows fixtures.
+Perhaps we had previously updated the code to add support for more
+Windows platforms, but we forgot to re-generate the test fixtures?
+```
+* (maint) Decouple hypervisors from generator (aa39202e)
+
+
+```
+(maint) Decouple hypervisors from generator
+
+This commit is a large refactor that teases apart the generate code from
+the hypervisor code.
+
+Previously the VMPooler hypervisor class was a subclass of the Generator
+class, which was fine when there was only one hypervisor, but made it
+difficult to add support for per-host/multiple hypervisors.
+
+Now, there's a 1-to-many relationship between the Generator
+(BeakerHostGenerator::Generator) and the
+Hypervisors (BeakerHostGenerator::Hypervisor).
+
+The giant map of OSINFO data that was previously in the
+'data/vmpooler.rb' has been promoted and moved into data.rb as the
+`osinfo` module function. The parts specific to the VMPooler hypervisor
+have been nested under submaps keyed by the name of the hypervisor,
+`:vmpooler`.
+
+Adding support for a new hypervisor now requires implementing
+BeakerHostGenerator::Hypervisor::Interface, and adding any appropriate
+platform data as a submap to the OSINFO map in data.rb, keyed under a
+symbol named after the new hypervisor (e.g. `:my_hypervisor`).
+
+The module function `BeakerHostGenerator::Data.get_platform_info` can
+then be used when implementing the hypervisor to extract the relevant
+platform data under the key `:my_hypervisor`.
+```
+### <a name = "0.5.0">0.5.0 - 31 Mar, 2016 (fa3ae0c8)
+
+* (HISTORY) update beaker-hostgenerator history for gem release 0.5.0 (fa3ae0c8)
 
 * (GEM) update beaker-hostgenerator version to 0.5.0 (36291ea6)
 

data/README.md

@@ -3,18 +3,19 @@
 `beaker-hostgenerator` is a command line utility designed to generate beaker
 host config files using a compact command line SUT specification.
 
-It currently only supports puppetlabs' internal [vmpooler][vmpooler] templates,
-but is designed in a way that makes it possible to easily add support for
-additional hypervisor templates (any hypervisor type supported by
-[beaker][beaker]).
+It currently supports Puppets' internal [vmpooler][vmpooler] hypervisor and
+static (non-provisioned) nodes, and is designed in a way that makes it possible
+to easily add support for additional hypervisors (any hypervisor type supported
+by [beaker][beaker]).
 
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
 **Table of Contents**
 
 - [Beaker Host Generator](#beaker-host-generator)
     - [Usage](#usage)
-        - [Simple two-host SUT layout](#simple-two-host-sut-layout)
-        - [Single-host SUT layout with Arbitrary Roles](#single-host-sut-layout-with-arbitrary-roles)
+        - [Simple two-host layout](#simple-two-host-layout)
+        - [Single host with Arbitrary Roles](#single-host-with-arbitrary-roles)
+        - [Two hosts with multiple hypervisors and arbitrary host settings](#two-hosts-with-multiple-hypervisors-and-arbitrary-host-settings)
     - [Testing](#testing)
         - [Test Fixtures](#test-fixtures)
             - [Generated Fixtures](#generated-fixtures)
@@ -22,12 +23,12 @@ additional hypervisor templates (any hypervisor type supported by
     - [License](#license)
 
 <!-- markdown-toc end -->
- 
+
 ## Usage
 
 Below are some example usages of `beaker-hostgenerator`.
 
-### Simple two-host SUT layout
+### Simple two-host layout
 
 ```
 $ beaker-hostgenerator centos6-64mdca-32a
@@ -67,7 +68,7 @@ CONFIG:
   pooling_api: http://vmpooler.delivery.puppetlabs.net/
 ```
 
-### Single-host SUT layout with Arbitrary Roles
+### Single host with Arbitrary Roles
 
 ```
 $ beaker-hostgenerator centos6-32compile_master,another_role.ma
@@ -101,12 +102,50 @@ CONFIG:
   pooling_api: http://vmpooler.delivery.puppetlabs.net/
 ```
 
+### Two hosts with multiple hypervisors and arbitrary host settings
+
+```
+$ beaker-hostgenerator centos6-64m{hypervisor=none\,hostname=static-master}-redhat7-64a{somekey=some-value}
+```
+
+Will generate
+
+```yaml
+---
+HOSTS:
+  static-master:
+    pe_dir:
+    pe_ver:
+    pe_upgrade_dir:
+    pe_upgrade_ver:
+    platform: el-6-x86_64
+    hypervisor: none
+    roles:
+    - agent
+    - master
+  redhat7-64-1:
+    pe_dir:
+    pe_ver:
+    pe_upgrade_dir:
+    pe_upgrade_ver:
+    hypervisor: vmpooler
+    platform: el-7-x86_64
+    template: redhat-7-x86_64
+    somekey: some-value
+    roles:
+    - agent
+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
 at the same time, run:
 ```bash
-bundle exec rake tests
+bundle exec rake test
 ```
 
 ### Test Fixtures
@@ -179,7 +218,7 @@ There are a few circumstances when you should expect to run the
 
 ## Support
 
-Support offered by [Puppet Labs](https://puppetlabs.com) may not always be timely
+Support offered by [Puppet](https://puppet.com) may not always be timely
 since it is maintained by a tooling support team that is primarily focused on
 improving tools, infrastructure, and automation for our Enterprise products.
 

data/beaker-hostgenerator.gemspec

@@ -5,8 +5,8 @@ require 'beaker-hostgenerator/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-hostgenerator"
   s.version     = BeakerHostGenerator::Version::STRING
-  s.authors     = ["Branan Purvine-Riley", "Wayne Warren"]
-  s.email       = ["qe-team@puppetlabs.com"]
+  s.authors     = ["Branan Purvine-Riley", "Wayne Warren", "Nate Wolfe"]
+  s.email       = ["qe-team@puppet.com"]
   s.homepage    = "https://github.com/puppetlabs/beaker-hostgenerator"
   s.summary     = "Beaker Host Generator Utility"
   s.description = <<-eos

data/lib/beaker-hostgenerator.rb

@@ -3,6 +3,5 @@
 module BeakerHostGenerator
       require 'beaker-hostgenerator/cli'
       require 'beaker-hostgenerator/data'
-      require 'beaker-hostgenerator/util'
       require 'beaker-hostgenerator/generator'
 end

data/lib/beaker-hostgenerator/cli.rb

@@ -1,4 +1,6 @@
 require 'beaker-hostgenerator/generator'
+require 'beaker-hostgenerator/hypervisor'
+require 'beaker-hostgenerator/roles'
 require 'optparse'
 
 module BeakerHostGenerator
@@ -23,7 +25,7 @@ module BeakerHostGenerator
 Usage: beaker-hostgenerator [options] <layout>
 
  where <layout> takes the following form:
-  <platform>-<arch><roles>[[-<platform>]-<arch>[[<arbitrary-roles>,[...]].]<roles>[...]]
+  <platform>-<arch>[[<arbitrary-roles>,[...]].]<roles>[{<arbitrary-settings>,[...]}][-<arch>[[<arbitrary-roles>,[...]].]<roles>[{<arbitrary-settings>,[...]}]][-<layout>]
 
  examples:
   centos6-64mdca-32a
@@ -44,6 +46,11 @@ Usage: beaker-hostgenerator [options] <layout>
   centos6-32compile_master,another_role.ma
    1 CentOS 6 32 bit node with roles = master, agent, compile_master, another_role
 
+ example with arbitrary host settings:
+  centos6-64m{hypervisor=none\\,hostname=static1\\,my-key=my-value}-32a
+   1 CentOS 6 64 bit node with roles = master, hypervisor = none, node name = static1, and my-key = my-value
+   1 CentOS 6 32 bit node with roles = agent and the default hypervisor
+
  Generally, it is expected that beaker-hostgenerator output will be redirected to a file, for example:
   beaker-hostgenerator centos6-64ma > host.cfg
 
@@ -53,14 +60,14 @@ Usage: beaker-hostgenerator [options] <layout>
 
         opts.on('-l',
                 '--list',
-                'List beaker-hostgenerator supported platforms and roles. ' <<
+                'List beaker-hostgenerator supported platforms, roles, and hypervisors. ' <<
                 'Does not produce host config.') do
-          @options[:list_platforms_and_roles] = true
+          @options[:list_supported_values] = true
         end
 
         opts.on('-t',
                 '--hypervisor HYPERVISOR',
-                'Set beaker-hostgenerator hypervisor. ') do |h|
+                'Set beaker-hostgenerator default hypervisor. ') do |h|
           @options[:hypervisor] = h
         end
 
@@ -90,7 +97,7 @@ Usage: beaker-hostgenerator [options] <layout>
         end
 
         opts.on('--disable-default-role',
-                "Do not include the default /'agent/' role.") do
+                "Do not include the default 'agent' role.") do
           @options[:disable_default_role] = true
         end
 
@@ -116,12 +123,11 @@ Usage: beaker-hostgenerator [options] <layout>
 
       optparse.parse!(argv)
 
-      if @options[:list_platforms_and_roles]
-        print_platforms_and_roles
+      if @options[:list_supported_values]
+        print_supported_values
         raise BeakerHostGenerator::Exceptions::SafeEarlyExit
       else
-        # Tokenizing the config definition for great justice
-        @tokens = argv[0].split('-')
+        @layout = argv[0]
 
         if @options[:osinfo_version] === 0
           warning = <<-eow
@@ -137,14 +143,24 @@ eow
       end
     end
 
-    def print_platforms_and_roles
-      puts "valid beaker-hostgenerator platforms:  "
-      osinfo = BeakerHostGenerator::Utils.get_platforms(@options[:hypervisor],
-                                                        @options[:osinfo_version])
-      osinfo.each do |k,v|
+    def execute
+      BeakerHostGenerator::Generator.new.generate(@layout, @options)
+    end
+
+    def execute!
+      puts execute
+    end
+
+    private
+
+    # Prints to stdout a human-readable listing of all supported values for
+    # the following: platforms, architectures, roles, and hypervisors.
+    def print_supported_values
+      puts "valid beaker-hostgenerator platforms:"
+      platforms = get_platforms(@options[:osinfo_version])
+      platforms.each do |k|
         puts "   #{k}"
       end
-
       puts "\n"
 
       puts "valid beaker-hostgenerator architectures:"
@@ -153,20 +169,16 @@ eow
       puts "   6432 => 64-bit OS with 32-bit Puppet (Windows Only)"
       puts "\n"
 
-      roles = BeakerHostGenerator::Utils.get_roles
-      puts "valid beaker-hostgenerator host roles:  "
-      roles.each do |k,v|
+      puts "valid beaker-hostgenerator host roles:"
+      BeakerHostGenerator::Roles::ROLES.each do |k,v|
         puts "   #{k} => #{v}"
       end
-    end
-
-    def execute
-      generator = BeakerHostGenerator::Generator.create @options
-      generator.generate @tokens
-    end
+      puts "\n"
 
-    def execute!
-      puts execute
+      puts "valid beaker-hostgenerator hypervisors:"
+      BeakerHostGenerator::Hypervisor.supported_hypervisors().keys.each do |k|
+        puts "   #{k}"
+      end
     end
   end
 end