Adding ability to systematically modify yaml from ansible.

3 files changed, 537 insertions, 0 deletions

diff --git a/roles/lib_utils/src/test/integration/files/kube-manager.yaml b/roles/lib_utils/src/test/integration/files/kube-manager.yaml
new file mode 100644
index 000000000..6f4b9e6dc
--- /dev/null
+++ b/roles/lib_utils/src/test/integration/files/kube-manager.yaml
@@ -0,0 +1,39 @@
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  name: kube-controller-manager
+  namespace: kube-system
+spec:
+  hostNetwork: true
+  containers:
+  - name: kube-controller-manager
+    image: openshift/kube:v1.0.0
+    command:
+    - /hyperkube
+    - controller-manager
+    - --master=http://127.0.0.1:8080
+    - --leader-elect=true
+    - --service-account-private-key-file=/etc/kubernetes/ssl/apiserver-key.pem
+    - --root-ca-file=/etc/kubernetes/ssl/ca.pem
+    livenessProbe:
+      httpGet:
+        host: 127.0.0.1
+        path: /healthz
+        port: 10252
+      initialDelaySeconds: 15
+      timeoutSeconds: 1
+    volumeMounts:
+    - mountPath: /etc/kubernetes/ssl
+      name: ssl-certs-kubernetes
+      readOnly: true
+    - mountPath: /etc/ssl/certs
+      name: ssl-certs-host
+      readOnly: true
+  volumes:
+  - hostPath:
+      path: /etc/kubernetes/ssl
+    name: ssl-certs-kubernetes
+  - hostPath:
+      path: /usr/share/ca-certificates
+    name: ssl-certs-host
diff --git a/roles/lib_utils/src/test/integration/yedit_test.yml b/roles/lib_utils/src/test/integration/yedit_test.yml
new file mode 100755
index 000000000..1760a7466
--- /dev/null
+++ b/roles/lib_utils/src/test/integration/yedit_test.yml
@@ -0,0 +1,221 @@
+#!/usr/bin/ansible-playbook
+# Yedit test so that we can quickly determine if features are working
+# Ensure that the kube-manager.yaml file exists
+#
+# ./yedit_test.yml -M ../../library
+#
+---
+- hosts: localhost
+  gather_facts: no
+  vars:
+    test_file: kube-manager-test.yaml
+    test: test
+  strategy: debug
+
+  post_tasks:
+  - name: copy the kube-manager.yaml file so that we have a pristine copy each time
+    copy:
+      src: kube-manager.yaml
+      dest: "./{{ test_file }}"
+    changed_when: False
+
+  ####### add key to top level #####
+  - name: add a key at the top level
+    yedit:
+      src: "{{ test_file }}"
+      key: yedittest
+      value: yedittest
+
+  - name: retrieve the inserted key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: yedittest
+    register: results
+
+  - name: Assert that key is at top level
+    assert:
+      that: results.result == 'yedittest'
+      msg: 'Test: add a key to top level failed.  yedittest != [{{ results.result }}]'
+  ###### end add key to top level #####
+
+  ###### modify multilevel key, value #####
+  - name: modify multilevel key, value
+    yedit:
+      src: "{{ test_file }}"
+      key: metadata-namespace
+      value: openshift-is-awesome
+      separator: '-'
+
+  - name: retrieve the inserted key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: metadata-namespace
+      separator: '-'
+    register: results
+
+  - name: Assert that key is as expected
+    assert:
+      that: results.result == 'openshift-is-awesome'
+      msg: 'Test: multilevel key, value modification:  openshift-is-awesome != [{{ results.result }}]'
+  ###### end modify multilevel key, value #####
+
+  ###### test a string boolean #####
+  - name: test a string boolean
+    yedit:
+      src: "{{ test_file }}"
+      key: spec.containers[0].volumeMounts[1].readOnly
+      value: 'true'
+      value_type: str
+
+  - name: retrieve the inserted key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: spec.containers[0].volumeMounts[1].readOnly
+    register: results
+
+  - name: Assert that key is a string
+    assert:
+      that: results.result == "true"
+      msg: "Test: boolean str:  'true' != [{{ results.result }}]"
+
+  - name: Assert that key is not bool
+    assert:
+      that: results.result != true
+      msg: "Test: boolean str:  true != [{{ results.result }}]"
+  ###### end test boolean string #####
+
+  ###### test array append #####
+  - name: test array append
+    yedit:
+      src: "{{ test_file }}"
+      key: spec.containers[0].command
+      value: --my-new-parameter=openshift
+      append: True
+
+  - name: retrieve the array
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: spec.containers[0].command
+    register: results
+
+  - name: Assert that the last element in array is our value
+    assert:
+      that: results.result[-1] == "--my-new-parameter=openshift"
+      msg: "Test: '--my-new-parameter=openshift' != [{{ results.result[-1] }}]"
+  ###### end test array append #####
+
+  ###### test non-existing array append #####
+  - name: test array append to non-existing key
+    yedit:
+      src: "{{ test_file }}"
+      key: nonexistingkey
+      value: --my-new-parameter=openshift
+      append: True
+
+  - name: retrieve the array
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: nonexistingkey
+    register: results
+
+  - name: Assert that the last element in array is our value
+    assert:
+      that: results.result[-1] == "--my-new-parameter=openshift"
+      msg: "Test: '--my-new-parameter=openshift' != [{{ results.result[-1] }}]"
+  ###### end test non-existing array append #####
+
+  ###### test array update modify #####
+  - name: test array update modify
+    yedit:
+      src: "{{ test_file }}"
+      key: spec.containers[0].command
+      value: --root-ca-file=/etc/k8s/ssl/my.pem
+      curr_value: --root-ca-file=/etc/kubernetes/ssl/ca.pem
+      curr_value_format: str
+      update: True
+
+  - name: retrieve the array
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: spec.containers[0].command
+    register: results
+
+  - name: Assert that the element in array is our value
+    assert:
+      that: results.result[5] == "--root-ca-file=/etc/k8s/ssl/my.pem"
+      msg: "Test: '--root-ca-file=/etc/k8s/ssl/my.pem' != [{{ results.result[5] }}]"
+  ###### end test array update modify#####
+
+  ###### test dict create #####
+  - name: test dict create
+    yedit:
+      src: "{{ test_file }}"
+      key: a.b.c
+      value: d
+
+  - name: retrieve the key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: a.b.c
+    register: results
+
+  - name: Assert that the key was created
+    assert:
+      that: results.result == "d"
+      msg: "Test: 'd' != [{{ results.result }}]"
+  ###### end test dict create #####
+
+  ###### test create dict value #####
+  - name: test create dict value
+    yedit:
+      src: "{{ test_file }}"
+      key: e.f.g
+      value:
+        h:
+          i:
+            j: k
+
+  - name: retrieve the key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: e.f.g.h.i.j
+    register: results
+
+  - name: Assert that the key was created
+    assert:
+      that: results.result == "k"
+      msg: "Test: 'k' != [{{ results.result }}]"
+  ###### end test dict create #####
+
+  ###### test create list value #####
+  - name: test create list value
+    yedit:
+      src: "{{ test_file }}"
+      key: z.x.y
+      value:
+      - 1
+      - 2
+      - 3
+
+  - name: retrieve the key
+    yedit:
+      src: "{{ test_file }}"
+      state: list
+      key: z#x#y
+      separator: '#'
+    register: results
+  - debug: var=results
+
+  - name: Assert that the key was created
+    assert:
+      that: results.result == [1, 2, 3]
+      msg: "Test: '[1, 2, 3]' != [{{ results.result }}]"
+###### end test create list value #####
diff --git a/roles/lib_utils/src/test/unit/yedit_test.py b/roles/lib_utils/src/test/unit/yedit_test.py
new file mode 100755
index 000000000..2793c5c1a
--- /dev/null
+++ b/roles/lib_utils/src/test/unit/yedit_test.py
@@ -0,0 +1,277 @@
+#!/usr/bin/env python2
+'''
+ Unit tests for yedit
+'''
+# To run
+# python -m unittest yedit_test
+#
+# .............................
+# ----------------------------------------------------------------------
+# Ran 29 tests in 0.133s
+# OK
+
+import os
+import sys
+import unittest
+
+# Removing invalid variable names for tests so that I can
+# keep them brief
+# pylint: disable=invalid-name,no-name-in-module
+# Disable import-error b/c our libraries aren't loaded in jenkins
+# pylint: disable=import-error
+# place yedit in our path
+yedit_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library')  # noqa: E501
+sys.path.insert(0, yedit_path)
+
+from yedit import Yedit  # noqa: E402
+
+# pylint: disable=too-many-public-methods
+# Silly pylint, moar tests!
+
+
+class YeditTest(unittest.TestCase):
+    '''
+     Test class for yedit
+    '''
+    data = {'a': 'a',
+            'b': {'c': {'d': [{'e': 'x'}, 'f', 'g']}},
+           }  # noqa: E124
+
+    filename = 'yedit_test.yml'
+
+    def setUp(self):
+        ''' setup method will create a file and set to known configuration '''
+        yed = Yedit(YeditTest.filename)
+        yed.yaml_dict = YeditTest.data
+        yed.write()
+
+    def test_load(self):
+        ''' Testing a get '''
+        yed = Yedit('yedit_test.yml')
+        self.assertEqual(yed.yaml_dict, self.data)
+
+    def test_write(self):
+        ''' Testing a simple write '''
+        yed = Yedit('yedit_test.yml')
+        yed.put('key1', 1)
+        yed.write()
+        self.assertTrue('key1' in yed.yaml_dict)
+        self.assertEqual(yed.yaml_dict['key1'], 1)
+
+    def test_write_x_y_z(self):
+        '''Testing a write of multilayer key'''
+        yed = Yedit('yedit_test.yml')
+        yed.put('x.y.z', 'modified')
+        yed.write()
+        yed.load()
+        self.assertEqual(yed.get('x.y.z'), 'modified')
+
+    def test_delete_a(self):
+        '''Testing a simple delete '''
+        yed = Yedit('yedit_test.yml')
+        yed.delete('a')
+        yed.write()
+        yed.load()
+        self.assertTrue('a' not in yed.yaml_dict)
+
+    def test_delete_b_c(self):
+        '''Testing delete of layered key '''
+        yed = Yedit('yedit_test.yml', separator=':')
+        yed.delete('b:c')
+        yed.write()
+        yed.load()
+        self.assertTrue('b' in yed.yaml_dict)
+        self.assertFalse('c' in yed.yaml_dict['b'])
+
+    def test_create(self):
+        '''Testing a create '''
+        os.unlink(YeditTest.filename)
+        yed = Yedit('yedit_test.yml')
+        yed.create('foo', 'bar')
+        yed.write()
+        yed.load()
+        self.assertTrue('foo' in yed.yaml_dict)
+        self.assertTrue(yed.yaml_dict['foo'] == 'bar')
+
+    def test_create_content(self):
+        '''Testing a create with content '''
+        content = {"foo": "bar"}
+        yed = Yedit("yedit_test.yml", content)
+        yed.write()
+        yed.load()
+        self.assertTrue('foo' in yed.yaml_dict)
+        self.assertTrue(yed.yaml_dict['foo'], 'bar')
+
+    def test_array_insert(self):
+        '''Testing a create with content '''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', 'inject')
+        self.assertTrue(yed.get('b:c:d[0]') == 'inject')
+
+    def test_array_insert_first_index(self):
+        '''Testing a create with content '''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', 'inject')
+        self.assertTrue(yed.get('b:c:d[1]') == 'f')
+
+    def test_array_insert_second_index(self):
+        '''Testing a create with content '''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', 'inject')
+        self.assertTrue(yed.get('b:c:d[2]') == 'g')
+
+    def test_dict_array_dict_access(self):
+        '''Testing a create with content'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', [{'x': {'y': 'inject'}}])
+        self.assertTrue(yed.get('b:c:d[0]:[0]:x:y') == 'inject')
+
+    def test_dict_array_dict_replace(self):
+        '''Testing multilevel delete'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', [{'x': {'y': 'inject'}}])
+        yed.put('b:c:d[0]:[0]:x:y', 'testing')
+        self.assertTrue('b' in yed.yaml_dict)
+        self.assertTrue('c' in yed.yaml_dict['b'])
+        self.assertTrue('d' in yed.yaml_dict['b']['c'])
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'], list))
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'][0], list))
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'][0][0], dict))
+        self.assertTrue('y' in yed.yaml_dict['b']['c']['d'][0][0]['x'])
+        self.assertTrue(yed.yaml_dict['b']['c']['d'][0][0]['x']['y'] == 'testing')  # noqa: E501
+
+    def test_dict_array_dict_remove(self):
+        '''Testing multilevel delete'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', [{'x': {'y': 'inject'}}])
+        yed.delete('b:c:d[0]:[0]:x:y')
+        self.assertTrue('b' in yed.yaml_dict)
+        self.assertTrue('c' in yed.yaml_dict['b'])
+        self.assertTrue('d' in yed.yaml_dict['b']['c'])
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'], list))
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'][0], list))
+        self.assertTrue(isinstance(yed.yaml_dict['b']['c']['d'][0][0], dict))
+        self.assertFalse('y' in yed.yaml_dict['b']['c']['d'][0][0]['x'])
+
+    def test_key_exists_in_dict(self):
+        '''Testing exist in dict'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', [{'x': {'y': 'inject'}}])
+        self.assertTrue(yed.exists('b:c', 'd'))
+
+    def test_key_exists_in_list(self):
+        '''Testing exist in list'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('b:c:d[0]', [{'x': {'y': 'inject'}}])
+        self.assertTrue(yed.exists('b:c:d', [{'x': {'y': 'inject'}}]))
+        self.assertFalse(yed.exists('b:c:d', [{'x': {'y': 'test'}}]))
+
+    def test_update_to_list_with_index(self):
+        '''Testing update to list with index'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('x:y:z', [1, 2, 3])
+        yed.update('x:y:z', [5, 6], index=2)
+        self.assertTrue(yed.get('x:y:z') == [1, 2, [5, 6]])
+        self.assertTrue(yed.exists('x:y:z', [5, 6]))
+        self.assertFalse(yed.exists('x:y:z', 4))
+
+    def test_update_to_list_with_curr_value(self):
+        '''Testing update to list with index'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('x:y:z', [1, 2, 3])
+        yed.update('x:y:z', [5, 6], curr_value=3)
+        self.assertTrue(yed.get('x:y:z') == [1, 2, [5, 6]])
+        self.assertTrue(yed.exists('x:y:z', [5, 6]))
+        self.assertFalse(yed.exists('x:y:z', 4))
+
+    def test_update_to_list(self):
+        '''Testing update to list'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('x:y:z', [1, 2, 3])
+        yed.update('x:y:z', [5, 6])
+        self.assertTrue(yed.get('x:y:z') == [1, 2, 3, [5, 6]])
+        self.assertTrue(yed.exists('x:y:z', [5, 6]))
+        self.assertFalse(yed.exists('x:y:z', 4))
+
+    def test_append_twice_to_list(self):
+        '''Testing append to list'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('x:y:z', [1, 2, 3])
+        yed.append('x:y:z', [5, 6])
+        yed.append('x:y:z', [5, 6])
+        self.assertTrue(yed.get('x:y:z') == [1, 2, 3, [5, 6], [5, 6]])
+        self.assertTrue(2 == yed.get('x:y:z').count([5, 6]))
+        self.assertFalse(yed.exists('x:y:z', 4))
+
+    def test_add_item_to_dict(self):
+        '''Testing update to dict'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('x:y:z', {'a': 1, 'b': 2})
+        yed.update('x:y:z', {'c': 3, 'd': 4})
+        self.assertTrue(yed.get('x:y:z') == {'a': 1, 'b': 2, 'c': 3, 'd': 4})
+        self.assertTrue(yed.exists('x:y:z', {'c': 3}))
+
+    def test_first_level_dict_with_none_value(self):
+        '''test dict value with none value'''
+        yed = Yedit(content={'a': None}, separator=":")
+        yed.put('a:b:c', 'test')
+        self.assertTrue(yed.get('a:b:c') == 'test')
+        self.assertTrue(yed.get('a:b'), {'c': 'test'})
+
+    def test_adding_yaml_variable(self):
+        '''test dict value with none value'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('z:y', '{{test}}')
+        self.assertTrue(yed.get('z:y') == '{{test}}')
+
+    def test_keys_with_underscore(self):
+        '''test dict value with none value'''
+        yed = Yedit("yedit_test.yml", separator=':')
+        yed.put('z_:y_y', {'test': '{{test}}'})
+        self.assertTrue(yed.get('z_:y_y') == {'test': '{{test}}'})
+
+    def test_first_level_array_update(self):
+        '''test update on top level array'''
+        yed = Yedit(content=[{'a': 1}, {'b': 2}, {'b': 3}], separator=':')
+        yed.update('', {'c': 4})
+        self.assertTrue({'c': 4} in yed.get(''))
+
+    def test_first_level_array_delete(self):
+        '''test remove top level key'''
+        yed = Yedit(content=[{'a': 1}, {'b': 2}, {'b': 3}])
+        yed.delete('')
+        self.assertTrue({'b': 3} not in yed.get(''))
+
+    def test_first_level_array_get(self):
+        '''test dict value with none value'''
+        yed = Yedit(content=[{'a': 1}, {'b': 2}, {'b': 3}])
+        yed.get('')
+        self.assertTrue([{'a': 1}, {'b': 2}, {'b': 3}] == yed.yaml_dict)
+
+    def test_pop_list_item(self):
+        '''test dict value with none value'''
+        yed = Yedit(content=[{'a': 1}, {'b': 2}, {'b': 3}], separator=':')
+        yed.pop('', {'b': 2})
+        self.assertTrue([{'a': 1}, {'b': 3}] == yed.yaml_dict)
+
+    def test_pop_list_item_2(self):
+        '''test dict value with none value'''
+        z = range(10)
+        yed = Yedit(content=z, separator=':')
+        yed.pop('', 5)
+        z.pop(5)
+        self.assertTrue(z == yed.yaml_dict)
+
+    def test_pop_dict_key(self):
+        '''test dict value with none value'''
+        yed = Yedit(content={'a': {'b': {'c': 1, 'd': 2}}}, separator='#')
+        yed.pop('a#b', 'c')
+        self.assertTrue({'a': {'b': {'d': 2}}} == yed.yaml_dict)
+
+    def tearDown(self):
+        '''TearDown method'''
+        os.unlink(YeditTest.filename)
+
+
+if __name__ == "__main__":
+    unittest.main()