Merge lp:~mbruzek/charms/precise/memcached/trunk into lp:charms/memcached

[Matt Bruzek]

Added Juju Amulet tests for memcached charm.

Added a deploy test, testing memcached with telnet, and configuration test.

https://codereview.appspot.com/55950045/

[Matt Bruzek (mbruzek)]

Please take a look.

[Matt Bruzek (mbruzek)]

Reviewers: mp+203565_code.launchpad.net,

Message:
Please take a look.

Description:
Added Juju Amulet tests for memcached charm.

Added a deploy test, testing memcached with telnet, and configuration
test.

https://code.launchpad.net/~mbruzek/charms/precise/memcached/trunk/+merge/203565

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/55950045/

Affected files (+154, -0 lines):
   A [revision details]
   A tests/00_setup.sh
   A tests/10_deploy_test.py

[Charles Butler (lazypower)]

Matt, Thank you for your work on this charm test suite, it looks
comprehensive enough to be comfortable, the only issue I found was in
the setup script there were missing dependencies.

Correct those issues and you get a +1 from me

https://codereview.appspot.com/55950045/diff/1/tests/00_setup.sh
File tests/00_setup.sh (right):

https://codereview.appspot.com/55950045/diff/1/tests/00_setup.sh#newcode13
tests/00_setup.sh:13: sudo apt-get install -y amulet
This is missing python3, and any associated python3 libraries to
complete the test run. The assumption is we are running this test on a
machine with nothing more than juju-core on it.

https://codereview.appspot.com/55950045/diff/1/tests/10_deploy_test.py
File tests/10_deploy_test.py (right):

https://codereview.appspot.com/55950045/diff/1/tests/10_deploy_test.py#newcode65
tests/10_deploy_test.py:65: try:
I like how you did this test. +1

https://codereview.appspot.com/55950045/diff/1/tests/10_deploy_test.py#newcode137
tests/10_deploy_test.py:137: message = 'The memcached charm passed the
deply tests!'
Typo on Deploy

https://codereview.appspot.com/55950045/

[lp:~mbruzek/charms/precise/memcached/trunk]

61. By Matt Bruzek <email address hidden> on 2014-01-28

Making changes based on lazyPower's code review comments.

[Matt Bruzek (mbruzek)]

Please take a look.

https://codereview.appspot.com/55950045/

[Matt Bruzek (mbruzek)]

I updated the code to respond to lazypower's code review comments.

https://codereview.appspot.com/55950045/

[Marco Ceppi (marcoceppi)]

This looks good as a test, needs some additional robustness, see inline
comments

https://codereview.appspot.com/55950045/diff/20001/tests/10_deploy_test.py
File tests/10_deploy_test.py (right):

https://codereview.appspot.com/55950045/diff/20001/tests/10_deploy_test.py#newcode96
tests/10_deploy_test.py:96: except:
It would be nice if you used

except Exception as e:

which would allow you to use the e to detail which of the areas failed
in the test. So for your message you could add a third option, str(e) to
get the message of the error which caused the exception. This should
help show authors why the charm is failing if it fails

https://codereview.appspot.com/55950045/diff/20001/tests/10_deploy_test.py#newcode133
tests/10_deploy_test.py:133: relation = mediawiki_unit.relation('cache',
'memcached:cache')
The cache relation for memcache sends host, port, and udp-port with the
last two being configurable. You should set these to non-standard ports
in the initial configuration and test that the values are sent on the
wire properly.

https://codereview.appspot.com/55950045/

[lp:~mbruzek/charms/precise/memcached/trunk]

62. By Matt Bruzek <email address hidden> on 2014-01-31

Addressed code review comments.

[Matt Bruzek (mbruzek)]

Please take a look.

https://codereview.appspot.com/55950045/

[Marco Ceppi (marcoceppi)]

LGTM, with one minor fix below

https://codereview.appspot.com/55950045/diff/40001/tests/10_deploy_test.py
File tests/10_deploy_test.py (right):

https://codereview.appspot.com/55950045/diff/40001/tests/10_deploy_test.py#newcode62
tests/10_deploy_test.py:62: port_string =
memcached_unit.info['open-ports'][0]
It'd be better to use configuration['tcp-port'] for this, instead of
querying the unit.info data.

https://codereview.appspot.com/55950045/

[lp:~mbruzek/charms/precise/memcached/trunk]

63. By Matt Bruzek <email address hidden> on 2014-02-06

Addressing the tcp-port review comment.

[Matt Bruzek (mbruzek)]

Please take a look.

https://codereview.appspot.com/55950045/

[Marco Ceppi (marcoceppi)]

LGTM

review: Approve

=== added directory 'tests'
=== added file 'tests/00_setup.sh'
--- tests/00_setup.sh	1970-01-01 00:00:00 +0000
+++ tests/00_setup.sh	2014-02-06 18:10:42 +0000
@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# The script installs amulet and other tools needed for the amulet tests.
+
+set -x 
+
+# Get the status of the amulet package, this returns 0 of package is installed.
+dpkg -s amulet
+if [ $? -ne 0 ]; then
+  # Install the Amulet testing harness.
+  sudo add-apt-repository -y ppa:juju/stable
+  sudo apt-get update 
+  sudo apt-get install -y amulet juju-core charm-tools
+fi
+dpkg -s python3
+if [ $? -ne 0 ]; then
+  # Install the Python3 libraries.
+  sudo apt-get install -y python3
+fi

=== added file 'tests/10_deploy_test.py'
--- tests/10_deploy_test.py	1970-01-01 00:00:00 +0000
+++ tests/10_deploy_test.py	2014-02-06 18:10:42 +0000
@@ -0,0 +1,146 @@
+#!/usr/bin/python3
+
+## This Amulet test deploys memcached.
+
+import amulet
+import telnetlib
+import time
+
+# The number of seconds to wait for the environment to setup.
+seconds = 1200
+
+d = amulet.Deployment()
+# Add the memcached charm to the deployment.
+d.add('memcached')
+# Add the mediawiki charm to the deployment.
+d.add('mediawiki')
+# Create a relation from memcached to mediawiki
+d.relate('memcached:cache', 'mediawiki:cache')
+
+# Create a configuration dictionary for custom memcached values.
+configuration = {'size': 512, 'connection-limit': 128, 'factor': 1.10,
+                 'tcp-port': 11212, 'udp-port': 11213}
+d.configure('memcached', configuration)
+# Expose memcached so it is visible to the tests.
+d.expose('memcached')
+
+try:
+    # Execute the deployer with the current mapping.
+    d.setup(timeout=seconds)
+    # Wait for the relation to finish the translations.
+    d.sentry.wait(seconds)
+except amulet.helpers.TimeoutError:
+    message = 'The environment did not setup in %d seconds.' % seconds
+    # The SKIP status enables skip or fail the test based on configuration.
+    amulet.raise_status(amulet.SKIP, msg=message)
+except:
+    raise
+
+# Get the sentry for memcached.
+memcached_unit = d.sentry.unit['memcached/0']
+
+## Test if the memcached service is running.
+
+# Run the command that checks if the memcached server instance is running.
+command = 'service memcached status'
+# Execute the command on the deployed service.
+output, code = memcached_unit.run(command)
+
+if code != 0:
+    message = 'The ' + command + ' returned %d.' % code
+    print(output)
+    amulet.raise_status(amulet.FAIL, msg=message)
+else:
+    message = 'The memcached service is running.'
+    print(output)
+    print(message)
+
+## Test memcached using telnet commands.
+
+# Get the public address for memcached instance.
+memcached_address = memcached_unit.info['public-address']
+# Get the port for memcached instance.
+memcached_port = configuration['tcp-port'] 
+
+try:
+    # Connect to memcached via telnet.
+    tn = telnetlib.Telnet(memcached_address, memcached_port)
+    date_time = time.strftime("%F %r")
+    # Write the command that gets the current greeting.
+    tn.write(b'get greeting\r\n')
+    # Read the current greeting.
+    response = tn.read_until(b'END', 2)
+    # Create a string with date and time for this test.
+    string = 'memcached test %s' % date_time
+    command = 'set greeting 1 0 %d' % len(string)
+    # Write the command that sets the new greeting.
+    tn.write(command.encode() + b'\r\n')
+    tn.write(string.encode() + b'\r\n')
+    # Read the response
+    response = tn.read_until(b'STORED', 2)
+    # Write the command that gets the greeting.
+    tn.write(b'get greeting\r\n')
+    # Get the new greeting in memcached.
+    response = tn.read_until(b'END', 2)
+    response = response.decode()
+    print('get greeting response:')
+    print(response)
+    # Look for the string in the response.
+    index = response.find(string)
+    if index != -1:
+        print('Found %s in the greeting response.' % string)
+    else:
+        print(response)
+        message = 'Did not find %s in the greeting from memcached.' % string
+        amulet.raise_status(amulet.FAIL, msg=message)
+    tn.write(b'quit\n')
+except Exception as e:
+    message = 'An error occurred communicating with memcached over telnet ' \
+        '{0}:{1} {3}'.format(memcached_address, memcached_port, str(e))
+    amulet.raise_status(amulet.FAIL, msg=message)
+finally:
+    tn.close()
+
+## Test if the memcached service is configured properly.
+
+# Get the contents of the memcached configuration file.
+config_string = memcached_unit.file_contents('/etc/memcached.conf')
+# Parse the configuration file for the values sent in the deployment.
+for line in config_string.splitlines():
+    if line.startswith('-m '):
+        size = line.split()[1]
+    elif line.startswith('-c '):
+        limit = line.split()[1]
+    elif line.startswith('-f '):
+        factor = line.split()[1]
+
+# Check for the configured values.
+if (configuration['size'] != int(size) or
+   configuration['connection-limit'] != int(limit) or
+   configuration['factor'] != float(factor)):
+    message = 'The memcached deployment was not configured correctly, size: ' \
+              '{0} limit: {1} factor: {2}'.format(size, limit, factor)
+    amulet.raise_status(amulet.FAIL, msg=message)
+else:
+    message = 'The memcached deployment was configured correctly.'
+    print(message)
+
+## Test if the relation is complete and data was exchanged properly.
+
+memcached_unit = d.sentry.unit['memcached/0']
+# Get the relation from memcached to mediawiki.
+relation = memcached_unit.relation('cache', 'mediawiki:cache')
+
+# Make sure the relation got the port information set by the configuration.
+if (configuration['tcp-port'] != int(relation['port']) or
+   configuration['udp-port'] != int(relation['udp-port'])):
+    message = 'The memcached relation was not configured correctly, port: ' \
+              '{0} udp-port: {1}'.format(relation['port'], relation['udp-port'])
+    amulet.raise_status(amulet.FAIL, msg=message)
+else:
+    message = 'The memcached relation was configured correctly.'
+    print(message)
+
+# Print a message indicating the charm passed all the tests.
+message = 'The memcached charm passed the deploy tests!'
+print(message)