beaker-hostgenerator 0.6.0 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmQ0NmI3NGFiYjQ2YjQxYzI3YTBhZTZhNzY5YzdhZjM5NjU0MmZjZQ==
+    MmVhOGFjMDhhMGU0ZjczZTc4ODVjOGQ0ZGQ5NDYxMDhjNWYxMmQ0OQ==
   data.tar.gz: !binary |-
-    ZWExY2JjZTI3MTBlYzc5Nzk2NjdhYjZhZTg2YjE4ZTMwYmEzZGRjYw==
+    ZmExZGFmZmY0MWRkYmJiZjFiY2ZlMWI2ZGVjMTI1ODE4M2MxYTBkYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZjY5N2NiNDc2OGM3NGVmNDhmM2Q4N2YzY2JlOWM4MWZlMDQxZjVmODU5MmRj
-    Y2EwNmFlMjM3NmFkMzk4NTI5MjRkMGFiYjAyZTVlYTk0OWU3N2ExNmVlNjYx
-    MTNjZjcyOWI4ZmY2ZDc4NzFhYjliOGFhOTc5YTU2MTgxZmM3YzQ=
+    NDA0NDM4MmM5MDE2ODk2YmI4NTA1NmUyMjk5MTMyODdhMWQ0Mzc5NGZkMWMw
+    ZGI4ZjI5NTkxYmI1Nzg0YzRiYzUzYTI2Njc0NmI0NTE1YzMzMDBiZTAyMDAy
+    MTI3MmU0ZWM2MmM4NTQxYmI3NmU1YTk5YTQwOTI3OTI4ZGUxZGY=
   data.tar.gz: !binary |-
-    ODNkYmRmY2RkNWIyNmRjZmE4ZDAwNjVhMTZhZmI0YzBkNDRmZTk4ZDE4NTE3
-    NWYxMmI4ODZlYzMxMWQ4ZWFhMjIzYmY0MmJkMmUxMDA4YTJiYTU0M2QxODc4
-    Mjc2YThkODhjMGRkYzEzZjQ1YTJiYTQwNmZiYjEwNDk5YTFkYmE=
+    ODA0NTBkYmIyN2FjNmZiYWUyYmVkMzNlYmZlYTFhYzU0ZGYzOTZlZWQxNjY0
+    ODkyMGIxYTczMzkzYThmYmEzODJlMjkyYTBhYzhjMmQyMzMwYjIxOTNjZDU4
+    ZmEyZTU3MmZiMzdkN2Y1N2M3YzRhY2NhZjY4YWQyMzJmZTY0NjU=

data/CHANGELOG.md

@@ -7,6 +7,21 @@ Versioning](http://semver.org).
 ## [Unreleased][unreleased]
 ### Changed
 
+## [0.7.0] - 2016-6-13
+- Add optional '--global-config' CLI argument to support arbitrary values in the
+  general CONFIG section of host files.
+- Add '--version' CLI flag to print out the library version to stdout.
+- Remove requirement that only valid (read: built-in) hypervisors are generated
+  by allowing any arbitrary string to be specified as the hypervisor. If the
+  hypervisor specified is not a built-in one there will be no additional
+  hypervisor-specific configuration generated.
+- Add platforms:
+  - aix-5.3-power
+  - aix-6.1-power
+  - aix-7.1-power
+  - solaris-10-sparc
+  - solaris-11-sparc
+
 ## [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.

data/HISTORY.md

@@ -1,6 +1,7 @@
 # default - History
 ## Tags
-* [LATEST - 11 May, 2016 (4a8ee90e)](#LATEST)
+* [LATEST - 13 Jun, 2016 (4792554b)](#LATEST)
+* [0.6.0 - 11 May, 2016 (c807eb0d)](#0.6.0)
 * [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)
@@ -12,7 +13,214 @@
 * [0.0.1 - 7 Oct, 2015 (d99251e6)](#0.0.1)
 
 ## Details
-### <a name = "LATEST">LATEST - 11 May, 2016 (4a8ee90e)
+### <a name = "LATEST">LATEST - 13 Jun, 2016 (4792554b)
+
+* (GEM) update beaker-hostgenerator version to 0.7.0 (4792554b)
+
+* Merge pull request #36 from nwolfe/qeng3987/release-0.7.0 (11256701)
+
+
+```
+Merge pull request #36 from nwolfe/qeng3987/release-0.7.0
+
+(QENG-3987) Update CHANGELOG for 0.7.0 release
+```
+* (QENG-3987) Update CHANGELOG for 0.7.0 release (2f9fa77c)
+
+* Merge pull request #33 from nwolfe/qeng3811-add-aix-and-sparc-platforms (9e73e059)
+
+
+```
+Merge pull request #33 from nwolfe/qeng3811-add-aix-and-sparc-platforms
+
+(QENG-3811) Add AIX and Solaris SPARC platforms
+```
+* Merge pull request #35 from nwolfe/maint/alphabetize-test-fixtures (26ae944e)
+
+
+```
+Merge pull request #35 from nwolfe/maint/alphabetize-test-fixtures
+
+(MAINT) Sort platforms alphabetically
+```
+* Merge pull request #34 from nwolfe/qeng3946-support-arbitrary-hypervisors (4d018b46)
+
+
+```
+Merge pull request #34 from nwolfe/qeng3946-support-arbitrary-hypervisors
+
+(QENG-3946) Support arbitrary hypervisors
+```
+* (QENG-3946) Support arbitrary hypervisors (cf62fc5e)
+
+
+```
+(QENG-3946) Support arbitrary hypervisors
+
+This commit allows unknown hypervisors to be specified by the user.
+Previously, if the hypervisor specified by the user was not one of the
+valid, built-in implementations then an error was thrown notifying the
+user that an invalid hypervisor was requested.
+Now, this is no longer an error, and instead the host generation will
+continue as normal but there will be no hypervisor-specific
+configuration. The name of the unknown hypervisor will be the value of
+the hypervisor configuration of the hosts.
+
+To implement this, we can repurpose the special `Hypervisor::None`
+implementation to instead represent an unknown (but equally valid)
+hypervisor. The unknown name will now be the value of `hypervisor` in
+the generated config, where it used to be `hypervisor: none`.
+
+For example:
+  $ .. centos6-64{hypervisor=custom}
+  ---
+  HOSTS:
+    centos6-64-1:
+      pe_dir:
+      pe_ver:
+      pe_upgrade_dir:
+      pe_upgrade_ver:
+      platform: el-6-x86_64
+      hypervisor: custom
+      roles:
+      - agent
+  CONFIG:
+    nfs_server: none
+    consoleport: 443
+```
+* (QENG-3811) Regenerate fixtures with new platforms (dbd40c80)
+
+
+```
+(QENG-3811) Regenerate fixtures with new platforms
+
+Our fixture generation isn't quite deterministic, and adding a new
+platform somehow causes unrelated platform fixtures to be changed.
+
+This commit deletes the entire `test/fixtures/generated` directory and
+regenerates them anew, with new fixtures for the new AIX and Solaris
+SPARC platforms.
+```
+* (QENG-3811) Add AIX and Solaris SPARC platforms (8c5eb30d)
+
+* (MAINT) Regenerate test fixtures and isolate them (d17d2341)
+
+
+```
+(MAINT) Regenerate test fixtures and isolate them
+
+Since we sorted the platforms alphabetically, the fixture generation
+results in different filenames. Basically every time we modify
+Data#platforms() we should regenerate the fixtures so we have all
+platforms covered.
+
+This moves the generated fixtures into a new directory called
+`test/fixtures/generated/` so it's easier to work with them and not have
+the manually created fixtures get in the way.
+```
+* (MAINT) Sort platforms alphabetically (2376853e)
+
+
+```
+(MAINT) Sort platforms alphabetically
+
+Just so it's easier to navigate the large structure in the code.
+```
+* Merge pull request #32 from nwolfe/qeng3808-alphanumeric-architectures (92eb8545)
+
+
+```
+Merge pull request #32 from nwolfe/qeng3808-alphanumeric-architectures
+
+(QENG-3808) Support uppercase alphanumeric architectures
+```
+* Merge pull request #31 from nwolfe/qeng3377-fix-version-flag (7bedf39f)
+
+
+```
+Merge pull request #31 from nwolfe/qeng3377-fix-version-flag
+
+(QENG-3377) Add --version CLI flag
+```
+* Merge pull request #30 from nwolfe/qeng3920-arbitrary-global-config-support (ffe6078a)
+
+
+```
+Merge pull request #30 from nwolfe/qeng3920-arbitrary-global-config-support
+
+(QENG-3920) Global host config CLI configuration support
+```
+* (QENG-3808) Support uppercase alphanumeric architectures (0fc1ba77)
+
+
+```
+(QENG-3808) Support uppercase alphanumeric architectures
+
+This commit adds support for uppercase-only alphanumeric architecture
+bits in platform names. For example, we can support things like
+"POWER", "POWER7", "S390X" instead of just "32" or "64".
+
+Uppercase letters allow for backwards compatibility when roles are
+specified, which come after the architecture bit. This implementation
+relies on the fact that the role and arbitrary role characters are
+only lowercase.
+
+This allows us to distinguish between the architecture "POWER" and the
+role "m" when parsing the spec "POWERm", as in "aix71-POWERm".
+```
+* (QENG-3377) Add --version CLI flag (2ddec220)
+
+
+```
+(QENG-3377) Add --version CLI flag
+
+This commit adds a -v/--version CLI flag to print the version number.
+
+This also refactors the flow-of-control to remove the need for the
+SafeEarlyExit exception by moving all output-generating codepaths out of
+the initialize method and into the execute method, and teasing apart the
+--list and default generation codepaths. The execute method
+now chooses the code path based on the CLI options set in initialize.
+
+While we no longer throw a SafeEarlyExit exception, it's effectively
+part of the API so we must wait until the appropriate time/release to
+delete it. Existing usages of it should not be broken with the changes
+in this commit.
+```
+* (QENG-3920) Global host config CLI configuration support (151918d9)
+
+
+```
+(QENG-3920) Global host config CLI configuration support
+
+This commit adds CLI support for specifying global configuration
+settings that will be included in the CONFIG section.
+
+For example:
+
+  $ beaker-hostgenerator --global-config {master=headless} redhat7-64m
+  ---
+  HOSTS:
+    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
+      roles:
+      - agent
+      - master
+  CONFIG:
+    nfs_server: none
+    consoleport: 443
+    master: headless
+    pooling_api: http://vmpooler.delivery.puppetlabs.net/
+```
+### <a name = "0.6.0">0.6.0 - 11 May, 2016 (c807eb0d)
+
+* (HISTORY) update beaker-hostgenerator history for gem release 0.6.0 (c807eb0d)
 
 * (GEM) update beaker-hostgenerator version to 0.6.0 (4a8ee90e)
 

data/README.md

@@ -3,19 +3,17 @@
 `beaker-hostgenerator` is a command line utility designed to generate beaker
 host config files using a compact command line SUT specification.
 
-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)
+    - [Hypervisors](#hypervisors)
     - [Usage](#usage)
         - [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)
+        - [Arbitrary global configuration settings](#arbitrary-global-configuration-settings)
+        - [Custom hypervisor](#custom-hypervisor)
     - [Testing](#testing)
         - [Test Fixtures](#test-fixtures)
             - [Generated Fixtures](#generated-fixtures)
@@ -24,6 +22,23 @@ by [beaker][beaker]).
 
 <!-- markdown-toc end -->
 
+## Hypervisors
+
+Any hypervisor may be specified and generated, but if it's not a built-in
+hypervisor you will have to provide the entire hypervisor configuration as
+input. See the [Custom hypervisor](#custom-hypervisor) example for more
+information.
+
+It currently provides built-in configuration for 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]).
+
+To see the list of built-in hypervisors you can run:
+```
+$ beaker-hostgenerator --list
+```
+
 ## Usage
 
 Below are some example usages of `beaker-hostgenerator`.
@@ -140,6 +155,70 @@ CONFIG:
   pooling_api: http://vmpooler.delivery.puppetlabs.net/
 ```
 
+### Arbitrary global configuration settings
+
+```
+$ beaker-hostgenerator --global-config {preserve_hosts=onfail\,log_level=debug\,server.ip=12.345.6789} redhat7-64m
+```
+
+Will generate
+
+```yaml
+---
+HOSTS:
+  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
+    roles:
+    - agent
+    - master
+CONFIG:
+  nfs_server: none
+  consoleport: 443
+  preserve_hosts: onfail
+  log_level: debug
+  server.ip: 12.345.6789
+  pooling_api: http://vmpooler.delivery.puppetlabs.net/
+```
+
+### Custom hypervisor
+
+The following example shows one way of generating a custom hypervisor that
+includes both per-host configuration and global configuration.
+
+The term "custom" in this case signifies that it's not a built-in hypervisor
+(like `vmpooler`), which means we'll have to provide all the configuration
+ourselves as there isn't any built-in configuration for our hypervisor.
+
+```
+$ beaker-hostgenerator --hypervisor=custom --global={custom_api=http://api.custom.net} centos6-64
+```
+
+Will generate
+
+```yaml
+---
+HOSTS:
+  centos6-64-1:
+    pe_dir:
+    pe_ver:
+    pe_upgrade_dir:
+    pe_upgrade_ver:
+    platform: el-6-x86_64
+    hypervisor: custom
+    roles:
+    - agent
+CONFIG:
+  nfs_server: none
+  consoleport: 443
+  custom_api: http://api.custom.net
+```
+
 ## Testing
 
 Beaker Host Generator currently uses both rspec and minitest tests. To run both

data/lib/beaker-hostgenerator/cli.rb

@@ -1,6 +1,7 @@
 require 'beaker-hostgenerator/generator'
 require 'beaker-hostgenerator/hypervisor'
 require 'beaker-hostgenerator/roles'
+require 'beaker-hostgenerator/version'
 require 'optparse'
 
 module BeakerHostGenerator
@@ -113,24 +114,51 @@ Usage: beaker-hostgenerator [options] <layout>
           @options[:osinfo_version] = version
         end
 
+        opts.on('--global-config KEYVALUE_STRING',
+                "General configuration settings to be included as-is in the " <<
+                "CONFIG section. Value should be in the form '{key=value,...}'.") do |p|
+          @options[:global_config] = p
+        end
+
         opts.on('-h',
                 '--help',
                 'Display command help.') do
-          puts opts
-          exit
+          @options[:help] = opts.to_s
+        end
+
+        opts.on('-v',
+                '--version',
+                'Display beaker-hostgenerator version number.') do
+          @options[:version] = true
         end
       end
 
       optparse.parse!(argv)
+      @layout = argv[0]
+    end
 
-      if @options[:list_supported_values]
-        print_supported_values
-        raise BeakerHostGenerator::Exceptions::SafeEarlyExit
+    def execute
+      if @options[:help]
+        @options[:help] # Value is help text string
+      elsif @options[:version]
+        BeakerHostGenerator::Version::STRING
+      elsif @options[:list_supported_values]
+        supported_values_help_text
       else
-        @layout = argv[0]
+        print_warnings
+        BeakerHostGenerator::Generator.new.generate(@layout, @options)
+      end
+    end
+
+    def execute!
+      puts execute
+    end
 
-        if @options[:osinfo_version] === 0
-          warning = <<-eow
+    private
+
+    def print_warnings
+      if @options[:osinfo_version] === 0
+        warning = <<-eow
 WARNING: Starting with beaker-hostgenerator 1.x platform strings for "el" hosts
 will correspond to the actual linux distribution name. ie, the platform string
 corresponding to a host specified as "centos4_64a" will be "centos-4-x86_64"
@@ -138,47 +166,40 @@ rather than "el-4-x86_64". It is recommended that you update your project's test
 suites ASAP or be forced to do so when beaker-hostgenerator development moves on
 to the 1.x series. We don't intend to backport features or platforms to 0.x.
 eow
-          STDERR.puts(warning)
-        end
+        STDERR.puts(warning)
       end
     end
 
-    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:"
+    # Builds help text with a human-readable listing of all supported values
+    # for the following: platforms, architectures, roles, and hypervisors.
+    def supported_values_help_text
+      result = "valid beaker-hostgenerator platforms:\n"
       platforms = get_platforms(@options[:osinfo_version])
       platforms.each do |k|
-        puts "   #{k}"
+        result << "   #{k}\n"
       end
-      puts "\n"
+      result << "\n\n"
 
-      puts "valid beaker-hostgenerator architectures:"
-      puts "   32   => 32-bit OS"
-      puts "   64   => 64-bit OS"
-      puts "   6432 => 64-bit OS with 32-bit Puppet (Windows Only)"
-      puts "\n"
+      result << "valid beaker-hostgenerator architectures:\n"
+      result << "   32    => 32-bit OS\n"
+      result << "   64    => 64-bit OS\n"
+      result << "   6432  => 64-bit OS with 32-bit Puppet (Windows Only)\n"
+      result << "   POWER => power OS (AIX only)\n"
+      result << "   SPARC => sparc OS (Solaris only)\n"
+      result << "\n\n"
 
-      puts "valid beaker-hostgenerator host roles:"
+      result << "built-in beaker-hostgenerator host roles:\n"
       BeakerHostGenerator::Roles::ROLES.each do |k,v|
-        puts "   #{k} => #{v}"
+        result << "   #{k} => #{v}\n"
       end
-      puts "\n"
+      result << "\n\n"
 
-      puts "valid beaker-hostgenerator hypervisors:"
-      BeakerHostGenerator::Hypervisor.supported_hypervisors().keys.each do |k|
-        puts "   #{k}"
+      result << "built-in beaker-hostgenerator hypervisors:\n"
+      BeakerHostGenerator::Hypervisor.builtin_hypervisors().keys.each do |k|
+        result << "   #{k}\n"
       end
+
+      result
     end
   end
 end