updated readme, pylintrc, plaintext sizes

Author: RitvikKapila

performance_tests/README.md

@@ -6,7 +6,7 @@ This project is licensed under the Apache-2.0 License.
 
 ## Overview
 
-Here are the keyrings / master key-providers that we plan to test:
+Here are the keyrings / master key-providers that we are testing:
 
 1. KMS Keyring / KMS Master Key Provider
 2. Raw AES Keyring / AES Master Key Provider
@@ -20,7 +20,7 @@ For each keyring / master key-provider, we test the execution time and memory co
 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.
+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 results for the performance test will be available in the results folder in the performance_tests directory.
 

performance_tests/consolidate_results.py

@@ -3,11 +3,12 @@
 """Script for consolidating results for execution times"""
 
 import csv
-import sys
+import argparse
+import numpy as np
 
 
 def calculate_statistics(_csv_file):
-    """Calculate min, max and average statistics for execution times in a CSV file."""
+    """Calculate min, max, average 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]
@@ -18,24 +19,26 @@ def calculate_statistics(_csv_file):
         _average = sum(data) / _total_entries
         _minimum = min(data)
         _maximum = max(data)
-        return _total_entries, _average, _minimum, _maximum
+        _perc_99 = np.percentile(data, 99) 
+        return _total_entries, _average, _minimum, _maximum, _perc_99
 
     return None
 
 
 if __name__ == "__main__":
-    if len(sys.argv) != 2:
-        print("Usage: python consolidate_results.py <csv_file>")
-        sys.exit(1)
+    parser = argparse.ArgumentParser()
+    parser.add_argument('csv_file',
+                        help='csv file containing the outputs of execution times for n_iter iterations')
+    args = parser.parse_args()
 
-    csv_file = sys.argv[1]
-    statistics = calculate_statistics(csv_file)
+    statistics = calculate_statistics(args.csv_file)
     if statistics:
-        total_entries, average, minimum, maximum = statistics
-        print("CSV File:", csv_file)
+        total_entries, average, minimum, maximum, perc_99 = statistics
+        print("CSV File:", args.csv_file)
         print("Total Entries:", total_entries)
         print("Average:", average)
         print("Minimum:", minimum)
         print("Maximum:", maximum)
+        print("99th percentile:", perc_99)
     else:
         print("No data found in the CSV file.")

performance_tests/src/aws_encryption_sdk_performance_tests/keyrings/pylintrc renamed to performance_tests/pylintrc

@@ -1 +1 @@
-amazon-cryptographic-material-providers-test-vectors @ git+https://github.com/aws/aws-cryptographic-material-providers-library.git@lucmcdon/python-mpl#subdirectory=TestVectorsAwsCryptographicMaterialProviders/runtimes/python
+aws-cryptographic-material-providers @ git+https://github.com/aws/aws-cryptographic-material-providers-library.git@lucmcdon/python-mpl#subdirectory=AwsCryptographicMaterialProviders/runtimes/python

performance_tests/requirements_mpl.txt

@@ -8,7 +8,6 @@
 from aws_cryptographic_materialproviders.mpl.config import MaterialProvidersConfig
 from aws_cryptographic_materialproviders.mpl.models import CreateAwsKmsKeyringInput
 from aws_cryptographic_materialproviders.mpl.references import IKeyring
-from aws_encryption_sdk import CommitmentPolicy
 
 
 def create_keyring(
@@ -55,9 +54,7 @@ def encrypt_using_keyring(
     :param keyring: Keyring to use for encryption.
     :type keyring: IKeyring
     """
-    client = aws_encryption_sdk.EncryptionSDKClient(
-        commitment_policy=CommitmentPolicy.REQUIRE_ENCRYPT_REQUIRE_DECRYPT
-    )
+    client = aws_encryption_sdk.EncryptionSDKClient()
 
     ciphertext_data, _ = client.encrypt(
         source=plaintext_data,
@@ -79,9 +76,7 @@ def decrypt_using_keyring(
     :param keyring: Keyring to use for decryption.
     :type keyring: IKeyring
     """
-    client = aws_encryption_sdk.EncryptionSDKClient(
-        commitment_policy=CommitmentPolicy.REQUIRE_ENCRYPT_REQUIRE_DECRYPT
-    )
+    client = aws_encryption_sdk.EncryptionSDKClient()
 
     decrypted_plaintext_data, _ = client.decrypt(
         source=ciphertext_data,

performance_tests/src/aws_encryption_sdk_performance_tests/keyrings/aws_kms_keyring.py

@@ -3,7 +3,6 @@
 """Performance tests for the AWS KMS master key provider."""
 
 import aws_encryption_sdk
-from aws_encryption_sdk import CommitmentPolicy
 
 
 def create_key_provider(
@@ -38,9 +37,7 @@ def encrypt_using_key_provider(
     :param key_provider: Master key provider to use for encryption.
     :type key_provider: aws_encryption_sdk.key_providers.base.MasterKeyProvider
     """
-    client = aws_encryption_sdk.EncryptionSDKClient(
-        commitment_policy=CommitmentPolicy.REQUIRE_ENCRYPT_REQUIRE_DECRYPT
-    )
+    client = aws_encryption_sdk.EncryptionSDKClient()
 
     ciphertext_data, _ = client.encrypt(
         source=plaintext_data,
@@ -62,9 +59,7 @@ def decrypt_using_key_provider(
     :param key_provider: Master key provider to use for decryption.
     :type key_provider: aws_encryption_sdk.key_providers.base.MasterKeyProvider
     """
-    client = aws_encryption_sdk.EncryptionSDKClient(
-        commitment_policy=CommitmentPolicy.REQUIRE_ENCRYPT_REQUIRE_DECRYPT
-    )
+    client = aws_encryption_sdk.EncryptionSDKClient()
 
     decrypted_plaintext_data, _ = client.decrypt(
         source=ciphertext_data,