From c25792965600baf821d0244682423ff841baffe1 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Thu, 9 Feb 2017 17:59:11 -0500 Subject: Adding oc_project to lib_openshift. --- roles/lib_openshift/src/ansible/oc_project.py | 33 +++++ roles/lib_openshift/src/class/oc_project.py | 180 ++++++++++++++++++++++++ roles/lib_openshift/src/doc/project | 81 +++++++++++ roles/lib_openshift/src/lib/project.py | 82 +++++++++++ roles/lib_openshift/src/sources.yml | 11 ++ roles/lib_openshift/src/test/unit/oc_project.py | 130 +++++++++++++++++ 6 files changed, 517 insertions(+) create mode 100644 roles/lib_openshift/src/ansible/oc_project.py create mode 100644 roles/lib_openshift/src/class/oc_project.py create mode 100644 roles/lib_openshift/src/doc/project create mode 100644 roles/lib_openshift/src/lib/project.py create mode 100755 roles/lib_openshift/src/test/unit/oc_project.py (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/ansible/oc_project.py b/roles/lib_openshift/src/ansible/oc_project.py new file mode 100644 index 000000000..b035cd712 --- /dev/null +++ b/roles/lib_openshift/src/ansible/oc_project.py @@ -0,0 +1,33 @@ +# pylint: skip-file +# flake8: noqa + +def main(): + ''' + ansible oc module for project + ''' + + module = AnsibleModule( + argument_spec=dict( + kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'), + state=dict(default='present', type='str', + choices=['present', 'absent', 'list']), + debug=dict(default=False, type='bool'), + name=dict(default=None, require=True, type='str'), + display_name=dict(default=None, type='str'), + node_selector=dict(default=None, type='list'), + description=dict(default=None, type='str'), + admin=dict(default=None, type='str'), + admin_role=dict(default='admin', type='str'), + ), + supports_check_mode=True, + ) + + rval = OCProject.run_ansible(module.params, module.check_mode) + if 'failed' in rval: + return module.fail_json(**rval) + + return module.exit_json(**rval) + + +if __name__ == '__main__': + main() diff --git a/roles/lib_openshift/src/class/oc_project.py b/roles/lib_openshift/src/class/oc_project.py new file mode 100644 index 000000000..e587570bb --- /dev/null +++ b/roles/lib_openshift/src/class/oc_project.py @@ -0,0 +1,180 @@ +# pylint: skip-file +# flake8: noqa + + +# pylint: disable=too-many-instance-attributes +class OCProject(OpenShiftCLI): + ''' Class to wrap the oc command line tools ''' + kind = 'namespace' + + def __init__(self, + config, + verbose=False): + ''' Constructor for OCProject ''' + super(OCProject, self).__init__(None, config.kubeconfig) + self.config = config + self._project = None + + @property + def project(self): + ''' property for project''' + if not self._project: + self.get() + return self._project + + @project.setter + def project(self, data): + ''' setter function for project propeorty''' + self._project = data + + def exists(self): + ''' return whether a project exists ''' + if self.project: + return True + + return False + + def get(self): + '''return project ''' + #result = self.openshift_cmd(['get', self.kind, self.config.name, '-o', 'json'], output=True, output_type='raw') + result = self._get(self.kind, self.config.name) + + if result['returncode'] == 0: + self.project = Project(content=result['results'][0]) + result['results'] = self.project.yaml_dict + + elif 'namespaces "%s" not found' % self.config.name in result['stderr']: + result = {'results': [], 'returncode': 0} + + return result + + def delete(self): + '''delete the object''' + return self._delete(self.kind, self.config.name) + + def create(self): + '''create a project ''' + cmd = ['new-project', self.config.name] + cmd.extend(self.config.to_option_list()) + + return self.openshift_cmd(cmd, oadm=True) + + def update(self): + '''update a project ''' + + self.project.update_annotation('display-name', self.config.config_options['display_name']['value']) + self.project.update_annotation('description', self.config.config_options['description']['value']) + + # work around for immutable project field + if self.config.config_options['node_selector']['value']: + self.project.update_annotation('node-selector', self.config.config_options['node_selector']['value']) + else: + self.project.update_annotation('node-selector', self.project.find_annotation('node-selector')) + + return self._replace_content(self.kind, self.config.namespace, self.project.yaml_dict) + + def needs_update(self): + ''' verify an update is needed ''' + result = self.project.find_annotation("display-name") + if result != self.config.config_options['display_name']['value']: + return True + + result = self.project.find_annotation("description") + if result != self.config.config_options['description']['value']: + return True + + result = self.project.find_annotation("node-selector") + if result != self.config.config_options['node_selector']['value']: + return True + + # Check rolebindings and policybindings + return False + + # pylint: disable=too-many-return-statements + @staticmethod + def run_ansible(params, check_mode): + '''run the idempotent ansible code''' + + pconfig = ProjectConfig(params['name'], + params['name'], + params['kubeconfig'], + {'admin': {'value': params['admin'], 'include': True}, + 'admin_role': {'value': params['admin_role'], 'include': True}, + 'description': {'value': params['description'], 'include': True}, + 'display_name': {'value': params['display_name'], 'include': True}, + 'node_selector': {'value': ','.join(params['node_selector']), 'include': True}, + }) + + oadm_project = OCProject(pconfig, verbose=params['debug']) + + state = params['state'] + + api_rval = oadm_project.get() + + ##### + # Get + ##### + if state == 'list': + exit_json(changed=False, results=api_rval['results'], state="list") + + ######## + # Delete + ######## + if state == 'absent': + if oadm_project.exists(): + + if check_mode: + return {'changed': True, 'msg': 'CHECK_MODE: Would have performed a delete.'} + + api_rval = oadm_project.delete() + + return {'changed': True, 'results': api_rval, 'state': state} + + return {'changed': False, 'state': state} + + if state == 'present': + ######## + # Create + ######## + if not oadm_project.exists(): + + if check_mode: + return {'changed': True, 'msg': 'CHECK_MODE: Would have performed a create.'} + + # Create it here + api_rval = oadm_project.create() + + # return the created object + api_rval = oadm_project.get() + + if api_rval['returncode'] != 0: + return {'failed': True, 'msg': api_rval} + + return {'changed': True, 'results': api_rval, 'state': state} + + ######## + # Update + ######## + if oadm_project.needs_update(): + + if check_mode: + return {'changed': True, 'msg': 'CHECK_MODE: Would have performed an update.'} + + api_rval = oadm_project.update() + + if api_rval['returncode'] != 0: + return {'failed': True, 'msg': api_rval} + + # return the created object + api_rval = oadm_project.get() + + if api_rval['returncode'] != 0: + return {'failed': True, 'msg': api_rval} + + return {'changed': True, 'results': api_rval, 'state': state} + + return {'changed': False, 'results': api_rval, 'state': state} + + return {'failed': True, + 'changed': False, + 'msg': 'Unknown state passed. [%s]' % state} diff --git a/roles/lib_openshift/src/doc/project b/roles/lib_openshift/src/doc/project new file mode 100644 index 000000000..92efe4320 --- /dev/null +++ b/roles/lib_openshift/src/doc/project @@ -0,0 +1,81 @@ +# flake8: noqa +# pylint: skip-file + +DOCUMENTATION = ''' +--- +module: oc_project +short_description: Module to manage openshift projects +description: + - Manage openshift projects programmatically. +options: + state: + description: + - If present, the project will be created if it doesn't exist or update if different. If absent, the project will be removed if present. If list, information about the project will be gathered and returned as part of the Ansible call results. + required: false + default: present + choices: ["present", "absent", "list"] + 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: [] + display_name: + description: + - The display name attribute for a project + required: false + default: None + aliases: [] + description: + description: + - The description attribute for a project + required: false + default: None + aliases: [] + admin: + description: + - The project admin username + required: false + default: false + aliases: [] + admin_role: + description: + - The project admin username + required: false + default: 'admin' + aliases: [] + node_selector: + description: + - The node selector for this project. + - This allows certain pods in this project to run on certain nodes. + required: false + default: None + aliases: [] +author: +- "Kenny Woodson " +extends_documentation_fragment: [] +''' + +EXAMPLES = ''' +- name: create secret + oc_project: + state: present + name: openshift-ops + display_name: operations team project + node_selector: + - top=secret + - noncustomer=True +''' diff --git a/roles/lib_openshift/src/lib/project.py b/roles/lib_openshift/src/lib/project.py new file mode 100644 index 000000000..1e28637de --- /dev/null +++ b/roles/lib_openshift/src/lib/project.py @@ -0,0 +1,82 @@ +# pylint: skip-file + +# pylint: disable=too-many-instance-attributes +class ProjectConfig(OpenShiftCLIConfig): + ''' project config object ''' + def __init__(self, rname, namespace, kubeconfig, project_options): + super(ProjectConfig, self).__init__(rname, rname, kubeconfig, project_options) + +class Project(Yedit): + ''' Class to wrap the oc command line tools ''' + annotations_path = "metadata.annotations" + kind = 'Service' + annotation_prefix = 'openshift.io/' + + def __init__(self, content): + '''Service constructor''' + super(Project, self).__init__(content=content) + + def get_annotations(self): + ''' get a list of ports ''' + return self.get(Project.annotations_path) or {} + + def add_annotations(self, inc_annos): + ''' add a port object to the ports list ''' + if not isinstance(inc_annos, list): + inc_annos = [inc_annos] + + annos = self.get_annotations() + if not annos: + self.put(Project.annotations_path, inc_annos) + else: + for anno in inc_annos: + for key, value in anno.items(): + annos[key] = value + + return True + + def find_annotation(self, key): + ''' find a specific port ''' + annotations = self.get_annotations() + for anno in annotations: + if Project.annotation_prefix + key == anno: + return annotations[anno] + + return None + + def delete_annotation(self, inc_anno_keys): + ''' remove an annotation from a project''' + if not isinstance(inc_anno_keys, list): + inc_anno_keys = [inc_anno_keys] + + annos = self.get(Project.annotations_path) or {} + + if not annos: + return True + + removed = False + for inc_anno in inc_anno_keys: + anno = self.find_annotation(inc_anno) + if anno: + del annos[Project.annotation_prefix + anno] + removed = True + + return removed + + def update_annotation(self, key, value): + ''' remove an annotation from a project''' + annos = self.get(Project.annotations_path) or {} + + if not annos: + return True + + updated = False + anno = self.find_annotation(key) + if anno: + annos[Project.annotation_prefix + key] = value + updated = True + + else: + self.add_annotations({Project.annotation_prefix + key: value}) + + return updated diff --git a/roles/lib_openshift/src/sources.yml b/roles/lib_openshift/src/sources.yml index a0e200d0a..c72fd4ea8 100644 --- a/roles/lib_openshift/src/sources.yml +++ b/roles/lib_openshift/src/sources.yml @@ -130,6 +130,17 @@ oc_process.py: - class/oc_process.py - ansible/oc_process.py +oc_project.py: +- doc/generated +- doc/license +- lib/import.py +- doc/project +- ../../lib_utils/src/class/yedit.py +- lib/base.py +- lib/project.py +- class/oc_project.py +- ansible/oc_project.py + oc_route.py: - doc/generated - doc/license diff --git a/roles/lib_openshift/src/test/unit/oc_project.py b/roles/lib_openshift/src/test/unit/oc_project.py new file mode 100755 index 000000000..42b95c54d --- /dev/null +++ b/roles/lib_openshift/src/test/unit/oc_project.py @@ -0,0 +1,130 @@ +#!/usr/bin/env python2 +''' + Unit tests for oc project +''' +# To run: +# ./oc_secret.py +# +# . +# Ran 1 test in 0.002s +# +# OK + +import os +import sys +import unittest +import mock + +# Removing invalid variable names for tests so that I can +# keep them brief +# pylint: disable=invalid-name,no-name-in-module +# Disable import-error b/c our libraries aren't loaded in jenkins +# pylint: disable=import-error,wrong-import-position +# place class in our python path +module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library') # noqa: E501 +sys.path.insert(0, module_path) +from oc_project import OCProject # noqa: E402 + + +class OCProjectTest(unittest.TestCase): + ''' + Test class for OCSecret + ''' + + def setUp(self): + ''' setup method will create a file and set to known configuration ''' + pass + + @mock.patch('oc_project.Utils.create_tmpfile_copy') + @mock.patch('oc_project.Utils._write') + @mock.patch('oc_project.OCProject._run') + def test_adding_a_project(self, mock_cmd, mock_write, mock_tmpfile_copy): + ''' Testing adding a project ''' + + # Arrange + + # run_ansible input parameters + params = { + 'state': 'present', + 'display_name': 'operations project', + 'name': 'operations', + 'node_selector': ['ops_only=True'], + 'kubeconfig': '/etc/origin/master/admin.kubeconfig', + 'debug': False, + 'admin': None, + 'admin_role': 'admin', + 'description': 'All things operations project', + } + + project_results = '''{ + "kind": "Project", + "apiVersion": "v1", + "metadata": { + "name": "operations", + "selfLink": "/oapi/v1/projects/operations", + "uid": "5e52afb8-ee33-11e6-89f4-0edc441d9666", + "resourceVersion": "1584", + "labels": {}, + "annotations": { + "openshift.io/node-selector": "ops_only=True", + "openshift.io/sa.initialized-roles": "true", + "openshift.io/sa.scc.mcs": "s0:c3,c2", + "openshift.io/sa.scc.supplemental-groups": "1000010000/10000", + "openshift.io/sa.scc.uid-range": "1000010000/10000" + } + }, + "spec": { + "finalizers": [ + "kubernetes", + "openshift.io/origin" + ] + }, + "status": { + "phase": "Active" + } + }''' + + # Return values of our mocked function call. These get returned once per call. + mock_cmd.side_effect = [ + (1, '', 'Error from server: namespaces "operations" not found'), + (1, '', 'Error from server: namespaces "operations" not found'), + (0, '', ''), # created + (0, project_results, ''), # fetch it + ] + + mock_tmpfile_copy.side_effect = [ + '/tmp/mocked_kubeconfig', + ] + + # Act + + results = OCProject.run_ansible(params, False) + + # Assert + self.assertTrue(results['changed']) + self.assertEqual(results['results']['returncode'], 0) + self.assertEqual(results['results']['results']['metadata']['name'], 'operations') + self.assertEqual(results['state'], 'present') + + # Making sure our mock was called as we expected + mock_cmd.assert_has_calls([ + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + mock.call(['oadm', 'new-project', 'operations', '--admin-role=admin', + '--display-name=operations project', '--description=All things operations project', + '--node-selector=ops_only=True'], None), + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + + ]) + + #mock_write.assert_has_calls([ + #mock.call(mock.ANY, "{'one': 1, 'two': 2, 'three': 3}"), + #]) + + def tearDown(self): + '''TearDown method''' + pass + + +if __name__ == "__main__": + unittest.main() -- cgit v1.2.3 From e8f02e60daf2d158a0fa6f08ac7d3ed89f9c5317 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Thu, 9 Feb 2017 21:51:12 -0500 Subject: Adding integration test. Fixed issue with node_selector. --- roles/lib_openshift/src/class/oc_project.py | 11 +-- .../src/test/integration/oc_project.yml | 83 ++++++++++++++++++++++ 2 files changed, 90 insertions(+), 4 deletions(-) create mode 100755 roles/lib_openshift/src/test/integration/oc_project.yml (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/class/oc_project.py b/roles/lib_openshift/src/class/oc_project.py index e587570bb..cf378ef6d 100644 --- a/roles/lib_openshift/src/class/oc_project.py +++ b/roles/lib_openshift/src/class/oc_project.py @@ -36,7 +36,6 @@ class OCProject(OpenShiftCLI): def get(self): '''return project ''' - #result = self.openshift_cmd(['get', self.kind, self.config.name, '-o', 'json'], output=True, output_type='raw') result = self._get(self.kind, self.config.name) if result['returncode'] == 0: @@ -90,11 +89,15 @@ class OCProject(OpenShiftCLI): # Check rolebindings and policybindings return False - # pylint: disable=too-many-return-statements + # pylint: disable=too-many-return-statements,too-many-branches @staticmethod def run_ansible(params, check_mode): '''run the idempotent ansible code''' + _ns = None + if params['node_selector'] is not None: + _ns = ','.join(params['node_selector']) + pconfig = ProjectConfig(params['name'], params['name'], params['kubeconfig'], @@ -102,7 +105,7 @@ class OCProject(OpenShiftCLI): 'admin_role': {'value': params['admin_role'], 'include': True}, 'description': {'value': params['description'], 'include': True}, 'display_name': {'value': params['display_name'], 'include': True}, - 'node_selector': {'value': ','.join(params['node_selector']), 'include': True}, + 'node_selector': {'value': _ns, 'include': True}, }) oadm_project = OCProject(pconfig, verbose=params['debug']) @@ -115,7 +118,7 @@ class OCProject(OpenShiftCLI): # Get ##### if state == 'list': - exit_json(changed=False, results=api_rval['results'], state="list") + return {'changed': False, 'results': api_rval['results'], 'state': state} ######## # Delete diff --git a/roles/lib_openshift/src/test/integration/oc_project.yml b/roles/lib_openshift/src/test/integration/oc_project.yml new file mode 100755 index 000000000..9f700c62c --- /dev/null +++ b/roles/lib_openshift/src/test/integration/oc_project.yml @@ -0,0 +1,83 @@ +#!/usr/bin/ansible-playbook --module-path=../../../library/ +# ./oc_project.yml -M ../../../library -e "cli_master_test=$OPENSHIFT_MASTER +--- +- hosts: "{{ cli_master_test }}" + gather_facts: no + user: root + tasks: + - name: create a project + oc_project: + display_name: operations project + name: operations + state: present + description: All things operations + node_selector: + - ops_only=true + register: projout + - debug: var=projout + + - assert: + that: + - "projout.results.results['metadata']['name'] == 'operations'" + - projout.changed + msg: project create failed. + + - name: create a project + oc_project: + display_name: operations project + name: operations + state: present + description: All things operations + node_selector: + - ops_only=true + register: projout + - debug: var=projout + + - assert: + that: + - "projout.results.results['metadata']['name'] == 'operations'" + - projout.changed == False + msg: project create failed. + + - name: update a project + oc_project: + display_name: operations project one + name: operations + state: present + description: All things operations + node_selector: + - ops_only=true + register: projout + - debug: var=projout + + - assert: + that: + - "projout.results.results['metadata']['annotations']['openshift.io/display-name'] == 'operations project one'" + - projout.changed == True + msg: project create failed. + + - name: update a project + oc_project: + name: operations + state: list + register: projout + - debug: var=projout + + - assert: + that: + - "projout.results['metadata']['annotations']['openshift.io/display-name'] == 'operations project one'" + - projout.changed == False + - projout.state == 'list' + msg: project list failed. + + - name: delete a project + oc_project: + name: operations + state: absent + register: projout + - debug: var=projout + + - assert: + that: + - projout.changed == True + msg: project delete failed. -- cgit v1.2.3 From 9ed2463827c2eeb7b5adae9d2878ffbdd81cbc74 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Thu, 9 Feb 2017 22:09:22 -0500 Subject: Fixing linters --- roles/lib_openshift/src/lib/project.py | 2 ++ roles/lib_openshift/src/test/unit/oc_project.py | 4 ---- 2 files changed, 2 insertions(+), 4 deletions(-) (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/lib/project.py b/roles/lib_openshift/src/lib/project.py index 1e28637de..a06f83d78 100644 --- a/roles/lib_openshift/src/lib/project.py +++ b/roles/lib_openshift/src/lib/project.py @@ -1,4 +1,6 @@ # pylint: skip-file +# flake8: noqa + # pylint: disable=too-many-instance-attributes class ProjectConfig(OpenShiftCLIConfig): diff --git a/roles/lib_openshift/src/test/unit/oc_project.py b/roles/lib_openshift/src/test/unit/oc_project.py index 42b95c54d..e3a7eba6f 100755 --- a/roles/lib_openshift/src/test/unit/oc_project.py +++ b/roles/lib_openshift/src/test/unit/oc_project.py @@ -117,10 +117,6 @@ class OCProjectTest(unittest.TestCase): ]) - #mock_write.assert_has_calls([ - #mock.call(mock.ANY, "{'one': 1, 'two': 2, 'three': 3}"), - #]) - def tearDown(self): '''TearDown method''' pass -- cgit v1.2.3 From 4d8df54bd8449a350e3eba59d9598b50d2e727ff Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Wed, 1 Mar 2017 11:04:50 -0500 Subject: Fixed docs. Added check for delete failures. Updated namespace to None. --- roles/lib_openshift/src/class/oc_project.py | 6 ++++-- roles/lib_openshift/src/lib/project.py | 15 ++++++++------- 2 files changed, 12 insertions(+), 9 deletions(-) (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/class/oc_project.py b/roles/lib_openshift/src/class/oc_project.py index cf378ef6d..642d85375 100644 --- a/roles/lib_openshift/src/class/oc_project.py +++ b/roles/lib_openshift/src/class/oc_project.py @@ -4,7 +4,7 @@ # pylint: disable=too-many-instance-attributes class OCProject(OpenShiftCLI): - ''' Class to wrap the oc command line tools ''' + ''' Project Class to manage project/namespace objects''' kind = 'namespace' def __init__(self, @@ -86,7 +86,6 @@ class OCProject(OpenShiftCLI): if result != self.config.config_options['node_selector']['value']: return True - # Check rolebindings and policybindings return False # pylint: disable=too-many-return-statements,too-many-branches @@ -131,6 +130,9 @@ class OCProject(OpenShiftCLI): api_rval = oadm_project.delete() + if api_rval['returncode'] != 0: + return {'failed': True, 'msg': api_rval} + return {'changed': True, 'results': api_rval, 'state': state} return {'changed': False, 'state': state} diff --git a/roles/lib_openshift/src/lib/project.py b/roles/lib_openshift/src/lib/project.py index a06f83d78..40994741c 100644 --- a/roles/lib_openshift/src/lib/project.py +++ b/roles/lib_openshift/src/lib/project.py @@ -6,24 +6,25 @@ class ProjectConfig(OpenShiftCLIConfig): ''' project config object ''' def __init__(self, rname, namespace, kubeconfig, project_options): - super(ProjectConfig, self).__init__(rname, rname, kubeconfig, project_options) + super(ProjectConfig, self).__init__(rname, None, kubeconfig, project_options) + class Project(Yedit): ''' Class to wrap the oc command line tools ''' annotations_path = "metadata.annotations" - kind = 'Service' + kind = 'Project' annotation_prefix = 'openshift.io/' def __init__(self, content): - '''Service constructor''' + '''Project constructor''' super(Project, self).__init__(content=content) def get_annotations(self): - ''' get a list of ports ''' + ''' return the annotations''' return self.get(Project.annotations_path) or {} def add_annotations(self, inc_annos): - ''' add a port object to the ports list ''' + ''' add an annotation to the other annotations''' if not isinstance(inc_annos, list): inc_annos = [inc_annos] @@ -38,7 +39,7 @@ class Project(Yedit): return True def find_annotation(self, key): - ''' find a specific port ''' + ''' find an annotation''' annotations = self.get_annotations() for anno in annotations: if Project.annotation_prefix + key == anno: @@ -66,7 +67,7 @@ class Project(Yedit): return removed def update_annotation(self, key, value): - ''' remove an annotation from a project''' + ''' remove an annotation for a project''' annos = self.get(Project.annotations_path) or {} if not annos: -- cgit v1.2.3 From a4fe8bfa6b4122bc1215bcb9798caf1c5eb6d181 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Wed, 1 Mar 2017 11:19:03 -0500 Subject: Fixed tests to align with new naming. --- roles/lib_openshift/src/test/unit/oc_project.py | 126 --------------------- .../lib_openshift/src/test/unit/test_oc_project.py | 126 +++++++++++++++++++++ 2 files changed, 126 insertions(+), 126 deletions(-) delete mode 100755 roles/lib_openshift/src/test/unit/oc_project.py create mode 100755 roles/lib_openshift/src/test/unit/test_oc_project.py (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/test/unit/oc_project.py b/roles/lib_openshift/src/test/unit/oc_project.py deleted file mode 100755 index e3a7eba6f..000000000 --- a/roles/lib_openshift/src/test/unit/oc_project.py +++ /dev/null @@ -1,126 +0,0 @@ -#!/usr/bin/env python2 -''' - Unit tests for oc project -''' -# To run: -# ./oc_secret.py -# -# . -# Ran 1 test in 0.002s -# -# OK - -import os -import sys -import unittest -import mock - -# Removing invalid variable names for tests so that I can -# keep them brief -# pylint: disable=invalid-name,no-name-in-module -# Disable import-error b/c our libraries aren't loaded in jenkins -# pylint: disable=import-error,wrong-import-position -# place class in our python path -module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library') # noqa: E501 -sys.path.insert(0, module_path) -from oc_project import OCProject # noqa: E402 - - -class OCProjectTest(unittest.TestCase): - ''' - Test class for OCSecret - ''' - - def setUp(self): - ''' setup method will create a file and set to known configuration ''' - pass - - @mock.patch('oc_project.Utils.create_tmpfile_copy') - @mock.patch('oc_project.Utils._write') - @mock.patch('oc_project.OCProject._run') - def test_adding_a_project(self, mock_cmd, mock_write, mock_tmpfile_copy): - ''' Testing adding a project ''' - - # Arrange - - # run_ansible input parameters - params = { - 'state': 'present', - 'display_name': 'operations project', - 'name': 'operations', - 'node_selector': ['ops_only=True'], - 'kubeconfig': '/etc/origin/master/admin.kubeconfig', - 'debug': False, - 'admin': None, - 'admin_role': 'admin', - 'description': 'All things operations project', - } - - project_results = '''{ - "kind": "Project", - "apiVersion": "v1", - "metadata": { - "name": "operations", - "selfLink": "/oapi/v1/projects/operations", - "uid": "5e52afb8-ee33-11e6-89f4-0edc441d9666", - "resourceVersion": "1584", - "labels": {}, - "annotations": { - "openshift.io/node-selector": "ops_only=True", - "openshift.io/sa.initialized-roles": "true", - "openshift.io/sa.scc.mcs": "s0:c3,c2", - "openshift.io/sa.scc.supplemental-groups": "1000010000/10000", - "openshift.io/sa.scc.uid-range": "1000010000/10000" - } - }, - "spec": { - "finalizers": [ - "kubernetes", - "openshift.io/origin" - ] - }, - "status": { - "phase": "Active" - } - }''' - - # Return values of our mocked function call. These get returned once per call. - mock_cmd.side_effect = [ - (1, '', 'Error from server: namespaces "operations" not found'), - (1, '', 'Error from server: namespaces "operations" not found'), - (0, '', ''), # created - (0, project_results, ''), # fetch it - ] - - mock_tmpfile_copy.side_effect = [ - '/tmp/mocked_kubeconfig', - ] - - # Act - - results = OCProject.run_ansible(params, False) - - # Assert - self.assertTrue(results['changed']) - self.assertEqual(results['results']['returncode'], 0) - self.assertEqual(results['results']['results']['metadata']['name'], 'operations') - self.assertEqual(results['state'], 'present') - - # Making sure our mock was called as we expected - mock_cmd.assert_has_calls([ - mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), - mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), - mock.call(['oadm', 'new-project', 'operations', '--admin-role=admin', - '--display-name=operations project', '--description=All things operations project', - '--node-selector=ops_only=True'], None), - mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), - - ]) - - def tearDown(self): - '''TearDown method''' - pass - - -if __name__ == "__main__": - unittest.main() diff --git a/roles/lib_openshift/src/test/unit/test_oc_project.py b/roles/lib_openshift/src/test/unit/test_oc_project.py new file mode 100755 index 000000000..3cc439bf7 --- /dev/null +++ b/roles/lib_openshift/src/test/unit/test_oc_project.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python2 +''' + Unit tests for oc project +''' +# To run: +# ./oc_secret.py +# +# . +# Ran 1 test in 0.002s +# +# OK + +import os +import sys +import unittest +import mock + +# Removing invalid variable names for tests so that I can +# keep them brief +# pylint: disable=invalid-name,no-name-in-module +# Disable import-error b/c our libraries aren't loaded in jenkins +# pylint: disable=import-error,wrong-import-position +# place class in our python path +module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library') # noqa: E501 +sys.path.insert(0, module_path) +from oc_project import OCProject # noqa: E402 + + +class OCProjectTest(unittest.TestCase): + ''' + Test class for OCSecret + ''' + + def setUp(self): + ''' setup method will create a file and set to known configuration ''' + pass + + @mock.patch('oc_project.Utils.create_tmpfile_copy') + @mock.patch('oc_project.Utils._write') + @mock.patch('oc_project.OCProject._run') + def test_adding_a_project(self, mock_cmd, mock_write, mock_tmpfile_copy): + ''' Testing adding a project ''' + + # Arrange + + # run_ansible input parameters + params = { + 'state': 'present', + 'display_name': 'operations project', + 'name': 'operations', + 'node_selector': ['ops_only=True'], + 'kubeconfig': '/etc/origin/master/admin.kubeconfig', + 'debug': False, + 'admin': None, + 'admin_role': 'admin', + 'description': 'All things operations project', + } + + project_results = '''{ + "kind": "Project", + "apiVersion": "v1", + "metadata": { + "name": "operations", + "selfLink": "/oapi/v1/projects/operations", + "uid": "5e52afb8-ee33-11e6-89f4-0edc441d9666", + "resourceVersion": "1584", + "labels": {}, + "annotations": { + "openshift.io/node-selector": "ops_only=True", + "openshift.io/sa.initialized-roles": "true", + "openshift.io/sa.scc.mcs": "s0:c3,c2", + "openshift.io/sa.scc.supplemental-groups": "1000010000/10000", + "openshift.io/sa.scc.uid-range": "1000010000/10000" + } + }, + "spec": { + "finalizers": [ + "kubernetes", + "openshift.io/origin" + ] + }, + "status": { + "phase": "Active" + } + }''' + + # Return values of our mocked function call. These get returned once per call. + mock_cmd.side_effect = [ + (1, '', 'Error from server: namespaces "operations" not found'), + (1, '', 'Error from server: namespaces "operations" not found'), + (0, '', ''), # created + (0, project_results, ''), # fetch it + ] + + mock_tmpfile_copy.side_effect = [ + '/tmp/mocked_kubeconfig', + ] + + # Act + + results = OCProject.run_ansible(params, False) + + # Assert + self.assertTrue(results['changed']) + self.assertEqual(results['results']['returncode'], 0) + self.assertEqual(results['results']['results']['metadata']['name'], 'operations') + self.assertEqual(results['state'], 'present') + + # Making sure our mock was called as we expected + mock_cmd.assert_has_calls([ + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + mock.call(['oc', 'adm', 'new-project', 'operations', '--admin-role=admin', + '--display-name=operations project', '--description=All things operations project', + '--node-selector=ops_only=True'], None), + mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), + + ]) + + def tearDown(self): + '''TearDown method''' + pass + + +if __name__ == "__main__": + unittest.main() -- cgit v1.2.3 From ee3609784e12a8961c8167d6326427f5808a9263 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Fri, 3 Mar 2017 10:25:56 -0500 Subject: Updating the namespace param to None. --- roles/lib_openshift/src/class/oc_project.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/class/oc_project.py b/roles/lib_openshift/src/class/oc_project.py index 642d85375..5b39b43fa 100644 --- a/roles/lib_openshift/src/class/oc_project.py +++ b/roles/lib_openshift/src/class/oc_project.py @@ -98,7 +98,7 @@ class OCProject(OpenShiftCLI): _ns = ','.join(params['node_selector']) pconfig = ProjectConfig(params['name'], - params['name'], + None, params['kubeconfig'], {'admin': {'value': params['admin'], 'include': True}, 'admin_role': {'value': params['admin_role'], 'include': True}, -- cgit v1.2.3 From c08768c051ae86a1c62feb878848acf0c653b82b Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Fri, 3 Mar 2017 10:46:55 -0500 Subject: Fixed the none namespace. Fixed tests with latest loc_oc_binary call. --- roles/lib_openshift/src/class/oc_project.py | 4 ++-- roles/lib_openshift/src/test/unit/test_oc_project.py | 7 ++++++- 2 files changed, 8 insertions(+), 3 deletions(-) (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/class/oc_project.py b/roles/lib_openshift/src/class/oc_project.py index 5b39b43fa..7e3984297 100644 --- a/roles/lib_openshift/src/class/oc_project.py +++ b/roles/lib_openshift/src/class/oc_project.py @@ -70,7 +70,7 @@ class OCProject(OpenShiftCLI): else: self.project.update_annotation('node-selector', self.project.find_annotation('node-selector')) - return self._replace_content(self.kind, self.config.namespace, self.project.yaml_dict) + return self._replace_content(self.kind, self.config.name, self.project.yaml_dict) def needs_update(self): ''' verify an update is needed ''' @@ -98,7 +98,7 @@ class OCProject(OpenShiftCLI): _ns = ','.join(params['node_selector']) pconfig = ProjectConfig(params['name'], - None, + 'None', params['kubeconfig'], {'admin': {'value': params['admin'], 'include': True}, 'admin_role': {'value': params['admin_role'], 'include': True}, diff --git a/roles/lib_openshift/src/test/unit/test_oc_project.py b/roles/lib_openshift/src/test/unit/test_oc_project.py index 3cc439bf7..1f9d353aa 100755 --- a/roles/lib_openshift/src/test/unit/test_oc_project.py +++ b/roles/lib_openshift/src/test/unit/test_oc_project.py @@ -35,10 +35,11 @@ class OCProjectTest(unittest.TestCase): ''' setup method will create a file and set to known configuration ''' pass + @mock.patch('oc_project.locate_oc_binary') @mock.patch('oc_project.Utils.create_tmpfile_copy') @mock.patch('oc_project.Utils._write') @mock.patch('oc_project.OCProject._run') - def test_adding_a_project(self, mock_cmd, mock_write, mock_tmpfile_copy): + def test_adding_a_project(self, mock_cmd, mock_write, mock_tmpfile_copy, mock_loc_oc_bin): ''' Testing adding a project ''' # Arrange @@ -96,6 +97,10 @@ class OCProjectTest(unittest.TestCase): '/tmp/mocked_kubeconfig', ] + mock_loc_oc_bin.side_effect = [ + 'oc', + ] + # Act results = OCProject.run_ansible(params, False) -- cgit v1.2.3 From 5f971b85bf8e252f6c98e4ff7419501b16a33527 Mon Sep 17 00:00:00 2001 From: Kenny Woodson Date: Mon, 6 Mar 2017 09:27:47 -0500 Subject: Mock runs differntly on travis. Fix the mock test params to be ANY. --- roles/lib_openshift/src/test/unit/test_oc_project.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'roles/lib_openshift/src') diff --git a/roles/lib_openshift/src/test/unit/test_oc_project.py b/roles/lib_openshift/src/test/unit/test_oc_project.py index 1f9d353aa..50d81e6a6 100755 --- a/roles/lib_openshift/src/test/unit/test_oc_project.py +++ b/roles/lib_openshift/src/test/unit/test_oc_project.py @@ -115,9 +115,8 @@ class OCProjectTest(unittest.TestCase): mock_cmd.assert_has_calls([ mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), - mock.call(['oc', 'adm', 'new-project', 'operations', '--admin-role=admin', - '--display-name=operations project', '--description=All things operations project', - '--node-selector=ops_only=True'], None), + mock.call(['oc', 'adm', 'new-project', 'operations', mock.ANY, + mock.ANY, mock.ANY, mock.ANY], None), mock.call(['oc', 'get', 'namespace', 'operations', '-o', 'json'], None), ]) -- cgit v1.2.3