elevage 0.1.0

data/features/list.feature

@@ -0,0 +1,315 @@
+Feature: LIST platform definition file items
+
+  As an Infracoder developing a command line tool
+  I want to display vcenters, networks, components, and other desired elements in the platform files
+  In order to maintain the health of the elevage platform definition files
+
+  Scenario: list desired state items for platform and environment definitions
+
+    Given a file named "platform.yml" with:
+    """
+    platform:
+      name: app
+      description: 'description of the app'
+
+      environments:
+        - int
+        - prod
+
+      tiers:
+        - Web
+        - App
+
+      nodenameconvention:
+        - environment
+        - '-'
+        - component
+        - '-'
+        - instance
+        - geo
+
+      pools:
+        webvmdefaults: &webvmdefaults
+          count: 2
+          tier: Web
+          image: 'centos-6.5-x86_64-20140714'
+          compute: nonprodweb
+          port: 80
+          runlist:
+            - 'role[loc_uswest]'
+            - 'role[base]'
+          componentrole: 'role[#]'
+
+        appvmdefaults: &appvmdefaults
+          <<: *webvmdefaults
+          tier: App
+          compute: nonprodapp
+
+      components:
+        api:
+          <<: *webvmdefaults
+          port: 8080
+
+        cui:
+          <<: *webvmdefaults
+          port: 8082
+
+        terracotta:
+          <<: *webvmdefaults
+          compute: nonprodtc
+          image: 'centos32g-6.5-x86_64-20140714'
+
+        email:
+          <<: *appvmdefaults
+          port: 8130
+
+        mq:
+          <<: *appvmdefaults
+          port: 1234
+          compute: nonprodmq
+          image: 'centos32g-6.5-x86_64-20140714'
+    """
+    Given a file named "infrastructure/vcenter.yml" with:
+    """
+    vcenter:
+      nonprod: &vcenter
+        geo: west
+        timezone: 085
+
+        host: 'www.google.com'
+        datacenter: 'WCDC NonProd'
+        imagefolder: 'Corporate/Platform Services/Templates'
+        destfolder: 'Corporate/Platform Services/app'
+        resourcepool: 'App-Web Linux/Corporate'
+        appendenv: true
+        appenddomain: true
+        datastores:
+          - NonProd_Cor_25
+          - NonProd_Cor_26
+          - NonProd_Cor_38
+          - NonProd_Cor_39
+
+        domain: dev.corp.local
+        dnsips:
+          - 10.10.10.5
+          - 10.10.10.6
+
+      prod:
+        <<: *vcenter
+
+        datacenter: 'WCDC Prod'
+        datastores:
+          - Prod_Cor_03
+          - Prod_Cor_04
+
+        domain: corp.local
+        dnsips:
+          - 10.20.100.5
+          - 10.20.100.6
+    """
+    Given a file named "infrastructure/network.yml" with:
+    """
+    network:
+      devweb:
+        vlanid: DEV_WEB_NET
+        gateway: '10.10.128.1'
+        netmask: 19
+
+      devapp:
+        vlanid: DEV_APP_NET
+        gateway: '10.10.160.1'
+        netmask: 20
+
+      prodweb:
+        vlanid: PRD_WEB_NET
+        gateway: '10.119.128.1'
+        netmask: 19
+
+      prodapp:
+        vlanid: PRD_APP_NET
+        gateway: '10.119.160.1'
+        netmask: 20
+    """
+    Given a file named "infrastructure/compute.yml" with:
+    """
+    compute:
+      default: &default
+        cpu: 2
+        ram: 2
+
+      nonprodweb:
+        <<: *default
+
+      nonprodapp:
+        <<: *default
+        ram: 6
+
+      nonprodtc:
+        <<: *default
+        ram: 8
+
+      nonprodmq:
+        <<: *default
+        ram: 12
+
+      prodweb:
+        <<: *default
+        ram: 6
+
+      prodapp:
+        <<: *default
+        ram: 6
+
+      prodtc:
+        <<: *default
+        ram: 32
+
+      prodmq:
+        <<: *default
+        cpu: 8
+        ram: 32
+    """
+    Given a file named "environments/int.yml" with:
+    """
+    environment:
+      vcenter: nonprod
+
+      pool:
+        webvmdefaults: &webvmdefaults
+            network: devweb
+            compute: nonprodweb
+
+        appvmdefaults: &appvmdefaults
+          <<: *webvmdefaults
+          network: devapp
+          compute: nonprodapp
+
+      components:
+        api:
+            addresses:
+                - 10.10.137.42
+                - 10.10.137.43
+
+        cui:
+            addresses:
+                - 10.10.137.64
+                - 10.10.137.65
+
+        terracotta:
+            addresses:
+                - 10.10.137.95
+                - 10.10.137.96
+
+        email:
+            addresses:
+                - 10.10.161.53
+                - 10.10.161.54
+
+        mq:
+            addresses:
+                - 10.10.161.77
+                - 10.10.161.78
+    """
+    Given a file named "environments/prod.yml" with:
+    """
+    environment:
+      vcenter: prod
+
+      pool:
+        webvmdefaults: &webvmdefaults
+            network: prodweb
+            count: 4
+            compute: prodweb
+
+        appvmdefaults: &appvmdefaults
+          <<: *webvmdefaults
+          network: prodapp
+          compute: prodapp
+
+
+      components:
+        api:
+            addresses:
+                - 10.119.137.72
+                - 10.119.137.73
+                - 10.119.137.74
+                - 10.119.137.75
+
+        cui:
+            addresses:
+                - 10.119.137.133
+                - 10.119.137.134
+                - 10.119.137.135
+                - 10.119.137.136
+
+        terracotta:
+            count: 2
+            compute: prodtc
+            addresses:
+                - 10.119.137.218
+                - 10.119.137.219
+            port: 0000
+
+        email:
+            addresses:
+                - 10.119.161.137
+                - 10.119.161.138
+                - 10.119.161.139
+                - 10.119.161.140
+
+        mq:
+            count: 2
+            compute: prodmq
+            addresses:
+                - 10.119.161.206
+                - 10.119.161.207
+    """
+
+    When I run `elevage list environments`
+    Then the exit status should be 0
+    And the output should contain "- int\n- prod"
+
+    When I run `elevage list tiers`
+    Then the exit status should be 0
+    And the output should contain "- Web\n- App"
+
+    When I run `elevage list pools`
+    Then the exit status should be 0
+    And the output should contain "appvmdefaults:\n  count: 2\n  tier: App\n  image: centos-6.5-x86_64-20140714\n  compute: nonprodapp\n  port: 80"
+
+    When I run `elevage list components`
+    Then the exit status should be 0
+    And the output should contain "terracotta:\n  count: 2\n  tier: Web\n  image: centos32g-6.5-x86_64-20140714\n  compute: nonprodtc\n  port: 80"
+
+    When I run `elevage list vcenter`
+    Then the exit status should be 0
+    And the output should contain "prod:\n  geo: west\n  timezone: 085\n  host: www.google.com\n  datacenter: WCDC Prod"
+
+    When I run `elevage list compute`
+    Then the exit status should be 0
+    And the output should contain "prodtc:\n  cpu: 2\n  ram: 32"
+
+    When I run `elevage list network`
+    Then the exit status should be 0
+    And the output should contain "prodweb:\n  vlanid: PRD_WEB_NET"
+
+    When I run `elevage list prod`
+    Then the exit status should be 0
+    And the output should contain "vlanid: PRD_WEB_NET"
+    And the output should contain "cpu: 2"
+    And the output should contain "datacenter: WCDC Prod"
+    And the output should contain "runlist: role[loc_uswest],role[base],role[api]"
+
+    When I run `elevage list prod -n`
+    Then the exit status should be 0
+    And the output should contain "10.119.161.137"
+    And the output should contain "prod-email-01w.app.corp.local"
+
+    When I run `elevage list int -n`
+    Then the exit status should be 0
+    And the output should contain "10.10.161.53"
+    And the output should contain "int-email-01w.app.dev.corp.local"
+
+    When I run `elevage list random`
+    Then the exit status should be 1
+    And the output should contain "unknown LIST command"

data/features/new.feature

@@ -0,0 +1,68 @@
+Feature: creating NEW platform definition files
+
+  As an Infracoder developing a command line tool
+  I want to test the accuracy of the files and folders created by the NEW command
+  In order to maintain the health of the elevage generator commands
+
+  Scenario: generating new platform
+
+    When I run `elevage new app`
+    Then the following files should exist:
+      |platform.yml|
+      |infrastructure/vcenter.yml|
+      |infrastructure/compute.yml|
+      |infrastructure/network.yml|
+    And the file "platform.yml" should contain:
+    """
+    platform:
+      name: app
+    """
+    And the file "infrastructure/vcenter.yml" should contain:
+    """
+    vcenter:
+    """
+    And the file "infrastructure/network.yml" should contain:
+    """
+    network:
+    """
+    And the file "infrastructure/compute.yml" should contain:
+    """
+    compute:
+    """
+
+  Scenario: generating new platform called when platform already exists
+
+    Given a file named "platform.yml" with:
+    """
+    platform:
+      name: app
+    """
+    When I run `elevage new app`
+    Then the exit status should be 1
+    And the output should contain "elevage: platform files already exist!"
+
+#  Scenario: generating new platform with -chef option
+#
+#    When I run `elevage new app -chef`
+#    Then the following files should exist:
+#      |app_definition/platform.yml|
+#      |app_definition/infrastructure/vcenter.yml|
+#      |app_definition/infrastructure/compute.yml|
+#      |app_definition/infrastructure/network.yml|
+#    And the file "app_definition/platform.yml" should contain:
+#    """
+#    platform:
+#      name: app
+#    """
+#    And the file "app_definition/infrastructure/vcenter.yml" should contain:
+#    """
+#    vcenter:
+#    """
+#    And the file "app_definition/infrastructure/network.yml" should contain:
+#    """
+#    network:
+#    """
+#    And the file "app_definition/infrastructure/compute.yml" should contain:
+#    """
+#    compute:
+#    """

data/features/step_definitions/elevage_steps.rb

@@ -0,0 +1,27 @@
+# rubocop:disable LineLength, StringLiterals
+When(/^I get general help for "([^"]*)"$/) do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} --help`)
+  step %(I run `#{app_name}`)
+end
+
+Then(/^the banner should be present$/) do
+  step %(the output should match /elevage commands:/)
+end
+
+Then(/^the following commands should be documented:$/) do |options|
+  options.raw.each do |option|
+    step %(the command "#{option[0]}" should be documented)
+  end
+end
+
+Then(/^the command "([^"]*)" should be documented$/) do |options|
+  options.split(',').map(&:strip).each do |option|
+    step %(the output should match /\\s*#{Regexp.escape(option)}[\\s\\W]+\\w[\\s\\w][\\s\\w]+/)
+  end
+end
+
+Then(/^the output should display the version$/) do
+  step %(the output should match /\\d+\\.\\d+\\.\\d+/)
+end
+# rubocop:enable LineLength, StringLiterals

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'elevage/runner'
+require 'coveralls'
+
+Coveralls.wear!
+
+Aruba::InProcess.main_class = Elevage::Runner
+Aruba.process = Aruba::InProcess

data/lib/elevage/build.rb

@@ -0,0 +1,109 @@
+require 'thor/group'
+
+module Elevage
+  # Create new platform definition files and environments folder structure
+  class Build < Thor::Group
+    include Thor::Actions
+
+    # Build subcommand arguments and options
+    # rubocop:disable LineLength
+    argument :env, type: :string, desc: DESC_BUILD
+    class_option :all, type: :boolean, aliases: '-a', desc: DESC_BUILD_ALL
+    class_option :tier, type: :string, aliases: '-t', desc: DESC_BUILD_TIER
+    class_option :component, type: :string, aliases: '-c', desc: DESC_BUILD_COMPONENT
+    class_option :node, type: :numeric, aliases: '-n', desc: DESC_BUILD_NODE
+    class_option :concurrency, type: :numeric, aliases: '-C', default: 8, desc: DESC_BUILD_CONCURRENCY
+    class_option :logfiles, type: :string, aliases: '-l', default: 'logs', desc: DESC_BUILD_LOGFILES
+    class_option :verbose, type: :boolean, aliases: '-v', default: false
+    # rubocop:enable LineLength
+
+    # dry-run
+    class_option 'dry-run', type: :boolean, desc: DESC_BUILD_DRY_RUN
+
+    # Additional options for passing to the knife command
+    # rubocop:disable LineLength
+    class_option 'vsuser', default: 'svc_provisioner', type: :string, desc: DESC_BUILD_VSUSER
+    class_option 'vspass', default: 'changeme', type: :string, desc: DESC_BUILD_VSPASS
+    class_option 'ssh-user', default: 'knife', type: :string, aliases: '-x', desc: DESC_BUILD_SSH_USER
+    class_option 'ssh-key', default: 'knife_rsa', type: :string, aliases: '-i', desc: DESC_BUILD_SSH_KEY
+    class_option 'template-file', default: 'chef-full.erb', type: :string, aliases: '-t', desc: DESC_BUILD_TEMPLATE_FILE
+    class_option 'bootstrap-version', default: '11.4.0', type: :string, aliases: '-b', desc: DESC_BUILD_BOOTSTRAP_VERSION
+    # rubocop:enable LineLength
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+    def build
+      # Make the logfile directory if it doesn't exist
+      Dir.mkdir(options[:logfiles]) unless Dir.exist?(options[:logfiles])
+
+      # Fetch the environment and make sure it passes basic health checks
+      @environment = Elevage::Environment.new(env)
+      fail(IOError) unless @environment.healthy?
+
+      # =============================================================
+      # Option sanity checking.
+      #
+      # What are we going to reject as invalid options?
+      #
+      if options[:all] && options[:tier] || options[:all] && options[:component] || options[:tier] && options[:component]
+        warn 'The --all, --tier and --component options may not be specified together.'
+        exit false
+      end
+
+      if options[:node] && !options[:component]
+        warn 'When requesting a --node you must specify which --component.'
+        exit false
+      end
+
+      unless options[:all] || options[:tier] || options[:component]
+        warn 'You must specify one of --all, --tier=<tier>, or --component=<component>'
+        exit false
+      end
+
+      # Determine what, exactly, we're supposed to build
+      if options[:all]
+        # =============================================================
+        # Build ALL THE THINGS!
+        #
+        @environment.provision(type: :all,
+                               options: options)
+
+      elsif options[:tier]
+        # =============================================================
+        # Build most of the things...
+        #
+        if options[:tier].eql?('tier')
+          warn 'Was asked to build a tier, but was not told which one!'
+          exit false
+        end
+        @environment.provision(type: :tier,
+                               tier: options[:tier],
+                               options: options)
+
+      elsif options[:component]
+        # =============================================================
+        # Build a few things...
+        #
+        if options[:component].eql?('component')
+          warn 'Was asked to build a component, but was not told which one!'
+          exit false
+        end
+        # See if we're actually only supposed to build just one thing...
+        if options[:node]
+          @environment.provision(type: :node,
+                                 component: options[:component],
+                                 instance: options[:node],
+                                 options: options)
+        else
+          @environment.provision(type: :component,
+                                 component: options[:component],
+                                 options: options)
+        end
+      end
+    end
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+  end
+end

data/lib/elevage/constants.rb

@@ -0,0 +1,113 @@
+# rubocop:disable LineLength, StringLiterals
+module Elevage
+  # options description messages
+  # DESC_followed by command and the description
+  DESC_VERSION = 'Display installed elevage gem version (Can also use -v)'
+  DESC_NEW = 'Prepare new platform files and folder structure at current location'
+  DESC_LIST = 'List ITEMs from platform desired state yml files'
+  DESC_LIST_NODES = 'used with environment name to list node names and ip addresses'
+  DESC_HEALTH = 'Health check of the Platform desired state yml files'
+  DESC_GENERATE = 'Generate new environment file based on platform template'
+  DESC_BUILD = 'Provision vms in an environment definition'
+  DESC_BUILD_DRY_RUN = 'Do not actually do anything, just display the commands that would be run.'
+  DESC_BUILD_ENV = 'Name of the platform environment to provision'
+  DESC_BUILD_USER = 'User name for vSphere'
+  DESC_BUILD_PASSWD = 'Password for vSphere'
+  DESC_BUILD_ALL = 'Build everything for the named environment'
+  DESC_BUILD_TIER = 'Build everything for the specified tier in the named environment'
+  DESC_BUILD_COMPONENT = 'Build all nodes for the specified component'
+  DESC_BUILD_NODE = 'Build the single specified node'
+  DESC_BUILD_VSUSER = 'Username for vSphere'
+  DESC_BUILD_VSPASS = 'Password for vSphere'
+  DESC_BUILD_SSH_USER = 'Unix username for ssh for chef-client bootstrap (must have sudo NOPASSWD access for root)'
+  DESC_BUILD_SSH_KEY = 'Path to SSH private key for ssh username for key-based authentication'
+  DESC_BUILD_TEMPLATE_FILE = 'File to be used as the chef-client bootstrap template script'
+  DESC_BUILD_BOOTSTRAP_VERSION = 'Version of chef-client to bootstrap on node'
+  DESC_BUILD_CONCURRENCY = 'Maximum number of simultaneous provisioning tasks'
+  DESC_BUILD_LOGFILES = 'Path where log files should be written'
+
+  # available List commands
+  LIST_CMDS = %w(environments tiers pools components network vcenter compute)
+
+  # Health check range settings
+  TIMEZONE_LIMIT = 159
+  CPU_LIMIT = 16
+  RAM_LIMIT = 128
+  POOL_LIMIT = 256
+
+  # Health check messages
+  MSG_HEALTHY = 'All base platform desired state files created and syntactically correct'
+  MSG_ENV_HEALTHY = ' specific definition yml syntactically correct'
+  MSG = {
+    empty_environments: "Empty environment definitions\n",
+    empty_tiers: "Empty tier definitions\n",
+    empty_nodenameconvention: "Empty nodenameconvention definitions\n",
+    pool_count_size: "Must define 1 or more nodes in a pool\n",
+    invalid_tiers: "Pool contains invalid tier reference\n",
+    no_image_ref: "No vm image referenced in pool definition\n",
+    invalid_compute: "Pool contains invalid compute reference\n",
+    invalid_port: "Pool contains invalid port definition\n",
+    invalid_runlist: "No pool runlist definition\n",
+    invalid_componentrole: "Pool Componentrole missing #\n",
+    invalid_geo: "no vCenter geo defined\n",
+    invalid_timezone: "Invalid vCenter timezone\n",
+    invalid_host: "vCenter host not accessible\n",
+    invalid_datacenter: "No datacenter defined for vCenter\n",
+    invalid_imagefolder: "No image location defined for vCenter build\n",
+    invalid_destfolder: "No destination folder defined for vCenter build\n",
+    invalid_appendenv: "Append environment to destination folder must be true or false\n",
+    invalid_appenddomain: "prepend app name to domain must be true or false\n",
+    empty_datastores: "No data stores defined for vCenter build\n",
+    invalid_domain: "No domain defined for node fqdn\n",
+    invalid_ip: "Invalid IP's defined for DNS lookup\n",
+    empty_network: "Empty Network defintions\n",
+    invalid_gateway: "Invalid gateway defined in network\n",
+    invalid_cpu: "Invalid compute cpu settings\n",
+    invalid_ram: "Invalid compute ram settings\n",
+    invalid_env_vcenter: "Environment contains invalid vcenter definition\n",
+    invalid_env_network: "Environment contains invalid network definition\n",
+    invalid_env_count: "Environment contains invalid number of nodes in pool\n",
+    invalid_env_compute: "Environment component pool contains invalid compute definition\n",
+    invalid_env_ip: "Environment component pool contains invalid or missing ip address definition\n",
+    invalid_env_tier: "Environment component pool contains invalid tier definition\n",
+    invalid_env_image: "Environment component pool contains invalid image definition\n",
+    invalid_env_port: "Environment component pool contains invalid port definition\n",
+    invalid_env_runlist: "Environment component pool contains invalid runlist specification\n",
+    invalid_env_componentrole: "Environment component pool contains invalid componentrole definition\n",
+    env_component_mismatch: "Environment components do not match platform definition\n"
+  }
+
+  # Templates
+  TEMPLATE_PLATFORM = 'templates/platform.yml.tt'
+  TEMPLATE_VCENTER = 'templates/vcenter.yml.tt'
+  TEMPLATE_NETWORK = 'templates/network.yml.tt'
+  TEMPLATE_COMPUTE = 'templates/compute.yml.tt'
+  TEMPLATE_ENV = 'templates/environment.yml.tt'
+
+  # filename defaults
+  YML_PLATFORM = 'platform.yml'
+  YML_VCENTER = 'infrastructure/vcenter.yml'
+  YML_NETWORK = 'infrastructure/network.yml'
+  YML_COMPUTE = 'infrastructure/compute.yml'
+  ENV_FOLDER = 'environments/'
+
+  # Build defaults
+  BUILD_CONCURRENT_DEFAULT = 4
+  BUILD_CHILD_WAIT_TIMEOUT = 0.5
+  BUILD_STATUS_INTERVAL = 60
+
+  # error messages
+  ERR = {
+    platform_exists: 'elevage: platform files already exist!',
+    not_list_cmd: 'elevage: used an unknown LIST command',
+    no_platform_file: 'elevage: platform.yml file not found!',
+    no_vcenter_file: 'elevage: infastructure/vcenter.yml file not found!',
+    no_network_file: 'elevage: infastructure/network.yml file not found!',
+    no_compute_file: 'elevage: infastructure/compute.yml file not found!',
+    env_exists: 'elevage: environment file already exists!',
+    env_not_defined: 'elevage: environment file not defined in platform',
+    no_env_file: 'elevage: Environment file in platform.yml not found',
+    fail_health_check: 'elevage: health check revealed errors'
+  }
+end
+# rubocop:enable LineLength, StringLiterals