ansible_spec 0.0.1.4 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72fba25ed4abe4c3996c35f674c6296a5b71ac74
-  data.tar.gz: 6f0a5120c52fd85162bf721022009382d9cd9f23
+  metadata.gz: 9786a12ddd76b367acc6a746e7933d3e05d8e8fc
+  data.tar.gz: 62c75b1aa15c19784b67a5250a5ac3d3e48edddd
 SHA512:
-  metadata.gz: f6f845d822b12278605e8ca7479b368ac6cf30c25826b23a17c7b079758db17a13e6419e3d04ff2f53ab82265d2841991343a3e77d8057760576ae3f23ad2a31
-  data.tar.gz: 22ca53f5baf32f1311ccfb9fb6ee69e3080f12a2b5e8b94fa885af96f3c674dfccb0bc8d994a2057b1c1f270de29f3ec19a01a39bc5c0e4756792bbbf5117c70
+  metadata.gz: 85c49993d9dcf8d4b7a731e9c7b7dce822c9a2574bb3707d1c174aea42aa8c4272495d0773c4e9158802e51455f730a2eb33e40e201452e5be0f1d6fc75f0a10
+  data.tar.gz: 06290b9e0c60a0f54071f8e0f393c1de390b8f5713e1de02e4085085fb0bc1e0241aa38981e6b7259c0ceb2a4e07052fef3be59ebdc4f7cb613cc2af2cdb8f2f

data/.travis.yml

@@ -4,5 +4,6 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.1.1
+  - 2.2.0
 script:
     - rspec spec

data/README.md

@@ -2,19 +2,38 @@
 [![Gem Version](https://badge.fury.io/rb/ansible_spec.svg)](http://badge.fury.io/rb/ansible_spec)
 [![Build Status](https://travis-ci.org/volanja/ansible_spec.svg?branch=master)](https://travis-ci.org/volanja/ansible_spec)  
 
-This is Severspec template for Run test Multi Role and Multi Host with Ansible  
-Create template (Rakefile and spec/spec_hepler.rb)  
-Serverspec template use Ansible InventoryFile and site.yml
+This gem is Ansible Config Parser for Serverspec.  
+Serverspec RakeTask uses Ansible Config(InventoryFile and Playbook).  
+Support Run Multi Role and Multi Host of Ansible.  
+
+This gem created template file until v0.0.1.4,  
+But it was modularized on v0.1. Because module is easy to unit-test and Rakefile is simple.  
+
+If you want old release that can create template, use `gem install ansible_spec -v 0.0.1.4`  
+But I can't support(Bug fix, Add feature) old release.  
+
+## New feature at v0.1
+
+- Support Serverspec v2
+- Simplification Rakefile and Modularization. Because of Improvement of testability.
+- Support InventoryParameters  
+  - ansible_ssh_port
+  - ansible_ssh_user
+  - ansible_ssh_host
+  - ansible_ssh_private_key_file
+- Support [hostlist expressions](http://docs.ansible.com/intro_inventory.html#hosts-and-groups)
+- Support DynamicInventory
 
 ## Installation
 
 install it yourself as:
 
-    $ gem install ansible_spec
+```
+$ gem install ansible_spec
+```
 
 ## Usage
-
-### Create file Serverspec
+### Create Rakafile & spec/spec_helper.rb
 
 ```
 $ ansiblespec-init 
@@ -24,6 +43,14 @@ $ ansiblespec-init
     create  .ansiblespec
 ```
 
+### VersionUp from v0.0.1.4 to v0.1
+
+```
+$ rm Rakefile
+$ rm spec/spec_helper.md
+$ ansiblespec-init 
+```
+
 ### Change .ansiblespec(v0.0.1.3)
 If `.ansiblespec` is exist, use variables(playbook and inventory).  
 So, If you don't use `site.yml` and `hosts`, you change this file.  
@@ -65,20 +92,62 @@ sample is [here](https://github.com/volanja/ansible-sample-tdd)
 ```
 
 ### Serverspec with Ansible
-Serverspec use this file.  (Rakefile understand Notation of Ansible.)  
-
-* hosts  
-hosts can use [group_name]  
+Serverspec use Ansible file.  (Rakefile understand Notation of Ansible.)  
+
+* Inventory file
+Inventory file can sue this:
+- InventoryParameters
+  - ansible_ssh_port
+  - ansible_ssh_user
+  - ansible_ssh_private_key
+  - ansible_ssh_host
+- define hosts as expressions. `host-[1:3]` would expand into `host-1`,`host-2`,`host-3`
+- Group Children
+- [DynamicInventory](http://docs.ansible.com/intro_dynamic_inventory.html)
 
 ```hosts
 [server]
-192.168.0.103
-192.168.0.104
+# skip line(comment)
+# normal
+192.168.0.1
+# use port 5309
+192.168.0.3:5309
+# use port 22
+192.168.0.2 ansible_ssh_port=22
+# use Private-key ~/.ssh/id_rsa
+192.168.0.4 ansible_ssh_private_key_file=~/.ssh/id_rsa
+# use user `git`
+192.168.0.5 ansible_ssh_user=git
+# use port 5555 & host 192.168.1.50
+jumper ansible_ssh_port=5555 ansible_ssh_host=192.168.1.50
+
+[web]
+# www1.example.com to www99.example.com
+www[1:99].example.com
+# www01.example.com to www99.example.com
+www[01:99].example.com
+
+[databases]
+# db-a.example.com to db-z.example.com
+db-[a:z].example.com
+# db-A.example.com to db-Z.example.com
+db-[A:Z].example.com
+
+# Multi Group. use server & databases
+[parent:children]
+server
+databases
+```
 
+or DynamicInventory(need execute permission)
+
+```example that DynamicInventory
+#!/bin/bash
+echo '{"databases": {"hosts": ["host1.example.com", "host2.example.com"],"vars":{"a": true}}}'
 ```
 
-* site.yml  
-site.yml can use ```include```  
+* playbook
+playbook can use `include`  
 
 ```site.yml
 - name: Ansible-Sample-TDD
@@ -86,12 +155,18 @@ site.yml can use ```include```
   user: root
   roles:
     - nginx
+- name: Ansible-Sample-TDD2
+  hosts: parent
+  user: root
+  roles:
+    - nginx
 ```
 
-## Run Test
+## Run Test(Sample)
 ```
 $ rake -T
-rake serverspec:Ansible-Sample-TDD  # Run serverspec for Ansible-Sample-TDD
+rake serverspec:Ansible-Sample-TDD   # Run serverspec for Ansible-Sample-TDD
+rake serverspec:Ansible-Sample-TDD2  # Run serverspec for Ansible-Sample-TDD2
 
 $ rake serverspec:Ansible-Sample-TDD
 Run serverspec for Ansible-Sample-TDD to 192.168.0.103

data/ansible_spec.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.version       = AnsibleSpec::VERSION
   gem.authors       = ["volanja"]
   gem.email         = ["volaaanja@gmail.com"]
-  gem.description   = %q{This is Severspec template for Run test Multi Role and Multi Host with Ansible}
-  gem.summary       = %q{This is Severspec template for Run test Multi Role and Multi Host with Ansbile}
-  gem.homepage      = "https://github.com/volanja"
+  gem.description   = %q{Ansible Config Parser for Serverspec. Run test Multi Role and Multi Host by Ansible Configuration}
+  gem.summary       = %q{Ansible Config Parser for Serverspec. Run test Multi Role and Multi Host by Ansible Configuration}
+  gem.homepage      = "https://github.com/volanja/ansible_spec"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
@@ -20,7 +20,11 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"
+  gem.add_development_dependency "diff-lcs"
+  gem.add_development_dependency "simplecov"
 
-  gem.add_runtime_dependency "serverspec", ">= 0.13.5"
+  gem.add_runtime_dependency "serverspec", ">= 2.0.0"
+  gem.add_runtime_dependency "hostlist_expression"
+  gem.add_runtime_dependency "oj"
 
 end

data/lib/ansible_spec.rb

@@ -1,4 +1,5 @@
 require "ansible_spec/version"
+require "ansible_spec/load_ansible"
 require "fileutils"
 
 # Reference
@@ -16,41 +17,7 @@ module AnsibleSpec
 
 
   def self.safe_create_spec_helper
-    content = <<'EOF'
-require 'serverspec'
-require 'pathname'
-require 'net/ssh'
-
-include SpecInfra::Helper::Ssh
-include SpecInfra::Helper::DetectOS
-
-RSpec.configure do |c|
-  if ENV['ASK_SUDO_PASSWORD']
-    require 'highline/import'
-    c.sudo_password = ask("Enter sudo password: ") { |q| q.echo = false }
-  else
-    c.sudo_password = ENV['SUDO_PASSWORD']
-  end
-  c.before :all do
-    block = self.class.metadata[:example_group_block]
-    if RUBY_VERSION.start_with?('1.8')
-      file = block.to_s.match(/.*@(.*):[0-9]+>/)[1]
-    else
-      file = block.source_location.first
-    end
-    host  = ENV['TARGET_HOST']
-    if c.host != host
-      c.ssh.close if c.ssh
-      c.host  = host
-      options = Net::SSH::Config.for(c.host)
-      user    = ENV['TARGET_USER']
-      options[:keys] = ENV['TARGET_PRIVATE_KEY']
-      c.ssh   = Net::SSH.start(host, user, options)
-    end
-  end
-end
-
-EOF
+    content = File.open(File.dirname(__FILE__) + "/../lib/src/spec/spec_helper.rb").read
     safe_mkdir("spec")
     safe_touch("spec/spec_helper.rb")
     File.open("spec/spec_helper.rb", 'w') do |f|
@@ -60,110 +27,15 @@ EOF
   end
 
   def self.safe_create_rakefile
-    content = <<'EOF'
-require 'rake'
-require 'rspec/core/rake_task'
-require 'yaml'
-
-# param: none
-# return: @playbook, @inventoryfile
-def load_ansiblespec()
-  f = '.ansiblespec'
-  if File.exist?(f)
-    y = YAML.load_file(f)
-    @playbook = y[0]['playbook']
-    @inventoryfile = y[0]['inventory']
-  else
-    @playbook = 'site.yml'
-    @inventoryfile = 'hosts'
-  end
-  if File.exist?(@playbook) == false
-    puts 'Error: ' + @playbook + ' is not Found. create site.yml or /.ansiblespec  See https://github.com/volanja/ansible_spec'
-    exit 1
-  elsif File.exist?(@inventoryfile) == false
-    puts 'Error: ' + @inventoryfile + ' is not Found. create hosts or /.ansiblespec  See https://github.com/volanja/ansible_spec'
-    exit 1
-  end
-end
-
-# param: inventory file of Ansible
-# return: Hash {"active_group_name" => ["192.168.0.1","192.168.0.2"]}
-def load_host(file)
-  hosts = File.open(file).read
-  active_group = Hash.new
-  active_group_name = ''
-  hosts.each_line{|line|
-    line = line.chomp
-    next if line.start_with?('#')
-    if line.start_with?('[') && line.end_with?(']')
-      active_group_name = line.gsub('[','').gsub(']','')
-      active_group["#{active_group_name}"] = Array.new
-    elsif active_group_name.empty? == false
-      next if line.empty? == true
-      active_group["#{active_group_name}"] << line
-    end
-  }
-  return active_group
-end
-
-# main
-load_ansiblespec
-load_file = YAML.load_file(@playbook)
-
-# e.g. comment-out
-if load_file === false
-  puts 'Error: No data in site.yml'
-  exit
-end
-
-properties = Array.new
-load_file.each do |site|
-  if site.has_key?("include")
-    properties.push YAML.load_file(site["include"])[0]
-  else
-    properties.push site
-  end
-end
-
-
-#load inventry file
-hosts = load_host(@inventoryfile)
-properties.each do |var|
-  if hosts.has_key?("#{var["hosts"]}")
-    var["hosts"] = hosts["#{var["hosts"]}"]
-  end
-end
-
-namespace :serverspec do
-  properties.each do |var|
-    var["hosts"].each do |host|
-      desc "Run serverspec for #{var["name"]}"
-      RSpec::Core::RakeTask.new(var["name"].to_sym) do |t|
-        puts "Run serverspec for #{var["name"]} to #{host}"
-        ENV['TARGET_HOST'] = host
-        ENV['TARGET_PRIVATE_KEY'] = '~/.ssh/id_rsa'
-        ENV['TARGET_USER'] = var["user"]
-        t.pattern = 'roles/{' + var["roles"].join(',') + '}/spec/*_spec.rb'
-      end
-    end
-  end
-end
-
-EOF
+    content = File.open(File.dirname(__FILE__) + "/../lib/src/Rakefile").read
     safe_touch("Rakefile")
     File.open("Rakefile", 'w') do |f|
       f.puts content
     end
-    
   end
 
   def self.safe_create_ansiblespec
-    content = <<'EOF'
---- 
-- 
-  playbook: site.yml
-  inventory: hosts
-EOF
+    content = File.open(File.dirname(__FILE__) + "/../lib/src/.ansiblespec").read
     safe_touch(".ansiblespec")
     File.open(".ansiblespec", 'w') do |f|
       f.puts content

data/lib/ansible_spec/load_ansible.rb

@@ -0,0 +1,179 @@
+require 'hostlist_expression'
+require 'oj'
+
+module AnsibleSpec
+  # param: inventory file of Ansible
+  # return: Hash {"group" => ["192.168.0.1","192.168.0.2"]}
+  # return: Hash {"group" => [{"name" => "192.168.0.1","uri" => "192.168.0.1", "port" => 22},...]}
+  def self.load_targets(file)
+    if File.executable?(file)
+      return get_dynamic_inventory(file)
+    end
+    f = File.open(file).read
+    res = Hash.new
+    group = ''
+    f.each_line{|line|
+      line = line.chomp
+      # skip
+      next if line.start_with?('#') #comment
+      next if line.empty? == true   #null
+
+      # get group
+      if line.start_with?('[') && line.end_with?(']')
+        group = line.gsub('[','').gsub(']','')
+        res["#{group}"] = Array.new
+        next
+      end
+
+      #get host
+      if group.empty? == false
+        host = Hash.new
+        # 1つのみ、かつ:を含まない場合
+        if line.split.count == 1 && !line.include?(":")
+          # 192.168.0.1
+          res["#{group}"] << line
+          next
+        elsif line.split.count == 1 && line.include?("[") && line.include?("]")
+          # www[01:50].example.com
+          # db-[a:f].example.com
+          hostlist_expression(line,":").each{|h|
+            res["#{group}"] << h
+          }
+          next
+        else
+          res["#{group}"] << get_inventory_param(line)
+          next
+        end
+      end
+    }
+
+    # parse children [group:children]
+    search = Regexp.new(":children".to_s)
+    res.keys.each{|k|
+      unless (k =~ search).nil?
+        # get group parent & merge parent
+        res.merge!(get_parent(res,search,k))
+        # delete group children
+        if res.has_key?("#{k}") && res.has_key?("#{k.gsub(search,'')}")
+          res.delete("#{k}")
+        end
+      end
+    }
+    return res
+  end
+
+  # param  hash   {"server"=>["192.168.0.103"], "databases"=>["192.168.0.104"], "pg:children"=>["server", "databases"]}
+  # param  search ":children"
+  # param  k      "pg:children"
+  # return {"server"=>["192.168.0.103"], "databases"=>["192.168.0.104"], "pg"=>["192.168.0.103", "192.168.0.104"]}
+  def self.get_parent(hash,search,k)
+    k_parent = k.gsub(search,'')
+    arry = Array.new
+    hash["#{k}"].each{|group|
+      arry = arry + hash["#{group}"]
+    }
+    h = Hash.new
+    h["#{k_parent}"] = arry
+    return h
+  end
+
+  # param filename
+  #       {"databases":{"hosts":["aaa.com","bbb.com"],"vars":{"a":true}}}
+  # return {"databases"=>["aaa.com", "bbb.com"]}
+  def self.get_dynamic_inventory(file)
+    so, se, st = Open3.capture3("./#{file}")
+    res = Hash.new
+    Oj.load(so.to_s).each{|k,v|
+      res["#{k.to_s}"] = v['hosts']
+    }
+    return res
+  end
+
+  # param ansible_ssh_port=22
+  # return: hash
+  def self.get_inventory_param(line)
+    host = Hash.new
+    # 初期値
+    host['name'] = line
+    host['port'] = 22
+    if line.include?(":") # 192.168.0.1:22
+      host['uri']  = line.split(":")[0]
+      host['port'] = line.split(":")[1].to_i
+      return host
+    end
+    # 192.168.0.1 ansible_ssh_port=22
+    line.split.each{|v|
+      unless v.include?("=")
+        host['uri'] = v
+      else
+        key,value = v.split("=")
+        host['port'] = value.to_i if key == "ansible_ssh_port"
+        host['private_key'] = value if key == "ansible_ssh_private_key_file"
+        host['user'] = value if key == "ansible_ssh_user"
+        host['uri'] = value if key == "ansible_ssh_host"
+      end
+    }
+    return host
+  end
+
+  # param: none
+  # return: playbook, inventoryfile
+  def self.load_ansiblespec()
+    f = '.ansiblespec'
+    if File.exist?(f)
+      y = YAML.load_file(f)
+      playbook = y[0]['playbook']
+      inventoryfile = y[0]['inventory']
+    else
+      playbook = 'site.yml'
+      inventoryfile = 'hosts'
+    end
+    if File.exist?(playbook) == false
+      puts 'Error: ' + playbook + ' is not Found. create site.yml or ./.ansiblespec  See https://github.com/volanja/ansible_spec'
+      exit 1
+    elsif File.exist?(inventoryfile) == false
+      puts 'Error: ' + inventoryfile + ' is not Found. create hosts or ./.ansiblespec  See https://github.com/volanja/ansible_spec'
+      exit 1
+    end
+    return playbook, inventoryfile
+  end
+
+  # param: playbook
+  # return: json
+  #         {"name"=>"Ansible-Sample-TDD", "hosts"=>"server", "user"=>"root", "roles"=>["nginx", "mariadb"]}
+  def self.load_playbook(f)
+    playbook = YAML.load_file(f)
+
+    # e.g. comment-out
+    if playbook === false
+      puts 'Error: No data in site.yml'
+      exit
+    end
+    properties = Array.new
+    playbook.each do |site|
+      if site.has_key?("include")
+        properties.push YAML.load_file(site["include"])[0]
+      else
+        properties.push site
+      end
+    end
+    return properties
+  end
+
+  # return: json
+  # {"name"=>"Ansible-Sample-TDD", "hosts"=>["192.168.0.103"], "user"=>"root", "roles"=>["nginx", "mariadb"]}
+  def self.get_properties()
+    playbook, inventoryfile = load_ansiblespec
+
+    #load inventry file
+    # inventory fileとplaybookのhostsをマッピングする。
+    hosts = load_targets(inventoryfile)
+    properties = load_playbook(playbook)
+    properties.each do |var|
+      if hosts.has_key?("#{var["hosts"]}")
+        var["hosts"] = hosts["#{var["hosts"]}"]
+      end
+    end
+    return properties
+  end
+end