ansible_spec 0.2.24 → 0.2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0866b7bafc7f4af084f4e132e9c3238e7618e7568b1c029fe8997cf4c511c86f'
-  data.tar.gz: 81e964b2f1751f33eb8f6805c953488b4a965d1bc3e20f4577e4b6feb2fe7dc6
+  metadata.gz: c590bfdd84716132e5a14c1ac3aa372aada32bbbc6f5e80e20c412db07cdcd48
+  data.tar.gz: bc136b7cc0ee1af57b2d9b4183de15b0efe20747b36b8cf023d4a5c3f6b51873
 SHA512:
-  metadata.gz: c349056c633eafd1f5835e362a326ca9fef0a52e482939828081df43ab7227a8cebedcf750963984d79df67c7ccc88349afc4ac67b517df2a209c67a3225d509
-  data.tar.gz: ee0722a55e92a7c0109553ad198ae2b0aefaf3f78e3a754137f95b55873060498ff0ec7a420732520c51c740be72108aa6c65b7d47ac96ecc17b5d490e93c9b4
+  metadata.gz: adfac09e9e273d179093a7d9aed9bec84b67cca40136958d6b387d6e2454370f2d1ebb3fc918d3ee508ad97b1e124da5b553c349596f1ab5e8372fb7792d33f8
+  data.tar.gz: aaea9c5fc67e8d9bf3f4966ba4673baac23229cc78a6d4e1a7cdee360eec7fc48920d50eed0d5c3f080583afe65677d3b73bda2925c64b35e7188e7cd8bf758d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 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)
 

data/lib/ansible_spec/load_ansible.rb

@@ -8,9 +8,15 @@ require 'ansible_spec/vendor/hash'
 
 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
@@ -67,8 +73,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 +87,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"]}
@@ -488,7 +506,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

data/lib/ansible_spec/version.rb

@@ -1,3 +1,3 @@
 module AnsibleSpec
-  VERSION = "0.2.24"
+  VERSION = "0.2.25"
 end

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/get_variable_spec.rb

@@ -254,6 +254,114 @@ describe "get_variablesの実行" do
     end
   end
 
+  context 'Correct operation : group vars for group1 hosts ' do
+    before do
+      @current_dir = Dir.pwd()
+      Dir.chdir('spec/case/get_variable/group_each_vars_parent_child/')
+      ENV["PLAYBOOK"] = 'site1.yml'
+      ENV["INVENTORY"] = 'hosts'
+      ENV["VARS_DIRS_PATH"] = ''
+      @res = AnsibleSpec.get_variables("192.168.1.1", 0, "group1")
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 6 pair in Hash' do
+      expect(@res.length).to eq 6
+    end
+
+    it 'exist each pair' do
+      expect(@res).to include( {"role_var"=>"group1"},
+                               {"site_var"=>"group1"},
+                               {"host_var"=>"group1"},
+                               {"group_var"=>"group1"},
+                               {"group_var_parent"=>"parentgroup"},
+                               {"group_all_var"=>"group all"}
+                             )
+    end
+
+    after do
+      ENV.delete('PLAYBOOK')
+      ENV.delete('INVENTORY')
+      ENV.delete('VARS_DIRS_PATH')
+      Dir.chdir(@current_dir)
+    end
+  end
+
+  context 'Correct operation : group vars for group2 hosts ' do
+    before do
+      @current_dir = Dir.pwd()
+      Dir.chdir('spec/case/get_variable/group_each_vars_parent_child/')
+      ENV["PLAYBOOK"] = 'site2.yml'
+      ENV["INVENTORY"] = 'hosts'
+      ENV["VARS_DIRS_PATH"] = ''
+      @res = AnsibleSpec.get_variables("192.168.1.2", 0, "group2")
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 6 pair in Hash' do
+      expect(@res.length).to eq 6
+    end
+
+    it 'exist each pair' do
+      expect(@res).to include( {"role_var"=>"group2"},
+                               {"site_var"=>"group2"},
+                               {"host_var"=>"group2"},
+                               {"group_var"=>"group2"},
+                               {"group_var_parent"=>"parentgroup"},
+                               {"group_all_var"=>"group all"}
+                             )
+    end
+
+    after do
+      ENV.delete('PLAYBOOK')
+      ENV.delete('INVENTORY')
+      ENV.delete('VARS_DIRS_PATH')
+      Dir.chdir(@current_dir)
+    end
+  end
+
+  context 'Correct operation : group vars for parentgroup hosts ' do
+    before do
+      @current_dir = Dir.pwd()
+      Dir.chdir('spec/case/get_variable/group_each_vars_parent_child/')
+      ENV["PLAYBOOK"] = 'site3.yml'
+      ENV["INVENTORY"] = 'hosts'
+      ENV["VARS_DIRS_PATH"] = ''
+      @res = AnsibleSpec.get_variables("192.168.1.1", 0, "parentgroup")
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 6 pair in Hash' do
+      expect(@res.length).to eq 6
+    end
+
+    it 'exist each pair' do
+      expect(@res).to include( {"role_var"=>"parentgroup"},
+                               {"site_var"=>"parentgroup"},
+                               {"host_var"=>"parentgroup"},
+                               {"group_var"=>"parentgroup"},
+                               {"group_var_parent"=>"parentgroup"},
+                               {"group_all_var"=>"group all"}
+                             )
+    end
+
+    after do
+      ENV.delete('PLAYBOOK')
+      ENV.delete('INVENTORY')
+      ENV.delete('VARS_DIRS_PATH')
+      Dir.chdir(@current_dir)
+    end
+  end
+
 end
 
 describe "get_hash_behaviourの実行" do

data/spec/load_ansible_spec.rb

@@ -400,6 +400,229 @@ EOF
     end
   end
 
+  context 'load_targets:Test invalid return_type' do
+    tmp_hosts = 'hosts'
+    content_excpetion_msg = "Variable return_type must be value 'groups' or 'groups_parent_child_relationships'"
+    before do
+      content_h = <<'EOF'
+[server]
+192.168.0.103
+192.168.0.104 ansible_ssh_port=22
+
+[databases]
+192.168.0.105
+192.168.0.106 ansible_ssh_port=5555
+
+[pg:children]
+server
+databases
+EOF
+      create_file(tmp_hosts,content_h)
+      begin
+        @res = AnsibleSpec.load_targets(tmp_hosts, return_type='some_invalid_option')
+      rescue ArgumentError => e
+        @res = e.message
+      end
+    end
+
+    it 'res is string' do
+      expect(@res.instance_of?(String)).to be_truthy
+    end
+
+    it 'exist 1 string' do
+      expect(@res.length).to eq content_excpetion_msg.length
+    end
+
+    it 'exist string' do
+      expect(@res).to include(content_excpetion_msg)
+    end
+
+    after do
+      File.delete(tmp_hosts)
+    end
+  end
+
+  context 'load_targets:Return groups; default return_type (="groups")' do
+    tmp_hosts = 'hosts'
+    before do
+      content_h = <<'EOF'
+[server]
+192.168.0.103
+192.168.0.104 ansible_ssh_port=22
+
+[databases]
+192.168.0.105
+192.168.0.106 ansible_ssh_port=5555
+
+[pg:children]
+server
+databases
+EOF
+      create_file(tmp_hosts,content_h)
+      @res = AnsibleSpec.load_targets(tmp_hosts)
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 1 group' do
+      expect(@res.length).to eq 3
+    end
+
+    it 'exist group' do
+      expect(@res.key?('server')).to be_truthy
+      expect(@res.key?('databases')).to be_truthy
+      expect(@res.key?('pg')).to be_truthy
+      expect(@res.key?('pg:children')).not_to be_truthy
+    end
+
+    it 'pg 192.168.0.103' do
+      obj = @res['pg'][0]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj).to include({'name' => '192.168.0.103',
+                              'uri' => '192.168.0.103',
+                              'port' => 22})
+    end
+
+    it 'pg 192.168.0.104 ansible_ssh_port=22' do
+      obj = @res['pg'][1]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj['name']).to eq '192.168.0.104 ansible_ssh_port=22'
+      expect(obj['uri']).to eq '192.168.0.104'
+      expect(obj['port']).to eq 22
+    end
+
+    it 'pg 192.168.0.105' do
+      obj = @res['pg'][2]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj).to include({'name' => '192.168.0.105',
+                              'uri' => '192.168.0.105',
+                              'port' => 22})
+    end
+
+    it 'pg 192.168.0.106 ansible_ssh_port=5555' do
+      obj = @res['pg'][3]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj['name']).to eq '192.168.0.106 ansible_ssh_port=5555'
+      expect(obj['uri']).to eq '192.168.0.106'
+      expect(obj['port']).to eq 5555
+    end
+
+    after do
+      File.delete(tmp_hosts)
+    end
+  end
+
+  context 'load_targets:Return groups; return_type="groups"' do
+    tmp_hosts = 'hosts'
+    before do
+      content_h = <<'EOF'
+[server]
+192.168.0.103
+192.168.0.104 ansible_ssh_port=22
+
+[databases]
+192.168.0.105
+192.168.0.106 ansible_ssh_port=5555
+
+[pg:children]
+server
+databases
+EOF
+      create_file(tmp_hosts,content_h)
+      @res = AnsibleSpec.load_targets(tmp_hosts, return_type='groups')
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 1 group' do
+      expect(@res.length).to eq 3
+    end
+
+    it 'exist group' do
+      expect(@res.key?('server')).to be_truthy
+      expect(@res.key?('databases')).to be_truthy
+      expect(@res.key?('pg')).to be_truthy
+      expect(@res.key?('pg:children')).not_to be_truthy
+    end
+
+    it 'pg 192.168.0.103' do
+      obj = @res['pg'][0]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj).to include({'name' => '192.168.0.103',
+                              'uri' => '192.168.0.103',
+                              'port' => 22})
+    end
+
+    it 'pg 192.168.0.104 ansible_ssh_port=22' do
+      obj = @res['pg'][1]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj['name']).to eq '192.168.0.104 ansible_ssh_port=22'
+      expect(obj['uri']).to eq '192.168.0.104'
+      expect(obj['port']).to eq 22
+    end
+
+    it 'pg 192.168.0.105' do
+      obj = @res['pg'][2]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj).to include({'name' => '192.168.0.105',
+                              'uri' => '192.168.0.105',
+                              'port' => 22})
+    end
+
+    it 'pg 192.168.0.106 ansible_ssh_port=5555' do
+      obj = @res['pg'][3]
+      expect(obj.instance_of?(Hash)).to be_truthy
+      expect(obj['name']).to eq '192.168.0.106 ansible_ssh_port=5555'
+      expect(obj['uri']).to eq '192.168.0.106'
+      expect(obj['port']).to eq 5555
+    end
+
+    after do
+      File.delete(tmp_hosts)
+    end
+  end
+
+  context 'load_targets:Return groups parent child relationships; return_type="groups_parent_child_relationships"' do
+    tmp_hosts = 'hosts'
+    before do
+      content_h = <<'EOF'
+[server]
+192.168.0.103
+192.168.0.104 ansible_ssh_port=22
+
+[databases]
+192.168.0.105
+192.168.0.106 ansible_ssh_port=5555
+
+[pg:children]
+server
+databases
+EOF
+      create_file(tmp_hosts,content_h)
+      @res = AnsibleSpec.load_targets(tmp_hosts, return_type='groups_parent_child_relationships')
+    end
+
+    it 'res is hash' do
+      expect(@res.instance_of?(Hash)).to be_truthy
+    end
+
+    it 'exist 1 group parent child relationship in Hash' do
+      expect(@res.length).to eq 1
+    end
+
+    it 'exist each pair' do
+      expect(@res).to include({"pg"=>["server", "databases"]})
+    end
+
+    after do
+      File.delete(tmp_hosts)
+    end
+  end
+
 end
 
 describe "load_playbookの実行" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible_spec
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 0.2.25
 platform: ruby
 authors:
 - volanja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-18 00:00:00.000000000 Z
+date: 2018-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,6 +184,15 @@ files:
 - spec/case/get_variable/group_each_vars/group_vars/group1.yml
 - spec/case/get_variable/group_each_vars/hosts
 - spec/case/get_variable/group_each_vars/site.yml
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/all.yml
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/group1/vars
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/group2/vars
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/parentgroup/vars
+- spec/case/get_variable/group_each_vars_parent_child/hosts
+- spec/case/get_variable/group_each_vars_parent_child/site.yml
+- spec/case/get_variable/group_each_vars_parent_child/site1.yml
+- spec/case/get_variable/group_each_vars_parent_child/site2.yml
+- spec/case/get_variable/group_each_vars_parent_child/site3.yml
 - spec/case/get_variable/group_host_playbook/group_vars/all.yml
 - spec/case/get_variable/group_host_playbook/group_vars/group1.yml
 - spec/case/get_variable/group_host_playbook/host_vars/192.168.1.1.yml
@@ -362,6 +371,15 @@ test_files:
 - spec/case/get_variable/group_each_vars/group_vars/group1.yml
 - spec/case/get_variable/group_each_vars/hosts
 - spec/case/get_variable/group_each_vars/site.yml
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/all.yml
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/group1/vars
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/group2/vars
+- spec/case/get_variable/group_each_vars_parent_child/group_vars/parentgroup/vars
+- spec/case/get_variable/group_each_vars_parent_child/hosts
+- spec/case/get_variable/group_each_vars_parent_child/site.yml
+- spec/case/get_variable/group_each_vars_parent_child/site1.yml
+- spec/case/get_variable/group_each_vars_parent_child/site2.yml
+- spec/case/get_variable/group_each_vars_parent_child/site3.yml
 - spec/case/get_variable/group_host_playbook/group_vars/all.yml
 - spec/case/get_variable/group_host_playbook/group_vars/group1.yml
 - spec/case/get_variable/group_host_playbook/host_vars/192.168.1.1.yml