fix

RitvikKapila · RitvikKapila · commit 8bfb71e08a44 · 2024-05-24T13:12:01.000-07:00
diff --git a/performance_tests/README.md b/performance_tests/README.md
@@ -1,26 +1,27 @@
-# Performance Tests for ESDK Python
+# aws-encryption-sdk performance tests
 
 ## License
 
 This project is licensed under the Apache-2.0 License.
 
 ## Overview
 
-Here are the keyrings / master key-providers that we are testing:
+This library tests the following keyrings / master key-providers:
 
 1. KMS Keyring / KMS Master Key Provider
 2. Raw AES Keyring / AES Master Key Provider
-3. HKeyring / caching CMM example ("old" caching solution vs the (current) "new" caching solution)
-4. Raw RSA Keyring / RSA Master Key Provider
+3. Raw RSA Keyring / RSA Master Key Provider
+4. Hierarchy Keyring
+5. Caching CMM
 
-For each test on the above keyrings / master key-providers, we measure the execution time and memory consumption in each test.
+For each test on the above keyrings / master key-providers, this package measures the execution time and memory consumption.
 
-For each keyring / master key-provider, we test the execution time and memory consumption time for three operations:
+For each keyring / master key-provider, the execution time and memory consumption time is measured for three operations:
 1. Create keyring / master key-provider
 2. Encrypt
 3. Decrypt
 
-We demonstrate the usage of the performance tests through an [AWS KMS Keyring](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html). However, the procedure is the same for any keyring / master key-provider, with slight change in the input arguments.
+The usage of the performance tests is demonstrated through an [AWS KMS Keyring](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-kms-keyring.html). However, the procedure is the same for any keyring / master key-provider, with slight change in the input arguments.
 
 The results for the performance test will be available in the results folder in the performance_tests directory.
 
@@ -122,13 +123,13 @@ mprof plot
 This 'mprof plot' command will plot the most recent mprofile log file.
 
 ## Usage: Performance Graph
-To generate a performance graph, please use the following command to generate the pstats log file by specifying the output pstats file path. Here, we use 'results/kms_keyring_create.pstats' as the output file.
+To generate a performance graph, please use the following command to generate the pstats log file by specifying the output pstats file path. Here, 'results/kms_keyring_create.pstats' is set as the default output file.
 
 ```
 python -m cProfile -o results/kms_keyring_create.pstats test/keyrings/test_aws_kms_keyring.py create
 ```
 
-After generating the pstats file, please run the following command to generate the performance graph. The output performance graph will be a .png file that you specify. Here, we use 'results/kms_keyring_create.png' as the output file.
+After generating the pstats file, please run the following command to generate the performance graph. The output performance graph will be a .png file that you specify. Here, 'results/kms_keyring_create.png' is set as the default output file.
 ```
 gprof2dot -f pstats results/kms_keyring_create.pstats | dot -Tpng -o results/kms_keyring_create.png && eog results/kms_keyring_create.png 
 ```
diff --git a/performance_tests/consolidate_results.py b/performance_tests/consolidate_results.py
@@ -8,7 +8,7 @@
 
 
 def calculate_statistics(_csv_file):
-    """Calculate min, max, average and p99 statistics for execution times in a CSV file."""
+    """Calculate average, trimmed average, minimum, maximum and p99 statistics for execution times in a CSV file."""
     with open(_csv_file, 'r', encoding='utf-8') as file:
         reader = csv.reader(file)
         data = [float(row[0]) for row in reader]
@@ -17,12 +17,12 @@ def calculate_statistics(_csv_file):
     if data:
         data = np.sort(data)
         _total_entries = len(data)
-        _average = sum(data) / _total_entries
-        _trimmed_average_99 = np.mean(data[0:int(0.99 * len(data))])
+        _average = np.mean(data)
+        _trimmed_average_99_bottom = np.mean(data[0:int(0.99 * len(data))])
         _minimum = min(data)
         _maximum = max(data)
         _perc_99 = np.percentile(data, 99)
-        return _total_entries, _average, _trimmed_average_99, _minimum, _maximum, _perc_99
+        return _total_entries, _average, _trimmed_average_99_bottom, _minimum, _maximum, _perc_99
 
     return None
 
@@ -35,11 +35,11 @@ def calculate_statistics(_csv_file):
 
     statistics = calculate_statistics(args.csv_file)
     if statistics:
-        total_entries, average, trimmend_average_99, minimum, maximum, perc_99 = statistics
+        total_entries, average, trimmend_average_99_bottom, minimum, maximum, perc_99 = statistics
         print("CSV File:", args.csv_file)
         print("Total Entries:", total_entries)
         print("Average:", average)
-        print("99th percentile trimmed average:", trimmend_average_99)
+        print("Bottom 99th percentile trimmed average:", trimmend_average_99_bottom)
         print("Minimum:", minimum)
         print("Maximum:", maximum)
         print("99th percentile:", perc_99)
diff --git a/performance_tests/src/aws_encryption_sdk_performance_tests/master_key_providers/aws_kms_master_key_provider.py b/performance_tests/src/aws_encryption_sdk_performance_tests/master_key_providers/aws_kms_master_key_provider.py
diff --git a/performance_tests/src/aws_encryption_sdk_performance_tests/utils/util.py b/performance_tests/src/aws_encryption_sdk_performance_tests/utils/util.py
@@ -7,6 +7,74 @@ class PerfTestUtils:
     """Utility functions for AWS Encryption SDK performance tests."""
     DEFAULT_N_ITERS = 100
     DEFAULT_FILE_SIZE = 'small'
+    DEFAULT_AES_256_STATIC_KEY = \
+        b'_\xcf"\x82\x03\x12\x9d\x00\x8a\xed\xaf\xe4\x80\x1d\x00t\xa6P\xac\xb6\xfe\xc5\xf6/{\xe7\xaaO\x01\x13W\x85'
+    DEFAULT_RSA_PUBLIC_KEY = bytes("-----BEGIN PUBLIC KEY-----\n"
+                                   + "MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAwEkp2yRpTAgZa4MDNxq8"
+                                   + "eQ7rkaVw9QTdJr9NFAtjUpM/6UQARJ2aAq8SjzkGk94EqfH6XqMWum/XQDIb5IWy"
+                                   + "E2nm4MCHED62mEEbjbDwtLmiWK0giZV3qe1PJ1LRLmeqRvjVHWc0b7QxnkjPCCnf"
+                                   + "Mpode5IQY3AZM3unIVFA043oD3ZPRsEch/hl2my2sxBa4PNod2cxw1PLbQVQWvKh"
+                                   + "f7ivmhVAKxwacXTb2yIynGljEgZZfkV1hATS9TGgHG2wpeZ9o0M4/JaN+TLgjruv"
+                                   + "gaE6vArdndBQcUV/NAOBeDegsfAsic7OC9FD/3MFgLo2g72WYY3BuCNMDj8L3lWK"
+                                   + "+vyC/S66cIvp1P2GzsccHSfcK0MC09ojnCbKF6D7tv5pIKhtvZRC7xcNv1ctS/fb"
+                                   + "UbMy4tH+8iwvJlTRGZuuEYDwoBFowNS1oHxeO1PI1im93inAYt5GhkMuaZKLaY64"
+                                   + "xe51LJNcP1ovAhHaMG8UGfeCiNBRjGEP3pMG8sgLyw9k3gqMVzX4MUfPlXQh503k"
+                                   + "3bVE/eymdsdZ1kAlMLR26IoQ6muAHtn0cy00RjRPy0hIQ2Z+ACog0ge91AyWgXjn"
+                                   + "0WYI3AUOzVRZAoqS7ymf2zQfyb3WVYBMfyYT9IhUZlAWq8uzEkoFs47r0LKrv6DA"
+                                   + "LX8MCeTVUP6ELg4Inaz8UDECAwEAAQ=="
+                                   + "\n-----END PUBLIC KEY-----", 'utf-8')
+
+    DEFAULT_RSA_PRIVATE_KEY = bytes("-----BEGIN RSA PRIVATE KEY-----\n"
+                                    + "MIIJJwIBAAKCAgEAwEkp2yRpTAgZa4MDNxq8eQ7rkaVw9QTdJr9NFAtjUpM/6UQA"
+                                    + "RJ2aAq8SjzkGk94EqfH6XqMWum/XQDIb5IWyE2nm4MCHED62mEEbjbDwtLmiWK0g"
+                                    + "iZV3qe1PJ1LRLmeqRvjVHWc0b7QxnkjPCCnfMpode5IQY3AZM3unIVFA043oD3ZP"
+                                    + "RsEch/hl2my2sxBa4PNod2cxw1PLbQVQWvKhf7ivmhVAKxwacXTb2yIynGljEgZZ"
+                                    + "fkV1hATS9TGgHG2wpeZ9o0M4/JaN+TLgjruvgaE6vArdndBQcUV/NAOBeDegsfAs"
+                                    + "ic7OC9FD/3MFgLo2g72WYY3BuCNMDj8L3lWK+vyC/S66cIvp1P2GzsccHSfcK0MC"
+                                    + "09ojnCbKF6D7tv5pIKhtvZRC7xcNv1ctS/fbUbMy4tH+8iwvJlTRGZuuEYDwoBFo"
+                                    + "wNS1oHxeO1PI1im93inAYt5GhkMuaZKLaY64xe51LJNcP1ovAhHaMG8UGfeCiNBR"
+                                    + "jGEP3pMG8sgLyw9k3gqMVzX4MUfPlXQh503k3bVE/eymdsdZ1kAlMLR26IoQ6muA"
+                                    + "Htn0cy00RjRPy0hIQ2Z+ACog0ge91AyWgXjn0WYI3AUOzVRZAoqS7ymf2zQfyb3W"
+                                    + "VYBMfyYT9IhUZlAWq8uzEkoFs47r0LKrv6DALX8MCeTVUP6ELg4Inaz8UDECAwEA"
+                                    + "AQKCAgBYJXH9lox6oT/d7DoeGbCKok9U/g1xFOC4cXvJE4tdgEkNCvJAgirmzhDo"
+                                    + "/RBJ2r4ylc3bclHp93kqYY4tzSgcBDElmLyRst4Ln9UcuB8wCeUlV4AR8iXgDPx7"
+                                    + "H1jrN/R0An/Xscb06hrQ37mgmWlLDiEz03qVyv6Sfj3YZSIdmPDnnamr2rzUjAdN"
+                                    + "AQcjwPyYIJ0kF3dVfmVDverfNljYbvZ44QMAgCqTFinvI5cl4p3a1nRSEU9UzM1U"
+                                    + "P4KRZatT8fxoSlmmWPIOacdNRzamax28tBJx1Nv7gQtV8cF5Na8BwwL3zYjhG/Za"
+                                    + "9QRxxWtWKyPz5oMGgY/M/BPZwUcrCXs9fiHKzFtGQK0C1AffIhUnmlLf90OKLkhW"
+                                    + "O6CSIAyRZl6aKhDRrtmM+n4tn9tjKOyrJ9WWFU/BV57v+MNo97tIWsPu0G7TSAIv"
+                                    + "JQAQlTKtpH1Nf4Kt3gCNILJcvBVOQPZ2TObJRqFD89/0daRr8ewmOeDYF0Q0h1n5"
+                                    + "9oWqnoseodYD2EnvttC50IpfSF3XMfugbDQ90t96uSlTAkFuPw+HI3ikhP4RxveB"
+                                    + "keBp+VUCKOdwfBCSWLLPGcU4dQlsmiEoIvkLr/z3rrsJKI/64/lqgfU3A7GqAgQz"
+                                    + "2dfrnf0UPVSjJjuCs/TKBXSDxghzhFAQ5rjH4laazzQdqrQUPQKCAQEA7uhWcnxM"
+                                    + "B62vjJDQ4cVhKGrTooE8PehrOGKKR2i1BrddvwwbXy8wlbHDgEjvSTc0yOr38vdk"
+                                    + "Miwul/gR2/EG3qGuI6OnnPp8tYWLYMkDjjYC5mcQXBnHT5BAmAIDEgC7Fi0O9+hM"
+                                    + "5fCy7/8admovUJZcOX8q+urs1LNakcLuusA0CGB9KJvNvIwOuMnhaVvaFXTf2oZ8"
+                                    + "55itKyoG6Ca/AR5aNuUO6YnL+rEQaYsKsreYwB1B8B0UTxgVl12YtJWZkG3SHAKR"
+                                    + "RQeqrZQPtIUgN5hk6dX0vzv4fvooGT162PrWckriqSKag4lxJnOp6DO0NyEGwf+4"
+                                    + "FaEItex7PFUMuwKCAQEAzgrvL+56sqhKho0Z3J/PYj4f4LNElE1hQ7sHd2QtfyYS"
+                                    + "Ig4qKiUJIKjfC9LrFjtyqRiH5OTs63eorO+757DTFWjXCSVUwppPcLyOyr5mrULL"
+                                    + "T2PE8LE0GBw2PnIkfMCuDlvxKp/Arb1Co5uRCWrSPHEcY+hSlp5SJYwNhs3HyNBZ"
+                                    + "soKmjnUtP+HX5KlBoMQEo8kKnlfBTSVl2WAeu5UaM4Z0Q8ZxgCMnhDx2lVmMohUw"
+                                    + "/qBDw+uA51vgSCSRQLamrlEZQ6jqUzD/9kNbqioMKuPCOZWIKBZvBJNe2hmF+JKb"
+                                    + "epSrtKIor229l98UbfYhhiAw0//qon+pGXANNyneAwKCAQAd5VMUBnvZJiHmnCSX"
+                                    + "bASpcxzCpBtuv8vTBXm6T97/VSjVBGXUdmpFATausfHHnrHrRoP6knymTqMR/0f0"
+                                    + "1ud+KotJCGysFyhN6sUzOlRIknewb0s7yzoGuc1reCz8Lr06nC7YVOhyiblKkQi1"
+                                    + "srnzAq3NwB0XwxgZ0cvOm68WDYE1XyWqVDzdkEUzWIftkEHtF2//v36X2KIq2Zp9"
+                                    + "qIOUV0EAx48jKEwvNcMRAgY3sQPbXo3mxyzIbQIeq+a1CldqHGQDf0rAcaIpEHMa"
+                                    + "quIKMvbF0DFNUOrasOEdr3TU/CajrL1KXvso5KUVI7oqRXYSw/49fouBoWIeqdYO"
+                                    + "CbKLAoIBAC9lzIgWMBuRIzO4mc5q5OYQrHygQJJtCobuK1WHsf+h3mH/KCvxwRvG"
+                                    + "PSkXKAVBP6sufXRmRSoVqLO/olY2ExjFuVHdSJZLsSKZ/a8eBbituN9WcCN+YCF7"
+                                    + "u+65izM3j9K1y9CmV0igVQgV7VNhQ2OsEX/aHcWQPg1tHl94TxEe/MNX0sDKq9Ia"
+                                    + "PfPYC8TT0s1qngq23TzF8ZwDxI4aSqC3uV8t80Yq0BhXYGAS7YsLnO22KGCVeF3A"
+                                    + "gOOXpeJhIg7PkSRDY0Qn7XnVHO0UJyBmrHNatquiHX/L9vHtFSiNcT7NnII9G2bf"
+                                    + "s9GP+78f865LEXBzWqJvA5Nad2/NLckCggEANWMjb5QcJqTSXn0f2UqJ7AicWoqQ"
+                                    + "dMjpY79N+2iz2tlNFD9/BC/l6QGhM4YMVLNDwM2Aak37P8ZnQ9frEjMCEoD2bIlO"
+                                    + "cWxVaXMP39rnLUPzg8D2TcjiQ2NBL4FDYXudZCUh4b1x70Gp2GiP7GxZwv2/SQhD"
+                                    + "j7cc4oNwaE1hkiMhAYbPgWUU06JQwWPcD8UmKUgdp2ET+eUEwfV0GVtNOSfGoenf"
+                                    + "ZqdaYcE8c3ft37JM5AsKo5h+G3qHOBRMEYHtQDybuvvFsg+hJ0BuxYt4mFubWZYL"
+                                    + "V/tu4K1kmEZXgTvNZWSsZaIY2xBus2Ol2rKTahA0d9ffGeUhRj+UQrWpxg=="
+                                    + "\n-----END RSA PRIVATE KEY-----", "utf-8")
 
     @staticmethod
     def read_file(filename):
@@ -26,8 +94,8 @@ def get_rsa_key_from_file(filename):
         return key
 
     @staticmethod
-    def print_time_list_to_csv(time_list, filename):
-        """Prints the time list to a CSV file."""
+    def write_time_list_to_csv(time_list, filename):
+        """Writes the time list to a CSV file."""
         with open('results/' + filename + '.csv', 'w', encoding='utf-8') as myfile:
             for time in time_list:
                 myfile.write(str(time) + '\n')
diff --git a/performance_tests/test/keyrings/test_aws_kms_keyring.py b/performance_tests/test/keyrings/test_aws_kms_keyring.py
@@ -9,8 +9,8 @@
 
 from aws_encryption_sdk_performance_tests.keyrings.aws_kms_keyring import (
     create_keyring,
-    create_kms_client,
     create_keyring_given_kms_client,
+    create_kms_client,
     decrypt_using_keyring,
     encrypt_using_keyring,
 )
diff --git a/performance_tests/test/master_key_providers/test_aws_kms_master_key_provider.py b/performance_tests/test/master_key_providers/test_aws_kms_master_key_provider.py
@@ -7,7 +7,7 @@
 import click
 from tqdm import tqdm
 
-from aws_encryption_sdk_performance_tests.master_key_providers.aws_kms_key_provider import (
+from aws_encryption_sdk_performance_tests.master_key_providers.aws_kms_master_key_provider import (
     create_key_provider,
     decrypt_using_key_provider,
     encrypt_using_key_provider,

Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,8 @@`
`9`	`9`
`10`	`10`	`from aws_encryption_sdk_performance_tests.keyrings.aws_kms_keyring import (`
`11`	`11`	`create_keyring,`
`12`		`- create_kms_client,`
`13`	`12`	`create_keyring_given_kms_client,`
	`13`	`+ create_kms_client,`
`14`	`14`	`decrypt_using_keyring,`
`15`	`15`	`encrypt_using_keyring,`
`16`	`16`	`)`