From b5de5357042c146a930097d52c3920808af89c42 Mon Sep 17 00:00:00 2001
From: Joel Diaz <jdiaz@redhat.com>
Date: Fri, 27 Jan 2017 20:39:06 +0000
Subject: oc_label ansible module

used for adding/removing labels on various OpenShift objects
---
 roles/lib_openshift/library/oc_label.py            | 1517 ++++++++++++++++++++
 roles/lib_openshift/src/ansible/oc_label.py        |   32 +
 roles/lib_openshift/src/class/oc_label.py          |  291 ++++
 roles/lib_openshift/src/doc/label                  |   65 +
 roles/lib_openshift/src/sources.yml                |   10 +
 .../src/test/integration/filter_plugins/filters.py |   25 +
 .../src/test/integration/oc_label.yml              |  404 ++++++
 7 files changed, 2344 insertions(+)
 create mode 100644 roles/lib_openshift/library/oc_label.py
 create mode 100644 roles/lib_openshift/src/ansible/oc_label.py
 create mode 100644 roles/lib_openshift/src/class/oc_label.py
 create mode 100644 roles/lib_openshift/src/doc/label
 create mode 100644 roles/lib_openshift/src/test/integration/filter_plugins/filters.py
 create mode 100755 roles/lib_openshift/src/test/integration/oc_label.yml

diff --git a/roles/lib_openshift/library/oc_label.py b/roles/lib_openshift/library/oc_label.py
new file mode 100644
index 000000000..9fc0a15b5
--- /dev/null
+++ b/roles/lib_openshift/library/oc_label.py
@@ -0,0 +1,1517 @@
+#!/usr/bin/env python
+# pylint: disable=missing-docstring
+# flake8: noqa: T001
+#     ___ ___ _  _ ___ ___    _ _____ ___ ___
+#    / __| __| \| | __| _ \  /_\_   _| __|   \
+#   | (_ | _|| .` | _||   / / _ \| | | _|| |) |
+#    \___|___|_|\_|___|_|_\/_/_\_\_|_|___|___/_ _____
+#   |   \ / _ \  | \| |/ _ \_   _| | __|   \_ _|_   _|
+#   | |) | (_) | | .` | (_) || |   | _|| |) | |  | |
+#   |___/ \___/  |_|\_|\___/ |_|   |___|___/___| |_|
+#
+# Copyright 2016 Red Hat, Inc. and/or its affiliates
+# and other contributors as indicated by the @author tags.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+'''
+   OpenShiftCLI class that wraps the oc commands in a subprocess
+'''
+# pylint: disable=too-many-lines
+
+from __future__ import print_function
+import atexit
+import json
+import os
+import re
+import shutil
+import subprocess
+# pylint: disable=import-error
+import ruamel.yaml as yaml
+from ansible.module_utils.basic import AnsibleModule
+
+DOCUMENTATION = '''
+---
+module: oc_label
+short_description: Create, modify, and idempotently manage openshift object labels.
+description:
+  - Manage openshift object labels programmatically.
+options:
+  state:
+    description:
+    - State represents whether to create, modify, delete, or list
+    required: true
+    default: present
+    choices: ["present", "absent", "list", "add"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  name:
+    description:
+    - Name of the object that is being queried.
+    required: false
+    default: None
+    aliases: []
+  namespace:
+    description:
+    - The namespace where the object lives.
+    required: false
+    default: None
+    aliases: []
+  kind:
+    description:
+    - The kind of OpenShift object being queried (node or pod).
+    required: true
+    default: None
+    choices: ["node", "pod"]
+    aliases: []
+  labels:
+    description:
+    - List of label_name=label_value items.
+    required: false
+    default: None
+    aliases: []
+  selector:
+    description:
+    - XXX
+    required: false
+    default: None
+    aliases: []
+author:
+- "Kenny Woodson <kwoodson@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: Add label to node
+  oc_label:
+    state: add
+    kind: node
+    name: ip-172-31-5-23.ec2.internal
+    labels:
+    - key: provision_date
+      value: "2017-01-01"
+'''
+# noqa: E301,E302
+
+
+class YeditException(Exception):
+    ''' Exception class for Yedit '''
+    pass
+
+
+# pylint: disable=too-many-public-methods
+class Yedit(object):
+    ''' Class to modify yaml files '''
+    re_valid_key = r"(((\[-?\d+\])|([0-9a-zA-Z%s/_-]+)).?)+$"
+    re_key = r"(?:\[(-?\d+)\])|([0-9a-zA-Z%s/_-]+)"
+    com_sep = set(['.', '#', '|', ':'])
+
+    # pylint: disable=too-many-arguments
+    def __init__(self,
+                 filename=None,
+                 content=None,
+                 content_type='yaml',
+                 separator='.',
+                 backup=False):
+        self.content = content
+        self._separator = separator
+        self.filename = filename
+        self.__yaml_dict = content
+        self.content_type = content_type
+        self.backup = backup
+        self.load(content_type=self.content_type)
+        if self.__yaml_dict is None:
+            self.__yaml_dict = {}
+
+    @property
+    def separator(self):
+        ''' getter method for yaml_dict '''
+        return self._separator
+
+    @separator.setter
+    def separator(self):
+        ''' getter method for yaml_dict '''
+        return self._separator
+
+    @property
+    def yaml_dict(self):
+        ''' getter method for yaml_dict '''
+        return self.__yaml_dict
+
+    @yaml_dict.setter
+    def yaml_dict(self, value):
+        ''' setter method for yaml_dict '''
+        self.__yaml_dict = value
+
+    @staticmethod
+    def parse_key(key, sep='.'):
+        '''parse the key allowing the appropriate separator'''
+        common_separators = list(Yedit.com_sep - set([sep]))
+        return re.findall(Yedit.re_key % ''.join(common_separators), key)
+
+    @staticmethod
+    def valid_key(key, sep='.'):
+        '''validate the incoming key'''
+        common_separators = list(Yedit.com_sep - set([sep]))
+        if not re.match(Yedit.re_valid_key % ''.join(common_separators), key):
+            return False
+
+        return True
+
+    @staticmethod
+    def remove_entry(data, key, sep='.'):
+        ''' remove data at location key '''
+        if key == '' and isinstance(data, dict):
+            data.clear()
+            return True
+        elif key == '' and isinstance(data, list):
+            del data[:]
+            return True
+
+        if not (key and Yedit.valid_key(key, sep)) and \
+           isinstance(data, (list, dict)):
+            return None
+
+        key_indexes = Yedit.parse_key(key, sep)
+        for arr_ind, dict_key in key_indexes[:-1]:
+            if dict_key and isinstance(data, dict):
+                data = data.get(dict_key, None)
+            elif (arr_ind and isinstance(data, list) and
+                  int(arr_ind) <= len(data) - 1):
+                data = data[int(arr_ind)]
+            else:
+                return None
+
+        # process last index for remove
+        # expected list entry
+        if key_indexes[-1][0]:
+            if isinstance(data, list) and int(key_indexes[-1][0]) <= len(data) - 1:  # noqa: E501
+                del data[int(key_indexes[-1][0])]
+                return True
+
+        # expected dict entry
+        elif key_indexes[-1][1]:
+            if isinstance(data, dict):
+                del data[key_indexes[-1][1]]
+                return True
+
+    @staticmethod
+    def add_entry(data, key, item=None, sep='.'):
+        ''' Get an item from a dictionary with key notation a.b.c
+            d = {'a': {'b': 'c'}}}
+            key = a#b
+            return c
+        '''
+        if key == '':
+            pass
+        elif (not (key and Yedit.valid_key(key, sep)) and
+              isinstance(data, (list, dict))):
+            return None
+
+        key_indexes = Yedit.parse_key(key, sep)
+        for arr_ind, dict_key in key_indexes[:-1]:
+            if dict_key:
+                if isinstance(data, dict) and dict_key in data and data[dict_key]:  # noqa: E501
+                    data = data[dict_key]
+                    continue
+
+                elif data and not isinstance(data, dict):
+                    return None
+
+                data[dict_key] = {}
+                data = data[dict_key]
+
+            elif (arr_ind and isinstance(data, list) and
+                  int(arr_ind) <= len(data) - 1):
+                data = data[int(arr_ind)]
+            else:
+                return None
+
+        if key == '':
+            data = item
+
+        # process last index for add
+        # expected list entry
+        elif key_indexes[-1][0] and isinstance(data, list) and int(key_indexes[-1][0]) <= len(data) - 1:  # noqa: E501
+            data[int(key_indexes[-1][0])] = item
+
+        # expected dict entry
+        elif key_indexes[-1][1] and isinstance(data, dict):
+            data[key_indexes[-1][1]] = item
+
+        return data
+
+    @staticmethod
+    def get_entry(data, key, sep='.'):
+        ''' Get an item from a dictionary with key notation a.b.c
+            d = {'a': {'b': 'c'}}}
+            key = a.b
+            return c
+        '''
+        if key == '':
+            pass
+        elif (not (key and Yedit.valid_key(key, sep)) and
+              isinstance(data, (list, dict))):
+            return None
+
+        key_indexes = Yedit.parse_key(key, sep)
+        for arr_ind, dict_key in key_indexes:
+            if dict_key and isinstance(data, dict):
+                data = data.get(dict_key, None)
+            elif (arr_ind and isinstance(data, list) and
+                  int(arr_ind) <= len(data) - 1):
+                data = data[int(arr_ind)]
+            else:
+                return None
+
+        return data
+
+    def write(self):
+        ''' write to file '''
+        if not self.filename:
+            raise YeditException('Please specify a filename.')
+
+        if self.backup and self.file_exists():
+            shutil.copy(self.filename, self.filename + '.orig')
+
+        tmp_filename = self.filename + '.yedit'
+        with open(tmp_filename, 'w') as yfd:
+            # pylint: disable=no-member
+            if hasattr(self.yaml_dict, 'fa'):
+                self.yaml_dict.fa.set_block_style()
+
+            yfd.write(yaml.dump(self.yaml_dict, Dumper=yaml.RoundTripDumper))
+
+        os.rename(tmp_filename, self.filename)
+
+        return (True, self.yaml_dict)
+
+    def read(self):
+        ''' read from file '''
+        # check if it exists
+        if self.filename is None or not self.file_exists():
+            return None
+
+        contents = None
+        with open(self.filename) as yfd:
+            contents = yfd.read()
+
+        return contents
+
+    def file_exists(self):
+        ''' return whether file exists '''
+        if os.path.exists(self.filename):
+            return True
+
+        return False
+
+    def load(self, content_type='yaml'):
+        ''' return yaml file '''
+        contents = self.read()
+
+        if not contents and not self.content:
+            return None
+
+        if self.content:
+            if isinstance(self.content, dict):
+                self.yaml_dict = self.content
+                return self.yaml_dict
+            elif isinstance(self.content, str):
+                contents = self.content
+
+        # check if it is yaml
+        try:
+            if content_type == 'yaml' and contents:
+                self.yaml_dict = yaml.load(contents, yaml.RoundTripLoader)
+                # pylint: disable=no-member
+                if hasattr(self.yaml_dict, 'fa'):
+                    self.yaml_dict.fa.set_block_style()
+            elif content_type == 'json' and contents:
+                self.yaml_dict = json.loads(contents)
+        except yaml.YAMLError as err:
+            # Error loading yaml or json
+            raise YeditException('Problem with loading yaml file. %s' % err)
+
+        return self.yaml_dict
+
+    def get(self, key):
+        ''' get a specified key'''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, key, self.separator)
+        except KeyError:
+            entry = None
+
+        return entry
+
+    def pop(self, path, key_or_item):
+        ''' remove a key, value pair from a dict or an item for a list'''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if entry is None:
+            return (False, self.yaml_dict)
+
+        if isinstance(entry, dict):
+            # pylint: disable=no-member,maybe-no-member
+            if key_or_item in entry:
+                entry.pop(key_or_item)
+                return (True, self.yaml_dict)
+            return (False, self.yaml_dict)
+
+        elif isinstance(entry, list):
+            # pylint: disable=no-member,maybe-no-member
+            ind = None
+            try:
+                ind = entry.index(key_or_item)
+            except ValueError:
+                return (False, self.yaml_dict)
+
+            entry.pop(ind)
+            return (True, self.yaml_dict)
+
+        return (False, self.yaml_dict)
+
+    def delete(self, path):
+        ''' remove path from a dict'''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if entry is None:
+            return (False, self.yaml_dict)
+
+        result = Yedit.remove_entry(self.yaml_dict, path, self.separator)
+        if not result:
+            return (False, self.yaml_dict)
+
+        return (True, self.yaml_dict)
+
+    def exists(self, path, value):
+        ''' check if value exists at path'''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if isinstance(entry, list):
+            if value in entry:
+                return True
+            return False
+
+        elif isinstance(entry, dict):
+            if isinstance(value, dict):
+                rval = False
+                for key, val in value.items():
+                    if entry[key] != val:
+                        rval = False
+                        break
+                else:
+                    rval = True
+                return rval
+
+            return value in entry
+
+        return entry == value
+
+    def append(self, path, value):
+        '''append value to a list'''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if entry is None:
+            self.put(path, [])
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        if not isinstance(entry, list):
+            return (False, self.yaml_dict)
+
+        # pylint: disable=no-member,maybe-no-member
+        entry.append(value)
+        return (True, self.yaml_dict)
+
+    # pylint: disable=too-many-arguments
+    def update(self, path, value, index=None, curr_value=None):
+        ''' put path, value into a dict '''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if isinstance(entry, dict):
+            # pylint: disable=no-member,maybe-no-member
+            if not isinstance(value, dict):
+                raise YeditException('Cannot replace key, value entry in ' +
+                                     'dict with non-dict type. value=[%s] [%s]' % (value, type(value)))  # noqa: E501
+
+            entry.update(value)
+            return (True, self.yaml_dict)
+
+        elif isinstance(entry, list):
+            # pylint: disable=no-member,maybe-no-member
+            ind = None
+            if curr_value:
+                try:
+                    ind = entry.index(curr_value)
+                except ValueError:
+                    return (False, self.yaml_dict)
+
+            elif index is not None:
+                ind = index
+
+            if ind is not None and entry[ind] != value:
+                entry[ind] = value
+                return (True, self.yaml_dict)
+
+            # see if it exists in the list
+            try:
+                ind = entry.index(value)
+            except ValueError:
+                # doesn't exist, append it
+                entry.append(value)
+                return (True, self.yaml_dict)
+
+            # already exists, return
+            if ind is not None:
+                return (False, self.yaml_dict)
+        return (False, self.yaml_dict)
+
+    def put(self, path, value):
+        ''' put path, value into a dict '''
+        try:
+            entry = Yedit.get_entry(self.yaml_dict, path, self.separator)
+        except KeyError:
+            entry = None
+
+        if entry == value:
+            return (False, self.yaml_dict)
+
+        # deepcopy didn't work
+        tmp_copy = yaml.load(yaml.round_trip_dump(self.yaml_dict,
+                                                  default_flow_style=False),
+                             yaml.RoundTripLoader)
+        # pylint: disable=no-member
+        if hasattr(self.yaml_dict, 'fa'):
+            tmp_copy.fa.set_block_style()
+        result = Yedit.add_entry(tmp_copy, path, value, self.separator)
+        if not result:
+            return (False, self.yaml_dict)
+
+        self.yaml_dict = tmp_copy
+
+        return (True, self.yaml_dict)
+
+    def create(self, path, value):
+        ''' create a yaml file '''
+        if not self.file_exists():
+            # deepcopy didn't work
+            tmp_copy = yaml.load(yaml.round_trip_dump(self.yaml_dict, default_flow_style=False),  # noqa: E501
+                                 yaml.RoundTripLoader)
+            # pylint: disable=no-member
+            if hasattr(self.yaml_dict, 'fa'):
+                tmp_copy.fa.set_block_style()
+            result = Yedit.add_entry(tmp_copy, path, value, self.separator)
+            if result:
+                self.yaml_dict = tmp_copy
+                return (True, self.yaml_dict)
+
+        return (False, self.yaml_dict)
+
+    @staticmethod
+    def get_curr_value(invalue, val_type):
+        '''return the current value'''
+        if invalue is None:
+            return None
+
+        curr_value = invalue
+        if val_type == 'yaml':
+            curr_value = yaml.load(invalue)
+        elif val_type == 'json':
+            curr_value = json.loads(invalue)
+
+        return curr_value
+
+    @staticmethod
+    def parse_value(inc_value, vtype=''):
+        '''determine value type passed'''
+        true_bools = ['y', 'Y', 'yes', 'Yes', 'YES', 'true', 'True', 'TRUE',
+                      'on', 'On', 'ON', ]
+        false_bools = ['n', 'N', 'no', 'No', 'NO', 'false', 'False', 'FALSE',
+                       'off', 'Off', 'OFF']
+
+        # It came in as a string but you didn't specify value_type as string
+        # we will convert to bool if it matches any of the above cases
+        if isinstance(inc_value, str) and 'bool' in vtype:
+            if inc_value not in true_bools and inc_value not in false_bools:
+                raise YeditException('Not a boolean type. str=[%s] vtype=[%s]'
+                                     % (inc_value, vtype))
+        elif isinstance(inc_value, bool) and 'str' in vtype:
+            inc_value = str(inc_value)
+
+        # If vtype is not str then go ahead and attempt to yaml load it.
+        if isinstance(inc_value, str) and 'str' not in vtype:
+            try:
+                inc_value = yaml.load(inc_value)
+            except Exception:
+                raise YeditException('Could not determine type of incoming ' +
+                                     'value. value=[%s] vtype=[%s]'
+                                     % (type(inc_value), vtype))
+
+        return inc_value
+
+    # pylint: disable=too-many-return-statements,too-many-branches
+    @staticmethod
+    def run_ansible(module):
+        '''perform the idempotent crud operations'''
+        yamlfile = Yedit(filename=module.params['src'],
+                         backup=module.params['backup'],
+                         separator=module.params['separator'])
+
+        if module.params['src']:
+            rval = yamlfile.load()
+
+            if yamlfile.yaml_dict is None and \
+               module.params['state'] != 'present':
+                return {'failed': True,
+                        'msg': 'Error opening file [%s].  Verify that the ' +
+                               'file exists, that it is has correct' +
+                               ' permissions, and is valid yaml.'}
+
+        if module.params['state'] == 'list':
+            if module.params['content']:
+                content = Yedit.parse_value(module.params['content'],
+                                            module.params['content_type'])
+                yamlfile.yaml_dict = content
+
+            if module.params['key']:
+                rval = yamlfile.get(module.params['key']) or {}
+
+            return {'changed': False, 'result': rval, 'state': "list"}
+
+        elif module.params['state'] == 'absent':
+            if module.params['content']:
+                content = Yedit.parse_value(module.params['content'],
+                                            module.params['content_type'])
+                yamlfile.yaml_dict = content
+
+            if module.params['update']:
+                rval = yamlfile.pop(module.params['key'],
+                                    module.params['value'])
+            else:
+                rval = yamlfile.delete(module.params['key'])
+
+            if rval[0] and module.params['src']:
+                yamlfile.write()
+
+            return {'changed': rval[0], 'result': rval[1], 'state': "absent"}
+
+        elif module.params['state'] == 'present':
+            # check if content is different than what is in the file
+            if module.params['content']:
+                content = Yedit.parse_value(module.params['content'],
+                                            module.params['content_type'])
+
+                # We had no edits to make and the contents are the same
+                if yamlfile.yaml_dict == content and \
+                   module.params['value'] is None:
+                    return {'changed': False,
+                            'result': yamlfile.yaml_dict,
+                            'state': "present"}
+
+                yamlfile.yaml_dict = content
+
+            # we were passed a value; parse it
+            if module.params['value']:
+                value = Yedit.parse_value(module.params['value'],
+                                          module.params['value_type'])
+                key = module.params['key']
+                if module.params['update']:
+                    # pylint: disable=line-too-long
+                    curr_value = Yedit.get_curr_value(Yedit.parse_value(module.params['curr_value']),  # noqa: E501
+                                                      module.params['curr_value_format'])  # noqa: E501
+
+                    rval = yamlfile.update(key, value, module.params['index'], curr_value)  # noqa: E501
+
+                elif module.params['append']:
+                    rval = yamlfile.append(key, value)
+                else:
+                    rval = yamlfile.put(key, value)
+
+                if rval[0] and module.params['src']:
+                    yamlfile.write()
+
+                return {'changed': rval[0],
+                        'result': rval[1], 'state': "present"}
+
+            # no edits to make
+            if module.params['src']:
+                # pylint: disable=redefined-variable-type
+                rval = yamlfile.write()
+                return {'changed': rval[0],
+                        'result': rval[1],
+                        'state': "present"}
+
+        return {'failed': True, 'msg': 'Unkown state passed'}
+# pylint: disable=too-many-lines
+# noqa: E301,E302,E303,T001
+
+
+class OpenShiftCLIError(Exception):
+    '''Exception class for openshiftcli'''
+    pass
+
+
+# pylint: disable=too-few-public-methods
+class OpenShiftCLI(object):
+    ''' Class to wrap the command line tools '''
+    def __init__(self,
+                 namespace,
+                 kubeconfig='/etc/origin/master/admin.kubeconfig',
+                 verbose=False,
+                 all_namespaces=False):
+        ''' Constructor for OpenshiftCLI '''
+        self.namespace = namespace
+        self.verbose = verbose
+        self.kubeconfig = kubeconfig
+        self.all_namespaces = all_namespaces
+
+    # Pylint allows only 5 arguments to be passed.
+    # pylint: disable=too-many-arguments
+    def _replace_content(self, resource, rname, content, force=False, sep='.'):
+        ''' replace the current object with the content '''
+        res = self._get(resource, rname)
+        if not res['results']:
+            return res
+
+        fname = '/tmp/%s' % rname
+        yed = Yedit(fname, res['results'][0], separator=sep)
+        changes = []
+        for key, value in content.items():
+            changes.append(yed.put(key, value))
+
+        if any([change[0] for change in changes]):
+            yed.write()
+
+            atexit.register(Utils.cleanup, [fname])
+
+            return self._replace(fname, force)
+
+        return {'returncode': 0, 'updated': False}
+
+    def _replace(self, fname, force=False):
+        '''replace the current object with oc replace'''
+        cmd = ['replace', '-f', fname]
+        if force:
+            cmd.append('--force')
+        return self.openshift_cmd(cmd)
+
+    def _create_from_content(self, rname, content):
+        '''create a temporary file and then call oc create on it'''
+        fname = '/tmp/%s' % rname
+        yed = Yedit(fname, content=content)
+        yed.write()
+
+        atexit.register(Utils.cleanup, [fname])
+
+        return self._create(fname)
+
+    def _create(self, fname):
+        '''call oc create on a filename'''
+        return self.openshift_cmd(['create', '-f', fname])
+
+    def _delete(self, resource, rname, selector=None):
+        '''call oc delete on a resource'''
+        cmd = ['delete', resource, rname]
+        if selector:
+            cmd.append('--selector=%s' % selector)
+
+        return self.openshift_cmd(cmd)
+
+    def _process(self, template_name, create=False, params=None, template_data=None):  # noqa: E501
+        '''process a template
+
+           template_name: the name of the template to process
+           create: whether to send to oc create after processing
+           params: the parameters for the template
+           template_data: the incoming template's data; instead of a file
+        '''
+        cmd = ['process']
+        if template_data:
+            cmd.extend(['-f', '-'])
+        else:
+            cmd.append(template_name)
+        if params:
+            param_str = ["%s=%s" % (key, value) for key, value in params.items()]
+            cmd.append('-v')
+            cmd.extend(param_str)
+
+        results = self.openshift_cmd(cmd, output=True, input_data=template_data)
+
+        if results['returncode'] != 0 or not create:
+            return results
+
+        fname = '/tmp/%s' % template_name
+        yed = Yedit(fname, results['results'])
+        yed.write()
+
+        atexit.register(Utils.cleanup, [fname])
+
+        return self.openshift_cmd(['create', '-f', fname])
+
+    def _get(self, resource, rname=None, selector=None):
+        '''return a resource by name '''
+        cmd = ['get', resource]
+        if selector:
+            cmd.append('--selector=%s' % selector)
+
+        cmd.extend(['-o', 'json'])
+
+        if rname:
+            cmd.append(rname)
+
+        rval = self.openshift_cmd(cmd, output=True)
+
+        # Ensure results are retuned in an array
+        if 'items' in rval:
+            rval['results'] = rval['items']
+        elif not isinstance(rval['results'], list):
+            rval['results'] = [rval['results']]
+
+        return rval
+
+    def _schedulable(self, node=None, selector=None, schedulable=True):
+        ''' perform oadm manage-node scheduable '''
+        cmd = ['manage-node']
+        if node:
+            cmd.extend(node)
+        else:
+            cmd.append('--selector=%s' % selector)
+
+        cmd.append('--schedulable=%s' % schedulable)
+
+        return self.openshift_cmd(cmd, oadm=True, output=True, output_type='raw')  # noqa: E501
+
+    def _list_pods(self, node=None, selector=None, pod_selector=None):
+        ''' perform oadm list pods
+
+            node: the node in which to list pods
+            selector: the label selector filter if provided
+            pod_selector: the pod selector filter if provided
+        '''
+        cmd = ['manage-node']
+        if node:
+            cmd.extend(node)
+        else:
+            cmd.append('--selector=%s' % selector)
+
+        if pod_selector:
+            cmd.append('--pod-selector=%s' % pod_selector)
+
+        cmd.extend(['--list-pods', '-o', 'json'])
+
+        return self.openshift_cmd(cmd, oadm=True, output=True, output_type='raw')
+
+    # pylint: disable=too-many-arguments
+    def _evacuate(self, node=None, selector=None, pod_selector=None, dry_run=False, grace_period=None, force=False):
+        ''' perform oadm manage-node evacuate '''
+        cmd = ['manage-node']
+        if node:
+            cmd.extend(node)
+        else:
+            cmd.append('--selector=%s' % selector)
+
+        if dry_run:
+            cmd.append('--dry-run')
+
+        if pod_selector:
+            cmd.append('--pod-selector=%s' % pod_selector)
+
+        if grace_period:
+            cmd.append('--grace-period=%s' % int(grace_period))
+
+        if force:
+            cmd.append('--force')
+
+        cmd.append('--evacuate')
+
+        return self.openshift_cmd(cmd, oadm=True, output=True, output_type='raw')
+
+    def _version(self):
+        ''' return the openshift version'''
+        return self.openshift_cmd(['version'], output=True, output_type='raw')
+
+    def _import_image(self, url=None, name=None, tag=None):
+        ''' perform image import '''
+        cmd = ['import-image']
+
+        image = '{0}'.format(name)
+        if tag:
+            image += ':{0}'.format(tag)
+
+        cmd.append(image)
+
+        if url:
+            cmd.append('--from={0}/{1}'.format(url, image))
+
+        cmd.append('-n{0}'.format(self.namespace))
+
+        cmd.append('--confirm')
+        return self.openshift_cmd(cmd)
+
+    # pylint: disable=too-many-arguments,too-many-branches
+    def openshift_cmd(self, cmd, oadm=False, output=False, output_type='json', input_data=None):
+        '''Base command for oc '''
+        cmds = []
+        if oadm:
+            cmds = ['/usr/bin/oadm']
+        else:
+            cmds = ['/usr/bin/oc']
+
+        if self.all_namespaces:
+            cmds.extend(['--all-namespaces'])
+        elif self.namespace:
+            cmds.extend(['-n', self.namespace])
+
+        cmds.extend(cmd)
+
+        rval = {}
+        results = ''
+        err = None
+
+        if self.verbose:
+            print(' '.join(cmds))
+
+        proc = subprocess.Popen(cmds,
+                                stdin=subprocess.PIPE,
+                                stdout=subprocess.PIPE,
+                                stderr=subprocess.PIPE,
+                                env={'KUBECONFIG': self.kubeconfig})
+
+        stdout, stderr = proc.communicate(input_data)
+        rval = {"returncode": proc.returncode,
+                "results": results,
+                "cmd": ' '.join(cmds)}
+
+        if proc.returncode == 0:
+            if output:
+                if output_type == 'json':
+                    try:
+                        rval['results'] = json.loads(stdout)
+                    except ValueError as err:
+                        if "No JSON object could be decoded" in err.args:
+                            err = err.args
+                elif output_type == 'raw':
+                    rval['results'] = stdout
+
+            if self.verbose:
+                print("STDOUT: {0}".format(stdout))
+                print("STDERR: {0}".format(stderr))
+
+            if err:
+                rval.update({"err": err,
+                             "stderr": stderr,
+                             "stdout": stdout,
+                             "cmd": cmds})
+
+        else:
+            rval.update({"stderr": stderr,
+                         "stdout": stdout,
+                         "results": {}})
+
+        return rval
+
+
+class Utils(object):
+    ''' utilities for openshiftcli modules '''
+    @staticmethod
+    def create_file(rname, data, ftype='yaml'):
+        ''' create a file in tmp with name and contents'''
+        path = os.path.join('/tmp', rname)
+        with open(path, 'w') as fds:
+            if ftype == 'yaml':
+                fds.write(yaml.dump(data, Dumper=yaml.RoundTripDumper))
+
+            elif ftype == 'json':
+                fds.write(json.dumps(data))
+            else:
+                fds.write(data)
+
+        # Register cleanup when module is done
+        atexit.register(Utils.cleanup, [path])
+        return path
+
+    @staticmethod
+    def create_files_from_contents(content, content_type=None):
+        '''Turn an array of dict: filename, content into a files array'''
+        if not isinstance(content, list):
+            content = [content]
+        files = []
+        for item in content:
+            path = Utils.create_file(item['path'], item['data'], ftype=content_type)
+            files.append({'name': os.path.basename(path), 'path': path})
+        return files
+
+    @staticmethod
+    def cleanup(files):
+        '''Clean up on exit '''
+        for sfile in files:
+            if os.path.exists(sfile):
+                if os.path.isdir(sfile):
+                    shutil.rmtree(sfile)
+                elif os.path.isfile(sfile):
+                    os.remove(sfile)
+
+    @staticmethod
+    def exists(results, _name):
+        ''' Check to see if the results include the name '''
+        if not results:
+            return False
+
+        if Utils.find_result(results, _name):
+            return True
+
+        return False
+
+    @staticmethod
+    def find_result(results, _name):
+        ''' Find the specified result by name'''
+        rval = None
+        for result in results:
+            if 'metadata' in result and result['metadata']['name'] == _name:
+                rval = result
+                break
+
+        return rval
+
+    @staticmethod
+    def get_resource_file(sfile, sfile_type='yaml'):
+        ''' return the service file '''
+        contents = None
+        with open(sfile) as sfd:
+            contents = sfd.read()
+
+        if sfile_type == 'yaml':
+            contents = yaml.load(contents, yaml.RoundTripLoader)
+        elif sfile_type == 'json':
+            contents = json.loads(contents)
+
+        return contents
+
+    @staticmethod
+    def filter_versions(stdout):
+        ''' filter the oc version output '''
+
+        version_dict = {}
+        version_search = ['oc', 'openshift', 'kubernetes']
+
+        for line in stdout.strip().split('\n'):
+            for term in version_search:
+                if not line:
+                    continue
+                if line.startswith(term):
+                    version_dict[term] = line.split()[-1]
+
+        # horrible hack to get openshift version in Openshift 3.2
+        #  By default "oc version in 3.2 does not return an "openshift" version
+        if "openshift" not in version_dict:
+            version_dict["openshift"] = version_dict["oc"]
+
+        return version_dict
+
+    @staticmethod
+    def add_custom_versions(versions):
+        ''' create custom versions strings '''
+
+        versions_dict = {}
+
+        for tech, version in versions.items():
+            # clean up "-" from version
+            if "-" in version:
+                version = version.split("-")[0]
+
+            if version.startswith('v'):
+                versions_dict[tech + '_numeric'] = version[1:].split('+')[0]
+                # "v3.3.0.33" is what we have, we want "3.3"
+                versions_dict[tech + '_short'] = version[1:4]
+
+        return versions_dict
+
+    @staticmethod
+    def openshift_installed():
+        ''' check if openshift is installed '''
+        import yum
+
+        yum_base = yum.YumBase()
+        if yum_base.rpmdb.searchNevra(name='atomic-openshift'):
+            return True
+
+        return False
+
+    # Disabling too-many-branches.  This is a yaml dictionary comparison function
+    # pylint: disable=too-many-branches,too-many-return-statements,too-many-statements
+    @staticmethod
+    def check_def_equal(user_def, result_def, skip_keys=None, debug=False):
+        ''' Given a user defined definition, compare it with the results given back by our query.  '''
+
+        # Currently these values are autogenerated and we do not need to check them
+        skip = ['metadata', 'status']
+        if skip_keys:
+            skip.extend(skip_keys)
+
+        for key, value in result_def.items():
+            if key in skip:
+                continue
+
+            # Both are lists
+            if isinstance(value, list):
+                if key not in user_def:
+                    if debug:
+                        print('User data does not have key [%s]' % key)
+                        print('User data: %s' % user_def)
+                    return False
+
+                if not isinstance(user_def[key], list):
+                    if debug:
+                        print('user_def[key] is not a list key=[%s] user_def[key]=%s' % (key, user_def[key]))
+                    return False
+
+                if len(user_def[key]) != len(value):
+                    if debug:
+                        print("List lengths are not equal.")
+                        print("key=[%s]: user_def[%s] != value[%s]" % (key, len(user_def[key]), len(value)))
+                        print("user_def: %s" % user_def[key])
+                        print("value: %s" % value)
+                    return False
+
+                for values in zip(user_def[key], value):
+                    if isinstance(values[0], dict) and isinstance(values[1], dict):
+                        if debug:
+                            print('sending list - list')
+                            print(type(values[0]))
+                            print(type(values[1]))
+                        result = Utils.check_def_equal(values[0], values[1], skip_keys=skip_keys, debug=debug)
+                        if not result:
+                            print('list compare returned false')
+                            return False
+
+                    elif value != user_def[key]:
+                        if debug:
+                            print('value should be identical')
+                            print(value)
+                            print(user_def[key])
+                        return False
+
+            # recurse on a dictionary
+            elif isinstance(value, dict):
+                if key not in user_def:
+                    if debug:
+                        print("user_def does not have key [%s]" % key)
+                    return False
+                if not isinstance(user_def[key], dict):
+                    if debug:
+                        print("dict returned false: not instance of dict")
+                    return False
+
+                # before passing ensure keys match
+                api_values = set(value.keys()) - set(skip)
+                user_values = set(user_def[key].keys()) - set(skip)
+                if api_values != user_values:
+                    if debug:
+                        print("keys are not equal in dict")
+                        print(api_values)
+                        print(user_values)
+                    return False
+
+                result = Utils.check_def_equal(user_def[key], value, skip_keys=skip_keys, debug=debug)
+                if not result:
+                    if debug:
+                        print("dict returned false")
+                        print(result)
+                    return False
+
+            # Verify each key, value pair is the same
+            else:
+                if key not in user_def or value != user_def[key]:
+                    if debug:
+                        print("value not equal; user_def does not have key")
+                        print(key)
+                        print(value)
+                        if key in user_def:
+                            print(user_def[key])
+                    return False
+
+        if debug:
+            print('returning true')
+        return True
+
+
+class OpenShiftCLIConfig(object):
+    '''Generic Config'''
+    def __init__(self, rname, namespace, kubeconfig, options):
+        self.kubeconfig = kubeconfig
+        self.name = rname
+        self.namespace = namespace
+        self._options = options
+
+    @property
+    def config_options(self):
+        ''' return config options '''
+        return self._options
+
+    def to_option_list(self):
+        '''return all options as a string'''
+        return self.stringify()
+
+    def stringify(self):
+        ''' return the options hash as cli params in a string '''
+        rval = []
+        for key, data in self.config_options.items():
+            if data['include'] \
+               and (data['value'] or isinstance(data['value'], int)):
+                rval.append('--%s=%s' % (key.replace('_', '-'), data['value']))
+
+        return rval
+
+
+# pylint: disable=too-many-instance-attributes
+class OCLabel(OpenShiftCLI):
+    ''' Class to wrap the oc command line tools '''
+
+    # pylint allows 5
+    # pylint: disable=too-many-arguments
+    def __init__(self,
+                 name,
+                 namespace,
+                 kind,
+                 kubeconfig,
+                 labels=None,
+                 selector=None,
+                 verbose=False):
+        ''' Constructor for OCLabel '''
+        super(OCLabel, self).__init__(namespace, kubeconfig)
+        self.name = name
+        self.namespace = namespace
+        self.kind = kind
+        self.kubeconfig = kubeconfig
+        self.labels = labels
+        self.selector = selector
+
+    def get_current_labels(self):
+        ''' get the current labels on object '''
+
+        return self.get()['results']['labels']
+
+    def compare_labels(self, host_labels):
+        ''' compare incoming labels against current labels'''
+
+        for label in self.labels:
+            if label['key'] not in host_labels or \
+               label['value'] != host_labels[label['key']]:
+                return False
+        return True
+
+    def all_user_labels_exist(self):
+        ''' return whether all the labels already exist '''
+
+        current_labels = self.get_current_labels()
+
+        for current_host_labels in current_labels:
+            rbool = self.compare_labels(current_host_labels)
+            if rbool == False:
+                return False
+        return True
+
+    def any_label_exists(self):
+        ''' return whether any single label already exists '''
+        current_labels = self.get_current_labels()
+
+        for current_host_labels in current_labels:
+            for label in self.labels:
+                if label['key'] in current_host_labels:
+                    return True
+        return False
+
+    def get_user_keys(self):
+        ''' go through list of user key:values and return all keys '''
+
+        user_keys = []
+        for label in self.labels:
+            user_keys.append(label['key'])
+
+        return user_keys
+
+    def get_current_label_keys(self):
+        ''' collect all the current label keys '''
+
+        current_label_keys = []
+        current_labels = self.get_current_labels()
+        for current_host_labels in current_labels:
+            for key in current_host_labels.keys():
+                current_label_keys.append(key)
+
+        return list(set(current_label_keys))
+
+    def get_extra_current_labels(self):
+        ''' return list of labels that are currently stored, but aren't
+            in user-provided list '''
+
+        current_labels = self.get_current_labels()
+        extra_labels = []
+        user_label_keys = self.get_user_keys()
+        current_label_keys = self.get_current_label_keys()
+
+        for current_key in current_label_keys:
+            if current_key not in user_label_keys:
+                extra_labels.append(current_key)
+
+        return extra_labels
+
+    def extra_current_labels(self):
+        ''' return whether there are labels currently stored that user
+            hasn't directly provided '''
+        extra_labels = self.get_extra_current_labels()
+
+        if len(extra_labels) > 0:
+                return True
+        else:
+            return False
+
+    def replace(self):
+        ''' replace currently stored labels with user provided labels '''
+        cmd = self.cmd_template()
+
+        # First delete any extra labels
+        extra_labels = self.get_extra_current_labels()
+        if len(extra_labels) > 0:
+            for label in extra_labels:
+                cmd.append("{}-".format(label))
+
+        # Now add/modify the user-provided label list
+        if len(self.labels) > 0:
+            for label in self.labels:
+                cmd.append("{}={}".format(label['key'], label['value']))
+
+        # --overwrite for the case where we are updating existing labels
+        cmd.append("--overwrite")
+        return self.openshift_cmd(cmd)
+
+    def get(self):
+        '''return label information '''
+
+        result_dict = {}
+        label_list = []
+
+        if self.name:
+            result = self._get(resource=self.kind, rname=self.name, selector=self.selector)
+
+            if 'labels' in result['results'][0]['metadata']:
+                label_list.append(result['results'][0]['metadata']['labels'])
+            else:
+                label_list.append({})
+
+        else:
+            result = self._get(resource=self.kind, selector=self.selector)
+
+            for item in result['results'][0]['items']:
+                if 'labels' in item['metadata']:
+                    label_list.append(item['metadata']['labels'])
+                else:
+                    label_list.append({})
+
+        result_dict['labels'] = label_list
+        result_dict['item_count'] = len(label_list)
+        result['results'] = result_dict
+
+        return result
+
+    def cmd_template(self):
+        ''' boilerplate oc command for modifying lables on this object '''
+        # let's build the cmd with what we have passed in
+        cmd = []
+        if self.namespace:
+            cmd = cmd + ["-n", self.namespace]
+
+        if self.selector:
+            cmd = cmd + ["--selector", self.selector]
+
+        cmd = cmd + ["--config", self.kubeconfig, "label", self.kind]
+
+        if self.name:
+            cmd = cmd + [self.name]
+
+        return cmd
+
+    def add(self):
+        ''' add labels '''
+        cmd = self.cmd_template()
+
+        for label in self.labels:
+            cmd.append("{}={}".format(label['key'], label['value']))
+
+        cmd.append("--overwrite")
+
+        return self.openshift_cmd(cmd)
+
+    def delete(self):
+        '''delete the labels'''
+        cmd = self.cmd_template()
+        for label in self.labels:
+            cmd.append("{}-".format(label['key']))
+
+        return self.openshift_cmd(cmd)
+
+    @staticmethod
+    def run_ansible(params, check_mode=False):
+        ''' run the idempotent ansible code
+
+            prams comes from the ansible portion of this module
+            check_mode: does the module support check mode. (module.check_mode)
+        '''
+        oc_label = OCLabel(params['name'],
+                           params['namespace'],
+                           params['kind'],
+                           params['kubeconfig'],
+                           params['labels'],
+                           params['selector'],
+                           verbose=params['debug'])
+
+        state = params['state']
+        name = params['name']
+        selector = params['selector']
+
+        api_rval = oc_label.get()
+
+        #####
+        # Get
+        #####
+        if state == 'list':
+            return {'changed': False, 'results': api_rval['results'], 'state': "list"}
+
+        #######
+        # Add
+        #######
+        if state == 'add':
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'add'"}
+            if not oc_label.all_user_labels_exist():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have performed an addition.'}
+                api_rval = oc_label.add()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "add"}
+
+            return {'changed': False, 'state': "add"}
+
+        ########
+        # Delete
+        ########
+        if state == 'absent':
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'absent'"}
+
+            if oc_label.any_label_exists():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have performed a delete.'}
+
+                api_rval = oc_label.delete()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "absent"}
+
+            return {'changed': False, 'state': "absent"}
+
+        if state == 'present':
+            ########
+            # Update
+            ########
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'present'"}
+            # if all the labels passed in don't already exist
+            # or if there are currently stored labels that haven't
+            # been passed in
+            if not oc_label.all_user_labels_exist() or \
+               oc_label.extra_current_labels():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have made changes.'}
+
+                api_rval = oc_label.replace()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                # return the created object
+                api_rval = oc_label.get()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "present"}
+
+            return {'changed': False, 'results': api_rval, 'state': "present"}
+
+        return {'failed': True,
+                'changed': False,
+                'results': 'Unknown state passed. %s' % state,
+                'state': "unknown"}
+
+def main():
+    ''' ansible oc module for labels '''
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'),
+            state=dict(default='present', type='str',
+                       choices=['present', 'absent', 'list', 'add']),
+            debug=dict(default=False, type='bool'),
+            kind=dict(default=None, type='str', required=True,
+                          choices=['node', 'pod']),
+            name=dict(default=None, type='str'),
+            namespace=dict(default=None, type='str'),
+            labels=dict(default=None, type='list'),
+            selector=dict(default=None, type='str'),
+        ),
+        supports_check_mode=True,
+        mutually_exclusive = (['name', 'selector']),
+    )
+
+    results = OCLabel.run_ansible(module.params, module.check_mode)
+
+    if 'failed' in results:
+        module.fail_json(**results)
+
+    module.exit_json(**results)
+
+if __name__ == '__main__':
+    main()
diff --git a/roles/lib_openshift/src/ansible/oc_label.py b/roles/lib_openshift/src/ansible/oc_label.py
new file mode 100644
index 000000000..53632678b
--- /dev/null
+++ b/roles/lib_openshift/src/ansible/oc_label.py
@@ -0,0 +1,32 @@
+# pylint: skip-file
+# flake8: noqa
+
+def main():
+    ''' ansible oc module for labels '''
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'),
+            state=dict(default='present', type='str',
+                       choices=['present', 'absent', 'list', 'add']),
+            debug=dict(default=False, type='bool'),
+            kind=dict(default=None, type='str', required=True,
+                          choices=['node', 'pod']),
+            name=dict(default=None, type='str'),
+            namespace=dict(default=None, type='str'),
+            labels=dict(default=None, type='list'),
+            selector=dict(default=None, type='str'),
+        ),
+        supports_check_mode=True,
+        mutually_exclusive = (['name', 'selector']),
+    )
+
+    results = OCLabel.run_ansible(module.params, module.check_mode)
+
+    if 'failed' in results:
+        module.fail_json(**results)
+
+    module.exit_json(**results)
+
+if __name__ == '__main__':
+    main()
diff --git a/roles/lib_openshift/src/class/oc_label.py b/roles/lib_openshift/src/class/oc_label.py
new file mode 100644
index 000000000..9c65b1760
--- /dev/null
+++ b/roles/lib_openshift/src/class/oc_label.py
@@ -0,0 +1,291 @@
+# pylint: skip-file
+# flake8: noqa
+
+# pylint: disable=too-many-instance-attributes
+class OCLabel(OpenShiftCLI):
+    ''' Class to wrap the oc command line tools '''
+
+    # pylint allows 5
+    # pylint: disable=too-many-arguments
+    def __init__(self,
+                 name,
+                 namespace,
+                 kind,
+                 kubeconfig,
+                 labels=None,
+                 selector=None,
+                 verbose=False):
+        ''' Constructor for OCLabel '''
+        super(OCLabel, self).__init__(namespace, kubeconfig)
+        self.name = name
+        self.namespace = namespace
+        self.kind = kind
+        self.kubeconfig = kubeconfig
+        self.labels = labels
+        self.selector = selector
+
+    def get_current_labels(self):
+        ''' get the current labels on object '''
+
+        return self.get()['results']['labels']
+
+    def compare_labels(self, host_labels):
+        ''' compare incoming labels against current labels'''
+
+        for label in self.labels:
+            if label['key'] not in host_labels or \
+               label['value'] != host_labels[label['key']]:
+                return False
+        return True
+
+    def all_user_labels_exist(self):
+        ''' return whether all the labels already exist '''
+
+        current_labels = self.get_current_labels()
+
+        for current_host_labels in current_labels:
+            rbool = self.compare_labels(current_host_labels)
+            if rbool == False:
+                return False
+        return True
+
+    def any_label_exists(self):
+        ''' return whether any single label already exists '''
+        current_labels = self.get_current_labels()
+
+        for current_host_labels in current_labels:
+            for label in self.labels:
+                if label['key'] in current_host_labels:
+                    return True
+        return False
+
+    def get_user_keys(self):
+        ''' go through list of user key:values and return all keys '''
+
+        user_keys = []
+        for label in self.labels:
+            user_keys.append(label['key'])
+
+        return user_keys
+
+    def get_current_label_keys(self):
+        ''' collect all the current label keys '''
+
+        current_label_keys = []
+        current_labels = self.get_current_labels()
+        for current_host_labels in current_labels:
+            for key in current_host_labels.keys():
+                current_label_keys.append(key)
+
+        return list(set(current_label_keys))
+
+    def get_extra_current_labels(self):
+        ''' return list of labels that are currently stored, but aren't
+            in user-provided list '''
+
+        current_labels = self.get_current_labels()
+        extra_labels = []
+        user_label_keys = self.get_user_keys()
+        current_label_keys = self.get_current_label_keys()
+
+        for current_key in current_label_keys:
+            if current_key not in user_label_keys:
+                extra_labels.append(current_key)
+
+        return extra_labels
+
+    def extra_current_labels(self):
+        ''' return whether there are labels currently stored that user
+            hasn't directly provided '''
+        extra_labels = self.get_extra_current_labels()
+
+        if len(extra_labels) > 0:
+                return True
+        else:
+            return False
+
+    def replace(self):
+        ''' replace currently stored labels with user provided labels '''
+        cmd = self.cmd_template()
+
+        # First delete any extra labels
+        extra_labels = self.get_extra_current_labels()
+        if len(extra_labels) > 0:
+            for label in extra_labels:
+                cmd.append("{}-".format(label))
+
+        # Now add/modify the user-provided label list
+        if len(self.labels) > 0:
+            for label in self.labels:
+                cmd.append("{}={}".format(label['key'], label['value']))
+
+        # --overwrite for the case where we are updating existing labels
+        cmd.append("--overwrite")
+        return self.openshift_cmd(cmd)
+
+    def get(self):
+        '''return label information '''
+
+        result_dict = {}
+        label_list = []
+
+        if self.name:
+            result = self._get(resource=self.kind, rname=self.name, selector=self.selector)
+
+            if 'labels' in result['results'][0]['metadata']:
+                label_list.append(result['results'][0]['metadata']['labels'])
+            else:
+                label_list.append({})
+
+        else:
+            result = self._get(resource=self.kind, selector=self.selector)
+
+            for item in result['results'][0]['items']:
+                if 'labels' in item['metadata']:
+                    label_list.append(item['metadata']['labels'])
+                else:
+                    label_list.append({})
+
+        result_dict['labels'] = label_list
+        result_dict['item_count'] = len(label_list)
+        result['results'] = result_dict
+
+        return result
+
+    def cmd_template(self):
+        ''' boilerplate oc command for modifying lables on this object '''
+        # let's build the cmd with what we have passed in
+        cmd = []
+        if self.namespace:
+            cmd = cmd + ["-n", self.namespace]
+
+        if self.selector:
+            cmd = cmd + ["--selector", self.selector]
+
+        cmd = cmd + ["--config", self.kubeconfig, "label", self.kind]
+
+        if self.name:
+            cmd = cmd + [self.name]
+
+        return cmd
+
+    def add(self):
+        ''' add labels '''
+        cmd = self.cmd_template()
+
+        for label in self.labels:
+            cmd.append("{}={}".format(label['key'], label['value']))
+
+        cmd.append("--overwrite")
+
+        return self.openshift_cmd(cmd)
+
+    def delete(self):
+        '''delete the labels'''
+        cmd = self.cmd_template()
+        for label in self.labels:
+            cmd.append("{}-".format(label['key']))
+
+        return self.openshift_cmd(cmd)
+
+    @staticmethod
+    def run_ansible(params, check_mode=False):
+        ''' run the idempotent ansible code
+
+            prams comes from the ansible portion of this module
+            check_mode: does the module support check mode. (module.check_mode)
+        '''
+        oc_label = OCLabel(params['name'],
+                           params['namespace'],
+                           params['kind'],
+                           params['kubeconfig'],
+                           params['labels'],
+                           params['selector'],
+                           verbose=params['debug'])
+
+        state = params['state']
+        name = params['name']
+        selector = params['selector']
+
+        api_rval = oc_label.get()
+
+        #####
+        # Get
+        #####
+        if state == 'list':
+            return {'changed': False, 'results': api_rval['results'], 'state': "list"}
+
+        #######
+        # Add
+        #######
+        if state == 'add':
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'add'"}
+            if not oc_label.all_user_labels_exist():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have performed an addition.'}
+                api_rval = oc_label.add()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "add"}
+
+            return {'changed': False, 'state': "add"}
+
+        ########
+        # Delete
+        ########
+        if state == 'absent':
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'absent'"}
+
+            if oc_label.any_label_exists():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have performed a delete.'}
+
+                api_rval = oc_label.delete()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "absent"}
+
+            return {'changed': False, 'state': "absent"}
+
+        if state == 'present':
+            ########
+            # Update
+            ########
+            if not (name or selector):
+                return {'failed': True,
+                        'msg': "Param 'name' or 'selector' is required if state == 'present'"}
+            # if all the labels passed in don't already exist
+            # or if there are currently stored labels that haven't
+            # been passed in
+            if not oc_label.all_user_labels_exist() or \
+               oc_label.extra_current_labels():
+                if check_mode:
+                    return {'changed': False, 'msg': 'Would have made changes.'}
+
+                api_rval = oc_label.replace()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                # return the created object
+                api_rval = oc_label.get()
+
+                if api_rval['returncode'] != 0:
+                    return {'failed': True, 'msg': api_rval}
+
+                return {'changed': True, 'results': api_rval, 'state': "present"}
+
+            return {'changed': False, 'results': api_rval, 'state': "present"}
+
+        return {'failed': True,
+                'changed': False,
+                'results': 'Unknown state passed. %s' % state,
+                'state': "unknown"}
diff --git a/roles/lib_openshift/src/doc/label b/roles/lib_openshift/src/doc/label
new file mode 100644
index 000000000..8122bd4b0
--- /dev/null
+++ b/roles/lib_openshift/src/doc/label
@@ -0,0 +1,65 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_label
+short_description: Create, modify, and idempotently manage openshift object labels.
+description:
+  - Modify openshift labels programmatically.
+options:
+  state:
+    description:
+    - State represents whether to create, modify, delete, or list
+    required: true
+    default: present
+    choices: ["present", "absent", "list", "add"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  kind:
+    description:
+    - The kind of object that can be managed.
+    required: false
+    default: None
+    choices:
+    - node
+    - pod
+    aliases: []
+  labels:
+    description:
+    - The labels to add to the resource.
+    required: false
+    default: None
+    aliases: []
+  selector:
+    description:
+    - The selector to apply to the query
+    required: false
+    default: None
+    aliases: []
+author:
+- "Joel Diaz <jdiaz@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: Add label to node
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: add
+    kind: node
+    labels:
+      - key: logging-infra-fluentd
+        value: 'true'
+'''
diff --git a/roles/lib_openshift/src/sources.yml b/roles/lib_openshift/src/sources.yml
index 32c3711d1..6438ff4bb 100644
--- a/roles/lib_openshift/src/sources.yml
+++ b/roles/lib_openshift/src/sources.yml
@@ -19,6 +19,16 @@ oc_edit.py:
 - class/oc_edit.py
 - ansible/oc_edit.py
 
+oc_label.py:
+- doc/generated
+- doc/license
+- lib/import.py
+- doc/label
+- ../../lib_utils/src/class/yedit.py
+- lib/base.py
+- class/oc_label.py
+- ansible/oc_label.py
+
 oc_obj.py:
 - doc/generated
 - doc/license
diff --git a/roles/lib_openshift/src/test/integration/filter_plugins/filters.py b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
new file mode 100644
index 000000000..6acbb47ec
--- /dev/null
+++ b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
@@ -0,0 +1,25 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# vim: expandtab:tabstop=4:shiftwidth=4
+'''
+Custom filters for use in testing
+'''
+
+class FilterModule(object):
+    ''' Custom ansible filters '''
+
+    @staticmethod
+    def label_dict_to_key_value_list(label_dict):
+        ''' given a dict of labels/values, return list of key: <key> value: <value> pairs'''
+
+        label_list = []
+        for key in label_dict:
+            label_list.append({'key': key, 'value': label_dict[key]})
+
+        return label_list
+
+    def filters(self):
+        ''' returns a mapping of filters to methods '''
+        return {
+            "label_dict_to_key_value_list": self.label_dict_to_key_value_list,
+        }
diff --git a/roles/lib_openshift/src/test/integration/oc_label.yml b/roles/lib_openshift/src/test/integration/oc_label.yml
new file mode 100755
index 000000000..0a2d438bd
--- /dev/null
+++ b/roles/lib_openshift/src/test/integration/oc_label.yml
@@ -0,0 +1,404 @@
+#!/usr/bin/ansible-playbook --module-path=../../../library/
+# ./oc_label.yml -e "cli_master_test=$OPENSHIFT_MASTER -e "cli_node_test=ip-172-0-31-1.ec2"
+---
+- hosts: "{{ cli_master_test }}"
+  gather_facts: no
+  user: root
+
+  vars:
+  - def_namespace: default
+  - def_kind: node
+
+  pre_tasks:
+  - name: ensure needed vars are defined
+    fail:
+      msg: "{{ item }} not defined"
+    when: "{{ item }} is not defined"
+    with_items:
+    - cli_node_test #openshift node to be used to add/remove labels to
+    - cli_master_test #ansible inventory instance to run playbook against
+
+  tasks:
+  - name: delete test labels (start from known starting position)
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+      - key: testlabel3
+
+  - name: list to check whether our test labels already exist
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: original_labels
+  - name: assert that testlabel2 and testlabel3 test labels don't exist
+    assert:
+      that: original_labels['results']['labels'][0]['testlabel2'] is not defined and
+            original_labels['results']['labels'][0]['testlabel3'] is not defined
+      msg: "{{ original_labels['results']['labels'] }}"
+
+  - name: add label
+    oc_label:
+      state: add
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+        value: "yes"
+    register: label_out
+  - name: assert adding label marked as changed
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: test if add label succeeded
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: assert that testlabel2 label actually added
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is defined and
+            label_out['results']['labels'][0]['testlabel2'] == "yes"
+      msg: "{{ label_out }}"
+
+  - name: test that re-adding does nothing
+    oc_label:
+      state: add
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+        value: "yes"
+    register: label_out
+  - name: assert that re-adding made no changes
+    assert:
+      that: label_out['changed'] == False
+      msg: "{{ label_out }}"
+
+  - name: test that modifying existing label marked modified
+    oc_label:
+      state: add
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+        value: "different"
+    register: label_out
+  - name: assert that modifying existing label marked modified
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: test if modify label actually did modification
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: assert that testlabel2 label actually modified
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is defined and
+            label_out['results']['labels'][0]['testlabel2'] == "different"
+      msg: "{{ label_out['results']['labels'] }}"
+
+  - name: delete non-existant label
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabelnone
+    register: label_out
+  - name: assert that deleting non-existant label marked not changed
+    assert:
+      that: label_out['changed'] == False
+      msg: "{{ label_out }}"
+
+  - name: delete label
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+    register: label_out
+  - name: assert that deleting existing label marked changed
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: re-delete label
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+    register: label_out
+  - name: assert that re-deleting label marked not changed
+    assert:
+      that: label_out['changed'] == False
+      msg: "{{ label_out }}"
+
+  - name: check whether really deleted
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: assert label actually deleted
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is not defined
+      msg: "{{ label_out }}"
+
+  - name: add two labels
+    oc_label:
+      state: add
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+        value: "yes"
+      - key: testlabel3
+        value: "yes"
+    register: label_out
+  - name: assert that adding two labels marked as changed
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: check whether both labels are there
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: assert that both labels actually exist
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is defined and
+            label_out['results']['labels'][0]['testlabel2'] == 'yes' and
+            label_out['results']['labels'][0]['testlabel3'] is defined and
+            label_out['results']['labels'][0]['testlabel3'] == 'yes'
+      msg: "{{ label_out['results']['labels'] }}"
+
+  - name: check whether two deletes work
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+      - key: testlabel3
+    register: label_out
+  - name: assert that change were made when delete both labels
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: check whether re-two deletes makes no changes
+    oc_label:
+      state: absent
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels:
+      - key: testlabel2
+      - key: testlabel3
+    register: label_out
+  - name: assert that change was not made when re-delete both labels
+    assert:
+      that: label_out['changed'] == False
+      msg: "{{ label_out }}"
+
+  - set_fact:
+      original_labels_as_key_value_list: "{{ original_labels['results']['labels'][0] | label_dict_to_key_value_list }}"
+
+  - name: check that present with original label list makes no changes
+    oc_label:
+      state: present
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels: "{{ original_labels_as_key_value_list }}"
+    register: label_out
+  - name: assert that no changes are made when current list matches existing list
+    assert:
+      that: label_out['changed'] == False
+      msg: "{{ label_out }}"
+
+  - name: check that present with extra item makes changes
+    oc_label:
+      state: present
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels: "{{ original_labels_as_key_value_list + [{'key': 'testlabel2', 'value': 'yes'}] }}"
+    register: label_out
+  - name: assert that changes were made
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: get current label list
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: asssert that new label was actually added
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is defined and
+            label_out['results']['labels'][0]['testlabel2'] == 'yes'
+      msg: "{{ label_out['results']['labels'] }}"
+
+  - name: check that present with changed item makes changes
+    oc_label:
+      state: present
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels: "{{ original_labels_as_key_value_list + [{'key': 'testlabel2', 'value': 'different'}]}}"
+    register: label_out
+  - name: assert that changes were made when existing key's value is changed
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: get current label list
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: asssert that changed label was actually changed
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is defined and
+            label_out['results']['labels'][0]['testlabel2'] == 'different'
+      msg: "{{ label_out['results']['labels'] }}"
+
+  - name: check that present with removed extra item makes changes
+    oc_label:
+      state: present
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+      labels: "{{ original_labels_as_key_value_list }}"
+    register: label_out
+  - name: assert that changes were made
+    assert:
+      that: label_out['changed'] == True
+      msg: "{{ label_out }}"
+
+  - name: get current label list
+    oc_label:
+      state: list
+      namespace: "{{ def_namespace }}"
+      kind: "{{ def_kind }}"
+      name: "{{ cli_node_test }}"
+    register: label_out
+  - name: asssert that present-removed actually removed
+    assert:
+      that: label_out['results']['labels'][0]['testlabel2'] is not defined
+      msg: "{{ label_out }}"
+
+
+
+
+
+
+
+
+
+
+
+#  - name: create route
+#    oc_route:
+#      name: test
+#      namespace: default
+#      tls_termination: edge
+#      cert_content: testing cert
+#      cacert_content: testing cacert
+#      key_content: key content
+#      service_name: test
+#      host: test.example
+#    register: routeout
+#  - debug: var=routeout
+#
+#  - assert:
+#      that: "routeout.results.results[0]['metadata']['name'] == 'test'"
+#      msg: route create failed
+#
+#  - name: get route
+#    oc_route:
+#      state: list
+#      name: test
+#      namespace: default
+#    register: routeout
+#  - debug: var=routeout
+#
+#  - assert:
+#      that: "routeout.results[0]['metadata']['name'] == 'test'"
+#      msg: get route failed
+#
+#  - name: delete route
+#    oc_route:
+#      state: absent
+#      name: test
+#      namespace: default
+#    register: routeout
+#  - debug: var=routeout
+#
+#  - assert:
+#      that: "routeout.results.returncode == 0"
+#      msg: delete route failed
+#
+#  - name: create route
+#    oc_route:
+#      name: test
+#      namespace: default
+#      tls_termination: edge
+#      cert_content: testing cert
+#      cacert_content: testing cacert
+#      key_content: testing key
+#      service_name: test
+#      host: test.example
+#    register: routeout
+#  - debug: var=routeout
+#
+#  - name: create route noop
+#    oc_route:
+#      name: test
+#      namespace: default
+#      tls_termination: edge
+#      cert_content: testing cert
+#      cacert_content: testing cacert
+#      key_content: testing key
+#      service_name: test
+#      host: test.example
+#    register: routeout
+#  - debug: var=routeout
+#
+#  - assert:
+#      that: "routeout.changed == False"
+#      msg: Route create not idempotent
-- 
cgit v1.2.3


From 4806fe365e11a9a0266c06d052537836397a26c6 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Tue, 31 Jan 2017 09:36:23 -0500
Subject: Fixing doc and generating new label with updated base.

---
 roles/lib_openshift/library/oc_label.py     | 93 ++++++++++++++++++-----------
 roles/lib_openshift/src/ansible/oc_label.py |  2 +-
 roles/lib_openshift/src/doc/label           |  9 +--
 3 files changed, 63 insertions(+), 41 deletions(-)

diff --git a/roles/lib_openshift/library/oc_label.py b/roles/lib_openshift/library/oc_label.py
index 9fc0a15b5..a876346f4 100644
--- a/roles/lib_openshift/library/oc_label.py
+++ b/roles/lib_openshift/library/oc_label.py
@@ -24,6 +24,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# -*- -*- -*- Begin included fragment: lib/import.py -*- -*- -*-
 '''
    OpenShiftCLI class that wraps the oc commands in a subprocess
 '''
@@ -40,12 +42,16 @@ import subprocess
 import ruamel.yaml as yaml
 from ansible.module_utils.basic import AnsibleModule
 
+# -*- -*- -*- End included fragment: lib/import.py -*- -*- -*-
+
+# -*- -*- -*- Begin included fragment: doc/label -*- -*- -*-
+
 DOCUMENTATION = '''
 ---
 module: oc_label
-short_description: Create, modify, and idempotently manage openshift object labels.
+short_description: Create, modify, and idempotently manage openshift labels.
 description:
-  - Manage openshift object labels programmatically.
+  - Modify openshift labels programmatically.
 options:
   state:
     description:
@@ -66,52 +72,47 @@ options:
     required: false
     default: False
     aliases: []
-  name:
-    description:
-    - Name of the object that is being queried.
-    required: false
-    default: None
-    aliases: []
-  namespace:
-    description:
-    - The namespace where the object lives.
-    required: false
-    default: None
-    aliases: []
   kind:
     description:
-    - The kind of OpenShift object being queried (node or pod).
-    required: true
+    - The kind of object that can be managed.
+    required: True
     default: None
-    choices: ["node", "pod"]
+    choices:
+    - node
+    - pod
+    - namespace
     aliases: []
   labels:
     description:
-    - List of label_name=label_value items.
+    - A list of labels to for the resource.
     required: false
     default: None
     aliases: []
   selector:
     description:
-    - XXX
+    - The selector to apply to the resource query
     required: false
     default: None
     aliases: []
 author:
-- "Kenny Woodson <kwoodson@redhat.com>"
+- "Joel Diaz <jdiaz@redhat.com>"
 extends_documentation_fragment: []
 '''
 
 EXAMPLES = '''
 - name: Add label to node
   oc_label:
+    name: ip-172-31-5-23.ec2.internal
     state: add
     kind: node
-    name: ip-172-31-5-23.ec2.internal
     labels:
-    - key: provision_date
-      value: "2017-01-01"
+      - key: logging-infra-fluentd
+        value: 'true'
 '''
+
+# -*- -*- -*- End included fragment: doc/label -*- -*- -*-
+
+# -*- -*- -*- Begin included fragment: ../../lib_utils/src/class/yedit.py -*- -*- -*-
 # noqa: E301,E302
 
 
@@ -676,6 +677,10 @@ class Yedit(object):
                         'state': "present"}
 
         return {'failed': True, 'msg': 'Unkown state passed'}
+
+# -*- -*- -*- End included fragment: ../../lib_utils/src/class/yedit.py -*- -*- -*-
+
+# -*- -*- -*- Begin included fragment: lib/base.py -*- -*- -*-
 # pylint: disable=too-many-lines
 # noqa: E301,E302,E303,T001
 
@@ -787,12 +792,11 @@ class OpenShiftCLI(object):
         cmd = ['get', resource]
         if selector:
             cmd.append('--selector=%s' % selector)
+        elif rname:
+            cmd.append(rname)
 
         cmd.extend(['-o', 'json'])
 
-        if rname:
-            cmd.append(rname)
-
         rval = self.openshift_cmd(cmd, output=True)
 
         # Ensure results are retuned in an array
@@ -882,6 +886,18 @@ class OpenShiftCLI(object):
         cmd.append('--confirm')
         return self.openshift_cmd(cmd)
 
+    def _run(self, cmds, input_data):
+        ''' Actually executes the command. This makes mocking easier. '''
+        proc = subprocess.Popen(cmds,
+                                stdin=subprocess.PIPE,
+                                stdout=subprocess.PIPE,
+                                stderr=subprocess.PIPE,
+                                env={'KUBECONFIG': self.kubeconfig})
+
+        stdout, stderr = proc.communicate(input_data)
+
+        return proc.returncode, stdout, stderr
+
     # pylint: disable=too-many-arguments,too-many-branches
     def openshift_cmd(self, cmd, oadm=False, output=False, output_type='json', input_data=None):
         '''Base command for oc '''
@@ -893,7 +909,7 @@ class OpenShiftCLI(object):
 
         if self.all_namespaces:
             cmds.extend(['--all-namespaces'])
-        elif self.namespace:
+        elif self.namespace is not None and self.namespace.lower() not in ['none', 'emtpy']:  # E501
             cmds.extend(['-n', self.namespace])
 
         cmds.extend(cmd)
@@ -905,18 +921,13 @@ class OpenShiftCLI(object):
         if self.verbose:
             print(' '.join(cmds))
 
-        proc = subprocess.Popen(cmds,
-                                stdin=subprocess.PIPE,
-                                stdout=subprocess.PIPE,
-                                stderr=subprocess.PIPE,
-                                env={'KUBECONFIG': self.kubeconfig})
+        returncode, stdout, stderr = self._run(cmds, input_data)
 
-        stdout, stderr = proc.communicate(input_data)
-        rval = {"returncode": proc.returncode,
+        rval = {"returncode": returncode,
                 "results": results,
                 "cmd": ' '.join(cmds)}
 
-        if proc.returncode == 0:
+        if returncode == 0:
             if output:
                 if output_type == 'json':
                     try:
@@ -1197,6 +1208,10 @@ class OpenShiftCLIConfig(object):
         return rval
 
 
+# -*- -*- -*- End included fragment: lib/base.py -*- -*- -*-
+
+# -*- -*- -*- Begin included fragment: class/oc_label.py -*- -*- -*-
+
 # pylint: disable=too-many-instance-attributes
 class OCLabel(OpenShiftCLI):
     ''' Class to wrap the oc command line tools '''
@@ -1486,6 +1501,10 @@ class OCLabel(OpenShiftCLI):
                 'results': 'Unknown state passed. %s' % state,
                 'state': "unknown"}
 
+# -*- -*- -*- End included fragment: class/oc_label.py -*- -*- -*-
+
+# -*- -*- -*- Begin included fragment: ansible/oc_label.py -*- -*- -*-
+
 def main():
     ''' ansible oc module for labels '''
 
@@ -1496,7 +1515,7 @@ def main():
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
             kind=dict(default=None, type='str', required=True,
-                          choices=['node', 'pod']),
+                          choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
             labels=dict(default=None, type='list'),
@@ -1515,3 +1534,5 @@ def main():
 
 if __name__ == '__main__':
     main()
+
+# -*- -*- -*- End included fragment: ansible/oc_label.py -*- -*- -*-
diff --git a/roles/lib_openshift/src/ansible/oc_label.py b/roles/lib_openshift/src/ansible/oc_label.py
index 53632678b..149b965d8 100644
--- a/roles/lib_openshift/src/ansible/oc_label.py
+++ b/roles/lib_openshift/src/ansible/oc_label.py
@@ -11,7 +11,7 @@ def main():
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
             kind=dict(default=None, type='str', required=True,
-                          choices=['node', 'pod']),
+                          choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
             labels=dict(default=None, type='list'),
diff --git a/roles/lib_openshift/src/doc/label b/roles/lib_openshift/src/doc/label
index 8122bd4b0..1274d58c1 100644
--- a/roles/lib_openshift/src/doc/label
+++ b/roles/lib_openshift/src/doc/label
@@ -4,7 +4,7 @@
 DOCUMENTATION = '''
 ---
 module: oc_label
-short_description: Create, modify, and idempotently manage openshift object labels.
+short_description: Create, modify, and idempotently manage openshift labels.
 description:
   - Modify openshift labels programmatically.
 options:
@@ -30,21 +30,22 @@ options:
   kind:
     description:
     - The kind of object that can be managed.
-    required: false
+    required: True
     default: None
     choices:
     - node
     - pod
+    - namespace
     aliases: []
   labels:
     description:
-    - The labels to add to the resource.
+    - A list of labels to for the resource.
     required: false
     default: None
     aliases: []
   selector:
     description:
-    - The selector to apply to the query
+    - The selector to apply to the resource query
     required: false
     default: None
     aliases: []
-- 
cgit v1.2.3


From 94fd71fa8fba70205519e18625975b83373c1535 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Tue, 31 Jan 2017 11:09:57 -0500
Subject: Adding unit test.  Fixed redudant calls to get.

---
 roles/lib_openshift/library/oc_label.py       |  60 ++++----
 roles/lib_openshift/src/class/oc_label.py     |  48 +++----
 roles/lib_openshift/src/doc/label             |   4 +-
 roles/lib_openshift/src/test/unit/oc_label.py | 188 ++++++++++++++++++++++++++
 4 files changed, 245 insertions(+), 55 deletions(-)
 create mode 100755 roles/lib_openshift/src/test/unit/oc_label.py

diff --git a/roles/lib_openshift/library/oc_label.py b/roles/lib_openshift/library/oc_label.py
index a876346f4..8840bfefa 100644
--- a/roles/lib_openshift/library/oc_label.py
+++ b/roles/lib_openshift/library/oc_label.py
@@ -56,7 +56,6 @@ options:
   state:
     description:
     - State represents whether to create, modify, delete, or list
-    required: true
     default: present
     choices: ["present", "absent", "list", "add"]
     aliases: []
@@ -75,8 +74,7 @@ options:
   kind:
     description:
     - The kind of object that can be managed.
-    required: True
-    default: None
+    default: node
     choices:
     - node
     - pod
@@ -888,11 +886,13 @@ class OpenShiftCLI(object):
 
     def _run(self, cmds, input_data):
         ''' Actually executes the command. This makes mocking easier. '''
+        curr_env = os.environ.copy()
+        curr_env.update({'KUBECONFIG': self.kubeconfig})
         proc = subprocess.Popen(cmds,
                                 stdin=subprocess.PIPE,
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE,
-                                env={'KUBECONFIG': self.kubeconfig})
+                                env=curr_env)
 
         stdout, stderr = proc.communicate(input_data)
 
@@ -903,9 +903,9 @@ class OpenShiftCLI(object):
         '''Base command for oc '''
         cmds = []
         if oadm:
-            cmds = ['/usr/bin/oadm']
+            cmds = ['oadm']
         else:
-            cmds = ['/usr/bin/oc']
+            cmds = ['oc']
 
         if self.all_namespaces:
             cmds.extend(['--all-namespaces'])
@@ -1212,6 +1212,7 @@ class OpenShiftCLIConfig(object):
 
 # -*- -*- -*- Begin included fragment: class/oc_label.py -*- -*- -*-
 
+
 # pylint: disable=too-many-instance-attributes
 class OCLabel(OpenShiftCLI):
     ''' Class to wrap the oc command line tools '''
@@ -1233,12 +1234,22 @@ class OCLabel(OpenShiftCLI):
         self.kind = kind
         self.kubeconfig = kubeconfig
         self.labels = labels
+        self._curr_labels = None
         self.selector = selector
 
-    def get_current_labels(self):
-        ''' get the current labels on object '''
+    @property
+    def current_labels(self):
+        '''property for the current labels'''
+        if self._curr_labels is None:
+            results = self.get()
+            self._curr_labels = results['labels']
 
-        return self.get()['results']['labels']
+        return self._curr_labels
+
+    @current_labels.setter
+    def current_labels(self, data):
+        '''property setter for current labels'''
+        self._curr_labels = data
 
     def compare_labels(self, host_labels):
         ''' compare incoming labels against current labels'''
@@ -1252,9 +1263,7 @@ class OCLabel(OpenShiftCLI):
     def all_user_labels_exist(self):
         ''' return whether all the labels already exist '''
 
-        current_labels = self.get_current_labels()
-
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             rbool = self.compare_labels(current_host_labels)
             if rbool == False:
                 return False
@@ -1262,9 +1271,8 @@ class OCLabel(OpenShiftCLI):
 
     def any_label_exists(self):
         ''' return whether any single label already exists '''
-        current_labels = self.get_current_labels()
 
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             for label in self.labels:
                 if label['key'] in current_host_labels:
                     return True
@@ -1283,8 +1291,7 @@ class OCLabel(OpenShiftCLI):
         ''' collect all the current label keys '''
 
         current_label_keys = []
-        current_labels = self.get_current_labels()
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             for key in current_host_labels.keys():
                 current_label_keys.append(key)
 
@@ -1294,7 +1301,6 @@ class OCLabel(OpenShiftCLI):
         ''' return list of labels that are currently stored, but aren't
             in user-provided list '''
 
-        current_labels = self.get_current_labels()
         extra_labels = []
         user_label_keys = self.get_user_keys()
         current_label_keys = self.get_current_label_keys()
@@ -1311,7 +1317,7 @@ class OCLabel(OpenShiftCLI):
         extra_labels = self.get_extra_current_labels()
 
         if len(extra_labels) > 0:
-                return True
+            return True
         else:
             return False
 
@@ -1357,8 +1363,9 @@ class OCLabel(OpenShiftCLI):
                 else:
                     label_list.append({})
 
-        result_dict['labels'] = label_list
-        result_dict['item_count'] = len(label_list)
+        self.current_labels = label_list
+        result_dict['labels'] = self.current_labels
+        result_dict['item_count'] = len(self.current_labels)
         result['results'] = result_dict
 
         return result
@@ -1366,17 +1373,12 @@ class OCLabel(OpenShiftCLI):
     def cmd_template(self):
         ''' boilerplate oc command for modifying lables on this object '''
         # let's build the cmd with what we have passed in
-        cmd = []
-        if self.namespace:
-            cmd = cmd + ["-n", self.namespace]
+        cmd = ["label", self.kind]
 
         if self.selector:
-            cmd = cmd + ["--selector", self.selector]
-
-        cmd = cmd + ["--config", self.kubeconfig, "label", self.kind]
-
-        if self.name:
-            cmd = cmd + [self.name]
+            cmd.extend(["--selector", self.selector])
+        elif self.name:
+            cmd.extend([self.name])
 
         return cmd
 
diff --git a/roles/lib_openshift/src/class/oc_label.py b/roles/lib_openshift/src/class/oc_label.py
index 9c65b1760..4fc2ffc13 100644
--- a/roles/lib_openshift/src/class/oc_label.py
+++ b/roles/lib_openshift/src/class/oc_label.py
@@ -1,6 +1,7 @@
 # pylint: skip-file
 # flake8: noqa
 
+
 # pylint: disable=too-many-instance-attributes
 class OCLabel(OpenShiftCLI):
     ''' Class to wrap the oc command line tools '''
@@ -22,12 +23,22 @@ class OCLabel(OpenShiftCLI):
         self.kind = kind
         self.kubeconfig = kubeconfig
         self.labels = labels
+        self._curr_labels = None
         self.selector = selector
 
-    def get_current_labels(self):
-        ''' get the current labels on object '''
+    @property
+    def current_labels(self):
+        '''property for the current labels'''
+        if self._curr_labels is None:
+            results = self.get()
+            self._curr_labels = results['labels']
+
+        return self._curr_labels
 
-        return self.get()['results']['labels']
+    @current_labels.setter
+    def current_labels(self, data):
+        '''property setter for current labels'''
+        self._curr_labels = data
 
     def compare_labels(self, host_labels):
         ''' compare incoming labels against current labels'''
@@ -41,9 +52,7 @@ class OCLabel(OpenShiftCLI):
     def all_user_labels_exist(self):
         ''' return whether all the labels already exist '''
 
-        current_labels = self.get_current_labels()
-
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             rbool = self.compare_labels(current_host_labels)
             if rbool == False:
                 return False
@@ -51,9 +60,8 @@ class OCLabel(OpenShiftCLI):
 
     def any_label_exists(self):
         ''' return whether any single label already exists '''
-        current_labels = self.get_current_labels()
 
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             for label in self.labels:
                 if label['key'] in current_host_labels:
                     return True
@@ -72,8 +80,7 @@ class OCLabel(OpenShiftCLI):
         ''' collect all the current label keys '''
 
         current_label_keys = []
-        current_labels = self.get_current_labels()
-        for current_host_labels in current_labels:
+        for current_host_labels in self.current_labels:
             for key in current_host_labels.keys():
                 current_label_keys.append(key)
 
@@ -83,7 +90,6 @@ class OCLabel(OpenShiftCLI):
         ''' return list of labels that are currently stored, but aren't
             in user-provided list '''
 
-        current_labels = self.get_current_labels()
         extra_labels = []
         user_label_keys = self.get_user_keys()
         current_label_keys = self.get_current_label_keys()
@@ -100,7 +106,7 @@ class OCLabel(OpenShiftCLI):
         extra_labels = self.get_extra_current_labels()
 
         if len(extra_labels) > 0:
-                return True
+            return True
         else:
             return False
 
@@ -146,8 +152,9 @@ class OCLabel(OpenShiftCLI):
                 else:
                     label_list.append({})
 
-        result_dict['labels'] = label_list
-        result_dict['item_count'] = len(label_list)
+        self.current_labels = label_list
+        result_dict['labels'] = self.current_labels
+        result_dict['item_count'] = len(self.current_labels)
         result['results'] = result_dict
 
         return result
@@ -155,17 +162,12 @@ class OCLabel(OpenShiftCLI):
     def cmd_template(self):
         ''' boilerplate oc command for modifying lables on this object '''
         # let's build the cmd with what we have passed in
-        cmd = []
-        if self.namespace:
-            cmd = cmd + ["-n", self.namespace]
+        cmd = ["label", self.kind]
 
         if self.selector:
-            cmd = cmd + ["--selector", self.selector]
-
-        cmd = cmd + ["--config", self.kubeconfig, "label", self.kind]
-
-        if self.name:
-            cmd = cmd + [self.name]
+            cmd.extend(["--selector", self.selector])
+        elif self.name:
+            cmd.extend([self.name])
 
         return cmd
 
diff --git a/roles/lib_openshift/src/doc/label b/roles/lib_openshift/src/doc/label
index 1274d58c1..e206d0d06 100644
--- a/roles/lib_openshift/src/doc/label
+++ b/roles/lib_openshift/src/doc/label
@@ -11,7 +11,6 @@ options:
   state:
     description:
     - State represents whether to create, modify, delete, or list
-    required: true
     default: present
     choices: ["present", "absent", "list", "add"]
     aliases: []
@@ -30,8 +29,7 @@ options:
   kind:
     description:
     - The kind of object that can be managed.
-    required: True
-    default: None
+    default: node
     choices:
     - node
     - pod
diff --git a/roles/lib_openshift/src/test/unit/oc_label.py b/roles/lib_openshift/src/test/unit/oc_label.py
new file mode 100755
index 000000000..875b97c42
--- /dev/null
+++ b/roles/lib_openshift/src/test/unit/oc_label.py
@@ -0,0 +1,188 @@
+#!/usr/bin/env python2
+'''
+ Unit tests for oc label
+'''
+# To run
+# python -m unittest version
+#
+# .
+# Ran 1 test in 0.597s
+#
+# OK
+
+import os
+import sys
+import unittest
+import mock
+
+# 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 class in our python path
+module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library')  # noqa: E501
+sys.path.insert(0, module_path)
+from oc_label import OCLabel  # noqa: E402
+
+
+class OCLabelTest(unittest.TestCase):
+    '''
+     Test class for OCLabel
+    '''
+
+    def setUp(self):
+        ''' setup method will create a file and set to known configuration '''
+        pass
+
+    @mock.patch('oc_label.OCLabel._run')
+    def test_state_list(self, mock_cmd):
+        ''' Testing a label list '''
+        params = {'name': 'default',
+                  'namespace': 'default',
+                  'labels': None,
+                  'state': 'list',
+                  'kind': 'namespace',
+                  'selector': None,
+                  'kubeconfig': '/etc/origin/master/admin.kubeconfig',
+                  'debug': False}
+
+        ns = '''{
+            "kind": "Namespace",
+            "apiVersion": "v1",
+            "metadata": {
+                "name": "default",
+                "selfLink": "/api/v1/namespaces/default",
+                "uid": "c45b9547-e3d3-11e6-ba9c-0eece8f2ce22",
+                "resourceVersion": "403024",
+                "creationTimestamp": "2017-01-26T14:28:55Z",
+                "labels": {
+                    "storage_pv_quota": "False"
+                },
+                "annotations": {
+                    "openshift.io/node-selector": "",
+                    "openshift.io/sa.initialized-roles": "true",
+                    "openshift.io/sa.scc.mcs": "s0:c1,c0",
+                    "openshift.io/sa.scc.supplemental-groups": "1000000000/10000",
+                    "openshift.io/sa.scc.uid-range": "1000000000/10000"
+                }
+            },
+            "spec": {
+                "finalizers": [
+                    "kubernetes",
+                    "openshift.io/origin"
+                ]
+            },
+            "status": {
+                "phase": "Active"
+            }
+        }'''
+
+
+        mock_cmd.side_effect = [
+            (0, ns, ''),
+        ]
+
+        results = OCLabel.run_ansible(params, False)
+
+        self.assertFalse(results['changed'])
+        self.assertTrue(results['results']['labels'] == [{'storage_pv_quota': 'False'}])
+
+    @mock.patch('oc_label.OCLabel._run')
+    def test_state_present(self, mock_cmd):
+        ''' Testing a label list '''
+        params = {'name': 'default',
+                  'namespace': 'default',
+                  'labels': [
+                      {'key': 'awesomens', 'value': 'testinglabel'},
+                      {'key': 'storage_pv_quota', 'value': 'False'}
+                  ],
+                  'state': 'present',
+                  'kind': 'namespace',
+                  'selector': None,
+                  'kubeconfig': '/etc/origin/master/admin.kubeconfig',
+                  'debug': False}
+
+        ns = '''{
+            "kind": "Namespace",
+            "apiVersion": "v1",
+            "metadata": {
+                "name": "default",
+                "selfLink": "/api/v1/namespaces/default",
+                "uid": "c45b9547-e3d3-11e6-ba9c-0eece8f2ce22",
+                "resourceVersion": "403024",
+                "creationTimestamp": "2017-01-26T14:28:55Z",
+                "labels": {
+                    "storage_pv_quota": "False"
+                },
+                "annotations": {
+                    "openshift.io/node-selector": "",
+                    "openshift.io/sa.initialized-roles": "true",
+                    "openshift.io/sa.scc.mcs": "s0:c1,c0",
+                    "openshift.io/sa.scc.supplemental-groups": "1000000000/10000",
+                    "openshift.io/sa.scc.uid-range": "1000000000/10000"
+                }
+            },
+            "spec": {
+                "finalizers": [
+                    "kubernetes",
+                    "openshift.io/origin"
+                ]
+            },
+            "status": {
+                "phase": "Active"
+            }
+        }'''
+
+        ns1 = '''{
+            "kind": "Namespace",
+            "apiVersion": "v1",
+            "metadata": {
+                "name": "default",
+                "selfLink": "/api/v1/namespaces/default",
+                "uid": "c45b9547-e3d3-11e6-ba9c-0eece8f2ce22",
+                "resourceVersion": "403024",
+                "creationTimestamp": "2017-01-26T14:28:55Z",
+                "labels": {
+                    "storage_pv_quota": "False",
+                    "awesomens": "testinglabel"
+                },
+                "annotations": {
+                    "openshift.io/node-selector": "",
+                    "openshift.io/sa.initialized-roles": "true",
+                    "openshift.io/sa.scc.mcs": "s0:c1,c0",
+                    "openshift.io/sa.scc.supplemental-groups": "1000000000/10000",
+                    "openshift.io/sa.scc.uid-range": "1000000000/10000"
+                }
+            },
+            "spec": {
+                "finalizers": [
+                    "kubernetes",
+                    "openshift.io/origin"
+                ]
+            },
+            "status": {
+                "phase": "Active"
+            }
+        }'''
+
+
+        mock_cmd.side_effect = [
+            (0, ns, ''),
+            (0, '', ''),
+            (0, ns1, ''),
+        ]
+
+        results = OCLabel.run_ansible(params, False)
+
+        self.assertTrue(results['changed'])
+        self.assertTrue(results['results']['results']['labels'][0] == \
+                       {'storage_pv_quota': 'False', 'awesomens': 'testinglabel'})
+
+    def tearDown(self):
+        '''TearDown method'''
+        pass
+
+
+if __name__ == "__main__":
+    unittest.main()
-- 
cgit v1.2.3


From f94417164f57891eb016ca5e98c6e713e1f66726 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Thu, 2 Feb 2017 09:36:01 -0500
Subject: Fixing linters.

---
 roles/lib_openshift/library/oc_label.py            | 11 +--
 roles/lib_openshift/src/ansible/oc_label.py        |  4 +-
 roles/lib_openshift/src/class/oc_label.py          |  7 +-
 .../src/test/integration/filter_plugins/filters.py |  1 +
 .../src/test/integration/oc_label.yml              | 85 +---------------------
 roles/lib_openshift/src/test/unit/oc_label.py      |  6 +-
 6 files changed, 17 insertions(+), 97 deletions(-)

diff --git a/roles/lib_openshift/library/oc_label.py b/roles/lib_openshift/library/oc_label.py
index 8840bfefa..2096f0a1d 100644
--- a/roles/lib_openshift/library/oc_label.py
+++ b/roles/lib_openshift/library/oc_label.py
@@ -1265,7 +1265,7 @@ class OCLabel(OpenShiftCLI):
 
         for current_host_labels in self.current_labels:
             rbool = self.compare_labels(current_host_labels)
-            if rbool == False:
+            if not rbool:
                 return False
         return True
 
@@ -1318,8 +1318,8 @@ class OCLabel(OpenShiftCLI):
 
         if len(extra_labels) > 0:
             return True
-        else:
-            return False
+
+        return False
 
     def replace(self):
         ''' replace currently stored labels with user provided labels '''
@@ -1401,6 +1401,7 @@ class OCLabel(OpenShiftCLI):
 
         return self.openshift_cmd(cmd)
 
+    # pylint: disable=too-many-branches,too-many-return-statements
     @staticmethod
     def run_ansible(params, check_mode=False):
         ''' run the idempotent ansible code
@@ -1517,14 +1518,14 @@ def main():
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
             kind=dict(default=None, type='str', required=True,
-                          choices=['node', 'pod', 'namespace']),
+                      choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
             labels=dict(default=None, type='list'),
             selector=dict(default=None, type='str'),
         ),
         supports_check_mode=True,
-        mutually_exclusive = (['name', 'selector']),
+        mutually_exclusive=(['name', 'selector']),
     )
 
     results = OCLabel.run_ansible(module.params, module.check_mode)
diff --git a/roles/lib_openshift/src/ansible/oc_label.py b/roles/lib_openshift/src/ansible/oc_label.py
index 149b965d8..685712963 100644
--- a/roles/lib_openshift/src/ansible/oc_label.py
+++ b/roles/lib_openshift/src/ansible/oc_label.py
@@ -11,14 +11,14 @@ def main():
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
             kind=dict(default=None, type='str', required=True,
-                          choices=['node', 'pod', 'namespace']),
+                      choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
             labels=dict(default=None, type='list'),
             selector=dict(default=None, type='str'),
         ),
         supports_check_mode=True,
-        mutually_exclusive = (['name', 'selector']),
+        mutually_exclusive=(['name', 'selector']),
     )
 
     results = OCLabel.run_ansible(module.params, module.check_mode)
diff --git a/roles/lib_openshift/src/class/oc_label.py b/roles/lib_openshift/src/class/oc_label.py
index 4fc2ffc13..8e1ba9ceb 100644
--- a/roles/lib_openshift/src/class/oc_label.py
+++ b/roles/lib_openshift/src/class/oc_label.py
@@ -54,7 +54,7 @@ class OCLabel(OpenShiftCLI):
 
         for current_host_labels in self.current_labels:
             rbool = self.compare_labels(current_host_labels)
-            if rbool == False:
+            if not rbool:
                 return False
         return True
 
@@ -107,8 +107,8 @@ class OCLabel(OpenShiftCLI):
 
         if len(extra_labels) > 0:
             return True
-        else:
-            return False
+
+        return False
 
     def replace(self):
         ''' replace currently stored labels with user provided labels '''
@@ -190,6 +190,7 @@ class OCLabel(OpenShiftCLI):
 
         return self.openshift_cmd(cmd)
 
+    # pylint: disable=too-many-branches,too-many-return-statements
     @staticmethod
     def run_ansible(params, check_mode=False):
         ''' run the idempotent ansible code
diff --git a/roles/lib_openshift/src/test/integration/filter_plugins/filters.py b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
index 6acbb47ec..71a29ab7d 100644
--- a/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
+++ b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
@@ -5,6 +5,7 @@
 Custom filters for use in testing
 '''
 
+
 class FilterModule(object):
     ''' Custom ansible filters '''
 
diff --git a/roles/lib_openshift/src/test/integration/oc_label.yml b/roles/lib_openshift/src/test/integration/oc_label.yml
index 0a2d438bd..ce9bc25bb 100755
--- a/roles/lib_openshift/src/test/integration/oc_label.yml
+++ b/roles/lib_openshift/src/test/integration/oc_label.yml
@@ -15,8 +15,8 @@
       msg: "{{ item }} not defined"
     when: "{{ item }} is not defined"
     with_items:
-    - cli_node_test #openshift node to be used to add/remove labels to
-    - cli_master_test #ansible inventory instance to run playbook against
+    - cli_node_test  # openshift node to be used to add/remove labels to
+    - cli_master_test  # ansible inventory instance to run playbook against
 
   tasks:
   - name: delete test labels (start from known starting position)
@@ -321,84 +321,3 @@
     assert:
       that: label_out['results']['labels'][0]['testlabel2'] is not defined
       msg: "{{ label_out }}"
-
-
-
-
-
-
-
-
-
-
-
-#  - name: create route
-#    oc_route:
-#      name: test
-#      namespace: default
-#      tls_termination: edge
-#      cert_content: testing cert
-#      cacert_content: testing cacert
-#      key_content: key content
-#      service_name: test
-#      host: test.example
-#    register: routeout
-#  - debug: var=routeout
-#
-#  - assert:
-#      that: "routeout.results.results[0]['metadata']['name'] == 'test'"
-#      msg: route create failed
-#
-#  - name: get route
-#    oc_route:
-#      state: list
-#      name: test
-#      namespace: default
-#    register: routeout
-#  - debug: var=routeout
-#
-#  - assert:
-#      that: "routeout.results[0]['metadata']['name'] == 'test'"
-#      msg: get route failed
-#
-#  - name: delete route
-#    oc_route:
-#      state: absent
-#      name: test
-#      namespace: default
-#    register: routeout
-#  - debug: var=routeout
-#
-#  - assert:
-#      that: "routeout.results.returncode == 0"
-#      msg: delete route failed
-#
-#  - name: create route
-#    oc_route:
-#      name: test
-#      namespace: default
-#      tls_termination: edge
-#      cert_content: testing cert
-#      cacert_content: testing cacert
-#      key_content: testing key
-#      service_name: test
-#      host: test.example
-#    register: routeout
-#  - debug: var=routeout
-#
-#  - name: create route noop
-#    oc_route:
-#      name: test
-#      namespace: default
-#      tls_termination: edge
-#      cert_content: testing cert
-#      cacert_content: testing cacert
-#      key_content: testing key
-#      service_name: test
-#      host: test.example
-#    register: routeout
-#  - debug: var=routeout
-#
-#  - assert:
-#      that: "routeout.changed == False"
-#      msg: Route create not idempotent
diff --git a/roles/lib_openshift/src/test/unit/oc_label.py b/roles/lib_openshift/src/test/unit/oc_label.py
index 875b97c42..3f7162070 100755
--- a/roles/lib_openshift/src/test/unit/oc_label.py
+++ b/roles/lib_openshift/src/test/unit/oc_label.py
@@ -78,7 +78,6 @@ class OCLabelTest(unittest.TestCase):
             }
         }'''
 
-
         mock_cmd.side_effect = [
             (0, ns, ''),
         ]
@@ -166,7 +165,6 @@ class OCLabelTest(unittest.TestCase):
             }
         }'''
 
-
         mock_cmd.side_effect = [
             (0, ns, ''),
             (0, '', ''),
@@ -176,8 +174,8 @@ class OCLabelTest(unittest.TestCase):
         results = OCLabel.run_ansible(params, False)
 
         self.assertTrue(results['changed'])
-        self.assertTrue(results['results']['results']['labels'][0] == \
-                       {'storage_pv_quota': 'False', 'awesomens': 'testinglabel'})
+        self.assertTrue(results['results']['results']['labels'][0] ==
+                        {'storage_pv_quota': 'False', 'awesomens': 'testinglabel'})
 
     def tearDown(self):
         '''TearDown method'''
-- 
cgit v1.2.3


From 4b054d7da5f404dfd8eb238b617e4dcf7dc93b17 Mon Sep 17 00:00:00 2001
From: Kenny Woodson <kwoodson@redhat.com>
Date: Thu, 2 Feb 2017 22:21:23 -0500
Subject: Doc enhancements.

---
 roles/lib_openshift/library/oc_label.py            | 36 +++++++++++++++++++---
 roles/lib_openshift/src/ansible/oc_label.py        |  2 +-
 roles/lib_openshift/src/doc/label                  | 34 ++++++++++++++++++--
 .../src/test/integration/filter_plugins/filters.py |  7 +++--
 4 files changed, 69 insertions(+), 10 deletions(-)

diff --git a/roles/lib_openshift/library/oc_label.py b/roles/lib_openshift/library/oc_label.py
index 2096f0a1d..9481d2a47 100644
--- a/roles/lib_openshift/library/oc_label.py
+++ b/roles/lib_openshift/library/oc_label.py
@@ -55,7 +55,11 @@ description:
 options:
   state:
     description:
-    - State represents whether to create, modify, delete, or list
+    - State controls the action that will be taken with resource
+    - 'present' will create or update and object to the desired state
+    - 'absent' will ensure certain labels are removed
+    - 'list' will read the labels
+    - 'add' will insert labels to the already existing labels
     default: present
     choices: ["present", "absent", "list", "add"]
     aliases: []
@@ -82,7 +86,9 @@ options:
     aliases: []
   labels:
     description:
-    - A list of labels to for the resource.
+    - A list of labels for the resource.
+    - Each list consists of a key and a value.
+    - eg, {'key': 'foo', 'value': 'bar'}
     required: false
     default: None
     aliases: []
@@ -98,7 +104,7 @@ extends_documentation_fragment: []
 '''
 
 EXAMPLES = '''
-- name: Add label to node
+- name: Add a single label to a node's existing labels
   oc_label:
     name: ip-172-31-5-23.ec2.internal
     state: add
@@ -106,6 +112,28 @@ EXAMPLES = '''
     labels:
       - key: logging-infra-fluentd
         value: 'true'
+
+- name: remove a label from a node
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: absent
+    kind: node
+    labels:
+      - key: color
+        value: blue
+
+- name: Ensure node has these exact labels
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: present
+    kind: node
+    labels:
+      - key: color
+        value: green
+      - key: type
+        value: master
+      - key: environment
+        value: production
 '''
 
 # -*- -*- -*- End included fragment: doc/label -*- -*- -*-
@@ -1517,7 +1545,7 @@ def main():
             state=dict(default='present', type='str',
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
-            kind=dict(default=None, type='str', required=True,
+            kind=dict(default='node', type='str', required=True,
                       choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
diff --git a/roles/lib_openshift/src/ansible/oc_label.py b/roles/lib_openshift/src/ansible/oc_label.py
index 685712963..28f004621 100644
--- a/roles/lib_openshift/src/ansible/oc_label.py
+++ b/roles/lib_openshift/src/ansible/oc_label.py
@@ -10,7 +10,7 @@ def main():
             state=dict(default='present', type='str',
                        choices=['present', 'absent', 'list', 'add']),
             debug=dict(default=False, type='bool'),
-            kind=dict(default=None, type='str', required=True,
+            kind=dict(default='node', type='str', required=True,
                       choices=['node', 'pod', 'namespace']),
             name=dict(default=None, type='str'),
             namespace=dict(default=None, type='str'),
diff --git a/roles/lib_openshift/src/doc/label b/roles/lib_openshift/src/doc/label
index e206d0d06..fb3ed2503 100644
--- a/roles/lib_openshift/src/doc/label
+++ b/roles/lib_openshift/src/doc/label
@@ -10,7 +10,11 @@ description:
 options:
   state:
     description:
-    - State represents whether to create, modify, delete, or list
+    - State controls the action that will be taken with resource
+    - 'present' will create or update and object to the desired state
+    - 'absent' will ensure certain labels are removed
+    - 'list' will read the labels
+    - 'add' will insert labels to the already existing labels
     default: present
     choices: ["present", "absent", "list", "add"]
     aliases: []
@@ -37,7 +41,9 @@ options:
     aliases: []
   labels:
     description:
-    - A list of labels to for the resource.
+    - A list of labels for the resource.
+    - Each list consists of a key and a value.
+    - eg, {'key': 'foo', 'value': 'bar'}
     required: false
     default: None
     aliases: []
@@ -53,7 +59,7 @@ extends_documentation_fragment: []
 '''
 
 EXAMPLES = '''
-- name: Add label to node
+- name: Add a single label to a node's existing labels
   oc_label:
     name: ip-172-31-5-23.ec2.internal
     state: add
@@ -61,4 +67,26 @@ EXAMPLES = '''
     labels:
       - key: logging-infra-fluentd
         value: 'true'
+
+- name: remove a label from a node
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: absent
+    kind: node
+    labels:
+      - key: color
+        value: blue
+
+- name: Ensure node has these exact labels
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: present
+    kind: node
+    labels:
+      - key: color
+        value: green
+      - key: type
+        value: master
+      - key: environment
+        value: production
 '''
diff --git a/roles/lib_openshift/src/test/integration/filter_plugins/filters.py b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
index 71a29ab7d..6990a11a8 100644
--- a/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
+++ b/roles/lib_openshift/src/test/integration/filter_plugins/filters.py
@@ -7,11 +7,14 @@ Custom filters for use in testing
 
 
 class FilterModule(object):
-    ''' Custom ansible filters '''
+    ''' Custom filters for use in integration testing '''
 
     @staticmethod
     def label_dict_to_key_value_list(label_dict):
-        ''' given a dict of labels/values, return list of key: <key> value: <value> pairs'''
+        ''' Given a dict of labels/values, return list of key: <key> value: <value> pairs
+
+            These are only used in integration testing.
+        '''
 
         label_list = []
         for key in label_dict:
-- 
cgit v1.2.3