elevage 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26d8f1dce1b2c33c9dafbfab62a0c61022542c75
-  data.tar.gz: 9007db613e819ce05d89eb91e2dfd2d41ffc71ed
+  metadata.gz: 831308271c5d157f33c0c90509d9368ed88652aa
+  data.tar.gz: 87a2972d4ad9e580b8d2d0dfff92a78f8cf28adb
 SHA512:
-  metadata.gz: 188b981a5844e3ea05e192e5e2f97bc80ec52fafc2fd958f7557ece1218b888d546999bb1e3a1e456ab5f8c55df08241d7f176b8e6aaacd109bd8f251c5b10ee
-  data.tar.gz: 621bf4c7b7e2cf2bbc30c86538adf130e5a735e55b50fabec589d9fa500d5fbcacb64a21e41b891944dbff67b803117bff6abe22ae23fc0d7e910896dec986e4
+  metadata.gz: 68f1b3bcd8ca570402fbb44c0e1d289c65693fc59fd51205625cfe0f58b47f674c53f6faf611f969eda99cd3992b219021e61e4c57d4a4e7d80b49e4316d85e3
+  data.tar.gz: 868903fced4812feec7cc8e43616c7b9e8d375ab5d7fac49d0a3f1c92c3fa40aa72adaed926dbe9c09ce0729be5d05d7ccb84b9e180c8c89fc6290935f3ebc74

data/.gitignore

@@ -18,4 +18,6 @@ tmp/
 .*sw[p-z]
 .ruby-version
 coverage/.last_run.json
-coverage/.resultset.json
+coverage/.resultset.json
+.yardoc/
+doc/

data/README.md

@@ -1,14 +1,35 @@
 # Elevage
 
-[![Build Status](https://travis-ci.org/ActiveSCM/elevage.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/ActiveSCM/elevage.png?travis)][gemnasium]
-[![Coverage Status](https://coveralls.io/repos/ActiveSCM/elevage/badge.png?branch=master)][coveralls]
-[![Inline docs](http://inch-ci.org/github/ActiveSCM/elevage.png?branch=master)][inch]
+[![Build Status](https://travis-ci.org/activenetwork-automation/elevage.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/activenetwork-automation/elevage.png?travis)][gemnasium]
+[![Coverage Status](https://coveralls.io/repos/activenetwork-automation/elevage/badge.png?branch=master)][coveralls]
+[![Inline docs](http://inch-ci.org/github/activenetwork-automation/elevage.png?branch=master)][inch]
 
-[travis]: http://travis-ci.org/ActiveSCM/elevage
-[gemnasium]: https://gemnasium.com/ActiveSCM/elevage
-[coveralls]: https://coveralls.io/r/ActiveSCM/elevage
-[inch]: http://inch-ci.org/github/ActiveSCM/elevage
+[travis]: http://travis-ci.org/activenetwork-automation/elevage
+[gemnasium]: https://gemnasium.com/activenetwork-automation/elevage
+[coveralls]: https://coveralls.io/r/activenetwork-automation/elevage
+[inch]: http://inch-ci.org/github/activenetwork-automation/elevage
+
+`elevage` is a command-line tool that allows you to define an application
+platform in a set of plain-text (YAML) configuration files and use those
+definitions to provision the virtual machines on which the application will
+live. The virtual machine will also be converged with the Chef runlists as
+defined your configuration files.
+
+Currently, `elevage` relies upon Chef's `knife` command and the `knife-vsphere`
+plugin, and has been tested with various releases of Chef 11 and 12 as well
+as the ChefDK.
+
+#### External Dependencies
+
+You must have the `knife` command installed on your path, and the
+`knife-vsphere` plugin installed. Your options are to:
+
+- Install [Chef Client](https://www.chef.io/download-chef-client/) and then
+install `knife-vsphere` via Chef's embedded ruby's `gem`
+- Install [ChefDK](https://downloads.chef.io/chef-dk/) and then
+`chef gem install knife-vsphere`
+- Install Chef via rubygems with `gem install chef knife-vsphere`
 
 #### Installation
 
@@ -86,14 +107,15 @@ Options:
 
 ## Contributing
 
-1. Fork it ( https://github.com/ActiveSCM/elevage/fork )
+1. Fork it ( https://github.com/activenetwork-automation/elevage/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
 ### License and Authors
-- Authors:: Nic Cheneweth (<nic.cheneweth@activenetwork.com>), (Gregory Ruiz-Ade <gregory.ruiz-ade@activenetwork.com>)
+- [Nic Cheneweth](https://github.com/Cheneweth)
+- [Gregory Ruiz-Ade](https://github.com/gkra)
 
 ```
 Copyright 2014 Active Network, LLC
@@ -109,4 +131,4 @@ 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/elevage.gemspec

@@ -19,21 +19,21 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency('rake')
+  spec.add_development_dependency('bundler', '~> 1.6')
+  spec.add_development_dependency('rake', '~> 10.4.2')
   spec.add_development_dependency('yard')
-  spec.add_development_dependency('aruba')
-  spec.add_development_dependency('cucumber')
-  spec.add_development_dependency('psych')
-  spec.add_development_dependency('rspec')
-  spec.add_development_dependency('guard')
-  spec.add_development_dependency('guard-rubocop')
-  spec.add_development_dependency('growl')
-  spec.add_development_dependency('coveralls')
-  spec.add_development_dependency('chef')
-  spec.add_development_dependency('knife-vsphere')
-  spec.add_dependency('thor')
-  spec.add_dependency('open4')
-  spec.add_dependency('english')
+  spec.add_development_dependency('aruba', '~> 0.6.2')
+  spec.add_development_dependency('cucumber', '~>2.0.0')
+  spec.add_development_dependency('psych', '= 2.0.5')
+  spec.add_development_dependency('rspec', '~> 3.3.0')
+  spec.add_development_dependency('guard', '~> 2.12.6')
+  spec.add_development_dependency('guard-rubocop', '~> 1.2.0')
+  spec.add_development_dependency('growl', '~> 1.0.3')
+  spec.add_development_dependency('coveralls', '~> 0.8.1')
+  spec.add_development_dependency('chef', '~> 12.3.0')
+  spec.add_development_dependency('knife-vsphere', '~> 1.0.1')
+  spec.add_dependency('thor', '~> 0.19.1')
+  spec.add_dependency('open4', '~> 1.3.4')
+  spec.add_dependency('english', '~> 0.6.3')
 end
 # rubocop:enable all

data/features/archive

@@ -84,13 +84,7 @@
         resourcepool: 'App-Web Linux/Corporate - o4'
         appendenv: true
         appenddomain: true
-        datastores:
-          - NonProd_Cor_PlaSer_25_111
-          - NonProd_Cor_PlaSer_26_111
-          - NonProd_Cor_PlaSer_38_111
-          - NonProd_Cor_PlaSer_39_111
-          - NonProd_Cor_PlaSer_40_111
-          - NonProd_Cor_PlaSer_41_111
+        datastore: 'NonProd_Cor_PlaSer'
 
         domain: dev.activenetwork.com
         dnsips:
@@ -101,20 +95,7 @@
         <<: *vcenter
 
         datacenter: 'WCDC Prod'
-        datastores:
-          - Prod_Cor_PlaSer_03_237
-          - Prod_Cor_PlaSer_04_237
-          - Prod_Cor_PlaSer_06F9_473
-          - Prod_Cor_PlaSer_06F9_473
-          - Prod_Cor_PlaSer_080D_473
-          - Prod_Cor_PlaSer_0812_473
-          - Prod_Cor_PlaSer_08E0_473
-          - Prod_Cor_PlaSer_08EA_473
-          - Prod_Cor_PlaSer_08F4_473
-          - Prod_Cor_PlaSer_0B89_473
-          - Prod_Cor_PlaSer_0B93_473
-          - Prod_Cor_PlaSer_847_473
-          - Prod_Cor_PlaSer_851_473
+        datastore: 'Prod_Cor_PlaSer'
 
         domain: active.tan
         dnsips:
@@ -311,4 +292,4 @@
                 - 10.219.161.78
     """
     When I run `elevage guard full`
-    Then the exit status should be 0
+    Then the exit status should be 0

data/features/build.feature

@@ -84,6 +84,7 @@ Feature: Provisioning platform vm's
         resourcepool: 'App-Web Linux/Corporate'
         appendenv: true
         appenddomain: true
+        appendtier: true
         datastores:
           - NonProd_Cor_25
           - NonProd_Cor_26
@@ -232,6 +233,6 @@ Feature: Provisioning platform vm's
     And the file "logs/qa-mq-01w.log" should contain:
     """
     qa-mq-01w: Provisioning.
-    knife vsphere vm clone --vsinsecure --start --vsuser svc_provisioner --vspass changeme --vshost www.google.com --folder Corporate/Platform Services/Templates --template centos32g-6.5-x86_64-20140714 --vsdc WCDC NonProd --dest-folder Corporate/Platform Services/app/qa --resource-pool App-Web Linux/Corporate --datastore NonProd_Cor_25 --ccpu 2 --cram 12 --cvlan DEV_APP_NET --cips 10.10.161.121/20 --cdnsips 10.10.10.5,10.10.10.6 --cgw 10.10.160.1 --chostname qa-mq-01w --ctz 085 --cdomain app.dev.corp.local --cdnssuffix app.dev.corp.local --bootstrap --template-file chef-full.erb --fqdn 10.10.161.121 --ssh-user knife --identity-file knife_rsa --node-name qa-mq-01w.qa.app.dev.corp.local --run-list role[loc_uswest],role[base],role[mq] --environment qa --bootstrap-version 11.4.0 qa-mq-01w.qa.app.dev.corp.local
+    knife vsphere vm clone --vsinsecure --start --vsuser svc_provisioner --vspass changeme --vshost www.google.com --folder Corporate/Platform Services/Templates --template centos32g-6.5-x86_64-20140714 --vsdc WCDC NonProd --dest-folder Corporate/Platform Services/app/qa/App --resource-pool App-Web Linux/Corporate --datastore  --ccpu 2 --cram 12 --cvlan DEV_APP_NET --cips 10.10.161.121/20 --cdnsips 10.10.10.5,10.10.10.6 --cgw 10.10.160.1 --chostname qa-mq-01w --ctz 085 --cdomain app.dev.corp.local --cdnssuffix app.dev.corp.local --bootstrap --template-file chef-full.erb --fqdn 10.10.161.121 --ssh-user knife --identity-file knife_rsa --node-name qa-mq-01w.app.dev.corp.local --run-list role[loc_uswest],role[base],role[mq] --environment qa --bootstrap-version 11.4.0 qa-mq-01w.app.dev.corp.local
     qa-mq-01w: exit status: 0
     """

data/features/generate.feature

@@ -83,11 +83,7 @@ Feature: GENERATE new environment yml file
         resourcepool: 'App-Web Linux/Corporate'
         appendenv: true
         appenddomain: true
-        datastores:
-          - NonProd_Cor_25
-          - NonProd_Cor_26
-          - NonProd_Cor_38
-          - NonProd_Cor_39
+        datastore: 'NonProd_Cor'
 
         domain: dev.corp.local
         dnsips:
@@ -98,9 +94,7 @@ Feature: GENERATE new environment yml file
         <<: *vcenter
 
         datacenter: 'WCDC Prod'
-        datastores:
-          - Prod_Cor_03
-          - Prod_Cor_04
+        datastore: 'Prod_Cor'
 
         domain: corp.local
         dnsips:
@@ -232,4 +226,4 @@ Feature: GENERATE new environment yml file
             -
 
 
-    """
+    """

data/features/health_env_failure.feature

@@ -84,11 +84,7 @@ Feature: HEALTH check of erroneous environment-only definition file items
         resourcepool: 'App-Web Linux/Corporate'
         appendenv: true
         appenddomain: true
-        datastores:
-          - NonProd_Cor_25
-          - NonProd_Cor_26
-          - NonProd_Cor_38
-          - NonProd_Cor_39
+        datastore: 'NonProd_Cor'
 
         domain: dev.corp.local
         dnsips:
@@ -99,9 +95,7 @@ Feature: HEALTH check of erroneous environment-only definition file items
         <<: *vcenter
 
         datacenter: 'WCDC Prod'
-        datastores:
-          - Prod_Cor_03
-          - Prod_Cor_04
+        datastore: 'Prod_Cor'
 
         domain: corp.local
         dnsips:

data/features/health_failure.feature

@@ -89,8 +89,7 @@ Feature: HEALTH check of erroneous platform definition file items
         resourcepool:
         appendenv: incorrect
         appenddomain:
-        datastores:
-          -
+        datastore:
 
         domain:
         dnsips:

data/features/health_success.feature

@@ -83,11 +83,7 @@ Feature: HEALTH check of correct platform definition file items
         resourcepool: 'App-Web Linux/Corporate'
         appendenv: true
         appenddomain: true
-        datastores:
-          - NonProd_Cor_25
-          - NonProd_Cor_26
-          - NonProd_Cor_38
-          - NonProd_Cor_39
+        datastore: 'NonProd_Cor'
 
         domain: dev.corp.local
         dnsips:
@@ -98,9 +94,7 @@ Feature: HEALTH check of correct platform definition file items
         <<: *vcenter
 
         datacenter: 'WCDC Prod'
-        datastores:
-          - Prod_Cor_03
-          - Prod_Cor_04
+        datastore: 'Prod_Cor'
 
         domain: corp.local
         dnsips:
@@ -276,4 +270,4 @@ Feature: HEALTH check of correct platform definition file items
     When I run `elevage health`
     Then the exit status should be 0
     And the output should contain "All base platform desired state files created and syntactically correct"
-    And the output should contain "specific definition yml syntactically correct"
+    And the output should contain "specific definition yml syntactically correct"

data/features/list.feature

@@ -83,11 +83,7 @@ Feature: LIST platform definition file items
         resourcepool: 'App-Web Linux/Corporate'
         appendenv: true
         appenddomain: true
-        datastores:
-          - NonProd_Cor_25
-          - NonProd_Cor_26
-          - NonProd_Cor_38
-          - NonProd_Cor_39
+        datastore: 'NonProd_Cor'
 
         domain: dev.corp.local
         dnsips:
@@ -98,9 +94,7 @@ Feature: LIST platform definition file items
         <<: *vcenter
 
         datacenter: 'WCDC Prod'
-        datastores:
-          - Prod_Cor_03
-          - Prod_Cor_04
+        datastore: 'Prod_Cor'
 
         domain: corp.local
         dnsips:
@@ -312,4 +306,4 @@ Feature: LIST platform definition file items
 
     When I run `elevage list random`
     Then the exit status should be 1
-    And the output should contain "unknown LIST command"
+    And the output should contain "unknown LIST command"

data/features/step_definitions/elevage_steps.rb

@@ -1,4 +1,4 @@
-# rubocop:disable LineLength, StringLiterals
+# rubocop:disable LineLength
 When(/^I get general help for "([^"]*)"$/) do |app_name|
   @app_name = app_name
   step %(I run `#{app_name} --help`)
@@ -24,4 +24,4 @@ end
 Then(/^the output should display the version$/) do
   step %(the output should match /\\d+\\.\\d+\\.\\d+/)
 end
-# rubocop:enable LineLength, StringLiterals
+# rubocop:enable LineLength

data/lib/elevage/build.rb

@@ -1,7 +1,8 @@
 require 'thor/group'
 
 module Elevage
-  # Create new platform definition files and environments folder structure
+  # Create new platform definition files and environments folder structure,
+  # used by the command line `build` option
   class Build < Thor::Group
     include Thor::Actions
 
@@ -35,6 +36,8 @@ module Elevage
     end
 
     # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    # Process and execute the `build` command
     def build
       # Make the logfile directory if it doesn't exist
       Dir.mkdir(options[:logfiles]) unless Dir.exist?(options[:logfiles])

data/lib/elevage/constants.rb

@@ -1,4 +1,4 @@
-# rubocop:disable LineLength, StringLiterals
+# rubocop:disable LineLength
 module Elevage
   # options description messages
   # DESC_followed by command and the description
@@ -110,4 +110,4 @@ module Elevage
     fail_health_check: 'elevage: health check revealed errors'
   }
 end
-# rubocop:enable LineLength, StringLiterals
+# rubocop:enable LineLength

data/lib/elevage/environment.rb

@@ -5,8 +5,10 @@ require_relative 'constants'
 require_relative 'platform'
 require_relative 'provisioner'
 
-# rubocop:disable ClassLength
+# Refer to README.md for use instructions
 module Elevage
+  # rubocop:disable ClassLength
+
   # Environment class
   class Environment
     attr_accessor :name
@@ -15,6 +17,10 @@ module Elevage
     attr_accessor :nodenameconvention
 
     # rubocop:disable LineLength
+
+    # Construct a new environment object.
+    # @param [String] env Name of the environment to construct
+    # @return [Elevage::Environment]
     def initialize(env)
       # Confirm environment has been defined in the platform
       platform = Elevage::Platform.new
@@ -32,8 +38,9 @@ module Elevage
     end
     # rubocop:enable LineLength
 
-    # Public: Environment class method
+    # List the nodes for this environment.
     # Returns multiline string = IP, fqdn, runlist
+    # @return [String] Expanded node list
     def list_nodes
       nodes =  @vcenter['destfolder'].to_s + "\n"
       @components.each do |component, _config|
@@ -47,6 +54,9 @@ module Elevage
     end
 
     # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    # Is the environment healthy?
+    # @return [Boolean] Health status of the environment
     def healthy?
       platform = Elevage::Platform.new
       health = ''
@@ -78,7 +88,8 @@ module Elevage
     end
     # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
 
-    # Public: basic class puts string output
+    # Override to string-ify the environment
+    # @return [String]
     def to_s
       puts @name
       puts @vcenter.to_yaml
@@ -86,10 +97,16 @@ module Elevage
       puts @nodenameconvention.to_yaml
     end
 
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
     # Public: method to request provisioning of all or a portion
     # of the environment
-    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
-    def provision(type: all, tier: nil, component: nil, instance: nil, options: nil)
+    # @param [String] type What type of provisioning, `:all`, `:tier`, `:component`, or `:node`
+    # @param [String] tier Name of the environment tier, when `type` is `:tier`
+    # @param [String] component Name of component to provision, when `type` is `:component` or `:node`
+    # @param [String] instance Numerical instance of the `component`, when `type` is `:node` (i.e., 1, 2, 3)
+    # @param [String] options Thor-provided `options` hash
+    def provision(type: :all, tier: nil, component: nil, instance: nil, options: nil)
       # Create the ProvisionerRunQueue to batch up our tasks
       runner = ProvisionerRunQueue.new
 
@@ -102,19 +119,15 @@ module Elevage
       end
 
       @components.each do |component_name, component_data|
-        next unless type.eql?(:all) || component_data['tier'].match(/#{tier}/i) && component_name.match(/#{component}/i)
+        next unless type.eql?(:all) || component_data['tier'].match(/\A#{tier.to_s}\z/i) || component_name.match(/\A#{component.to_s}\z/i)
 
         1.upto(component_data['addresses'].count) do |component_instance|
           next unless instance == component_instance || instance.nil?
-
           instance_name = node_name(component_name, component_instance)
-
           # Create the Provisioner
           provisioner = Elevage::Provisioner.new(instance_name, component_data, component_instance, self, options)
-
           # Add it to the queue
           runner.provisioners << provisioner
-
         end
       end
 
@@ -127,18 +140,18 @@ module Elevage
 
     private
 
-    # Private: updates env hash with necessary info from Platform files.
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    # Updates env hash with necessary info from Platform files.
     # This is a blend of env and Platform info needed to construct
     # Environment class object
     #
-    # Params
-    #   env: string passed from commend line, simple environment name
-    #   env_yaml: hash from requested environment.yml
-    #   platform: Platform class object built from standard
-    #             platform definition files
-    #
-    # Returns Hash: updated env_yaml hash
-    # rubocop:disable MethodLength, LineLength
+    # @param [String] env String passed from commend line, simple environment
+    # name
+    # @param [Hash] env_yaml Hash from requested environment.yml
+    # @param [Elevage::Platform] platform Platform class object built from
+    # standard platform definition files
+    # @return [Hash] Updated env_yaml hash
     def build_env(env, env_yaml, platform)
       # substitute vcenter resources from vcenter.yml for location defined in environment file
       env_yaml['vcenter'] = platform.vcenter[env_yaml['vcenter']]
@@ -150,7 +163,12 @@ module Elevage
       # component info. The Build command will run error checking before building, but to support
       #  the debugging value of the list command only hash.merge! is performed at this point.
       platform.components.each do |component, _config|
-        env_yaml['components'][component].merge!(platform.components[component]) { |_key, v1, _v2| v1 } unless env_yaml['components'][component].nil?
+        begin
+          env_yaml['components'][component].merge!(platform.components[component]) { |_key, v1, _v2| v1 } unless env_yaml['components'][component].nil?
+        rescue => error
+          puts "ERROR: build_env: could not merge component \"#{component}\" for environment \"#{env}\"!"
+          raise error
+        end
       end
       # substitute network and components for specified values from platform definition files
       env_yaml['components'].each do |component, _config|
@@ -163,21 +181,28 @@ module Elevage
       unless env_yaml['vcenter'].nil?
         # append env name to destination folder if appendenv == true
         env_yaml['vcenter']['destfolder'] += (env_yaml['vcenter']['appendenv'] ? '/' + env.to_s : '')
+
         # prepend app name to domain if appenddomain == true
-        env_yaml['vcenter']['appenddomain'] ? env_yaml['vcenter']['domain'] = '.' + platform.name + '.' + env_yaml['vcenter']['domain'] : ''
+        # If 'appenddomain' is true, add the environment name as a subdomain.
+        if env_yaml['vcenter']['appenddomain']
+          env_yaml['vcenter']['domain'] = '.' + platform.name + '.' + env_yaml['vcenter']['domain']
+        end
+
+        # Make sure the domain has a leading '.' or things don't look right.
+        env_yaml['vcenter']['domain'].sub!(/^/, '.') unless env_yaml['vcenter']['domain'].match(/^\./)
+
       end
       env_yaml
     end
-    # rubocop:enable MethodLength, LineLength
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
 
-    # Private: construct a node hostname from parameters
-    #
-    # Params
-    #   component: Hash, environment components
-    #   instance: integer, passed from loop iterator
-    #
-    # Returns hostname as String
     # rubocop:disable MethodLength
+
+    # Construct a node hostname from parameters
+    #
+    # @param [Hash] component Hash, environment components
+    # @param [integer] instance integer, passed from loop iterator
+    # @return [String] hostname
     def node_name(component, instance)
       name = ''
       @nodenameconvention.each do |i|
@@ -198,22 +223,24 @@ module Elevage
     end
     # rubocop:enable MethodLength
 
-    # Private: Constructs the node runlist from parameters
-    #
-    # Params
-    #   list: Array of strings from component runlist hash key value
-    #   componentrole:  String value from component, performs simple
-    #                   string substitution of for component string
-    #                   in component role string
-    #   component: String, component name
-    #
-    # Returns runlist as String
     # rubocop:disable LineLength
+
+    # Constructs the node runlist from parameters
+    #
+    # @param [Array] list Array of strings from component runlist hash key
+    # value
+    # @param [String] componentrole String value from component, performs
+    # simple string substitution of component string in component role string
+    # @param [String] component Name of the component
+    # @return [String] Chef runlist
     def run_list(list, componentrole, component)
       list.join(',') + (componentrole ? ',' + componentrole.gsub('#', component) : '')
     end
     # rubocop:enable LineLength
 
+    # Ensure the environment file exists
+    # @param [String] env_file Environment file name
+    # @return [Boolean] True if `env_file` exists
     def env_file_exists?(env_file)
       fail(IOError, ERR[:no_environment_file]) unless File.file?(env_file)
       true

data/lib/elevage/generate.rb

@@ -11,13 +11,14 @@ module Elevage
     end
 
     # rubocop:disable MethodLength, CyclomaticComplexity, PerceivedComplexity
+
+    # Process the `generate` command to create a new environment file
     def create_environment
       fail IOError, ERR[:env_exists] if File.file?(ENV_FOLDER + env + '.yml')
       platform = Elevage::Platform.new
       platformfile = File.open(YML_PLATFORM, 'r')
-      #
-      # The things from here forward I would rather have in the template file
-      # but that is even uglier, trying to get formatting correct
+      # TODO: The things from here forward I would rather have in the template
+      # file but that is even uglier, trying to get formatting correct
       # will need to investigate some POWER erb skills to clean this up
       @env_pools = ''
       @env_components = ''

data/lib/elevage/health.rb

@@ -10,6 +10,8 @@ module Elevage
     end
 
     # rubocop:disable LineLength
+
+    # Check the platform definition correctness
     def check_platform
       @platform = Elevage::Platform.new
       puts @platform.healthy? ? MSG_HEALTHY : fail(IOError, ERR[:fail_health_check])
@@ -17,6 +19,8 @@ module Elevage
     # rubocop:enable LineLength
 
     # rubocop:disable LineLength
+
+    # Check each environment definition for correctness
     def check_environments
       @platform.environments.each do |env|
         puts Elevage::Environment.new(env).healthy? ? (env + MSG_ENV_HEALTHY) : fail(IOError, ERR[:fail_health_check])

data/lib/elevage/new.rb

@@ -11,16 +11,18 @@ module Elevage
       File.dirname(__FILE__)
     end
 
-    # Confirm command is not being run in folder with
-    # existing platform definition
+    # Confirm command is not being run in folder with existing platform
+    # definition
     def already_exists?
       File.file?(YML_PLATFORM) && fail(IOError, ERR[:platform_exists])
     end
 
+    # Create the platform definition file
     def create_platform_file
       template(TEMPLATE_PLATFORM, YML_PLATFORM)
     end
 
+    # Create the infrastructure definition files
     def create_infrastructure_files
       template(TEMPLATE_VCENTER, YML_VCENTER)
       template(TEMPLATE_NETWORK, YML_NETWORK)