serverspec_launcher 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 869e70e73b82b15d96dafe2b4f9a25adaca95beef038f421345b030a18c190d7
-  data.tar.gz: 1b7020c969a27c0f6dbe9bb8f30b2cb4f70534f00f1f6862c961ed3946673f47
+  metadata.gz: c7f4e2ec421c549a1d9c00424757c4d14b671a53f7eec83b4628071f5554efd3
+  data.tar.gz: 903bd958354012b07b8896d3e82735a32900e08d450c875cc3ff3ea1070f3644
 SHA512:
-  metadata.gz: 76b5ee6d396d148a019f9002571576991e60838f2278679c23a58b51de7abd0b11a5d0b68901521525b3414b0d61bd52550856ea0eaf52f039b9dc1ecacf7497
-  data.tar.gz: 7da748e49339824c4c16f6a060c3056c3f06a229102f101d10ef25d44afe00185d5217595dabd3c435776019d93ddf77f29693c19f29ed174c09338a5450ee87
+  metadata.gz: 434da33e43b8a283af112b1c3cbeba59ebf9f0586bd7305c41110a08a03446b754837e475b51fd30033482b865ebb75828f98ab38cb93f93a432d3f58dec837f
+  data.tar.gz: 7399373d264ee5207366c1b68e9eab1ab5ef455eae67663d3fcb7516e15223a5eedcb2fb6318d0095d35c311570d7f676d67632b7752c7e0d868caea15b5c2ab

data/lib/serverspec_launcher/helpers/symbolize_helper.rb

@@ -21,5 +21,10 @@ module SymbolizeHelper
     def deep_symbolize_keys
       SymbolizeHelper.symbolize_recursive(self)
     end
+
+    def deep_merge(second)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : Array === v1 && Array === v2 ? v1 | v2 : [:undefined, nil, :nil].include?(v2) ? v1 : v2 }
+      self.merge(second.to_h, &merger)
+    end
   end
 end

data/lib/serverspec_launcher/rake_tasks.rb

@@ -15,11 +15,10 @@ class ServerspecLauncherRakeTasks
   using SymbolizeHelper
 
   def initialize(properties = nil)
-
-    @properties = properties ? properties : YAML.load_file('properties.yml')
+    @properties = properties ? properties.deep_symbolize_keys : YAML.load_file('properties.yml').deep_symbolize_keys
     options = @properties[:options] || {}
     @fail_on_err = options[:fail_on_err]
-    @formatters = options[:formatters] || []
+    @formatters = options[:formatters] || ['docs_screen']
     @colorize = options[:color].nil? ? true : options[:color]
   end
 
@@ -29,27 +28,21 @@ class ServerspecLauncherRakeTasks
     debug_tasks
 
     namespace :serverspec do
-      task all: @properties[:targets].keys.map { |key| 'serverspec:' + key.split('.')[0] }
-      @properties[:targets].keys.each do |key|
-        target = @properties[:targets][key]
-        options = {
-          fail_on_err: target[:fail_on_err] || @fail_on_err,
-          formatters: target[:formatters] || @formatters,
-          color: target[:color].nil? ? @colorize : target[:color]
-        }
-        spec_type = target[:spec_type] || 'role'
-        if target[:hosts].is_a?(Array)
-
-          task_array(key, spec_type, target, options)
-        elsif target[:hosts]
-          host = target[:hosts]
-          task_name = (key || target[:name]).to_s
-          rake_task(host, key, task_name, spec_type, options)
-        else
-          task_name = (key || target[:name]).to_s
-          rake_task(key, key, task_name, spec_type, options)
+      targets = @properties[:targets] || {}
+      task all: targets.keys.map { |key| 'serverspec:' + key.to_s.split('.')[0] }
+      targets.keys.each do |key|
+        target = targets[key]
+        process_target(key, target)
+      end
+
+      environments = @properties[:environments] || {}
+      environments.keys.each do |key|
+        environment = environments[key]
+        environment[:targets].each do |target, hash|
+          process_target("#{key}:#{target}", hash)
         end
       end
+
     end
   end
 
@@ -67,10 +60,10 @@ class ServerspecLauncherRakeTasks
 
   def rake_task(host, key, task_name, spec_type, options = {})
     desc "Run serverspec to #{key}"
-    RSpec::Core::RakeTask.new(host.split('.')[0].to_sym) do |t|
-      ENV['TARGET_HOST'] = host
-      ENV['TARGET'] = key
-      ENV['TASK_NAME'] = task_name
+    RSpec::Core::RakeTask.new(host.to_s.split('.')[0].to_sym) do |t|
+      ENV['TARGET_HOST'] = host.to_s
+      ENV['TARGET'] = key.to_s
+      ENV['TASK_NAME'] = task_name.to_s
       t.pattern = "spec/#{spec_type}_spec.rb"
       t.fail_on_error = options[:fail_on_err]
       set_formatters(task_name, options, t)
@@ -100,7 +93,7 @@ class ServerspecLauncherRakeTasks
     if options[:formatters].include?('html')
       opts = "#{opts}  --format html --out reports/#{key}.html"
     end
-    if options[:formatters].include?('html_report')
+    if options[:formatters].include?('html_report') || options[:formatters].include?('html_pretty')
       opts = "#{opts}  --format RspecHtmlReporter"
     end
     if options[:formatters].include?('json')
@@ -132,6 +125,28 @@ class ServerspecLauncherRakeTasks
     tasks = ServerspecLauncherRakeTasks.new properties
     tasks.load_tasks
   end
+
+  private
+
+  def process_target(key, target)
+    options = {
+        fail_on_err: target[:fail_on_err] || @fail_on_err,
+        formatters: target[:formatters] || @formatters,
+        color: target[:color].nil? ? @colorize : target[:color]
+    }
+    spec_type = target[:spec_type] || 'role'
+    if target[:hosts].is_a?(Array)
+
+      task_array(key, spec_type, target, options)
+    elsif target[:hosts]
+      host = target[:hosts]
+      task_name = (key || target[:name]).to_s
+      rake_task(host, key, task_name, spec_type, options)
+    else
+      task_name = (key || target[:name]).to_s
+      rake_task(key, key, task_name, spec_type, options)
+    end
+  end
 end
 
 ServerspecLauncherRakeTasks.load unless $dont_load_rake_tasks

data/lib/serverspec_launcher/spec_helper.rb

@@ -13,12 +13,14 @@ require 'bundler'
 require 'specinfra'
 
 require 'serverspec_launcher/helpers/example_helper'
+require 'serverspec_launcher/helpers/symbolize_helper'
 
 # Does all the setup fo r the serverspec tests
 class SpecHelper
   include ExampleHelper
+  using SymbolizeHelper
 
-  attr_reader :properties
+  attr_reader :properties, :target_properties
   def initialize(host = ENV['TARGET_HOST'], target = ENV['TARGET'], properties = nil)
     @host = host
     @target = target
@@ -27,10 +29,19 @@ class SpecHelper
   end
 
   def load_properties(properties = nil)
-    @properties = properties ? properties : YAML.load_file('properties.yml')
-    @target_properties = @properties[:targets][@target]
+    @properties = properties ? properties.deep_symbolize_keys : YAML.load_file('properties.yml').deep_symbolize_keys
+    if @target.include? ':'
+      @target_properties = @properties[:environments][@target.split(':')[0].to_sym][:targets][@target.split(':')[1].to_sym]
+    else
+      @target_properties = @properties[:targets][@target.to_sym]
+    end
+
     @backend = @target_properties[:backend] || 'ssh'
     @target_properties[:target] = ENV['TASK_NAME']
+
+    @target_properties[:variables] =  @properties[:variables] ? @properties[:variables].deep_merge(@target_properties[:variables]) : {}.deep_merge(@target_properties[:variables])
+    @target_properties[:environment] =  @properties[:environment] ? @properties[:variables].deep_merge(@target_properties[:environment]) : {}.deep_merge(@target_properties[:environment])
+
     set_property @target_properties
   end
 
@@ -73,8 +84,6 @@ class SpecHelper
       { variable.to_sym => value }
     end.reduce({}, :merge)
     set :env, env
-    set :env, 'LEEK' => 'SHEEK'
-    puts env
   end
 
   def sudo_checks

data/lib/serverspec_launcher/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ServerspecLauncher
-  VERSION = '0.1.12'
+  VERSION = '0.2.0'
 end

data/serverspec_launcher.gemspec

@@ -27,8 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'debase'
   spec.add_runtime_dependency 'serverspec'
   spec.add_runtime_dependency 'rspec_junit_formatter'
   spec.add_runtime_dependency 'rspec-tick-formatter', '0.1.3'
+  spec.add_runtime_dependency 'rspec_html_reporter', '~> 1.0.0'
   spec.add_runtime_dependency 'docker-api'
 end

data/templates/properties.yaml.erb

@@ -1,29 +1,156 @@
 ---
-:targets:
-#  ssh-example:
-#    :hosts:
-#      - raspberrypi
-#      - blueberrypi
-#    :user: pi
-#    :roles:
-#      - development::docker
-#  exec-example:
-#    :backend: exec
-#    :roles:
-#      - :name: development::ruby
-#        :description: Ruby Development
-#      - development::docker
-#  docker-image-example:
-#    :backend: docker
-#    :docker_image: mongo
-#    :roles:
-#      - database::mongo
-#  docker-container-examples:
-#    :backend: docker
-#    :docker_container: jenkins
-#    :roles:
-#      - build_tools::jenkins
-#  vagrant-example:
-#    :backend: vagrant
-#    :roles:
-#     - debug::environment_vars
+
+options:
+  # Stop the test on the first failure (default: true)
+  fail_on_err: true
+  # Specify output format defaults is docs_screen multiple formatters can be specified
+  formaters:
+    # RSpec Documentation Formatter writing to file reports/<target>.docs
+    - docs
+    # RSpec Documentation Formatter writing to screen
+    - docs_screen
+    # Tick/Cross output to screen
+    - tick
+    # Tick/Cross output to file reports/<target>.tick
+    - tick_file
+    # JUnit Reports
+    - junit
+    # HTML Reports
+    - html
+    # Pretty HTML Reports
+    - html_pretty
+    # JSON Output
+    - json
+    # RSpec .F* progress bar
+    - progress
+  # Use colorized output (default: true)
+  color: false
+
+# Load shared examples from third party gems, useful for sharing infrastucture tests across projects
+shared_example_gems:
+  - my_shared_examples
+
+# Specify environment variables used on the hosts when testing
+# these are available as ENV['<var name>'] from the tests
+environment:
+  SOMEVAR: some value
+
+# Specify variable to be used in the tests
+# these are available from the tests as property[:variables][:<variable name>]
+variables:
+  my_var: some value
+
+
+# Target Based Testing
+# For each target specified here there will be a rake task defined which can be invoked via 'serverspec:<target name>'.
+# Targets with multiple hosts will also have 'serverspec:<target name>:<hostname>' defined for each host.
+# Running 'serverspec:<target name>' will execute against all hosts in the target
+# Running the 'serverspec' rake task will invoke all targets and environments
+
+targets:
+  # Running against a host via ssh
+  ssh-example:
+    backend: ssh
+    # specify host if left blank will use target name as hostname
+    hosts: raspberrypi
+    # uses specific user
+    user: pi
+    # run spec file spec/pi_spec.rb
+    spec_type: pi
+  
+  # Running against multiple hosts via ssh
+  ssh-multi-host-example:
+    # Dont really need to specify ssh backend as it is the default but including for completeness
+    hosts:
+      - raspberrypi
+      - blueberrypi
+    # uses specific user
+    user: pi
+    # run spec file spec/pi_spec.rb
+    spec_type: pi
+    # Don't fail the run if the target fails (if blank uses the global value which defaults to true)
+    fail_on_err: true
+
+  # Run against local host  
+  exec-example:
+    backend: exec
+    # Run spec file spec/localhost_spec.rb
+    spec_type: localhost
+    # Specify variable to be used in tests as property[:variables][:<variable name>]
+    variables:
+      # Specify a new variable
+      some_var: some value
+      # Override an existing vale
+      my_var: new value
+
+  # Run tests against a docker images
+  docker-image-example:
+    backend: docker
+    # Run against the mongo docker image from docker hub
+    docker_image: mongo
+    # Use shared behaviors loaded from spec/shared/.rb
+    roles:
+      - database::mongo
+
+  # Run tests against a running docker container
+  docker-container-examples:
+    backend: docker
+    # Run against container named jenkins
+    docker_container: jenkins
+    # Explicitly specify the role spec file spec/role_spec.rb which should be generated by 'serverspec_launcher init'
+    # This isn't really needed as role is the default spec_type
+    spec_type: role
+    roles:
+      # Run role with in context
+      - name: build_tools::jenkins
+        description: Jenkins Container
+
+  # Run tests against a docker build file
+  dockerfile-examples:
+    backend: docker
+    # Build image from Dockerfile in current directory
+    docker_build_dir: .
+    # Run spec file spec/docker_spec.rb
+    spec_type: docker
+
+
+  # Run tests against a vagrant file
+  vagrant-example:
+    backend: vagrant
+    roles:
+    - debug::environment_vars
+    environment:
+      # This environment var will only be availble to this target
+      MY_VAR: my value
+      # Override a globally set environment var
+      SOMEVAR: some other value
+
+environments:
+  qa:
+    variables:
+      # Override global variable
+      my_var: enviroment value
+      some_thing: a value
+
+    targets:
+      webservers: &webservers
+        hosts:
+          - web1.qa.domain
+          - web2.qa.domain
+        variables:
+          # Override variable
+          some_thing: new value
+
+  performance:
+    targets:
+      webservers:
+        # Yaml anchors are supported
+        <<: *webservers
+        hosts:
+        - web1.perf.domain
+        - web2.perf.domain
+        - web3.perf.domain
+        - web4.perf.domain
+        variables:
+          # Override variable
+          some_thing: new value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec_launcher
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Wardrobe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2018-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: serverspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec_html_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement