first step in ocimage

roles/lib_openshift/src/ansible/oc_image.py

@@ -0,0 +1,35 @@
+# 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, type='str'),
+            image_tag=dict(default=None, type='str'),
+            content_type=dict(default='raw', choices=['yaml', 'json', 'raw'], 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,90 @@
+# pylint: skip-file
+
+# pylint: disable=too-many-arguments
+class OCImage(OpenShiftCLI):
+    ''' Class to wrap the oc command line tools
+    '''
+    def __init__(self,
+                 namespace,
+                 registry_url,
+                 image_name,
+                 image_tag,
+                 kubeconfig='/etc/origin/master/admin.kubeconfig',
+                 verbose=False):
+        ''' Constructor for OpenshiftOC '''
+        super(OCImage, self).__init__(namespace, kubeconfig)
+        self.namespace = namespace
+        self.registry_url = registry_url
+        self.image_name = image_name
+        self.image_tag = image_tag
+        self.kubeconfig = kubeconfig
+        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 '"%s" not found' % 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)
+
+
+    @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"}
+
+        if not params['image_name']:
+            return {"failed": True, "msg": 'Please specify a name when state is absent|present.'}
+
+        if state == 'present':
+
+            ########
+            # Create
+            ########
+            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 {"changed": True, "results": api_rval, "state": "present"}
+
+
+            # image exists, no change
+            return {"changed": False, "results": api_rval, "state": "present"}
+
+        return {"failed": True, "changed": False, "results": "Unknown state passed. {0}".format(state), "state": "unknown"}

roles/lib_openshift/src/doc/image

@@ -0,0 +1,92 @@
+# flake8: noqa
+# pylint: skip-file
+
+DOCUMENTATION = '''
+---
+module: oc_label
+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 or update and object to the desired state
+    - 'absent' will ensure certain labels are removed
+    - 'list' will read the labels
+    - 'add' will insert labels to the already existing labels
+    default: present
+    choices: ["present", "absent", "list", "add"]
+    aliases: []
+  kubeconfig:
+    description:
+    - The path for the kubeconfig file to use for authentication
+    required: false
+    default: /etc/origin/master/admin.kubeconfig
+    aliases: []
+  debug:
+    description:
+    - Turn on debug output.
+    required: false
+    default: False
+    aliases: []
+  kind:
+    description:
+    - The kind of object that can be managed.
+    default: node
+    choices:
+    - node
+    - pod
+    - namespace
+    aliases: []
+  labels:
+    description:
+    - A list of labels for the resource.
+    - Each list consists of a key and a value.
+    - eg, {'key': 'foo', 'value': 'bar'}
+    required: false
+    default: None
+    aliases: []
+  selector:
+    description:
+    - The selector to apply to the resource query
+    required: false
+    default: None
+    aliases: []
+author:
+- "Joel Diaz <jdiaz@redhat.com>"
+extends_documentation_fragment: []
+'''
+
+EXAMPLES = '''
+- name: Add a single label to a node's existing labels
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: add
+    kind: node
+    labels:
+      - key: logging-infra-fluentd
+        value: 'true'
+
+- name: remove a label from a node
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: absent
+    kind: node
+    labels:
+      - key: color
+        value: blue
+
+- name: Ensure node has these exact labels
+  oc_label:
+    name: ip-172-31-5-23.ec2.internal
+    state: present
+    kind: node
+    labels:
+      - key: color
+        value: green
+      - key: type
+        value: master
+      - key: environment
+        value: production
+'''

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

@@ -0,0 +1,250 @@
+#!/usr/bin/env python2
+'''
+ Unit tests for oc label
+'''
+# To run
+# python -m unittest image
+#
+# .
+# Ran 1 test in 0.597s
+#
+# OK
+
+import os
+import sys
+import unittest
+import mock
+
+# Removing invalid variable names for tests so that I can
+# keep them brief
+# pylint: disable=invalid-name,no-name-in-module
+# Disable import-error b/c our libraries aren't loaded in jenkins
+# pylint: disable=import-error
+# place class in our python path
+module_path = os.path.join('/'.join(os.path.realpath(__file__).split('/')[:-4]), 'library')  # noqa: E501
+sys.path.insert(0, module_path)
+from oc_image import OCImage  # noqa: E402
+
+
+class OCImageTest(unittest.TestCase):
+    '''
+     Test class for OCImage
+    '''
+
+    def setUp(self):
+        ''' setup method will create a file and set to known configuration '''
+        pass
+
+    @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 image list '''
+        params = {'registry_url': 'registry.ops.openshift.com',
+                  'image_name': 'oso-rhel7-zagg-web',
+                  'image_tag': 'int',
+                  'name': 'default',
+                  'namespace': 'default',
+                  'labels': None,
+                  'state': 'list',
+                  'kind': 'namespace',
+                  'selector': None,
+                  '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 list '''
+        params = {'registry_url': 'registry.ops.openshift.com',
+                  'image_name': 'oso-rhel7-zagg-web',
+                  'image_tag': 'int',
+                  'name': 'default',
+                  'namespace': 'default',
+                  'state': 'present',
+                  'kind': 'namespace',
+                  'selector': None,
+                  '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
+                            }
+                        ]
+                    }
+                ]
+            }
+        }
+        '''
+        istream1 = '''{
+            "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, ''),
+            (0, '', ''),
+            (0, istream1, ''),
+        ]
+
+        mock_tmpfile_copy.side_effect = [
+            '/tmp/mocked_kubeconfig',
+        ]
+
+        results = OCImage.run_ansible(params, False)
+
+        self.assertTrue(results['changed'])
+        self.assertTrue(results['results']['results']['labels'][0] ==
+                        {'storage_pv_quota': 'False', 'awesomens': 'testinglabel'})
+
+    def tearDown(self):
+        '''TearDown method'''
+        pass
+
+
+if __name__ == "__main__":
+    unittest.main()