283 lines
10 KiB
Python
Executable File
283 lines
10 KiB
Python
Executable File
#!/usr/bin/env python
|
|
import moto
|
|
import os
|
|
from botocore import xform_name
|
|
from botocore.session import Session
|
|
import boto3
|
|
|
|
|
|
script_dir = os.path.dirname(os.path.abspath(__file__))
|
|
alternative_service_names = {"lambda": "awslambda"}
|
|
|
|
|
|
def get_moto_implementation(service_name):
|
|
service_name = (
|
|
service_name.replace("-", "") if "-" in service_name else service_name
|
|
)
|
|
alt_service_name = (
|
|
alternative_service_names[service_name]
|
|
if service_name in alternative_service_names
|
|
else service_name
|
|
)
|
|
mock = None
|
|
mock_name = None
|
|
if hasattr(moto, "mock_{}".format(alt_service_name)):
|
|
mock_name = "mock_{}".format(alt_service_name)
|
|
mock = getattr(moto, mock_name)
|
|
elif hasattr(moto, "mock_{}".format(service_name)):
|
|
mock_name = "mock_{}".format(service_name)
|
|
mock = getattr(moto, mock_name)
|
|
if mock is None:
|
|
return None, None
|
|
backends = list(mock().backends.values())
|
|
if backends:
|
|
backend = backends[0]["us-east-1"] if "us-east-1" in backends[0] else backends[0]["global"]
|
|
return backend, mock_name
|
|
|
|
|
|
def get_module_name(o):
|
|
klass = o.__class__
|
|
module = klass.__module__
|
|
if module == 'builtins':
|
|
return klass.__qualname__ # avoid outputs like 'builtins.str'
|
|
return module + '.' + klass.__qualname__
|
|
|
|
|
|
def calculate_extended_implementation_coverage():
|
|
service_names = Session().get_available_services()
|
|
coverage = {}
|
|
for service_name in service_names:
|
|
moto_client, mock_name = get_moto_implementation(service_name)
|
|
if not moto_client:
|
|
continue
|
|
real_client = boto3.client(service_name, region_name="us-east-1")
|
|
implemented = dict()
|
|
not_implemented = []
|
|
|
|
operation_names = [
|
|
xform_name(op) for op in real_client.meta.service_model.operation_names
|
|
]
|
|
for op in operation_names:
|
|
if moto_client and op in dir(moto_client):
|
|
implemented[op] = getattr(moto_client, op)
|
|
else:
|
|
not_implemented.append(op)
|
|
|
|
coverage[service_name] = {
|
|
"docs": moto_client.__doc__,
|
|
"module_name": get_module_name(moto_client),
|
|
"name": mock_name,
|
|
"implemented": implemented,
|
|
"not_implemented": not_implemented,
|
|
}
|
|
return coverage
|
|
|
|
|
|
def calculate_implementation_coverage():
|
|
service_names = Session().get_available_services()
|
|
coverage = {}
|
|
for service_name in service_names:
|
|
moto_client, _ = get_moto_implementation(service_name)
|
|
real_client = boto3.client(service_name, region_name="us-east-1")
|
|
implemented = []
|
|
not_implemented = []
|
|
|
|
operation_names = [
|
|
xform_name(op) for op in real_client.meta.service_model.operation_names
|
|
]
|
|
for op in operation_names:
|
|
if moto_client and op in dir(moto_client):
|
|
implemented.append(op)
|
|
else:
|
|
not_implemented.append(op)
|
|
|
|
coverage[service_name] = {
|
|
"implemented": implemented,
|
|
"not_implemented": not_implemented,
|
|
}
|
|
return coverage
|
|
|
|
|
|
def print_implementation_coverage(coverage):
|
|
for service_name in sorted(coverage):
|
|
implemented = coverage.get(service_name)["implemented"]
|
|
not_implemented = coverage.get(service_name)["not_implemented"]
|
|
operations = sorted(implemented + not_implemented)
|
|
|
|
if implemented and not_implemented:
|
|
percentage_implemented = int(
|
|
100.0 * len(implemented) / (len(implemented) + len(not_implemented))
|
|
)
|
|
elif implemented:
|
|
percentage_implemented = 100
|
|
else:
|
|
percentage_implemented = 0
|
|
|
|
print("")
|
|
print("## {}\n".format(service_name))
|
|
print("{}% implemented\n".format(percentage_implemented))
|
|
for op in operations:
|
|
if op in implemented:
|
|
print("- [X] {}".format(op))
|
|
else:
|
|
print("- [ ] {}".format(op))
|
|
|
|
|
|
def write_implementation_coverage_to_file(coverage):
|
|
implementation_coverage_file = "{}/../IMPLEMENTATION_COVERAGE.md".format(script_dir)
|
|
# rewrite the implementation coverage file with updated values
|
|
# try deleting the implementation coverage file
|
|
try:
|
|
os.remove(implementation_coverage_file)
|
|
except OSError:
|
|
pass
|
|
|
|
print("Writing to {}".format(implementation_coverage_file))
|
|
with open(implementation_coverage_file, "w+") as file:
|
|
completely_unimplemented = []
|
|
for service_name in sorted(coverage):
|
|
implemented = coverage.get(service_name)["implemented"]
|
|
if len(implemented) == 0:
|
|
completely_unimplemented.append(service_name)
|
|
continue
|
|
not_implemented = coverage.get(service_name)["not_implemented"]
|
|
operations = sorted(implemented + not_implemented)
|
|
|
|
if implemented and not_implemented:
|
|
percentage_implemented = int(
|
|
100.0 * len(implemented) / (len(implemented) + len(not_implemented))
|
|
)
|
|
elif implemented:
|
|
percentage_implemented = 100
|
|
else:
|
|
percentage_implemented = 0
|
|
|
|
file.write("\n")
|
|
file.write("## {}\n".format(service_name))
|
|
file.write("<details>\n")
|
|
file.write(
|
|
"<summary>{}% implemented</summary>\n\n".format(percentage_implemented)
|
|
)
|
|
for op in operations:
|
|
if op in implemented:
|
|
file.write("- [X] {}\n".format(op))
|
|
else:
|
|
file.write("- [ ] {}\n".format(op))
|
|
file.write("</details>\n")
|
|
|
|
file.write("\n")
|
|
file.write("## Unimplemented:\n")
|
|
file.write("<details>\n\n")
|
|
for service in completely_unimplemented:
|
|
file.write("- {}\n".format(service))
|
|
file.write("</details>")
|
|
|
|
|
|
def write_implementation_coverage_to_docs(coverage):
|
|
implementation_coverage_file = "{}/../docs/docs/services/index.rst".format(script_dir)
|
|
# rewrite the implementation coverage file with updated values
|
|
# try deleting the implementation coverage file
|
|
try:
|
|
os.remove(implementation_coverage_file)
|
|
except OSError:
|
|
pass
|
|
|
|
print("Writing to {}".format(implementation_coverage_file))
|
|
completely_unimplemented = []
|
|
for service_name in sorted(coverage):
|
|
implemented = coverage.get(service_name)["implemented"]
|
|
if len(implemented) == 0:
|
|
completely_unimplemented.append(service_name)
|
|
continue
|
|
not_implemented = coverage.get(service_name)["not_implemented"]
|
|
operations = sorted(list(implemented.keys()) + not_implemented)
|
|
|
|
service_coverage_file = "{}/../docs/docs/services/{}.rst".format(script_dir, service_name)
|
|
shorthand = service_name.replace(" ", "_")
|
|
|
|
with open(service_coverage_file, "w+") as file:
|
|
file.write(f".. _implementedservice_{shorthand}:\n")
|
|
file.write("\n")
|
|
|
|
file.write(".. |start-h3| raw:: html\n\n")
|
|
file.write(" <h3>")
|
|
file.write("\n\n")
|
|
|
|
file.write(".. |end-h3| raw:: html\n\n")
|
|
file.write(" </h3>")
|
|
file.write("\n\n")
|
|
|
|
title = f"{service_name}"
|
|
file.write("=" * len(title) + "\n")
|
|
file.write(title + "\n")
|
|
file.write(("=" * len(title)) + "\n")
|
|
file.write("\n")
|
|
|
|
if coverage[service_name]["docs"]:
|
|
# Only show auto-generated documentation if it exists
|
|
file.write(".. autoclass:: " + coverage[service_name].get("module_name"))
|
|
file.write("\n\n")
|
|
|
|
file.write("|start-h3| Example usage |end-h3|\n\n")
|
|
file.write(f""".. sourcecode:: python
|
|
|
|
@{coverage[service_name]['name']}
|
|
def test_{coverage[service_name]['name'][5:]}_behaviour:
|
|
boto3.client("{service_name}")
|
|
...
|
|
|
|
""")
|
|
file.write("\n\n")
|
|
|
|
file.write("|start-h3| Implemented features for this service |end-h3|\n\n")
|
|
|
|
for op in operations:
|
|
if op in implemented:
|
|
file.write("- [X] {}\n".format(op))
|
|
docs = getattr(implemented[op], "__doc__")
|
|
if docs:
|
|
file.write(f" {docs}\n\n")
|
|
else:
|
|
file.write("- [ ] {}\n".format(op))
|
|
file.write("\n")
|
|
|
|
|
|
with open(implementation_coverage_file, "w+") as file:
|
|
file.write(".. _implemented_services:\n")
|
|
file.write("\n")
|
|
file.write("\n")
|
|
|
|
file.write("====================\n")
|
|
file.write("Implemented Services\n")
|
|
file.write("====================\n")
|
|
file.write("\n")
|
|
file.write("Please see a list of all currently supported services. Each service will have a list of the endpoints that are implemented.\n")
|
|
file.write("Each service will also have an example on how to mock an individual service.\n\n")
|
|
file.write("Note that you can mock multiple services at the same time:\n\n")
|
|
file.write(".. sourcecode:: python\n\n")
|
|
file.write(" @mock_s3\n")
|
|
file.write(" @mock_sqs\n")
|
|
file.write(" def test_both_s3_and_sqs():\n")
|
|
file.write(" ...\n")
|
|
file.write("\n\n")
|
|
file.write(".. sourcecode:: python\n\n")
|
|
file.write(" @mock_all\n")
|
|
file.write(" def test_all_supported_services_at_the_same_time():\n")
|
|
file.write(" ...\n")
|
|
file.write("\n")
|
|
|
|
file.write("\n")
|
|
file.write(".. toctree::\n")
|
|
file.write(" :titlesonly:\n")
|
|
file.write(" :maxdepth: 1\n")
|
|
file.write(" :glob:\n")
|
|
file.write("\n")
|
|
file.write(" *\n")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
cov = calculate_implementation_coverage()
|
|
write_implementation_coverage_to_file(cov)
|
|
xcov = calculate_extended_implementation_coverage()
|
|
write_implementation_coverage_to_docs(xcov)
|