Adds comments per review comment

tests/functional/tests.py

@@ -149,6 +149,9 @@ def is_s3(client):
     return "s3.amazonaws" in client._endpoint_url
 
 def test_make_bucket_default_region(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "make_bucket(bucket_name, location)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     # Default location
@@ -169,6 +172,9 @@ def test_make_bucket_default_region(client, log_output):
     print(log_output.json_report())
 
 def test_make_bucket_with_region(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "make_bucket(bucket_name, location)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     # A non-default location
@@ -189,6 +195,9 @@ def test_make_bucket_with_region(client, log_output):
     print(log_output.json_report())
 
 def test_negative_make_bucket_invalid_name(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "make_bucket(bucket_name, location)"
+
     # Get a unique bucket_name
     bucket_name = generate_bucket_name()
     # Default location
@@ -216,6 +225,9 @@ def test_negative_make_bucket_invalid_name(client, log_output):
     print(log_output.json_report())
 
 def test_make_bucket_recreate(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "make_bucket(bucket_name, location)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     # s3 amazon has a bug and can let a bucket to be recreated for
@@ -243,6 +255,9 @@ def test_make_bucket_recreate(client, log_output):
         exit()
 
 def test_list_buckets(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_buckets(  )"
+
     # Get a unique bucket_name
     bucket_name = generate_bucket_name()
 
@@ -263,6 +278,9 @@ def test_list_buckets(client, log_output):
     print(log_output.json_report())
 
 def test_fput_object_small_file(client, testfile, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "fput_object(bucket_name, object_name, file_path, content_type, metadata)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -288,6 +306,9 @@ def test_fput_object_small_file(client, testfile, log_output):
     print(log_output.json_report())
 
 def test_fput_object_large_file(client, largefile, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "fput_object(bucket_name, object_name, file_path, content_type, metadata)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -315,6 +336,9 @@ def test_fput_object_large_file(client, largefile, log_output):
     print(log_output.json_report())
 
 def test_fput_object_with_content_type(client, testfile, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "fput_object(bucket_name, object_name, file_path, content_type, metadata)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -342,6 +366,9 @@ def test_fput_object_with_content_type(client, testfile, log_output):
     print(log_output.json_report())
 
 def test_copy_object_no_copy_condition(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "copy_object(bucket_name, object_name, object_source, conditions)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -371,6 +398,9 @@ def test_copy_object_no_copy_condition(client, log_output):
     print(log_output.json_report())
 
 def test_copy_object_etag_match(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "copy_object(bucket_name, object_name, object_source, conditions)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -406,6 +436,9 @@ def test_copy_object_etag_match(client, log_output):
     print(log_output.json_report())
 
 def test_copy_object_negative_etag_match(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "copy_object(bucket_name, object_name, object_source, conditions)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -444,6 +477,9 @@ def test_copy_object_negative_etag_match(client, log_output):
     print(log_output.json_report())
 
 def test_copy_object_modified_since(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "copy_object(bucket_name, object_name, object_source, conditions)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -479,8 +515,10 @@ def test_copy_object_modified_since(client, log_output):
     # Test passes
     print(log_output.json_report())
 
-
 def test_copy_object_unmodified_since(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "copy_object(bucket_name, object_name, object_source, conditions)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -522,6 +560,9 @@ def test_copy_object_unmodified_since(client, log_output):
     print(log_output.json_report())
 
 def test_put_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "put_object(bucket_name, object_name, data, length, content_type, metadata)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -567,6 +608,9 @@ def test_put_object(client, log_output):
     print(log_output.json_report())
 
 def test_negative_put_object_with_path_segment(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "put_object(bucket_name, object_name, data, length, content_type, metadata)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = "/a/b/c/" + uuid.uuid4().__str__()
@@ -625,6 +669,9 @@ def validate_stat_data(st_obj, expected_size, expected_meta):
         raise ValueError("Metadata key 'x-amz-meta-testing' not found")
 
 def test_stat_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "stat_object(bucket_name, object_name)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -666,6 +713,9 @@ def test_stat_object(client, log_output):
     print(log_output.json_report())
 
 def test_remove_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "remove_object(bucket_name, object_name)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -686,6 +736,9 @@ def test_remove_object(client, log_output):
     print(log_output.json_report())
 
 def test_get_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "get_object(bucket_name, object_name, request_headers)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -713,6 +766,9 @@ def test_get_object(client, log_output):
     print(log_output.json_report())
 
 def test_fget_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "fget_object(bucket_name, object_name, file_path, request_headers)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -737,6 +793,9 @@ def test_fget_object(client, log_output):
     print(log_output.json_report())
 
 def test_get_partial_object_with_default_length(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "get_partial_object(bucket_name, object_name, offset, length, request_headers)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -770,6 +829,9 @@ def test_get_partial_object_with_default_length(client, log_output):
     print(log_output.json_report())
 
 def test_get_partial_object(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "get_partial_object(bucket_name, object_name, offset, length, request_headers)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -803,6 +865,9 @@ def test_get_partial_object(client, log_output):
     print(log_output.json_report())
 
 def test_list_objects(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_objects(bucket_name, prefix, recursive)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -853,6 +918,9 @@ def list_objects_api_test(client, bucket_name, expected_no, *argv):
         raise ValueError("Listed no of objects ({}), does not match the expected no of objects ({})".format(no_of_files, expected_no))
 
 def test_list_objects_with_prefix(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_objects(bucket_name, prefix, recursive)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -933,6 +1001,9 @@ def test_list_objects_with_prefix(client, log_output):
     print(log_output.json_report())
 
 def test_list_objects_with_1001_files(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_objects(bucket_name, prefix, recursive)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     object_name = uuid.uuid4().__str__()
@@ -968,6 +1039,9 @@ def test_list_objects_with_1001_files(client, log_output):
     print(log_output.json_report())
 
 def test_list_objects_v2(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_objects(bucket_name, prefix, recursive)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -1028,6 +1102,9 @@ def uniq_list(list1, list2):
     return sorted(list(set(list1)) + list(set(list2) - set(list1)))
 
 def test_list_incomplete_uploads(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "list_incomplete_uploads(bucket_name, prefix, recursive)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -1062,6 +1139,9 @@ def test_list_incomplete_uploads(client, log_output):
     print(log_output.json_report())
 
 def test_remove_incomplete_upload(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "remove_incomplete_upload(bucket_name, object_name)"
+
     # Get a unique bucket_name and object_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['object_name'] = object_name = uuid.uuid4().__str__()
@@ -1092,6 +1172,9 @@ def test_remove_incomplete_upload(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_get_object_default_expiry(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_get_object(bucket_name, object_name, expires, response_headers)"
+
     _http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED',
                                 ca_certs=certifi.where())
     # Get a unique bucket_name and object_name
@@ -1123,6 +1206,9 @@ def test_presigned_get_object_default_expiry(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_get_object_expiry_5sec(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_get_object(bucket_name, object_name, expires, response_headers)"
+
     _http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED',
                                 ca_certs=certifi.where())
     # Get a unique bucket_name and object_name
@@ -1161,6 +1247,9 @@ def test_presigned_get_object_expiry_5sec(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_get_object_response_headers(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_get_object(bucket_name, object_name, expires, response_headers)"
+
     _http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED',
                                 ca_certs=certifi.where())
     # Get a unique bucket_name and object_name
@@ -1201,6 +1290,9 @@ def test_presigned_get_object_response_headers(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_put_object_default_expiry(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_put_object(bucket_name, object_name, expires)"
+
     _http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED',
                                 ca_certs=certifi.where())
 
@@ -1234,6 +1326,9 @@ def test_presigned_put_object_default_expiry(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_put_object_expiry_5sec(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_put_object(bucket_name, object_name, expires)"
+
     _http = urllib3.PoolManager(cert_reqs='CERT_REQUIRED',
                                 ca_certs=certifi.where())
 
@@ -1266,6 +1361,9 @@ def test_presigned_put_object_expiry_5sec(client, log_output):
     print(log_output.json_report())
 
 def test_presigned_post_policy(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "presigned_post_policy(post_policy)"
+
     bucket_name = generate_bucket_name()
     no_of_days = 10
     prefix = 'objectPrefix/'
@@ -1357,6 +1455,9 @@ def threaded_get_object(cli, bckt_name, obj_name, obj_data):
     print(log_output.json_report())
 
 def test_get_bucket_policy(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "get_bucket_policy(bucket_name, prefix)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     try:
@@ -1378,6 +1479,9 @@ def test_get_bucket_policy(client, log_output):
             raise Exception(err)
 
 def test_set_bucket_policy_readonly(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "set_bucket_policy(bucket_name, prefix, policy_access)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['prefix'] = prefix = ''
@@ -1403,6 +1507,9 @@ def test_set_bucket_policy_readonly(client, log_output):
             raise Exception(err)
 
 def test_set_bucket_policy_readwrite(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "set_bucket_policy(bucket_name, prefix, policy_access)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['prefix'] = prefix = ''
@@ -1428,6 +1535,9 @@ def test_set_bucket_policy_readwrite(client, log_output):
             raise Exception(err)
 
 def test_no_bucket_policy(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "set_bucket_policy(bucket_name, prefix, policy_access)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     log_output.args['prefix'] = prefix = ''
@@ -1455,6 +1565,9 @@ def test_no_bucket_policy(client, log_output):
             raise Exception(err)
 
 def test_remove_objects(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "remove_objects(bucket_name, objects_iter)"
+
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()
     try:
@@ -1484,6 +1597,9 @@ def test_remove_objects(client, log_output):
     print(log_output.json_report())
 
 def test_remove_bucket(client, log_output):
+    # default value for function attribute for log_output is;
+    # log_output.function = "remove_bucket(bucket_name)"
+
 
     # Get a unique bucket_name
     log_output.args['bucket_name'] = bucket_name = generate_bucket_name()