diff options
| author | Kenny Woodson <kwoodson@redhat.com> | 2017-01-13 14:29:48 -0500 | 
|---|---|---|
| committer | Kenny Woodson <kwoodson@redhat.com> | 2017-01-17 10:47:16 -0500 | 
| commit | ea33e223e34bb2b8efae6b165f3ac9729357cb46 (patch) | |
| tree | 73c704561e5896835b1fcfbf281a7c700bfa4ee3 /roles/lib_openshift | |
| parent | 07331b47724dbb7cd6952c1a2af54275ace7726e (diff) | |
| download | openshift-ea33e223e34bb2b8efae6b165f3ac9729357cb46.tar.gz openshift-ea33e223e34bb2b8efae6b165f3ac9729357cb46.tar.bz2 openshift-ea33e223e34bb2b8efae6b165f3ac9729357cb46.tar.xz openshift-ea33e223e34bb2b8efae6b165f3ac9729357cb46.zip | |
Adding oc_edit module to lib_openshift.
Diffstat (limited to 'roles/lib_openshift')
| -rw-r--r-- | roles/lib_openshift/library/oc_edit.py | 1311 | ||||
| -rw-r--r-- | roles/lib_openshift/library/oc_route.py | 925 | ||||
| -rw-r--r-- | roles/lib_openshift/src/ansible/oc_edit.py | 48 | ||||
| -rw-r--r-- | roles/lib_openshift/src/class/oc_edit.py | 94 | ||||
| -rw-r--r-- | roles/lib_openshift/src/class/oc_route.py | 1 | ||||
| -rw-r--r-- | roles/lib_openshift/src/doc/edit | 116 | ||||
| -rw-r--r-- | roles/lib_openshift/src/doc/route | 6 | ||||
| -rwxr-xr-x | roles/lib_openshift/src/generate.py | 3 | ||||
| -rw-r--r-- | roles/lib_openshift/src/lib/base.py | 66 | ||||
| -rw-r--r-- | roles/lib_openshift/src/lib/import.py | 5 | ||||
| -rw-r--r-- | roles/lib_openshift/src/lib/route.py | 1 | ||||
| -rw-r--r-- | roles/lib_openshift/src/sources.yml (renamed from roles/lib_openshift/src/generate_sources.yml) | 10 | ||||
| -rw-r--r-- | roles/lib_openshift/src/test/integration/route.yml | 58 | 
13 files changed, 2143 insertions, 501 deletions
| diff --git a/roles/lib_openshift/library/oc_edit.py b/roles/lib_openshift/library/oc_edit.py new file mode 100644 index 000000000..f78cbf2b3 --- /dev/null +++ b/roles/lib_openshift/library/oc_edit.py @@ -0,0 +1,1311 @@ +#!/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_edit +short_description: Modify, and idempotently manage openshift objects. +description: +  - Modify openshift objects programmatically. +options: +  state: +    description: +    - Currently present is only supported state. +    required: true +    default: present +    choices: ["present"] +    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: str +    aliases: [] +  kind: +    description: +    - The kind attribute of the object. +    required: True +    default: None +    choices: +    - bc +    - buildconfig +    - configmaps +    - dc +    - deploymentconfig +    - imagestream +    - imagestreamtag +    - is +    - istag +    - namespace +    - project +    - projects +    - node +    - ns +    - persistentvolume +    - pv +    - rc +    - replicationcontroller +    - routes +    - scc +    - secret +    - securitycontextconstraints +    - service +    - svc +    aliases: [] +  file_name: +    description: +    - The file name in which to edit +    required: false +    default: None +    aliases: [] +  file_format: +    description: +    - The format of the file being edited. +    required: false +    default: yaml +    aliases: [] +  content: +    description: +    - Content of the file +    required: false +    default: None +    aliases: [] +  force: +    description: +    - Whether or not to force the operation +    required: false +    default: None +    aliases: [] +  separator: +    description: +    - The separator format for the edit. +    required: false +    default: '.' +    aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +oc_edit: +  kind: rc +  name: hawkular-cassandra-rc +  namespace: openshift-infra +  content: +    spec.template.spec.containers[0].resources.limits.memory: 512 +    spec.template.spec.containers[0].resources.requests.memory: 256 +''' +# 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): +        '''return all pods ''' +        cmd = ['-n', self.namespace, 'replace', '-f', fname] +        if force: +            cmd.append('--force') +        return self.openshift_cmd(cmd) + +    def _create_from_content(self, rname, content): +        '''return all pods ''' +        fname = '/tmp/%s' % rname +        yed = Yedit(fname, content=content) +        yed.write() + +        atexit.register(Utils.cleanup, [fname]) + +        return self._create(fname) + +    def _create(self, fname): +        '''return all pods ''' +        return self.openshift_cmd(['create', '-f', fname, '-n', self.namespace]) + +    def _delete(self, resource, rname, selector=None): +        '''return all pods ''' +        cmd = ['delete', resource, rname, '-n', self.namespace] +        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 +        '''return all pods ''' +        cmd = ['process', '-n', self.namespace] +        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(['-n', self.namespace, '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) +        if self.all_namespaces: +            cmd.extend(['--all-namespaces']) +        elif self.namespace: +            cmd.extend(['-n', self.namespace]) + +        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 manage-node evacuate ''' +        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 _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 +    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'] + +        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 str(err): +                            err = str(err) +                elif output_type == 'raw': +                    rval['results'] = stdout + +            if self.verbose: +                print(stdout) +                print(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 + +    # 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 + + +class Edit(OpenShiftCLI): +    ''' Class to wrap the oc command line tools +    ''' +    # pylint: disable=too-many-arguments +    def __init__(self, +                 kind, +                 namespace, +                 resource_name=None, +                 kubeconfig='/etc/origin/master/admin.kubeconfig', +                 separator='.', +                 verbose=False): +        ''' Constructor for OpenshiftOC ''' +        super(Edit, self).__init__(namespace, kubeconfig) +        self.namespace = namespace +        self.kind = kind +        self.name = resource_name +        self.kubeconfig = kubeconfig +        self.separator = separator +        self.verbose = verbose + +    def get(self): +        '''return a secret by name ''' +        return self._get(self.kind, self.name) + +    def update(self, file_name, content, force=False, content_type='yaml'): +        '''run update ''' +        if file_name: +            if content_type == 'yaml': +                data = yaml.load(open(file_name)) +            elif content_type == 'json': +                data = json.loads(open(file_name).read()) + +            changes = [] +            yed = Yedit(filename=file_name, content=data, separator=self.separator) +            for key, value in content.items(): +                changes.append(yed.put(key, value)) + +            if any([not change[0] for change in changes]): +                return {'returncode': 0, 'updated': False} + +            yed.write() + +            atexit.register(Utils.cleanup, [file_name]) + +            return self._replace(file_name, force=force) + +        return self._replace_content(self.kind, self.name, content, force=force, sep=self.separator) + +    @staticmethod +    def run_ansible(params, check_mode): +        '''run the ansible idempotent code''' + +        ocedit = Edit(params['kind'], +                      params['namespace'], +                      params['name'], +                      kubeconfig=params['kubeconfig'], +                      separator=params['separator'], +                      verbose=params['debug']) + +        api_rval = ocedit.get() + +        ######## +        # Create +        ######## +        if not Utils.exists(api_rval['results'], params['name']): +            return {"failed": True, 'msg': api_rval} + +        ######## +        # Update +        ######## +        if check_mode: +            return {'changed': True, 'msg': 'CHECK_MODE: Would have performed edit'} + +        api_rval = ocedit.update(params['file_name'], +                                 params['content'], +                                 params['force'], +                                 params['file_format']) + +        if api_rval['returncode'] != 0: +            return {"failed": True, 'msg': api_rval} + +        if 'updated' in api_rval and not api_rval['updated']: +            return {"changed": False, 'results': api_rval, 'state': 'present'} + +        # return the created object +        api_rval = ocedit.get() + +        if api_rval['returncode'] != 0: +            return {"failed": True, 'msg': api_rval} + +        return {"changed": True, 'results': api_rval, 'state': 'present'} + + +def main(): +    ''' +    ansible oc module for editing objects +    ''' + +    module = AnsibleModule( +        argument_spec=dict( +            kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'), +            state=dict(default='present', type='str', +                       choices=['present']), +            debug=dict(default=False, type='bool'), +            namespace=dict(default='default', type='str'), +            name=dict(default=None, required=True, type='str'), +            kind=dict(required=True, +                      type='str', +                      choices=['dc', 'deploymentconfig', +                               'rc', 'replicationcontroller', +                               'svc', 'service', +                               'scc', 'securitycontextconstraints', +                               'ns', 'namespace', 'project', 'projects', +                               'is', 'imagestream', +                               'istag', 'imagestreamtag', +                               'bc', 'buildconfig', +                               'routes', +                               'node', +                               'secret', +                               'pv', 'persistentvolume']), +            file_name=dict(default=None, type='str'), +            file_format=dict(default='yaml', type='str'), +            content=dict(default=None, required=True, type='dict'), +            force=dict(default=False, type='bool'), +            separator=dict(default='.', type='str'), +        ), +        supports_check_mode=True, +    ) + +    rval = Edit.run_ansible(module.params, module.check_mode) +    if 'failed' in rval: +        module.fail_json(**rval) + +    module.exit_json(**rval) + +if __name__ == '__main__': +    main() diff --git a/roles/lib_openshift/library/oc_route.py b/roles/lib_openshift/library/oc_route.py index 9efa6d0c7..de186ded7 100644 --- a/roles/lib_openshift/library/oc_route.py +++ b/roles/lib_openshift/library/oc_route.py @@ -1,5 +1,6 @@  #!/usr/bin/env python  # pylint: disable=missing-docstring +# flake8: noqa: T001  #     ___ ___ _  _ ___ ___    _ _____ ___ ___  #    / __| __| \| | __| _ \  /_\_   _| __|   \  #   | (_ | _|| .` | _||   / / _ \| | | _|| |) | @@ -28,22 +29,23 @@  '''  # pylint: disable=too-many-lines - +from __future__ import print_function  import atexit  import json  import os  import re -import ruamel.yaml as yaml  import shutil  import subprocess +# pylint: disable=import-error +import ruamel.yaml as yaml  from ansible.module_utils.basic import AnsibleModule  DOCUMENTATION = '''  --- -module: yedit -short_description: Create, modify, and idempotently manage yaml files. +module: oc_route +short_description: Create, modify, and idempotently manage openshift routes.  description: -  - Modify yaml files programmatically. +  - Manage openshift route objects programmatically.  options:    state:      description: @@ -155,461 +157,7 @@ EXAMPLES = '''      tls_termination: reencrypt    run_once: true  ''' -''' -   OpenShiftCLI class that wraps the oc commands in a subprocess -''' -# pylint: disable=too-many-lines - - -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): -        '''return all pods ''' -        cmd = ['-n', self.namespace, 'replace', '-f', fname] -        if force: -            cmd.append('--force') -        return self.openshift_cmd(cmd) - -    def _create_from_content(self, rname, content): -        '''return all pods ''' -        fname = '/tmp/%s' % rname -        yed = Yedit(fname, content=content) -        yed.write() - -        atexit.register(Utils.cleanup, [fname]) - -        return self._create(fname) - -    def _create(self, fname): -        '''return all pods ''' -        return self.openshift_cmd(['create', '-f', fname, '-n', self.namespace]) - -    def _delete(self, resource, rname, selector=None): -        '''return all pods ''' -        cmd = ['delete', resource, rname, '-n', self.namespace] -        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 -        '''return all pods ''' -        cmd = ['process', '-n', self.namespace] -        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(['-n', self.namespace, '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) -        if self.all_namespaces: -            cmd.extend(['--all-namespaces']) -        elif self.namespace: -            cmd.extend(['-n', self.namespace]) - -        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 manage-node evacuate ''' -        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 _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 -    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'] - -        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.message: -                            err = err.message -                elif output_type == 'raw': -                    rval['results'] = stdout - -            if self.verbose: -                print stdout -                print 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 - -    # 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 +# noqa: E301,E302  class YeditException(Exception): @@ -617,6 +165,7 @@ class YeditException(Exception):      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/_-]+)).?)+$" @@ -1172,6 +721,461 @@ class Yedit(object):                          '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): +        '''return all pods ''' +        cmd = ['-n', self.namespace, 'replace', '-f', fname] +        if force: +            cmd.append('--force') +        return self.openshift_cmd(cmd) + +    def _create_from_content(self, rname, content): +        '''return all pods ''' +        fname = '/tmp/%s' % rname +        yed = Yedit(fname, content=content) +        yed.write() + +        atexit.register(Utils.cleanup, [fname]) + +        return self._create(fname) + +    def _create(self, fname): +        '''return all pods ''' +        return self.openshift_cmd(['create', '-f', fname, '-n', self.namespace]) + +    def _delete(self, resource, rname, selector=None): +        '''return all pods ''' +        cmd = ['delete', resource, rname, '-n', self.namespace] +        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 +        '''return all pods ''' +        cmd = ['process', '-n', self.namespace] +        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(['-n', self.namespace, '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) +        if self.all_namespaces: +            cmd.extend(['--all-namespaces']) +        elif self.namespace: +            cmd.extend(['-n', self.namespace]) + +        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 manage-node evacuate ''' +        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 _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 +    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'] + +        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 str(err): +                            err = str(err) +                elif output_type == 'raw': +                    rval['results'] = stdout + +            if self.verbose: +                print(stdout) +                print(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 + +    # 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 + +# noqa: E302,E301  # pylint: disable=too-many-instance-attributes @@ -1335,6 +1339,7 @@ class OCRoute(OpenShiftCLI):          skip = []          return not Utils.check_def_equal(self.config.data, self.route.yaml_dict, skip_keys=skip, debug=True) +    # pylint: disable=too-many-return-statements,too-many-branches      @staticmethod      def run_ansible(params, files, check_mode=False):          ''' run the idempotent asnible code diff --git a/roles/lib_openshift/src/ansible/oc_edit.py b/roles/lib_openshift/src/ansible/oc_edit.py new file mode 100644 index 000000000..5c5954747 --- /dev/null +++ b/roles/lib_openshift/src/ansible/oc_edit.py @@ -0,0 +1,48 @@ +# pylint: skip-file +# flake8: noqa + + +def main(): +    ''' +    ansible oc module for editing objects +    ''' + +    module = AnsibleModule( +        argument_spec=dict( +            kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'), +            state=dict(default='present', type='str', +                       choices=['present']), +            debug=dict(default=False, type='bool'), +            namespace=dict(default='default', type='str'), +            name=dict(default=None, required=True, type='str'), +            kind=dict(required=True, +                      type='str', +                      choices=['dc', 'deploymentconfig', +                               'rc', 'replicationcontroller', +                               'svc', 'service', +                               'scc', 'securitycontextconstraints', +                               'ns', 'namespace', 'project', 'projects', +                               'is', 'imagestream', +                               'istag', 'imagestreamtag', +                               'bc', 'buildconfig', +                               'routes', +                               'node', +                               'secret', +                               'pv', 'persistentvolume']), +            file_name=dict(default=None, type='str'), +            file_format=dict(default='yaml', type='str'), +            content=dict(default=None, required=True, type='dict'), +            force=dict(default=False, type='bool'), +            separator=dict(default='.', type='str'), +        ), +        supports_check_mode=True, +    ) + +    rval = Edit.run_ansible(module.params, module.check_mode) +    if 'failed' in rval: +        module.fail_json(**rval) + +    module.exit_json(**rval) + +if __name__ == '__main__': +    main() diff --git a/roles/lib_openshift/src/class/oc_edit.py b/roles/lib_openshift/src/class/oc_edit.py new file mode 100644 index 000000000..0734e2085 --- /dev/null +++ b/roles/lib_openshift/src/class/oc_edit.py @@ -0,0 +1,94 @@ +# pylint: skip-file +# flake8: noqa + +class Edit(OpenShiftCLI): +    ''' Class to wrap the oc command line tools +    ''' +    # pylint: disable=too-many-arguments +    def __init__(self, +                 kind, +                 namespace, +                 resource_name=None, +                 kubeconfig='/etc/origin/master/admin.kubeconfig', +                 separator='.', +                 verbose=False): +        ''' Constructor for OpenshiftOC ''' +        super(Edit, self).__init__(namespace, kubeconfig) +        self.namespace = namespace +        self.kind = kind +        self.name = resource_name +        self.kubeconfig = kubeconfig +        self.separator = separator +        self.verbose = verbose + +    def get(self): +        '''return a secret by name ''' +        return self._get(self.kind, self.name) + +    def update(self, file_name, content, force=False, content_type='yaml'): +        '''run update ''' +        if file_name: +            if content_type == 'yaml': +                data = yaml.load(open(file_name)) +            elif content_type == 'json': +                data = json.loads(open(file_name).read()) + +            changes = [] +            yed = Yedit(filename=file_name, content=data, separator=self.separator) +            for key, value in content.items(): +                changes.append(yed.put(key, value)) + +            if any([not change[0] for change in changes]): +                return {'returncode': 0, 'updated': False} + +            yed.write() + +            atexit.register(Utils.cleanup, [file_name]) + +            return self._replace(file_name, force=force) + +        return self._replace_content(self.kind, self.name, content, force=force, sep=self.separator) + +    @staticmethod +    def run_ansible(params, check_mode): +        '''run the ansible idempotent code''' + +        ocedit = Edit(params['kind'], +                      params['namespace'], +                      params['name'], +                      kubeconfig=params['kubeconfig'], +                      separator=params['separator'], +                      verbose=params['debug']) + +        api_rval = ocedit.get() + +        ######## +        # Create +        ######## +        if not Utils.exists(api_rval['results'], params['name']): +            return {"failed": True, 'msg': api_rval} + +        ######## +        # Update +        ######## +        if check_mode: +            return {'changed': True, 'msg': 'CHECK_MODE: Would have performed edit'} + +        api_rval = ocedit.update(params['file_name'], +                                 params['content'], +                                 params['force'], +                                 params['file_format']) + +        if api_rval['returncode'] != 0: +            return {"failed": True, 'msg': api_rval} + +        if 'updated' in api_rval and not api_rval['updated']: +            return {"changed": False, 'results': api_rval, 'state': 'present'} + +        # return the created object +        api_rval = ocedit.get() + +        if api_rval['returncode'] != 0: +            return {"failed": True, 'msg': api_rval} + +        return {"changed": True, 'results': api_rval, 'state': 'present'} diff --git a/roles/lib_openshift/src/class/oc_route.py b/roles/lib_openshift/src/class/oc_route.py index f0cfa5820..05b1be409 100644 --- a/roles/lib_openshift/src/class/oc_route.py +++ b/roles/lib_openshift/src/class/oc_route.py @@ -64,6 +64,7 @@ class OCRoute(OpenShiftCLI):          skip = []          return not Utils.check_def_equal(self.config.data, self.route.yaml_dict, skip_keys=skip, debug=True) +    # pylint: disable=too-many-return-statements,too-many-branches      @staticmethod      def run_ansible(params, files, check_mode=False):          ''' run the idempotent asnible code diff --git a/roles/lib_openshift/src/doc/edit b/roles/lib_openshift/src/doc/edit new file mode 100644 index 000000000..212d88f65 --- /dev/null +++ b/roles/lib_openshift/src/doc/edit @@ -0,0 +1,116 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_edit +short_description: Modify, and idempotently manage openshift objects. +description: +  - Modify openshift objects programmatically. +options: +  state: +    description: +    - Currently present is only supported state. +    required: true +    default: present +    choices: ["present"] +    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: str +    aliases: [] +  kind: +    description: +    - The kind attribute of the object. +    required: True +    default: None +    choices: +    - bc +    - buildconfig +    - configmaps +    - dc +    - deploymentconfig +    - imagestream +    - imagestreamtag +    - is +    - istag +    - namespace +    - project +    - projects +    - node +    - ns +    - persistentvolume +    - pv +    - rc +    - replicationcontroller +    - routes +    - scc +    - secret +    - securitycontextconstraints +    - service +    - svc +    aliases: [] +  file_name: +    description: +    - The file name in which to edit +    required: false +    default: None +    aliases: [] +  file_format: +    description: +    - The format of the file being edited. +    required: false +    default: yaml +    aliases: [] +  content: +    description: +    - Content of the file +    required: false +    default: None +    aliases: [] +  force: +    description: +    - Whether or not to force the operation +    required: false +    default: None +    aliases: [] +  separator: +    description: +    - The separator format for the edit. +    required: false +    default: '.' +    aliases: [] +author: +- "Kenny Woodson <kwoodson@redhat.com>" +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +oc_edit: +  kind: rc +  name: hawkular-cassandra-rc +  namespace: openshift-infra +  content: +    spec.template.spec.containers[0].resources.limits.memory: 512 +    spec.template.spec.containers[0].resources.requests.memory: 256 +''' diff --git a/roles/lib_openshift/src/doc/route b/roles/lib_openshift/src/doc/route index 256f6b8f3..1797d4d33 100644 --- a/roles/lib_openshift/src/doc/route +++ b/roles/lib_openshift/src/doc/route @@ -3,10 +3,10 @@  DOCUMENTATION = '''  --- -module: yedit -short_description: Create, modify, and idempotently manage yaml files. +module: oc_route +short_description: Create, modify, and idempotently manage openshift routes.  description: -  - Modify yaml files programmatically. +  - Manage openshift route objects programmatically.  options:    state:      description: diff --git a/roles/lib_openshift/src/generate.py b/roles/lib_openshift/src/generate.py index f4b46aa91..003136833 100755 --- a/roles/lib_openshift/src/generate.py +++ b/roles/lib_openshift/src/generate.py @@ -9,6 +9,7 @@ import yaml  # pylint: disable=anomalous-backslash-in-string  GEN_STR = "#!/usr/bin/env python\n" + \            "# pylint: disable=missing-docstring\n" + \ +          "# flake8: noqa: T001\n" + \            "#     ___ ___ _  _ ___ ___    _ _____ ___ ___\n" + \            "#    / __| __| \| | __| _ \  /_\_   _| __|   \\\n" + \            "#   | (_ | _|| .` | _||   / / _ \| | | _|| |) |\n" + \ @@ -18,7 +19,7 @@ GEN_STR = "#!/usr/bin/env python\n" + \            "#   |___/ \___/  |_|\_|\___/ |_|   |___|___/___| |_|\n"  OPENSHIFT_ANSIBLE_PATH = os.path.dirname(os.path.realpath(__file__)) -OPENSHIFT_ANSIBLE_SOURCES_PATH = os.path.join(OPENSHIFT_ANSIBLE_PATH, 'generate_sources.yml')  # noqa: E501 +OPENSHIFT_ANSIBLE_SOURCES_PATH = os.path.join(OPENSHIFT_ANSIBLE_PATH, 'sources.yml')  # noqa: E501  def main(): diff --git a/roles/lib_openshift/src/lib/base.py b/roles/lib_openshift/src/lib/base.py index 9830150be..4e9aa4461 100644 --- a/roles/lib_openshift/src/lib/base.py +++ b/roles/lib_openshift/src/lib/base.py @@ -1,9 +1,7 @@  # pylint: skip-file  # flake8: noqa -''' -   OpenShiftCLI class that wraps the oc commands in a subprocess -'''  # pylint: disable=too-many-lines +# noqa: E301,E302,E303,T001  class OpenShiftCLIError(Exception): @@ -213,7 +211,7 @@ class OpenShiftCLI(object):          err = None          if self.verbose: -            print ' '.join(cmds) +            print(' '.join(cmds))          proc = subprocess.Popen(cmds,                                  stdin=subprocess.PIPE, @@ -232,14 +230,14 @@ class OpenShiftCLI(object):                      try:                          rval['results'] = json.loads(stdout)                      except ValueError as err: -                        if "No JSON object could be decoded" in err.message: -                            err = err.message +                        if "No JSON object could be decoded" in str(err): +                            err = str(err)                  elif output_type == 'raw':                      rval['results'] = stdout              if self.verbose: -                print stdout -                print stderr +                print(stdout) +                print(stderr)              if err:                  rval.update({"err": err, @@ -350,50 +348,50 @@ class Utils(object):              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 +                        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]) +                        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 +                        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]) +                            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' +                            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] +                            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 +                        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" +                        print("dict returned false: not instance of dict")                      return False                  # before passing ensure keys match @@ -401,31 +399,31 @@ class Utils(object):                  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 +                        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 +                        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 +                        print("value not equal; user_def does not have key") +                        print(key) +                        print(value)                          if key in user_def: -                            print user_def[key] +                            print(user_def[key])                      return False          if debug: -            print 'returning true' +            print('returning true')          return True diff --git a/roles/lib_openshift/src/lib/import.py b/roles/lib_openshift/src/lib/import.py index 1fc75f466..c2b30e019 100644 --- a/roles/lib_openshift/src/lib/import.py +++ b/roles/lib_openshift/src/lib/import.py @@ -5,12 +5,13 @@  '''  # pylint: disable=too-many-lines - +from __future__ import print_function  import atexit  import json  import os  import re -import ruamel.yaml as yaml  import shutil  import subprocess +# pylint: disable=import-error +import ruamel.yaml as yaml  from ansible.module_utils.basic import AnsibleModule diff --git a/roles/lib_openshift/src/lib/route.py b/roles/lib_openshift/src/lib/route.py index 11dc1dfbf..df062b0dd 100644 --- a/roles/lib_openshift/src/lib/route.py +++ b/roles/lib_openshift/src/lib/route.py @@ -1,5 +1,6 @@  # pylint: skip-file  # flake8: noqa +# noqa: E302,E301  # pylint: disable=too-many-instance-attributes diff --git a/roles/lib_openshift/src/generate_sources.yml b/roles/lib_openshift/src/sources.yml index d8fcc6141..945d4d13f 100644 --- a/roles/lib_openshift/src/generate_sources.yml +++ b/roles/lib_openshift/src/sources.yml @@ -3,8 +3,16 @@ oc_route.py:  - doc/license  - lib/import.py  - doc/route -- lib/base.py  - ../../lib_utils/src/class/yedit.py +- lib/base.py  - lib/route.py  - class/oc_route.py  - ansible/oc_route.py +oc_edit.py: +- doc/license +- lib/import.py +- doc/edit +- ../../lib_utils/src/class/yedit.py +- lib/base.py +- class/oc_edit.py +- ansible/oc_edit.py diff --git a/roles/lib_openshift/src/test/integration/route.yml b/roles/lib_openshift/src/test/integration/route.yml new file mode 100644 index 000000000..6a96b334f --- /dev/null +++ b/roles/lib_openshift/src/test/integration/route.yml @@ -0,0 +1,58 @@ +#!/usr/bin/ansible-playbook +# ./route.yml -M ../../../library -e "cli_master_test=$OPENSHIFT_MASTER +--- +- hosts: "{{ cli_master_test }}" +  gather_facts: no +  user: root +  tasks: +  - name: create route +    oc_route: +      name: test +      namespace: test +      tls_termination: edge +      cert_content: testing cert +      cacert_content: testing cacert +      service_name: test +      host: test.example +    register: routeout +  - debug: var=routeout + +  - name: get route +    oc_route: +      state: list +      name: test +      namespace: default +    register: routeout +  - debug: var=routeout + +  - name: delete route +    oc_route: +      state: absent +      name: test +      namespace: default +    register: routeout +  - debug: var=routeout + +  - name: create route +    oc_route: +      name: test +      namespace: test +      tls_termination: edge +      cert_content: testing cert +      cacert_content: testing cacert +      service_name: test +      host: test.example +    register: routeout +  - debug: var=routeout + +  - name: create route noop +    oc_route: +      name: test +      namespace: test +      tls_termination: edge +      cert_content: testing cert +      cacert_content: testing cacert +      service_name: test +      host: test.example +    register: routeout +  - debug: var=routeout | 
