Merge pull request #3758 from kwoodson/ocimage

Merged by openshift-bot

roles/lib_openshift/src/ansible/oc_image.py

@@ -0,0 +1,34 @@
+# pylint: skip-file
+# flake8: noqa
+
+
+def main():
+    '''
+    ansible oc module for image import
+    '''
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            kubeconfig=dict(default='/etc/origin/master/admin.kubeconfig', type='str'),
+            state=dict(default='present', type='str',
+                       choices=['present', 'list']),
+            debug=dict(default=False, type='bool'),
+            namespace=dict(default='default', type='str'),
+            registry_url=dict(default=None, type='str'),
+            image_name=dict(default=None, required=True, type='str'),
+            image_tag=dict(default=None, type='str'),
+            force=dict(default=False, type='bool'),
+        ),
+
+        supports_check_mode=True,
+    )
+
+    rval = OCImage.run_ansible(module.params, module.check_mode)
+
+    if 'failed' in rval:
+        module.fail_json(**rval)
+
+    module.exit_json(**rval)
+
+if __name__ == '__main__':
+    main()

roles/lib_openshift/src/class/oc_image.py

@@ -0,0 +1,91 @@
+# pylint: skip-file
+# flake8: noqa
+
+
+# pylint: disable=too-many-arguments
+class OCImage(OpenShiftCLI):
+    ''' Class to import and create an imagestream object'''
+    def __init__(self,
+                 namespace,
+                 registry_url,
+                 image_name,
+                 image_tag,
+                 kubeconfig='/etc/origin/master/admin.kubeconfig',
+                 verbose=False):
+        ''' Constructor for OCImage'''
+        super(OCImage, self).__init__(namespace, kubeconfig)
+        self.registry_url = registry_url
+        self.image_name = image_name
+        self.image_tag = image_tag
+        self.verbose = verbose
+
+    def get(self):
+        '''return a image by name '''
+        results = self._get('imagestream', self.image_name)
+        results['exists'] = False
+        if results['returncode'] == 0 and results['results'][0]:
+            results['exists'] = True
+
+        if results['returncode'] != 0 and '"{}" not found'.format(self.image_name) in results['stderr']:
+            results['returncode'] = 0
+
+        return results
+
+    def create(self, url=None, name=None, tag=None):
+        '''Create an image '''
+        return self._import_image(url, name, tag)
+
+
+    # pylint: disable=too-many-return-statements
+    @staticmethod
+    def run_ansible(params, check_mode):
+        ''' run the ansible idempotent code '''
+
+        ocimage = OCImage(params['namespace'],
+                          params['registry_url'],
+                          params['image_name'],
+                          params['image_tag'],
+                          kubeconfig=params['kubeconfig'],
+                          verbose=params['debug'])
+
+        state = params['state']
+
+        api_rval = ocimage.get()
+
+        #####
+        # Get
+        #####
+        if state == 'list':
+            if api_rval['returncode'] != 0:
+                return {"failed": True, "msg": api_rval}
+            return {"changed": False, "results": api_rval, "state": "list"}
+
+        ########
+        # Create
+        ########
+        if state == 'present':
+
+            if not Utils.exists(api_rval['results'], params['image_name']):
+
+                if check_mode:
+                    return {"changed": False, "msg": 'CHECK_MODE: Would have performed a create'}
+
+                api_rval = ocimage.create(params['registry_url'],
+                                          params['image_name'],
+                                          params['image_tag'])
+
+                if api_rval['returncode'] != 0:
+                    return {"failed": True, "msg": api_rval}
+
+                # return the newly created object
+                api_rval = ocimage.get()
+
+                if api_rval['returncode'] != 0:
+                    return {"failed": True, "msg": api_rval}
+
+                return {"changed": True, "results": api_rval, "state": "present"}
+
+            # image exists, no change
+            return {"changed": False, "results": api_rval, "state": "present"}
+
+        return {"failed": True, "changed": False, "msg": "Unknown state passed. {0}".format(state)}

roles/lib_openshift/src/doc/image

@@ -0,0 +1,75 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_image
+short_description: Create, modify, and idempotently manage openshift labels.
+description:
+  - Modify openshift labels programmatically.
+options:
+  state:
+    description:
+    - State controls the action that will be taken with resource
+    - 'present' will create.  Does _not_ support update.
+    - 'list' will read the labels
+    default: present
+    choices: ["present", "list"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  namespace:
+    description:
+    - The namespace where this object lives
+    required: false
+    default: default
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  registry_url:
+    description:
+    - The url for the registry so that openshift can pull the image
+    required: false
+    default: None
+    aliases: []
+  image_name:
+    description:
+    - The name of the image being imported
+    required: false
+    default: False
+    aliases: []
+  image_tag:
+    description:
+    - The tag of the image being imported
+    required: false
+    default: None
+    aliases: []
+author:
+- "Ivan Horvath<ihorvath@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: Get an imagestream
+  oc_image:
+    name: php55
+    state: list
+  register: imageout
+
+- name: create an imagestream
+  oc_image:
+    state: present
+    image_name: php55
+    image_tag: int
+    registry_url: registry.example.com
+    namespace: default
+  register: imageout
+'''

roles/lib_openshift/src/sources.yml

@@ -110,6 +110,7 @@ oc_env.py:
 - class/oc_env.py
 - ansible/oc_env.py
 
+
 oc_group.py:
 - doc/generated
 - doc/license
@@ -121,6 +122,16 @@ oc_group.py:
 - class/oc_group.py
 - ansible/oc_group.py
 
+oc_image.py:
+- doc/generated
+- doc/license
+- lib/import.py
+- doc/image
+- ../../lib_utils/src/class/yedit.py
+- lib/base.py
+- class/oc_image.py
+- ansible/oc_image.py
+
 oc_label.py:
 - doc/generated
 - doc/license

roles/lib_openshift/src/test/unit/test_oc_image.py

@@ -0,0 +1,280 @@
+'''
+ Unit tests for oc image
+'''
+import os
+import sys
+import unittest
+import mock
+import six
+
+# Removing invalid variable names for tests so that I can
+# keep them brief
+# pylint: disable=invalid-name,no-name-in-module
+# Disable import-error b/c our libraries aren't loaded in jenkins
+# pylint: disable=import-error
+# place class in our python path
+module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library')  # noqa: E501
+sys.path.insert(0, module_path)
+from oc_image import OCImage, locate_oc_binary  # noqa: E402
+
+
+class OCImageTest(unittest.TestCase):
+    '''
+     Test class for OCImage
+    '''
+
+    @mock.patch('oc_image.Utils.create_tmpfile_copy')
+    @mock.patch('oc_image.OCImage._run')
+    def test_state_list(self, mock_cmd, mock_tmpfile_copy):
+        ''' Testing a label list '''
+        params = {'registry_url': 'registry.ops.openshift.com',
+                  'image_name': 'oso-rhel7-zagg-web',
+                  'image_tag': 'int',
+                  'namespace': 'default',
+                  'state': 'list',
+                  'kubeconfig': '/etc/origin/master/admin.kubeconfig',
+                  'debug': False}
+
+        istream = '''{
+            "kind": "ImageStream",
+            "apiVersion": "v1",
+            "metadata": {
+                "name": "oso-rhel7-zagg-web",
+                "namespace": "default",
+                "selfLink": "/oapi/v1/namespaces/default/imagestreams/oso-rhel7-zagg-web",
+                "uid": "6ca2b199-dcdb-11e6-8ffd-0a5f8e3e32be",
+                "resourceVersion": "8135944",
+                "generation": 1,
+                "creationTimestamp": "2017-01-17T17:36:05Z",
+                "annotations": {
+                    "openshift.io/image.dockerRepositoryCheck": "2017-01-17T17:36:05Z"
+                }
+            },
+            "spec": {
+                "tags": [
+                    {
+                        "name": "int",
+                        "annotations": null,
+                        "from": {
+                            "kind": "DockerImage",
+                            "name": "registry.ops.openshift.com/ops/oso-rhel7-zagg-web:int"
+                        },
+                        "generation": 1,
+                        "importPolicy": {}
+                    }
+                ]
+            },
+            "status": {
+                "dockerImageRepository": "172.30.183.164:5000/default/oso-rhel7-zagg-web",
+                "tags": [
+                    {
+                        "tag": "int",
+                        "items": [
+                            {
+                                "created": "2017-01-17T17:36:05Z",
+                                "dockerImageReference": "registry.ops.openshift.com/ops/oso-rhel7-zagg-web@sha256:645bab780cf18a9b764d64b02ca65c39d13cb16f19badd0a49a1668629759392",
+                                "image": "sha256:645bab780cf18a9b764d64b02ca65c39d13cb16f19badd0a49a1668629759392",
+                                "generation": 1
+                            }
+                        ]
+                    }
+                ]
+            }
+        }
+        '''
+
+        mock_cmd.side_effect = [
+            (0, istream, ''),
+        ]
+
+        mock_tmpfile_copy.side_effect = [
+            '/tmp/mocked_kubeconfig',
+        ]
+
+        results = OCImage.run_ansible(params, False)
+
+        self.assertFalse(results['changed'])
+        self.assertEquals(results['results']['results'][0]['metadata']['name'], 'oso-rhel7-zagg-web')
+
+    @mock.patch('oc_image.Utils.create_tmpfile_copy')
+    @mock.patch('oc_image.OCImage._run')
+    def test_state_present(self, mock_cmd, mock_tmpfile_copy):
+        ''' Testing a image present '''
+        params = {'registry_url': 'registry.ops.openshift.com',
+                  'image_name': 'oso-rhel7-zagg-web',
+                  'image_tag': 'int',
+                  'namespace': 'default',
+                  'state': 'present',
+                  'kubeconfig': '/etc/origin/master/admin.kubeconfig',
+                  'debug': False}
+
+        istream = '''{
+            "kind": "ImageStream",
+            "apiVersion": "v1",
+            "metadata": {
+                "name": "oso-rhel7-zagg-web",
+                "namespace": "default",
+                "selfLink": "/oapi/v1/namespaces/default/imagestreams/oso-rhel7-zagg-web",
+                "uid": "6ca2b199-dcdb-11e6-8ffd-0a5f8e3e32be",
+                "resourceVersion": "8135944",
+                "generation": 1,
+                "creationTimestamp": "2017-01-17T17:36:05Z",
+                "annotations": {
+                    "openshift.io/image.dockerRepositoryCheck": "2017-01-17T17:36:05Z"
+                }
+            },
+            "spec": {
+                "tags": [
+                    {
+                        "name": "int",
+                        "annotations": null,
+                        "from": {
+                            "kind": "DockerImage",
+                            "name": "registry.ops.openshift.com/ops/oso-rhel7-zagg-web:int"
+                        },
+                        "generation": 1,
+                        "importPolicy": {}
+                    }
+                ]
+            },
+            "status": {
+                "dockerImageRepository": "172.30.183.164:5000/default/oso-rhel7-zagg-web",
+                "tags": [
+                    {
+                        "tag": "int",
+                        "items": [
+                            {
+                                "created": "2017-01-17T17:36:05Z",
+                                "dockerImageReference": "registry.ops.openshift.com/ops/oso-rhel7-zagg-web@sha256:645bab780cf18a9b764d64b02ca65c39d13cb16f19badd0a49a1668629759392",
+                                "image": "sha256:645bab780cf18a9b764d64b02ca65c39d13cb16f19badd0a49a1668629759392",
+                                "generation": 1
+                            }
+                        ]
+                    }
+                ]
+            }
+        }
+        '''
+
+        mock_cmd.side_effect = [
+            (1, '', 'Error from server: imagestreams "oso-rhel7-zagg-web" not found'),
+            (0, '', ''),
+            (0, istream, ''),
+        ]
+
+        mock_tmpfile_copy.side_effect = [
+            '/tmp/mocked_kubeconfig',
+        ]
+
+        results = OCImage.run_ansible(params, False)
+
+        self.assertTrue(results['changed'])
+        self.assertTrue(results['results']['results'][0]['metadata']['name'] == 'oso-rhel7-zagg-web')
+
+    @unittest.skipIf(six.PY3, 'py2 test only')
+    @mock.patch('os.path.exists')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_fallback(self, mock_env_get, mock_path_exists):
+        ''' Testing binary lookup fallback '''
+
+        mock_env_get.side_effect = lambda _v, _d: ''
+
+        mock_path_exists.side_effect = lambda _: False
+
+        self.assertEqual(locate_oc_binary(), 'oc')
+
+    @unittest.skipIf(six.PY3, 'py2 test only')
+    @mock.patch('os.path.exists')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_path(self, mock_env_get, mock_path_exists):
+        ''' Testing binary lookup in path '''
+
+        oc_bin = '/usr/bin/oc'
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_path_exists.side_effect = lambda f: f == oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)
+
+    @unittest.skipIf(six.PY3, 'py2 test only')
+    @mock.patch('os.path.exists')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_usr_local(self, mock_env_get, mock_path_exists):
+        ''' Testing binary lookup in /usr/local/bin '''
+
+        oc_bin = '/usr/local/bin/oc'
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_path_exists.side_effect = lambda f: f == oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)
+
+    @unittest.skipIf(six.PY3, 'py2 test only')
+    @mock.patch('os.path.exists')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_home(self, mock_env_get, mock_path_exists):
+        ''' Testing binary lookup in ~/bin '''
+
+        oc_bin = os.path.expanduser('~/bin/oc')
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_path_exists.side_effect = lambda f: f == oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)
+
+    @unittest.skipIf(six.PY2, 'py3 test only')
+    @mock.patch('shutil.which')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_fallback_py3(self, mock_env_get, mock_shutil_which):
+        ''' Testing binary lookup fallback '''
+
+        mock_env_get.side_effect = lambda _v, _d: ''
+
+        mock_shutil_which.side_effect = lambda _f, path=None: None
+
+        self.assertEqual(locate_oc_binary(), 'oc')
+
+    @unittest.skipIf(six.PY2, 'py3 test only')
+    @mock.patch('shutil.which')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_path_py3(self, mock_env_get, mock_shutil_which):
+        ''' Testing binary lookup in path '''
+
+        oc_bin = '/usr/bin/oc'
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_shutil_which.side_effect = lambda _f, path=None: oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)
+
+    @unittest.skipIf(six.PY2, 'py3 test only')
+    @mock.patch('shutil.which')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_usr_local_py3(self, mock_env_get, mock_shutil_which):
+        ''' Testing binary lookup in /usr/local/bin '''
+
+        oc_bin = '/usr/local/bin/oc'
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_shutil_which.side_effect = lambda _f, path=None: oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)
+
+    @unittest.skipIf(six.PY2, 'py3 test only')
+    @mock.patch('shutil.which')
+    @mock.patch('os.environ.get')
+    def test_binary_lookup_in_home_py3(self, mock_env_get, mock_shutil_which):
+        ''' Testing binary lookup in ~/bin '''
+
+        oc_bin = os.path.expanduser('~/bin/oc')
+
+        mock_env_get.side_effect = lambda _v, _d: '/bin:/usr/bin'
+
+        mock_shutil_which.side_effect = lambda _f, path=None: oc_bin
+
+        self.assertEqual(locate_oc_binary(), oc_bin)