diff options
24 files changed, 184 insertions, 67 deletions
diff --git a/apidocs/src/samples/db-backup-create-incremental-request-json.txt b/apidocs/src/samples/db-backup-create-incremental-request-json.txt new file mode 100644 index 00000000..3af4ac8f --- /dev/null +++ b/apidocs/src/samples/db-backup-create-incremental-request-json.txt @@ -0,0 +1,7 @@ +POST /v1.0/1234/backups HTTP/1.1 +User-Agent: python-troveclient +Host: troveapi.org +X-Auth-Token: 87c6033c-9ff6-405f-943e-2deb73f278b7 +Accept: application/json +Content-Type: application/json + diff --git a/apidocs/src/samples/db-backup-create-incremental-request.json b/apidocs/src/samples/db-backup-create-incremental-request.json new file mode 100644 index 00000000..902545c9 --- /dev/null +++ b/apidocs/src/samples/db-backup-create-incremental-request.json @@ -0,0 +1,9 @@ +{ + "backup": { + "description": "My Incremental Backup", + "instance": "44b277eb-39be-4921-be31-3d61b43651d7", + "name": "Incremental Snapshot", + "parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4" + } +} + diff --git a/apidocs/src/samples/db-backup-create-incremental-response-json.txt b/apidocs/src/samples/db-backup-create-incremental-response-json.txt new file mode 100644 index 00000000..a55a2e69 --- /dev/null +++ b/apidocs/src/samples/db-backup-create-incremental-response-json.txt @@ -0,0 +1,5 @@ +HTTP/1.1 202 Accepted +Content-Type: application/json +Content-Length: 462 +Date: Mon, 18 Mar 2013 19:09:17 GMT + diff --git a/apidocs/src/samples/db-backup-create-incremental-response.json b/apidocs/src/samples/db-backup-create-incremental-response.json new file mode 100644 index 00000000..e70aefcc --- /dev/null +++ b/apidocs/src/samples/db-backup-create-incremental-response.json @@ -0,0 +1,20 @@ +{ + "backup": { + "created": "2014-10-30T12:30:00", + "datastore": { + "type": "mysql", + "version": "5.5", + "version_id": "b00000b0-00b0-0b00-00b0-000b000000bb" + }, + "description": "My Incremental Backup", + "id": "2e351a71-dd28-4bcb-a7d6-d36a5b487173", + "instance_id": "44b277eb-39be-4921-be31-3d61b43651d7", + "locationRef": null, + "name": "Incremental Snapshot", + "parent_id": "a9832168-7541-4536-b8d9-a8a9b79cf1b4", + "size": null, + "status": "NEW", + "updated": "2014-10-30T12:30:00" + } +} + diff --git a/apidocs/src/samples/db-backup-get-response.json b/apidocs/src/samples/db-backup-get-response.json index eea2dd2a..ee7dc113 100644 --- a/apidocs/src/samples/db-backup-get-response.json +++ b/apidocs/src/samples/db-backup-get-response.json @@ -12,7 +12,7 @@ "locationRef": "http://localhost/path/to/backup", "name": "snapshot", "parent_id": null, - "size": null, + "size": 0.14, "status": "COMPLETED", "updated": "2014-10-30T12:30:00" } diff --git a/apidocs/src/samples/db-backup-list-response.json b/apidocs/src/samples/db-backup-list-response.json index 9ea7eb04..a7cb7013 100644 --- a/apidocs/src/samples/db-backup-list-response.json +++ b/apidocs/src/samples/db-backup-list-response.json @@ -13,7 +13,7 @@ "locationRef": "http://localhost/path/to/backup", "name": "snapshot", "parent_id": null, - "size": null, + "size": 0.14, "status": "COMPLETED", "updated": "2014-10-30T12:30:00" } diff --git a/apidocs/src/samples/db-backups-by-instance-response.json b/apidocs/src/samples/db-backups-by-instance-response.json index 9ea7eb04..a7cb7013 100644 --- a/apidocs/src/samples/db-backups-by-instance-response.json +++ b/apidocs/src/samples/db-backups-by-instance-response.json @@ -13,7 +13,7 @@ "locationRef": "http://localhost/path/to/backup", "name": "snapshot", "parent_id": null, - "size": null, + "size": 0.14, "status": "COMPLETED", "updated": "2014-10-30T12:30:00" } diff --git a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt b/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt index bbb477c3..88efdd83 100644 --- a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt +++ b/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response-json.txt @@ -1,5 +1,5 @@ HTTP/1.1 200 OK Content-Type: application/json -Content-Length: 154 +Content-Length: 149 Date: Mon, 18 Mar 2013 19:09:17 GMT diff --git a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json b/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json index bc639b67..db0ebd91 100644 --- a/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json +++ b/apidocs/src/samples/db-configuration-parameter-for-datastore-version-response.json @@ -1,6 +1,6 @@ { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "min_size": "0", + "min": "0", "name": "collation_server", "restart_required": false, "type": "string" diff --git a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt b/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt index bbb477c3..88efdd83 100644 --- a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt +++ b/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response-json.txt @@ -1,5 +1,5 @@ HTTP/1.1 200 OK Content-Type: application/json -Content-Length: 154 +Content-Length: 149 Date: Mon, 18 Mar 2013 19:09:17 GMT diff --git a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json b/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json index bc639b67..db0ebd91 100644 --- a/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json +++ b/apidocs/src/samples/db-configuration-parameter-without-datastore-version-response.json @@ -1,6 +1,6 @@ { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "min_size": "0", + "min": "0", "name": "collation_server", "restart_required": false, "type": "string" diff --git a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt b/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt index 4c54c87b..4ffc0d8e 100644 --- a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt +++ b/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response-json.txt @@ -1,5 +1,5 @@ HTTP/1.1 200 OK Content-Type: application/json -Content-Length: 1085 +Content-Length: 1030 Date: Mon, 18 Mar 2013 19:09:17 GMT diff --git a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json b/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json index b147c701..fb517d8b 100644 --- a/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json +++ b/apidocs/src/samples/db-configuration-parameters-for-datastore-version-response.json @@ -2,47 +2,47 @@ "configuration-parameters": [ { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "min_size": "0", + "min": "0", "name": "collation_server", "restart_required": false, "type": "string" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "65535", - "min_size": "0", + "max": "65535", + "min": "0", "name": "connect_timeout", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "57671680", - "min_size": "0", + "max": "57671680", + "min": "0", "name": "innodb_buffer_pool_size", "restart_required": true, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "4294967296", - "min_size": "0", + "max": "4294967296", + "min": "0", "name": "join_buffer_size", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "4294967296", - "min_size": "0", + "max": "4294967296", + "min": "0", "name": "key_buffer_size", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "1", - "min_size": "0", + "max": "1", + "min": "0", "name": "local_infile", "restart_required": false, "type": "integer" diff --git a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt b/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt index 4c54c87b..4ffc0d8e 100644 --- a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt +++ b/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response-json.txt @@ -1,5 +1,5 @@ HTTP/1.1 200 OK Content-Type: application/json -Content-Length: 1085 +Content-Length: 1030 Date: Mon, 18 Mar 2013 19:09:17 GMT diff --git a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json b/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json index b147c701..fb517d8b 100644 --- a/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json +++ b/apidocs/src/samples/db-configuration-parameters-without-datastore-version-response.json @@ -2,47 +2,47 @@ "configuration-parameters": [ { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "min_size": "0", + "min": "0", "name": "collation_server", "restart_required": false, "type": "string" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "65535", - "min_size": "0", + "max": "65535", + "min": "0", "name": "connect_timeout", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "57671680", - "min_size": "0", + "max": "57671680", + "min": "0", "name": "innodb_buffer_pool_size", "restart_required": true, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "4294967296", - "min_size": "0", + "max": "4294967296", + "min": "0", "name": "join_buffer_size", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "4294967296", - "min_size": "0", + "max": "4294967296", + "min": "0", "name": "key_buffer_size", "restart_required": false, "type": "integer" }, { "datastore_version_id": "b00000b0-00b0-0b00-00b0-000b000000bb", - "max_size": "1", - "min_size": "0", + "max": "1", + "min": "0", "name": "local_infile", "restart_required": false, "type": "integer" diff --git a/apidocs/src/samples/db-list-databases-pagination-response.json b/apidocs/src/samples/db-list-databases-pagination-response.json index aa3dfdd4..3dc9e46e 100644 --- a/apidocs/src/samples/db-list-databases-pagination-response.json +++ b/apidocs/src/samples/db-list-databases-pagination-response.json @@ -6,7 +6,7 @@ ], "links": [ { - "href": "https://troveapi.org/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?marker=anotherdb&limit=1", + "href": "https://troveapi.org/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/databases?limit=1&marker=anotherdb", "rel": "next" } ] diff --git a/apidocs/src/samples/db-list-users-pagination-response.json b/apidocs/src/samples/db-list-users-pagination-response.json index 0985df73..eebba6fb 100644 --- a/apidocs/src/samples/db-list-users-pagination-response.json +++ b/apidocs/src/samples/db-list-users-pagination-response.json @@ -1,7 +1,7 @@ { "links": [ { - "href": "https://troveapi.org/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?marker=dbuser2%2540%2525&limit=2", + "href": "https://troveapi.org/v1.0/1234/instances/44b277eb-39be-4921-be31-3d61b43651d7/users?limit=2&marker=dbuser2%2540%2525", "rel": "next" } ], diff --git a/apidocs/src/samples/db-mgmt-list-hosts-response.json b/apidocs/src/samples/db-mgmt-list-hosts-response.json index 2ec7086a..3fe0eb52 100644 --- a/apidocs/src/samples/db-mgmt-list-hosts-response.json +++ b/apidocs/src/samples/db-mgmt-list-hosts-response.json @@ -1,12 +1,12 @@ { "hosts": [ { - "instanceCount": 0, - "name": "hostname_2" - }, - { "instanceCount": 1, "name": "hostname_1" + }, + { + "instanceCount": 0, + "name": "hostname_2" } ] } diff --git a/generate_examples.py b/generate_examples.py index ff9bcd08..afe14e6c 100644..100755 --- a/generate_examples.py +++ b/generate_examples.py @@ -1,4 +1,24 @@ +#!/usr/bin/env python + +# Copyright 2014 OpenStack Foundation +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# + import run_tests +import argparse +import os +import sys def import_tests(): @@ -7,4 +27,15 @@ def import_tests(): if __name__ == "__main__": + parser = argparse.ArgumentParser(description='Generate Example Snippets') + parser.add_argument('--fix-examples', action='store_true', + help='Fix the examples rather than failing tests.') + + args = parser.parse_args() + if args.fix_examples: + os.environ['TESTS_FIX_EXAMPLES'] = 'True' + # Remove the '--fix-examples' argument from sys.argv as it is not a + # valid argument in the run_tests module. + sys.argv.pop(sys.argv.index('--fix-examples')) + run_tests.main(import_tests) diff --git a/requirements.txt b/requirements.txt index 98755ab8..fc4b307f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -32,3 +32,4 @@ MySQL-python Babel>=1.3 six>=1.7.0 stevedore>=1.1.0 # Apache-2.0 +ordereddict diff --git a/trove/common/pagination.py b/trove/common/pagination.py index 99ee280c..b587b7f3 100644 --- a/trove/common/pagination.py +++ b/trove/common/pagination.py @@ -16,6 +16,11 @@ import urllib import six.moves.urllib.parse as urlparse +try: + from collections import OrderedDict +except ImportError: + from ordereddict import OrderedDict + def url_quote(s): if s is None: @@ -88,7 +93,8 @@ class AppUrl(object): # then add &foo=bar to the URL. parsed_url = urlparse.urlparse(self.url) # Build a dictionary out of the query parameters in the URL - query_params = dict(urlparse.parse_qsl(parsed_url.query)) + # with an OrderedDict to preserve the order of the URL. + query_params = OrderedDict(urlparse.parse_qsl(parsed_url.query)) # Use kwargs to change or update any values in the query dict. query_params.update(kwargs) diff --git a/trove/tests/examples/client.py b/trove/tests/examples/client.py index 208f9728..5d4a38e1 100644 --- a/trove/tests/examples/client.py +++ b/trove/tests/examples/client.py @@ -166,32 +166,47 @@ class SnippetWriter(object): file.write("%s\n" % line) def assert_output_matches(): - # If this test is failing for you, comment out this next if os.path.isfile(filename): with open(filename, 'r') as original_file: original = original_file.read() - if empty: - fail('Error: output missing in new snippet generation ' - 'for %s. Old content follows:\n"""%s"""' - % (filename, original)) - expected = original.split('\n') - # Remove the last item which will look like a duplicated - # file ending newline - expected.pop() - diff = '\n'.join(goofy_diff(expected, actual)) - if diff: - fail('Error: output files differ for %s:\n%s' - % (filename, diff)) + if empty: + fail('Error: output missing in new snippet generation ' + 'for %s. Old content follows:\n"""%s"""' + % (filename, original)) + elif filename.endswith('.json'): + assert_json_matches(original) + else: + assert_file_matches(original) elif not empty: fail('Error: new file necessary where there was no file ' 'before. Filename=%s\nContent follows:\n"""%s"""' % (filename, output)) - # If this test is failing for you, comment out this line, generate - # the files, and then commit the changed files as part of your review. - #assert_output_matches() - - if not empty: + def assert_file_matches(original): + expected = original.split('\n') + # Remove the last item which will look like a duplicated + # file ending newline + expected.pop() + diff = '\n'.join(goofy_diff(expected, actual)) + if diff: + fail('Error: output files differ for %s:\n%s' + % (filename, diff)) + + def assert_json_matches(original): + try: + expected = json.loads(original) + actual = json.loads(output) + except ValueError: + fail('Invalid json!\nExpected: %s\nActual: %s' + % (original, output)) + + if expected != actual: + # Re-Use the same failure output if the json is different + assert_file_matches(original) + + if not os.environ.get('TESTS_FIX_EXAMPLES'): + assert_output_matches() + elif not empty: write_actual_file() diff --git a/trove/tests/examples/snippets.py b/trove/tests/examples/snippets.py index d373a113..3f92dead 100644 --- a/trove/tests/examples/snippets.py +++ b/trove/tests/examples/snippets.py @@ -15,6 +15,7 @@ import json import time import logging +import functools from proboscis import before_class from proboscis import test @@ -37,6 +38,7 @@ trove_client._logger.setLevel(logging.CRITICAL) FAKE_INFO = {'m': 30, 's': 0, 'uuid': 'abcdef00-aaaa-aaaa-aaaa-bbbbbbbbbbbb'} EXAMPLE_BACKUP_ID = "a9832168-7541-4536-b8d9-a8a9b79cf1b4" +EXAMPLE_BACKUP_INCREMENTAL_ID = "2e351a71-dd28-4bcb-a7d6-d36a5b487173" EXAMPLE_CONFIG_ID = "43a6ea86-e959-4735-9e46-a6a5d4a2d80f" EXAMPLE_INSTANCE_ID = "44b277eb-39be-4921-be31-3d61b43651d7" EXAMPLE_INSTANCE_ID_2 = "d5a9db64-7ef7-41c5-8e1e-4013166874bc" @@ -821,18 +823,31 @@ class Backups(ActiveMixin): @test def create_backup(self): set_fake_stuff(uuid=EXAMPLE_BACKUP_ID) - - def create_backup(client): - backup = client.backups.create(name='snapshot', - instance=json_instance.id, - description="My Backup") - with open("/tmp/mario", 'a') as f: - f.write("BACKUP = %s\n" % backup.id) - return backup - results = self.snippet( "backup_create", "/backups", "POST", 202, "Accepted", - create_backup) + lambda client: client.backups.create( + name='snapshot', + instance=json_instance.id, + description="My Backup" + ) + ) + self._wait_for_active("BACKUP") + assert_equal(len(results), 1) + self.json_backup = results[JSON_INDEX] + + @test + def create_incremental_backup(self): + set_fake_stuff(uuid=EXAMPLE_BACKUP_INCREMENTAL_ID) + results = self.snippet( + "backup_create_incremental", "/backups", "POST", 202, "Accepted", + lambda client: client.backups.create( + name='Incremental Snapshot', + instance=json_instance.id, + parent_id=EXAMPLE_BACKUP_ID, + description="My Incremental Backup" + ) + ) + self._wait_for_active("BACKUP") assert_equal(len(results), 1) self.json_backup = results[JSON_INDEX] @@ -1076,6 +1091,7 @@ class MgmtAccount(Example): def for_both(func): + @functools.wraps(func) def both(self): for result in self.results: func(self, result) diff --git a/trove/tests/fakes/nova.py b/trove/tests/fakes/nova.py index a4ec53a7..60877a04 100644 --- a/trove/tests/fakes/nova.py +++ b/trove/tests/fakes/nova.py @@ -22,6 +22,11 @@ from trove.tests.fakes.common import authorize import eventlet import uuid +try: + from collections import OrderedDict +except ImportError: + from ordereddict import OrderedDict + LOG = logging.getLogger(__name__) FAKE_HOSTS = ["fake_host_1", "fake_host_2"] @@ -638,7 +643,9 @@ class FakeHost(object): class FakeHosts(object): def __init__(self, servers): - self.hosts = {} + # Use an ordered dict to make the results of the fake api call + # return in the same order for the example generator. + self.hosts = OrderedDict() for host in FAKE_HOSTS: self.add_host(FakeHost(host, servers)) |