ansible_spec 0.2.23 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea92ad1db5c6331ab0f51cb0cc9f8357d6fad5a1
-  data.tar.gz: 3529e094be9910fb8acb9c1e3df7661e4e21135e
+SHA256:
+  metadata.gz: d77ce9fa38453ab6f652cc6c20a79509c722d615790cb49b59ec8e37154aad7b
+  data.tar.gz: 27384622e2d91ad928ee5b37fa061efa3b80af5baad5b887823ec3df7e83dded
 SHA512:
-  metadata.gz: 4f8121627c3ffb1b2011e8b77d2ef0704b8f64ab59075c2973e7768c7fb26a1c21606332acdb7a6faedc1d4d17be4287abf354de010fc4c72ded2d7db003aa88
-  data.tar.gz: ded735c540319da5a2443d9639390f3e0a5d915a5249e410d0295f3f32b99b09bcc6625384d2778784bf8f7484f4f199a6a5c52b6dce9eb2f0a6149927f59d3b
+  metadata.gz: 2591637e35a8fa5fe8f2add17e24d5f32844030d9fd1f268ec4a0e607bb4f2500ef8a75c166c337d20c8e97c8db979dc1bdf317f64f5f93095493699bef37665
+  data.tar.gz: e1124d4328dc3430545f94a87306fc9148f3b91bc5074d84180edac293966115b15794e5ecd142335a2c972415143f7893bf6516d951bfb4b4ffd1f2855d561d

data/.travis.yml

@@ -1,12 +1,15 @@
 language: ruby
+dist: trusty  # work at Ubuntu 14.04 for install Ruby 1.9.3
 sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.10
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 script:
     - rspec spec

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# v0.3.2
+- Merge [#135 Fix wrong index by empty group](https://github.com/volanja/ansible_spec/pull/135) by [mamiya312](https://github.com/mamiya312)
+
+# v0.3.1
+- Fix [#126 no implicit conversion of nil into Array Error when process get_parent](https://github.com/volanja/ansible_spec/issues/126) by [shogos3](https://github.com/shogos3)
+
+# v0.3
+- Support Ansible Vault  (Run Ruby 2.1.0 and higher.)
+ - Merge [#116 Feature ansible vault](https://github.com/volanja/ansible_spec/pull/116) by [RebelCodeBase](https://github.com/RebelCodeBase)
+ - Merge [#123 skip test at unsupported version ref ansible vault](https://github.com/volanja/ansible_spec/pull/123) by volanja
+
+And Some Bug Fixed. See [Milestone v0.3](https://github.com/volanja/ansible_spec/milestone/13?closed=1)
+
+# v0.2.25
+- Merge [#118 Incorporate group parent child relationships into variable assignment hierarchy](https://github.com/volanja/ansible_spec/pull/118) by [rbramwell](https://github.com/rbramwell)
+
+# v0.2.24
+- Merge [#117 Feature resolve variables](https://github.com/volanja/ansible_spec/pull/117) by [RebelCodeBase](https://github.com/RebelCodeBase)
+
 # v0.2.23
 - Merge [#115 Support import_playbook](https://github.com/volanja/ansible_spec/pull/115) by [seiji](https://github.com/seiji)
 - Merge [#113 Make ENV variables override SSH config file options](https://github.com/volanja/ansible_spec/pull/113) by [Jonnymcc](https://github.com/Jonnymcc)

data/Gemfile

@@ -13,3 +13,8 @@ if Gem::Version.new(RUBY_VERSION.dup) <= Gem::Version.new('1.9.3')
   # winrm 2.1.1 dropped Ruby 1.9 support.
   gem 'winrm', '< 2.1.1'
 end
+
+if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1')
+  # Ansible::Vault support Ruby 2.1.0 and higher.
+  gem 'ansible-vault'
+end

data/README.md

@@ -1,6 +1,6 @@
 # ansible_spec
 
-[![Gem Version](https://badge.fury.io/rb/ansible_spec.svg)](http://badge.fury.io/rb/ansible_spec)
+[![Gem Version](https://badge.fury.io/rb/ansible_spec.svg)](https://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 a Ruby gem that implements an Ansible Config Parser for Serverspec.

data/ansible_spec.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "bundler"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "diff-lcs"
   gem.add_development_dependency "simplecov"
@@ -28,5 +28,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "oj"
   gem.add_runtime_dependency "winrm"
   gem.add_runtime_dependency "inifile"
+  gem.add_runtime_dependency "ansible-vault"
 
 end

data/lib/ansible_spec/load_ansible.rb

@@ -5,12 +5,21 @@ require 'open3'
 require 'yaml'
 require 'inifile'
 require 'ansible_spec/vendor/hash'
+if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1')
+  require 'ansible/vault'
+end
 
 module AnsibleSpec
   # param: inventory file of Ansible
+  # param: return_type 'groups' or 'groups_parent_child_relationships'
   # 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)
+  # return: Hash {"pg" => ["server", "databases"]}
+  def self.load_targets(file, return_type = 'groups')
+    if not ['groups', 'groups_parent_child_relationships'].include?(return_type)
+      raise ArgumentError, "Variable return_type must be value 'groups' or 'groups_parent_child_relationships'"
+    end
+
     if File.executable?(file)
       return get_dynamic_inventory(file)
     end
@@ -20,7 +29,7 @@ module AnsibleSpec
     hosts = Hash.new
     hosts.default = Hash.new
     f.each_line{|line|
-      line = line.chomp
+      line = line.strip
       # skip
       next if line.start_with?('#') #comment
       next if line.empty? == true   #null
@@ -67,8 +76,12 @@ module AnsibleSpec
 
     # parse children [group:children]
     search = Regexp.new(":children".to_s)
+    groups_parent_child_relationships = Hash.new
     groups.keys.each{|k|
       unless (k =~ search).nil?
+        # get parent child relationships
+        k_parent = k.gsub(search,'')
+        groups_parent_child_relationships["#{k_parent}"] = groups["#{k}"]
         # get group parent & merge parent
         groups.merge!(get_parent(groups,search,k))
         # delete group children
@@ -77,7 +90,15 @@ module AnsibleSpec
         end
       end
     }
-    return groups
+
+    return_value = groups # default
+    if return_type == 'groups'
+      return_value = groups
+    elsif return_type == 'groups_parent_child_relationships'
+      return_value = groups_parent_child_relationships
+    end
+
+    return return_value
   end
 
   # param  hash   {"server"=>["192.168.0.103"], "databases"=>["192.168.0.104"], "pg:children"=>["server", "databases"]}
@@ -140,6 +161,7 @@ module AnsibleSpec
     # 初期値
     host['name'] = line
     host['port'] = 22
+    host['connection'] = "ssh"
     if line.include?(":") # 192.168.0.1:22
       host['uri']  = line.split(":")[0]
       host['port'] = line.split(":")[1].to_i
@@ -347,15 +369,39 @@ module AnsibleSpec
       if File.directory?(vars_file)
         Dir.glob(File.join(vars_file, '*')).each { |f|
           vars = load_vars_file(vars, f)
-	}
+        }
       else
-        yaml = YAML.load_file(vars_file)
-        vars = merge_variables(vars, yaml)
+        # you can use Ansible::Vault when use ruby 2.1.0 and higher.
+        # Ansible::Vault support Ruby 2.1.0 and higher.
+        if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1')
+          if Ansible::Vault.encrypted?(vars_file)
+            yaml = load_encrypted_file(vars_file)
+          else
+            yaml = YAML.load_file(vars_file)
+          end
+          vars = merge_variables(vars, yaml)
+        else
+          # Ruby 1.9 and 2.0
+          yaml = YAML.load_file(vars_file)
+          vars = merge_variables(vars, yaml)
+        end
       end
     end
     return vars
   end
 
+  # param: variable file
+  # return: be merged hash
+  def self.load_encrypted_file(vars_file)
+    cfg = AnsibleSpec::AnsibleCfg.new
+    vault_password_file = cfg.get('defaults', 'vault_password_file')
+    if vault_password_file
+      vault_password = File.open(vault_password_file).read.chomp
+      yaml = YAML.load(Ansible::Vault.read(path: vars_file, password: vault_password))
+    end
+    return yaml
+  end
+
   # param: target hash
   # param: be merged hash
   def self.merge_variables(vars, hash)
@@ -431,9 +477,46 @@ module AnsibleSpec
       target_host.keys[0]
   end
 
+  # query replace jinja2 templates with target values 
+  # param: hash (cf. result self.get_variables)
+  # param: number of iterations if found_template
+  # return: hash
+  def self.resolve_variables(vars, max_level=100)
+    vars_yaml = vars.to_yaml
+    level = 0
+    begin
+      found_template = false
+      level += 1
+
+      # query replace jinja2 templates in yaml
+      # replace in-place (gsub!)
+      # use non-greedy regex (.*?)
+      vars_yaml.gsub!(/{{.*?}}/) do |template|
+
+        # grab target variable
+        # ignore whitespaces (\s*)
+        # use non-greedy regex (.*?)
+        target = template.gsub(/{{\s*(.*?)\s*}}/, '\1')
+        
+        # lookup value of target variable
+        value = vars[target]
+        
+        # return lookup value if it exists
+        # or leave template alone  
+        if value.nil? 
+          template
+        else 
+          found_template = true
+          value
+        end
+      end
+    end while found_template and level <= max_level
+    return YAML.load(vars_yaml)
+  end
+
   def self.get_variables(host, group_idx, hosts=nil)
     vars = {}
-    p = self.get_properties
+    p = self.get_properties.compact.reject{|e| e["hosts"].length == 0}
 
     # roles default
     p[group_idx]['roles'].each do |role|
@@ -451,7 +534,21 @@ module AnsibleSpec
 
     # each group vars
     if p[group_idx].has_key?('group')
-      vars = load_vars_file(vars ,"#{vars_dirs_path}group_vars/#{p[group_idx]['group']}", true)
+      # get groups parent child relationships
+      playbook, inventoryfile = load_ansiblespec
+      groups_rels = load_targets(inventoryfile, return_type='groups_parent_child_relationships')
+      # get parental lineage
+      g = p[group_idx]['group']
+      groups_stack = Array.new
+      groups_stack << g
+      groups_rels.keys.each{|k|
+        groups_stack << k if (groups_rels[k].include?(g))
+      }
+      # get vars from parents groups then child group
+      groups_parents_then_child = groups_stack.reverse.flatten
+      groups_parents_then_child.each{|group|
+        vars = load_vars_file(vars ,"#{vars_dirs_path}group_vars/#{group}", true)
+      }
     end
 
     # each host vars
@@ -479,7 +576,7 @@ module AnsibleSpec
       end
     end
 
-    return vars
+    return resolve_variables(vars)
 
   end
 

data/lib/ansible_spec/version.rb

@@ -1,3 +1,3 @@
 module AnsibleSpec
-  VERSION = "0.2.23"
+  VERSION = "0.3.2"
 end

data/lib/src/spec/spec_helper.rb

@@ -23,15 +23,16 @@ when 'ssh'
 #
   set :backend, :ssh
 
+  # Ansible use `BECOME`, But Serverspec use `SUDO`.
   if ENV['ASK_BECOME_PASSWORD']
     begin
       require 'highline/import'
     rescue LoadError
       fail "highline is not available. Try installing it."
     end
-    set :become_password, ask("Enter become password: ") { |q| q.echo = false }
+    set :sudo_password, ask("Enter become password: ") { |q| q.echo = false }
   else
-    set :become_password, ENV['BECOME_PASSWORD']
+    set :sudo_password, ENV['BECOME_PASSWORD']
   end
 
   options = Net::SSH::Config.for(host)
@@ -48,8 +49,8 @@ when 'ssh'
   set :host,        options[:host_name] || host
   set :ssh_options, options
 
-  # Disable become
-  # set :become, false
+  # Disable become (Serverspec use sudo)
+  # set :disable_sudo, true
 
 
   # Set environment variables

data/spec/case/get_variable/empty_group/group_vars/group_a.yml

@@ -0,0 +1,2 @@
+---
+group_a_var: hoge

data/spec/case/get_variable/empty_group/group_vars/group_b.yml

@@ -0,0 +1,2 @@
+---
+group_b_var: fuga

data/spec/case/get_variable/empty_group/hosts

@@ -0,0 +1,3 @@
+[group_a]
+[group_b]
+localhost.localdomain ansible_ssh_private_key_file=~/.ssh/id_rsa

data/spec/case/get_variable/empty_group/site.yml

@@ -0,0 +1,9 @@
+---
+- name: playbook_a
+  hosts: group_a
+  roles:
+    - role_a
+- name: playbook_b
+  hosts: group_b
+  roles:
+    - role_b

data/spec/case/get_variable/group_each_vars_parent_child/group_vars/all.yml

@@ -0,0 +1,6 @@
+---
+role_var:  "group all"
+site_var:  "group all"
+host_var:  "group all"
+group_var: "group all"
+group_all_var: "group all"

data/spec/case/get_variable/group_each_vars_parent_child/group_vars/group1/vars

@@ -0,0 +1,4 @@
+role_var:  "group1"
+site_var:  "group1"
+host_var:  "group1"
+group_var: 'group1'

data/spec/case/get_variable/group_each_vars_parent_child/group_vars/group2/vars

@@ -0,0 +1,4 @@
+role_var:  "group2"
+site_var:  "group2"
+host_var:  "group2"
+group_var: 'group2'

data/spec/case/get_variable/group_each_vars_parent_child/group_vars/parentgroup/vars

@@ -0,0 +1,5 @@
+role_var:  "parentgroup"
+site_var:  "parentgroup"
+host_var:  "parentgroup"
+group_var: 'parentgroup'
+group_var_parent: 'parentgroup'

data/spec/case/get_variable/group_each_vars_parent_child/hosts

@@ -0,0 +1,13 @@
+[group1]
+192.168.1.1
+
+[group2]
+192.168.1.2
+
+[all]
+192.168.1.1
+192.168.1.2
+
+[parentgroup:children]
+group1
+group2

data/spec/case/get_variable/group_each_vars_parent_child/site.yml

@@ -0,0 +1,6 @@
+- name: group1
+  hosts: group1
+  connection: local
+  roles:
+  - test
+  - test/nested

data/spec/case/get_variable/group_each_vars_parent_child/site1.yml

@@ -0,0 +1,6 @@
+- name: group1
+  hosts: group1
+  connection: local
+  roles:
+  - test
+  - test/nested

data/spec/case/get_variable/group_each_vars_parent_child/site2.yml

@@ -0,0 +1,6 @@
+- name: group2
+  hosts: group2
+  connection: local
+  roles:
+  - test
+  - test/nested

data/spec/case/get_variable/group_each_vars_parent_child/site3.yml

@@ -0,0 +1,6 @@
+- name: parentgroup
+  hosts: parentgroup
+  connection: local
+  roles:
+  - test
+  - test/nested

data/spec/case/get_variable/resolve_variables/group_vars/all.yml

@@ -0,0 +1,24 @@
+---
+var_nested_one_1: 'val_nested_one'
+var_nested_one_2: "{{ var_nested_one_1 }}"
+
+var_nested_two_1: 'val_nested_two'
+var_nested_two_2: "{{ var_nested_two_1 }}"
+var_nested_two_3: "{{ var_nested_two_2 }}"
+
+var_nested_hash_1: 'val_hash'
+var_nested_hash_2:
+  key: "{{ var_nested_hash_1 }}"
+
+var_nested_array_1: 'val_array'
+var_nested_array_2:
+  - "{{ var_nested_array_1 }}"
+
+var_nested_array_hash_1: 'val_array_hash'
+var_nested_array_hash_2:
+  - key: "{{ var_nested_array_hash_1 }}"
+
+var_nested_whitespace_1: val_nested_whitespace
+var_nested_whitespace_2: "{{var_nested_whitespace_1  }}"
+
+var_missingtarget_2: "{{ var_missingtarget_1 }}"

data/spec/case/get_variable/resolve_variables/hosts

@@ -0,0 +1,5 @@
+[resolve]
+192.168.1.1
+
+
+