Merge lp:~mpontillo/maas/basic-speed-test-endpoint into lp:~maas-committers/maas/trunk

[Mike Pontillo]

Add basic speed-test API endpoint.

[MAAS Lander (maas-lander)]

Transitioned to Git.

lp:maas has now moved from Bzr to Git.
Please propose your branches with Launchpad using Git.

git clone https://git.launchpad.net/maas

Unmerged revisions

5594. By Mike Pontillo on 2016-12-07

Add basic speed-test API endpoint.

=== added file 'src/maasserver/api/speed_test.py'
--- src/maasserver/api/speed_test.py	1970-01-01 00:00:00 +0000
+++ src/maasserver/api/speed_test.py	2016-12-07 16:32:54 +0000
@@ -0,0 +1,76 @@
+# Copyright 2016 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Speed test API handler."""
+
+from django.http import HttpResponse
+from django.http.response import HttpResponseBadRequest
+from formencode.validators import (
+    Number,
+    StringBool,
+)
+from maasserver.api.utils import get_optional_param
+
+
+def get_random_testdata(size):
+    with open('/dev/urandom', 'rb') as dev_random:
+        return dev_random.read(size)
+
+
+def get_zero_testdata(size):
+    with open('/dev/zero', 'rb') as dev_zero:
+        return dev_zero.read(size)
+
+
+# Cache one megabyte of random test data.
+DEFAULT_SIZE = (1024 * 1024)
+# Don't allow the user to ask for more than 64 megabytes.
+MAX_SIZE = (1024 * 1024 * 64)
+RANDOM_TESTDATA = dict()
+RANDOM_TESTDATA[DEFAULT_SIZE] = get_random_testdata(DEFAULT_SIZE)
+
+
+def speed_test(request):
+    """API endpoint that can be used for simple speed tests.
+
+    No authentication is required in order to use this end point.
+
+    Optional parameters
+    -------------------
+    random
+        If False, uses zeroes as a test payload, rather than the default
+        of using random test data. (Default: True)
+
+    size
+        Specifies the number of bytes to use as a test payload.
+        Default is 1048576 (one megabyte).
+
+    pattern
+        If specified, uses the specified string for a test payload instead of
+        random (or zero) data.
+    """
+    size = int(get_optional_param(
+        request.GET, 'size', default=DEFAULT_SIZE, validator=Number))
+    random = get_optional_param(
+        request.GET, 'random', default=True, validator=StringBool)
+    pattern = get_optional_param(
+        request.GET, 'pattern', default=None)
+    # If the user specified a pattern, that imples they don't want to use
+    # random data for the test payload.
+    if pattern is not None:
+        random = False
+    if size > MAX_SIZE:
+        return HttpResponseBadRequest(
+            content_type="text/plain",
+            content="Invalid size; maximum is %d bytes." % MAX_SIZE)
+    if random:
+        if size in RANDOM_TESTDATA:
+            content = RANDOM_TESTDATA[size]
+        else:
+            content = get_random_testdata(size)
+    elif pattern:
+        content = pattern * int(size / len(pattern))
+    else:
+        content = get_zero_testdata(size)
+    return HttpResponse(
+        content_type="application/octet-stream", content=content)

=== modified file 'src/maasserver/urls_api.py'
--- src/maasserver/urls_api.py	2016-12-07 12:46:14 +0000
+++ src/maasserver/urls_api.py	2016-12-07 16:32:54 +0000
@@ -137,6 +137,7 @@
     SpaceHandler,
     SpacesHandler,
 )
+from maasserver.api.speed_test import speed_test
 from maasserver.api.ssh_keys import (
     SSHKeyHandler,
     SSHKeysHandler,
@@ -325,6 +326,7 @@
     url(r'doc/$', api_doc, name='api-doc'),
     url(r'describe/$', describe, name='describe'),
     url(r'version/$', version_handler, name='version_handler'),
+    url(r'speed-test/$', speed_test, name='speed_test_handler'),
 )