vaquero_io 0.1.1

data/features/new.feature

@@ -0,0 +1,118 @@
+Feature: New platform definition files for specified provider
+
+  As an Infracoder developing the vaquero command line tool
+  I want to test the ability to create platform definition template files for a provider
+  In order to assist the user in creating and maintaining definition files for product platforms
+
+  Scenario: Request help with NEW commands
+
+    When I run `vaquero help new`
+    Then the exit status should be 0
+    And the output should contain "Usage:"
+    And the output should contain "new"
+
+
+  Scenario: Create new platform definition file based on current provider
+
+    Given a file named "../../lib/providers/vaquero-test-a/Providerfile.yml" with:
+    """
+    provider:
+      name: vaquero-test-a
+      version: 0.1.0
+      location:
+
+      structure:
+
+        require:
+          - file1
+          - file2
+          - file3
+
+        platform:
+          path:
+          params:
+            count:
+              type: integer
+              range: 1..100
+            runlist:
+              array:
+                type: string
+                match: 'regex'
+            componentrole:
+              type: string
+              match: 'regex'
+            chefserver:
+              type: string
+              match: 'regex'
+
+        file1:
+          path: 'folder1/'
+          params:
+            location:
+              type: string
+              match: 'regex'
+            host:
+              type: string
+              match: 'regex'
+
+        file2:
+          path: 'folder1/'
+          params:
+            vlanid:
+              type: string
+              match: 'regex'
+            gateway:
+              type: IP
+            netmask:
+              type: integer
+              range: 1..24
+
+        file3:
+          path: 'folder2/'
+          params:
+            ram:
+              type: integer
+              range: 128..262144
+            cpu:
+              type: integer
+              range: 1..16
+            drive:
+              hash:
+                mount:
+                  type: string
+                  match: 'regex'
+                capacity:
+                  type: integer
+                  range: 8..2048
+            image:
+              type: string
+              match: 'regex'
+    """
+    Given a file named "../../lib/providers/vaquero-test-a/templates/platform.yml" with:
+    """
+    platform:
+    """
+    Given a file named "../../lib/providers/vaquero-test-a/templates/file1.yml" with:
+    """
+    file1:
+    """
+    Given a file named "../../lib/providers/vaquero-test-a/templates/file2.yml" with:
+    """
+    file2:
+    """
+    Given a file named "../../lib/providers/vaquero-test-a/templates/file3.yml" with:
+    """
+    file3:
+    """
+    Given a file named "../../lib/providers/vaquero-test-a/vaquero_test_a.rb" with:
+    """
+    """
+    When I run `vaquero new --provider vaquero-test-a`
+    Then the exit status should be 0
+    And the output should contain "Platform definition files successfully created"
+    And the following files should exist:
+      |platform.yml|
+      |folder1/file1.yml|
+      |folder1/file2.yml|
+      |folder2/file3.yml|
+    And I will clean up the test plugin "lib/providers/vaquero-test-a" when finished

data/features/plugin.feature

@@ -0,0 +1,138 @@
+Feature: Provider plugin modules
+
+  As an Infracoder developing the vaquero command line tool
+  I want to test the accuracy of the Provider plugin interactions for the PLUGIN command
+  In order to maintain the users ability to use and create provider plugins for custom infrastructure targets
+
+  Scenario: Request help with PLUGIN commands
+
+    When I get general help for "vaquero plugin"
+    Then the exit status should be 0
+    And the following commands should be documented:
+      |help|
+      |list|
+      |init|
+      |install|
+      |update|
+      |remove|
+
+  Scenario: List installed Providers
+
+    Given a file named "../../lib/providers/vaquero-test-a/Providerfile.yml" with:
+    """
+    provider:
+      name: test-installed-a
+      version: 0.0.0.a
+    """
+    Given a file named "../../lib/providers/vaquero-test-b/Providerfile.yml" with:
+    """
+    provider:
+      name: test-installed-b
+      version: 0.0.0.b
+    """
+    When I run `vaquero plugin list`
+    Then the exit status should be 0
+    And the output should contain "test-installed-a (0.0.0.a)"
+    And the output should contain "test-installed-b (0.0.0.b)"
+    And I will clean up the test plugin "lib/providers/vaquero-test-a" when finished
+    And I will clean up the test plugin "lib/providers/vaquero-test-b" when finished
+
+  Scenario: New Providerfile template
+
+    When I run `vaquero plugin init`
+    Then the exit status should be 0
+    And the output should contain "create  Providerfile.yml"
+    And the following files should exist:
+      |Providerfile.yml|
+    And the file "Providerfile.yml" should contain:
+    """
+    provider:
+      # define the plugin name that can be used to select this provider from the command line or environmental variable
+      name:
+      version: 0.0.0
+    """
+
+    When I run `vaquero plugin init example`
+    Then the exit status should be 0
+    And the output should contain "called with arguments"
+
+  Scenario: Install new Provider
+
+    When I run `vaquero plugin install`
+    Then the exit status should be 0
+    And the output should contain "called with no arguments"
+
+    When I run `vaquero plugin install https://github.com/vaquero-io/vaquero_io-plugin-test.git`
+    Then the exit status should be 0
+    And the output should contain "Successfully installed vaquero_io-plugin-test"
+    And the following files should exist:
+      |../../lib/providers/vaquero_io-plugin-test/Providerfile.yml|
+      |../../lib/providers/vaquero_io-plugin-test/vaquero_io_plugin_test.rb|
+    And the file "../../lib/providers/vaquero_io-plugin-test/Providerfile.yml" should contain:
+    """
+    provider:
+      name: vaquero_io-plugin-test
+      version: 0.1.1
+      location: https://github.com/vaquero-io/vaquero_io-plugin-test.git
+    """
+    And I will clean up the test plugin "lib/providers/vaquero_io-plugin-test" when finished
+
+    Given a file named "../../lib/providers/vaquero_io-plugin-test/Providerfile.yml" with:
+    """
+    provider:
+      name: vaquero_io-plugin-test
+      version: 0.1.1
+      location: https://github.com/vaquero-io/vaquero_io-plugin-test.git
+    """
+    When I run `vaquero plugin install https://github.com/vaquero-io/vaquero_io-plugin-test.git`
+    Then the exit status should be 0
+    And the output should contain "vaquero_io-plugin-test already installed"
+    And I will clean up the test plugin "lib/providers/vaquero_io-plugin-test" when finished
+
+  Scenario: Update installed Provider(s)
+
+    Given a file named "../../lib/providers/vaquero_io-plugin-test/Providerfile.yml" with:
+    """
+    provider:
+      name: vaquero_io-plugin-test
+      version: 0.1.1
+      location: https://github.com/vaquero-io/vaquero_io-plugin-test.git
+    """
+    When I run `vaquero plugin update vaquero_io-plugin-test`
+    Then the exit status should be 0
+    And the output should contain "vaquero_io-plugin-test provider already at current version"
+    And I will clean up the test plugin "lib/providers/vaquero_io-plugin-test" when finished
+
+    Given a file named "../../lib/providers/vaquero_io-plugin-test/Providerfile.yml" with:
+    """
+    provider:
+      name: vaquero_io-plugin-test
+      version: 0.0.0
+      location: https://github.com/vaquero-io/vaquero_io-plugin-test.git
+    """
+    When I run `vaquero plugin update vaquero_io-plugin-test`
+    Then the exit status should be 0
+    And the output should contain "Updated vaquero_io-plugin-test version 0.0.0 -> 0.1.1"
+    And I will clean up the test plugin "lib/providers/vaquero_io-plugin-test" when finished
+
+  Scenario: Remove Provider
+
+    When I run `vaquero plugin remove`
+    Then the exit status should be 0
+    And the output should contain "called with no arguments"
+
+    When I run `vaquero plugin remove vaquero_io-plugin-test`
+    Then the exit status should be 1
+    And the output should contain "Missing or invalid Providerfile"
+
+    Given a file named "../../lib/providers/vaquero_io-plugin-test/Providerfile.yml" with:
+    """
+    provider:
+      name: vaquero_io-plugin-test
+      version: 0.1.1
+      location: https://github.com/vaquero-io/vaquero_io-plugin-test.git
+    """
+    When I run `vaquero plugin remove vaquero_io-plugin-test`
+    Then the exit status should be 0
+    And the output should contain "vaquero_io-plugin-test removed"
+    And I will clean up the test plugin "lib/providers/vaquero_io-plugin-test" when finished

data/features/step_definitions/vaquero_steps.rb

@@ -0,0 +1,43 @@
+require 'fileutils'
+# 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 /vaquero_io 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
+
+Then(/^I will clean up the test plugin "([^"]*)" when finished$/) do |plugin|
+  puts plugin
+  puts Dir.pwd
+  FileUtils.remove_dir(plugin) if File.file?("#{plugin}/Providerfile.yml")
+end
+
+# Then(/^I will clean up the test plugin "([^"]*)" when finished$/) do |plugin|
+#   FileUtils.remove_dir('lib/providers/vaquero_io-plugin-test') if File.file?('lib/providers/vaquero_io-plugin-test/Providerfile.yml')
+# end
+
+# Given(/^I have cleaned up the test plugin$/) do
+#   FileUtils.remove_dir('lib/providers/vaquero_io-plugin-test') if File.file?('lib/providers/vaquero_io-plugin-test/Providerfile.yml')
+# end
+
+# rubocop:enable LineLength, StringLiterals

data/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'vaquero_io/runner'
+require 'coveralls'
+
+ENV['PATH'] = "/lib#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+Coveralls.wear!
+
+Aruba::InProcess.main_class = VaqueroIo::Runner
+Aruba.process = Aruba::InProcess

data/features/vaquero.feature

@@ -0,0 +1,28 @@
+Feature: Behavior of CLI with general features and commands
+
+  As an Infracoder developing a command line tool
+  I need to have the basic structure of the tool created
+  In order to engage in the BDD of the tool
+
+  Scenario: Request help with commands
+
+    When I get general help for "vaquero"
+    Then the exit status should be 0
+    And the banner should be present
+    And the following commands should be documented:
+      |help|
+      |version|
+      |plugin|
+      |new|
+
+  Scenario: Display gem version
+
+    When I run `vaquero -v`
+    Then the output should display the version
+
+# commands
+#
+#  $vaquero new <appname>, create yml folder structure for new platform definition
+#  $vaquero generate <environment>, generate new environment yml for current platform
+#  $vaquero validate [-e <env>, -p] no param is all, -e is specific env, -p is platform files only
+#  $vaquero build

data/lib/vaquero_io/build.rb

@@ -0,0 +1,130 @@
+module VaqueroIo
+  # Instantiates the platform
+  # builds the environment hash then
+  # passes to provider plugin
+  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 :component, type: :string, aliases: '-c', desc: DESC_BUILD_COMPONENT
+    class_option :node, type: :string, aliases: '-n', desc: DESC_BUILD_NODE
+    class_option :named_nodes, type: :boolean, default: true
+    class_option :verbose, type: :boolean, aliases: '-v', default: false
+    class_option :provider, type: :string, aliases: '-p'
+    class_option :verify_ssl, type: :boolean, default: nil
+    class_option :dry_run, type: :boolean, default: false
+    class_option :provider_username, type: :string, default: nil
+    class_option :provider_password, type: :string, default: nil
+    class_option :provider_options, type: :string, default: nil
+
+    # TODO: we don't have a tier definition any longer
+    # class_option :tier, type: :string, aliases: '-t', desc: DESC_BUILD_TIER
+    # TODO: Concurrency is an aspect of the provisioner not the tool so somehow you
+    # have to find a way to pass/set any kind of provider required options that is plugin agnostic
+    # class_option :concurrency, type: :numeric, aliases: '-C', default: 8, desc: DESC_BUILD_CONCURRENCY
+    # TODO: What to do about logfiles?
+    # class_option :logfiles, type: :string, aliases: '-l', default: 'logs', desc: DESC_BUILD_LOGFILES
+    # rubocop:enable LineLength
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    def build
+      # TODO: Initially, i am just passing the entire
+      # environment hash to the plugin
+      # But this can be further broken down based on parameters passed to build
+      provider = options[:provider] ? VaqueroIo::Provider.new(options[:provider]) : nil
+
+      plat = VaqueroIo::Platform.new(provider)
+
+      env_build = plat.environment(env)
+
+      if env_build.nil?
+        puts ''
+        puts "Platform #{plat.product} definition handed us a nil object for environment #{env}"
+        puts 'Cowardly refusing to build invalid environment definition!'
+        puts ''
+        fail(IOError, "Validation of platform #{plat.product} environment #{env} failed.")
+      end
+
+      # here we figure out what to cut
+
+      # If we're requesting a single component, we'll just do that.
+      if options[:component]
+        comp = options[:component]
+        unless env_build['components'][comp]
+          fail(IOError, "Requested component #{comp} not found in environment #{env}")
+        end
+        env_build['components'] = { comp => env_build['components'][comp] }
+        if options[:node]
+          node_list = []
+          node_max = env_build['components'][comp]['count']
+          options[:node].split(/,/).each do |n|
+            fail(IOError, "Requested node (#{n}) greater than component count (#{node_max})") if n.to_i > node_max.to_i
+            node_list << env_build['components'][comp]['nodes'][n.to_i - 1]
+          end
+
+          env_build['components'][comp]['nodes'] = node_list
+          env_build['components'][comp]['count'] = node_list.size
+        end
+      end
+
+      # Parse provider options from key1=val1,key2=val2 to a hash
+      provider_options = {}
+      options[:provider_options].split(/,/).each do |keyval|
+        key, value = keyval.split(/=/)
+        # Convert the key to a symbol
+        key = key.to_sym
+        # Do some quick checks for obvious boolean values
+        case value.downcase
+        when 'true'
+          value = true
+        when 'false'
+          value = false
+        end
+        provider_options[key] = value
+      end if options[:provider_options]
+
+      # Provision
+      provider_options = {
+        username:    options[:provider_username],
+        password:    options[:provider_password],
+        named_nodes: options[:named_nodes],
+        verify_ssl:  options[:verify_ssl],
+        dry_run:     options[:dry_run]
+      }.merge(provider_options)
+
+      if options[:dry_run]
+        puts "\nDry run only, will not do anything!\n"
+        puts "Calling provider #{provider} with options:"
+        provider_options.each { |k, v| puts " - '#{k}' = '#{v}'" }
+      end
+      puts "\nBuilding:"
+      puts "  Product: #{plat.product}"
+      puts "  Environment: #{env_build['environment']}"
+      puts '  Components:'
+      env_build['components'].each do |name, component|
+        print "   - #{name}"
+        component['nodes'].each_with_index do |n, i|
+          print ' (' if i == 0
+          print n
+          if i == component['nodes'].size - 1
+            puts ')'
+          else
+            print ', '
+          end
+        end
+      end
+
+      plat.provision(env_build, provider_options) # unless options[:dry_run]
+    end
+
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+  end
+end

data/lib/vaquero_io/config.rb

@@ -0,0 +1,19 @@
+# Gem default configuration settings
+# rubocop:disable LineLength
+module VaqueroIo
+  # plugin conventions
+  PROVIDERFILE = 'Providerfile.yml'
+  PROVIDERS_PATH = "#{File.dirname(__FILE__).chomp('vaquero_io')}providers/"
+  LIST_PLUGINS_PATH = "#{PROVIDERS_PATH + '**/Providerfile.yml'}"
+  TEMPLATE_PROVIDER = "templates/#{PROVIDERFILE}.tt"
+  TMP_INSTALL_FOLDER = "#{Dir.pwd}/tmp-providers"
+  TMP_INSTALL_PROVIDER = "#{TMP_INSTALL_FOLDER}/#{PROVIDERFILE}"
+  ENVIRONMENTFILE = 'environments/'
+
+  # provider platform temmplates
+  PLATFORMFILE = 'platform.yml'
+
+  # system variables
+  PUTENV_PROVIDER = 'PUTENV_PROVIDER'
+end
+# rubocop:enable LineLength

data/lib/vaquero_io/messages.rb

@@ -0,0 +1,40 @@
+# string constants for interactive messages
+# rubocop:disable LineLength
+module VaqueroIo
+  # command descriptions
+  DESC_VERSION = 'Display gem version'
+
+  DESC_PLUGIN = 'Manage Provider plugin modules'
+  DESC_PLUGIN_LIST = 'List installed Provider plugins'
+  DESC_PLUGIN_INSTALL = 'Install Provider plugin from LOCATION'
+  DESC_PLUGIN_UPDATE = 'Update installed Provider plugins'
+  DESC_PLUGIN_REMOVE = 'Remove installed Provider plugin'
+  DESC_PLUGIN_INIT = 'Create new Providerfile template for custom provider development'
+
+  DESC_NEW = 'Create new platform definition files based on specified Provider'
+  MSG_NEW_SUCCESS = 'Platform definition files successfully created'
+
+  DESC_HEALTH = 'Health check of all platform files and list all nodes for ENVIRONMENT'
+  HEALTHY = 'Success: Platform definition files exist and parameters match type requirements'
+
+  DESC_BUILD = 'Provision vms in an environment definition'
+  DESC_BUILD_ALL = 'Build everything for the named environment'
+  DESC_BUILD_COMPONENT = 'Build all nodes for the specified component'
+  DESC_BUILD_NODE = 'Build the single specified node'
+
+  # Error messages
+  NO_PROVIDER_FILE = 'Missing or invalid Providerfile'
+  NO_PROVIDER = 'Must specify a valid, installed provider plugin for platform definition'
+  PLUGINS_CURRENT = ' provider already at current version'
+  PLATFORM_EXISTS = 'Platform files already exist at this location'
+
+  MISSING_PLATFORM = 'Missing or invalid platform definitions file:'
+
+  FAIL_PROVIDER = 'Incorrect Provider'
+  WARN_PROVIDER_VERSION = 'Warning: Version difference between Provider plugin and platform definition'
+  FAIL_EMPTY_ENVIRONMENTS = 'Empty environments definition'
+  FAIL_EMPTY_NODENAME = 'Empty nodename convention'
+  FAIL_REQUIRED_FILES = 'No references to required file:'
+  FAIL_MISSING_ENV = 'Defined environment files not found:'
+end
+# rubocop:enable LineLength