Merge lp:~viswesn/juju-ci-tools/assess-check-openstack into lp:juju-ci-tools

[viswesuwara nathan]

Validation of Juju validate-image and validate-tool on generating agent image and tools for Openstack cloud.

[Christopher Lee (veebers)]

A couple of comments inline.

review: Needs Fixing

[lp:~viswesn/juju-ci-tools/assess-check-openstack]

1799. By viswesuwara nathan on 2016-12-14

Review comments addressed

1800. By viswesuwara nathan on 2016-12-15

Fixed couple of indentation and error messages

1801. By viswesuwara nathan on 2017-01-06

Added Unit test cases and addressed code comments

Unmerged revisions

1801. By viswesuwara nathan on 2017-01-06

Added Unit test cases and addressed code comments

1800. By viswesuwara nathan on 2016-12-15

Fixed couple of indentation and error messages

1799. By viswesuwara nathan on 2016-12-14

Review comments addressed

1798. By viswesuwara nathan on 2016-12-12

Verify juju validate-tool and validate-image for openstack cloud

=== added file 'assess_check_openstack.py'
--- assess_check_openstack.py	1970-01-01 00:00:00 +0000
+++ assess_check_openstack.py	2017-01-06 14:05:59 +0000
@@ -0,0 +1,187 @@
+#!/usr/bin/env python
+"""
+    assess_check_openstack.py perform juju metadata generate-image and
+    generate-tools for the passed argument and  does juju validation for
+    images and tools using juju metadata validate-image and validate-tools
+"""
+
+from __future__ import print_function
+
+import argparse
+import logging
+import sys
+import json
+import subprocess
+import os
+
+from shutil import copyfile
+
+from deploy_stack import (
+    BootstrapManager,
+    )
+from utility import (
+    add_basic_testing_arguments,
+    configure_logging,
+    JujuAssertionError,
+    temp_dir,
+    )
+
+__metaclass__ = type
+
+log = logging.getLogger("assess_check_openstack")
+
+JUJU_IMAGE_INDEX = "images/streams/v1/index.json"
+JUJU_TOOL_INDEX = "tools/streams/v1/index2.json"
+
+
+def do_validate_image(image, region, endpoint, series, source_dir, client):
+    """
+    Invoke cmd 'juju metadata validate-images' to validate
+    image metadata and ensure image(s) exist for a model
+    :param image: String representing image ID
+    :param region: String representing region name
+    :param endpoint: String representing endpoint
+    :param series: String representing series
+    :param source_dir: The source directory containing tools and metadata
+    :param client: Juju client
+    """
+    try:
+        output = client.validate_images(
+            source_dir, region, endpoint, series, provider="openstack")
+    except subprocess.CalledProcessError as e:
+        raise JujuAssertionError(
+            "Failed to execute juju metadata validate-images: {}".format(e))
+
+    validate_images_output = json.loads(output)
+    actual_image_id = validate_images_output["ImageIds"][0]
+    actual_region_name = validate_images_output["Region"]
+    actual_index_url = validate_images_output["Resolve Metadata"]["indexURL"]
+
+    if actual_image_id != image:
+        raise JujuAssertionError(
+            'juju validate-image failed for image. Expected {} Got {}'.format(
+                image, actual_image_id))
+
+    if actual_region_name != region:
+        raise JujuAssertionError(
+            'juju validate-image failed for region. Expected {} Got {}'.format(
+                region, actual_region_name))
+
+    index_url = os.path.join("file:///", source_dir[1:], JUJU_IMAGE_INDEX)
+    if actual_index_url != index_url:
+        raise JujuAssertionError(
+            'juju validate-image failed for indexURL. '
+            'Expected {} Got {}'.format(index_url, actual_index_url))
+
+    log.info("juju validate-image done successfully")
+
+
+def do_validate_tool(region, endpoint, series, stream, source_dir, client):
+    """
+    Invoke juju cmd 'juju metadata validate-tools' to validate tools
+    metadata and ensure tool tarball exist for Juju version
+    :param region: String representing region name
+    :param endpoint: String representing endpoint
+    :param series: String representing series
+    :param stream:  String representing stream
+    :param source_dir: The source directory containing tools and metadata
+    :param client: Juju client
+    """
+    try:
+        output = client.validate_tools(
+            source_dir, region, endpoint, series, stream, provider="openstack")
+        validate_tool_output = json.loads(output)
+        actual_index_url = validate_tool_output["Resolve Metadata"]["indexURL"]
+
+        index_url = os.path.join("file:///", source_dir[1:], JUJU_TOOL_INDEX)
+        if actual_index_url != index_url:
+            raise JujuAssertionError(
+                'juju validate-tools failed for indexURL. '
+                'Expcted {} Got {}'.format(index_url, actual_index_url))
+
+    except subprocess.CalledProcessError as e:
+        raise JujuAssertionError(
+            "Failed to execute juju metadata validate-tools {}".format(e))
+
+    log.info("juju validate-tools done successfully")
+
+
+def copy_agent_file(stream, src_agent_file, agent_dir):
+    """
+     Copy the specified source agent file to the specified
+     target agent directory.
+    :param stream: The released or develop stream directory to be created
+    :param src_agent_file: The source juju agent file
+    :param agent_dir: The directory to copy the orignal juju agent file
+    """
+    if stream.startswith("releas"):
+        target_dir = os.path.join(agent_dir, "tools", "released")
+    else:
+        target_dir = os.path.join(agent_dir, "tools", "develop")
+
+    os.makedirs(target_dir)
+
+    dst_agent_file = os.path.join(target_dir, os.path.basename(src_agent_file))
+    copyfile(src_agent_file, dst_agent_file)
+
+
+def assess_check_openstack(args):
+    """
+    Perform juju validataion for image and tool metadata
+    :param args: Parsed command line arguments
+    """
+    bs_manager = BootstrapManager.from_args(args)
+    client = bs_manager.client
+    with temp_dir() as agent_dir:
+        copy_agent_file(args.stream, args.agent_file, agent_dir)
+        client.generate_image(agent_dir, args.image, args.arch, args.series,
+                              args.region, args.endpoint)
+        client.generate_tool(agent_dir, args.stream)
+        do_validate_image(args.image, args.region, args.endpoint, args.series,
+                          agent_dir, client)
+        do_validate_tool(args.region, args.endpoint, args.series, args.stream,
+                         agent_dir, client)
+
+
+def parse_args(argv):
+    """Parse all arguments."""
+    parser = argparse.ArgumentParser(
+        description="Perform juju metadata validation for images and tools")
+    add_basic_testing_arguments(parser)
+
+    parser.add_argument('--arch',
+                        default='amd64',
+                        help='the image architecture')
+    parser.add_argument('--stream',
+                        default='released',
+                        help='the image stream',
+                        choices=["released", "develop"])
+    parser.add_argument('--endpoint', required=True,
+                        default=None,
+                        help='the regional cloud endpoint')
+    parser.add_argument('--image', required=True,
+                        default=None,
+                        help='the image id')
+    parser.add_argument('--agent-file', required=True,
+                        default=None,
+                        help='agent file to be used during bootstrap.')
+
+    return parser.parse_args(argv)
+
+
+def main(argv=None):
+    args = parse_args(argv)
+    configure_logging(args.verbose)
+
+    if args.series is None:
+        raise JujuAssertionError("argument --series is required")
+
+    if args.region is None:
+        raise JujuAssertionError("argument --region is required")
+
+    assess_check_openstack(args)
+
+    return 0
+
+if __name__ == '__main__':
+    sys.exit(main())

=== modified file 'jujupy.py'
--- jujupy.py	2017-01-03 17:04:07 +0000
+++ jujupy.py	2017-01-06 14:05:59 +0000
@@ -2725,6 +2725,32 @@
         return self.get_juju_output('list-clouds', '--format',
                                     format, include_e=False)
 
+    def validate_tools(self, source_dir, region, endpoint, series, stream,
+                       provider, format='json'):
+        args = ('validate-tools', '-p', provider, '-s', series, '-r', region,
+                '-d', source_dir, '-u', endpoint, '--stream', stream)
+        args += ('--format', format)
+        return self.get_juju_output("metadata", *args, include_e=False)
+
+    def validate_images(self, source_dir, region, endpoint, series, provider,
+                        format='json'):
+        args = ('validate-images', '-p', provider, '-s', series, '-r', region,
+                '-d', source_dir, '-u', endpoint)
+        args += ('--format', format)
+        return self.get_juju_output("metadata", *args, include_e=False)
+
+    def generate_image(self, source_dir, image, arch, series, region,
+                       endpoint):
+        args = ('generate-image', '-a', arch, '-i', image, '-r', region,
+                '-s', series, '-u', endpoint, '-d', source_dir)
+        return self.juju("metadata", args, include_e=False)
+
+    def generate_tool(self, source_dir, stream=None):
+        args = ('generate-tools', '-d', source_dir)
+        if stream is not None:
+            args += ('--stream', stream)
+        return self.juju('metadata', args, include_e=False)
+
     def add_cloud_interactive(self, cloud_name, cloud):
         child = self.expect('add-cloud', include_e=False)
         try:

=== added file 'tests/test_assess_check_openstack.py'
--- tests/test_assess_check_openstack.py	1970-01-01 00:00:00 +0000
+++ tests/test_assess_check_openstack.py	2017-01-06 14:05:59 +0000
@@ -0,0 +1,108 @@
+
+from tests import (
+    TestCase,
+    )
+
+from mock import (
+    patch,
+    )
+from fakejuju import (
+    fake_juju_client,
+    )
+from utility import (
+    JujuAssertionError,
+    )
+
+from assess_check_openstack import (
+    do_validate_image,
+    do_validate_tool,
+    parse_args,
+    )
+
+
+class TestParseArgs(TestCase):
+    def test_parse_args_(self):
+        args = parse_args(['base', 'foo', 'bar',
+                           '--series', 'amd64',
+                           '--agent-file',
+                           '/home/juju-2.1-beta1-xenial-amd64.tgz',
+                           '--endpoint', 'http://example.juju.com',
+                           '--image', '843bef24-8c70-40e1-a380-972717c9e4b3',
+                           '--region', 'foo'])
+        self.assertEqual(args.endpoint, "http://example.juju.com")
+        self.assertEqual(args.image, "843bef24-8c70-40e1-a380-972717c9e4b3")
+        self.assertEqual(args.region, "foo")
+        self.assertEqual(args.agent_file,
+                         "/home/juju-2.1-beta1-xenial-amd64.tgz")
+
+
+class TestAssessCheckOpenStack(TestCase):
+    def test_do_validate_image(self):
+        args = parse_args(['base', 'foo', 'bar',
+                           '--series', 'amd64',
+                           '--agent-file',
+                           '/home/juju-2.1-beta1-xenial-amd64.tgz',
+                           '--endpoint', 'http://example.juju.com',
+                           '--image', '843bef24-8c70-40e1-a380-972717c9e4b3',
+                           '--region', 'foo'])
+        mock_client = fake_juju_client()
+        output = '{' \
+                 '"ImageIds":["843bef24-8c70-40e1-a380-972717c9e4b3"],' \
+                 '"Region":"foo","Resolve Metadata":' \
+                 '{' \
+                 '"source":"local metadata directory",' \
+                 '"signed":false,' \
+                 '"indexURL":' \
+                 '"file:///tmp/tmpFpwJ3k/images/streams/v1/index.json"' \
+                 '}' \
+                 '}\n'
+
+        with patch('jujupy.EnvJujuClient.validate_images',
+                   return_value=output, autospec=True):
+            do_validate_image(args.image, args.region, args.endpoint,
+                              args.series, "/tmp/tmpFpwJ3k", mock_client)
+
+    def test_do_validate_image_with_assert_raises(self):
+        args = parse_args(['base', 'foo', 'bar',
+                           '--series', 'amd64',
+                           '--agent-file',
+                           '/home/juju-2.1-beta1-xenial-amd64.tgz',
+                           '--endpoint', 'http://example.juju.com',
+                           '--image', '843bef24-8c70-40e1-a380-972717c9e4b3',
+                           '--region', 'foo'])
+        mock_client = fake_juju_client()
+        output = '{' \
+                 '"ImageIds":["843bef24-8c70-40e1-a380-972717c9e4"],' \
+                 '"Region":"foo","Resolve Metadata":' \
+                 '{' \
+                 '"source":"local metadata directory",' \
+                 '"signed":false,' \
+                 '"indexURL":' \
+                 '"file:///tmp/tmpFpwJ3k/images/streams/v1/index.json"' \
+                 '}' \
+                 '}\n'
+
+        with patch('jujupy.EnvJujuClient.validate_images',
+                   return_value=output, autospec=True):
+            with self.assertRaises(JujuAssertionError):
+                do_validate_image(args.image, args.region, args.endpoint,
+                                  args.series, "/tmp/tmpFpwJ3k", mock_client)
+
+    def test_do_validate_tools(self):
+        args = parse_args(['base', 'foo', 'bar',
+                           '--agent-file',
+                           '/home/juju-2.1-beta1-xenial-amd64.tgz',
+                           '--endpoint', 'http://example.juju.com',
+                           '--image', '843bef24-8c70-40e1-a380-972717c9e4b3',
+                           '--region', 'foo'])
+        mock_client = fake_juju_client()
+        output = '{"Matching Tools Versions":["2.0.1-xenial-amd64"],' \
+                 '"Resolve Metadata":{' \
+                 '"source":"local source",' \
+                 '"signed":false,' \
+                 '"indexURL":' \
+                 '"file:///tmp/tmpRo0uM_/tools/streams/v1/index2.json"}}\n'
+        with patch('jujupy.EnvJujuClient.validate_tools',
+                   return_value=output, autospec=True):
+            do_validate_tool(args.region, args.endpoint, args.series,
+                             args.stream, "/tmp/tmpRo0uM_", mock_client)

=== modified file 'tests/test_jujupy.py'
--- tests/test_jujupy.py	2017-01-03 17:04:07 +0000
+++ tests/test_jujupy.py	2017-01-06 14:05:59 +0000
@@ -3479,6 +3479,56 @@
         mock.assert_called_with(
             'list-clouds', '--format', 'json', include_e=False)
 
+    def test_validate_tools(self):
+        client = EnvJujuClient(JujuData('foo'), None, None)
+        with patch.object(client, 'get_juju_output', autospec=True,
+                          return_value='') as mock:
+            client.validate_tools('source_dir', 'region', 'endpoint',
+                                  'series', 'stream', 'provider')
+        mock.assert_called_once_with('metadata', 'validate-tools',
+                                     '-p', 'provider', '-s', 'series',
+                                     '-r', 'region', '-d', 'source_dir',
+                                     '-u', 'endpoint', '--stream', 'stream',
+                                     '--format', 'json',
+                                     include_e=False)
+
+    def test_validate_images(self):
+        client = EnvJujuClient(JujuData('foo'), None, None)
+        with patch.object(client, 'get_juju_output', autospec=True,
+                          return_value='') as mock:
+            client.validate_images('source_dir', 'region', 'endpoint',
+                                   'series', 'provider')
+        mock.assert_called_once_with('metadata', 'validate-images',
+                                     '-p', 'provider', '-s', 'series',
+                                     '-r', 'region', '-d', 'source_dir',
+                                     '-u', 'endpoint', '--format', 'json',
+                                     include_e=False)
+
+    def test_generate_image(self):
+        client = EnvJujuClient(JujuData('foo'), None, None)
+        args = ('generate-image', '-a', 'arch', '-i', 'image', '-r',
+                'region', '-s', 'series', '-u', 'endpoint', '-d', 'source_dir')
+        with patch.object(client, 'juju', autospec=True) as mock:
+            client.generate_image('source_dir', 'image', 'arch', 'series',
+                                  'region', 'endpoint')
+        mock.assert_called_once_with('metadata', args, include_e=False)
+
+    def test_generate_tool(self):
+        client = EnvJujuClient(JujuData('foo'), None, None)
+        with patch.object(client, 'juju', autospec=True) as mock:
+            client.generate_tool('/agents')
+        mock.assert_called_once_with('metadata',
+                                     ('generate-tools', '-d', '/agents'),
+                                     include_e=False)
+
+    def test_generate_tool_with_stream(self):
+        client = EnvJujuClient(JujuData('foo'), None, None)
+        with patch.object(client, 'juju', autospec=True) as mock:
+            client.generate_tool('/agents', "testing")
+        mock.assert_called_once_with(
+            'metadata', ('generate-tools', '-d', '/agents',
+                         '--stream', 'testing'), include_e=False)
+
     def test_add_cloud_interactive_maas(self):
         client = fake_juju_client()
         clouds = {'foo': {