# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file 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. from nose.tools import assert_equal from botocore.session import get_session SERVICE_RENAMES = { # Actual service name we use -> Allowed computed service name. 'alexaforbusiness': 'alexa-for-business', 'apigateway': 'api-gateway', 'application-autoscaling': 'application-auto-scaling', 'appmesh': 'app-mesh', 'autoscaling': 'auto-scaling', 'autoscaling-plans': 'auto-scaling-plans', 'ce': 'cost-explorer', 'cloudhsmv2': 'cloudhsm-v2', 'cloudsearchdomain': 'cloudsearch-domain', 'cognito-idp': 'cognito-identity-provider', 'config': 'config-service', 'cur': 'cost-and-usage-report-service', 'datapipeline': 'data-pipeline', 'directconnect': 'direct-connect', 'devicefarm': 'device-farm', 'discovery': 'application-discovery-service', 'dms': 'database-migration-service', 'ds': 'directory-service', 'dynamodbstreams': 'dynamodb-streams', 'elasticbeanstalk': 'elastic-beanstalk', 'elastictranscoder': 'elastic-transcoder', 'elb': 'elastic-load-balancing', 'elbv2': 'elastic-load-balancing-v2', 'es': 'elasticsearch-service', 'events': 'cloudwatch-events', 'globalaccelerator': 'global-accelerator', 'iot-data': 'iot-data-plane', 'iot-jobs-data': 'iot-jobs-data-plane', 'iot1click-devices': 'iot-1click-devices-service', 'iot1click-projects': 'iot-1click-projects', 'kinesisanalytics': 'kinesis-analytics', 'kinesisanalyticsv2': 'kinesis-analytics-v2', 'kinesisvideo': 'kinesis-video', 'lex-models': 'lex-model-building-service', 'lex-runtime': 'lex-runtime-service', 'logs': 'cloudwatch-logs', 'machinelearning': 'machine-learning', 'marketplacecommerceanalytics': 'marketplace-commerce-analytics', 'marketplace-entitlement': 'marketplace-entitlement-service', 'meteringmarketplace': 'marketplace-metering', 'mgh': 'migration-hub', 'sms-voice': 'pinpoint-sms-voice', 'resourcegroupstaggingapi': 'resource-groups-tagging-api', 'route53': 'route-53', 'route53domains': 'route-53-domains', 's3control': 's3-control', 'sdb': 'simpledb', 'secretsmanager': 'secrets-manager', 'serverlessrepo': 'serverlessapplicationrepository', 'servicecatalog': 'service-catalog', 'stepfunctions': 'sfn', 'storagegateway': 'storage-gateway', } ENDPOINT_PREFIX_OVERRIDE = { # entry in endpoints.json -> actual endpoint prefix. # The autoscaling-* services actually send requests to the # autoscaling service, but they're exposed as separate clients # in botocore. 'autoscaling-plans': 'autoscaling', 'application-autoscaling': 'autoscaling', # For neptune, we send requests to the RDS endpoint. 'neptune': 'rds', 'docdb': 'rds', } NOT_SUPPORTED_IN_SDK = [ 'mobileanalytics', ] def test_endpoint_matches_service(): # This verifies client names match up with data from the endpoints.json # file. We want to verify that every entry in the endpoints.json # file corresponds to a client we can construct via # session.create_client(...). # So first we get a list of all the service names in the endpoints # file. session = get_session() loader = session.get_component('data_loader') endpoints = loader.load_data('endpoints') # A service can be in multiple partitions so we're using # a set here to remove dupes. services_in_endpoints_file = set([]) for partition in endpoints['partitions']: for service in partition['services']: # There are some services we don't support in the SDK # so we don't need to add them to the list of services # we need to check. if service not in NOT_SUPPORTED_IN_SDK: services_in_endpoints_file.add(service) # Now we need to cross check them against services we know about. # The entries in endpoints.json are keyed off of the endpoint # prefix. We don't directly have that data, so we have to load # every service model and look up its endpoint prefix in its # ``metadata`` section. known_services = loader.list_available_services('service-2') known_endpoint_prefixes = [ session.get_service_model(service_name).endpoint_prefix for service_name in known_services ] # Now we go through every known endpoint prefix in the endpoints.json # file and ensure it maps to an endpoint prefix we've seen # in a service model. for endpoint_prefix in services_in_endpoints_file: # Check for an override where we know that an entry # in the endpoints.json actually maps to a different endpoint # prefix. endpoint_prefix = ENDPOINT_PREFIX_OVERRIDE.get(endpoint_prefix, endpoint_prefix) yield (_assert_known_endpoint_prefix, endpoint_prefix, known_endpoint_prefixes) def _assert_known_endpoint_prefix(endpoint_prefix, known_endpoint_prefixes): assert endpoint_prefix in known_endpoint_prefixes def test_service_name_matches_endpoint_prefix(): # Generates tests for each service to verify that the computed service # named based on the service id matches the service name used to # create a client (i.e the directory name in botocore/data) # unless there is an explicit exception. session = get_session() loader = session.get_component('data_loader') # Load the list of available services. The names here represent what # will become the client names. services = loader.list_available_services('service-2') for service in services: yield _assert_service_name_matches_endpoint_prefix, session, service def _assert_service_name_matches_endpoint_prefix(session, service_name): service_model = session.get_service_model(service_name) computed_name = service_model.service_id.replace(' ', '-').lower() # Handle known exceptions where we have renamed the service directory # for one reason or another. actual_service_name = SERVICE_RENAMES.get(service_name, service_name) assert_equal( computed_name, actual_service_name, "Actual service name `%s` does not match expected service name " "we computed: `%s`" % ( actual_service_name, computed_name))