Code cleanup

Author: Genbox

.globalconfig

@@ -206,6 +206,12 @@ dotnet_diagnostic.CA1711.severity = none # Identifiers should not have incorrect
 dotnet_diagnostic.S2997.severity = error # "IDisposables" created in a "using" statement should not be returned
 dotnet_diagnostic.S125.severity = none # Sections of code should not be commented out
 
+dotnet_diagnostic.RCS1003.severity = none # Add braces to if-else (when expression spans over multiple lines)
+dotnet_diagnostic.MA0003.severity = none # Add parameter name to improve readability
+dotnet_diagnostic.RCS1063.severity = none # Avoid usage of do statement to create an infinite loop
+
+
+
 # Broken
 dotnet_diagnostic.S2589.severity = none # Boolean expressions should not be gratuitous
 dotnet_diagnostic.S2583.severity = none # Conditionally executed code should be reachable

SimpleS3.sln.DotSettings

@@ -0,0 +1,7 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ConvertIfStatementToSwitchStatement/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ForCanBeConvertedToForeach/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ForeachCanBeConvertedToQueryUsingAnotherGetEnumerator/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ForeachCanBePartlyConvertedToQueryUsingAnotherGetEnumerator/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=InvertIf/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=LoopCanBeConvertedToQuery/@EntryIndexedValue">DO_NOT_SHOW</s:String></wpf:ResourceDictionary>

Src/ProviderTests/.globalconfig

@@ -0,0 +1,3 @@
+dotnet_diagnostic.CA1515.severity = none # Consider making public types internal
+dotnet_diagnostic.CS8618.severity = none # Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
+dotnet_diagnostic.CA1822.severity = none # Mark members as static

Src/ProviderTests/Buckets/BucketLifecycleConfigurationTests.cs

@@ -28,7 +28,7 @@ await CreateTempBucketAsync(provider, client, async tempBucket =>
             rule3.Expiration = new S3Expiration(DateTimeOffset.UtcNow.AddDays(1));
             rule3.Filter = new S3Filter { Tag = new KeyValuePair<string, string>("type", "temp") };
 
-            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, new[] { rule1, rule2, rule3 });
+            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, [rule1, rule2, rule3]);
             Assert.True(putResp.IsSuccess);
 
             GetBucketLifecycleConfigurationResponse getResp = await client.GetBucketLifecycleConfigurationAsync(tempBucket);
@@ -67,7 +67,7 @@ await CreateTempBucketAsync(provider, client, async tempBucket =>
             rule.Expiration = new S3Expiration(DateTimeOffset.UtcNow.AddDays(10));
             rule.Filter = new S3Filter(); //Empty filter means the whole bucket is affected
 
-            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, new[] { rule });
+            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, [rule]);
             Assert.True(putResp.IsSuccess);
 
             GetBucketLifecycleConfigurationResponse getResp = await client.GetBucketLifecycleConfigurationAsync(tempBucket);
@@ -99,7 +99,7 @@ await CreateTempBucketAsync(provider, client, async tempBucket =>
             rule.Filter = filter;
             rule.Expiration = new S3Expiration(DateTimeOffset.UtcNow.AddDays(1));
 
-            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, new[] { rule });
+            PutBucketLifecycleConfigurationResponse putResp = await client.PutBucketLifecycleConfigurationAsync(tempBucket, [rule]);
             Assert.True(putResp.IsSuccess);
 
             GetBucketLifecycleConfigurationResponse getResp = await client.GetBucketLifecycleConfigurationAsync(tempBucket);

Src/ProviderTests/Misc/MultipleProvidersAttribute.cs

@@ -6,34 +6,26 @@
 
 namespace Genbox.ProviderTests.Misc;
 
-public sealed class MultipleProvidersAttribute : DataAttribute
+internal sealed class MultipleProvidersAttribute(S3Provider providers, params object[] otherData) : DataAttribute
 {
-    private readonly object[] _otherData;
-    private readonly S3Provider _providers;
     private bool _shouldSkip;
 
-    public MultipleProvidersAttribute(S3Provider providers, params object[] otherData)
-    {
-        _providers = providers;
-        _otherData = otherData;
-    }
-
     public override string? Skip => _shouldSkip ? "Not supported" : null;
 
     public override IEnumerable<object?[]> GetData(MethodInfo testMethod)
     {
         foreach ((S3Provider provider, IProfile profile, ISimpleClient client) in ProviderSetup.Instance.Clients)
         {
-            _shouldSkip = !_providers.HasFlag(provider);
+            _shouldSkip = !providers.HasFlag(provider);
             string bucket = UtilityHelper.GetTestBucket(profile);
 
-            if (_otherData.Length > 0)
+            if (otherData.Length > 0)
             {
-                foreach (object o in _otherData)
-                    yield return new[] { provider, bucket, client, o };
+                foreach (object o in otherData)
+                    yield return [provider, bucket, client, o];
             }
             else
-                yield return new object?[] { provider, bucket, client };
+                yield return [provider, bucket, client];
         }
     }
 }

Src/ProviderTests/Misc/ProviderSetup.cs

@@ -6,7 +6,7 @@
 
 namespace Genbox.ProviderTests.Misc;
 
-public class ProviderSetup
+internal class ProviderSetup
 {
     private ProviderSetup()
     {

Src/ProviderTests/Misc/TestConstants.cs

@@ -1,6 +1,6 @@
 namespace Genbox.ProviderTests.Misc;
 
-public static class TestConstants
+internal static class TestConstants
 {
     public const string TestUsername = "qvistian";
     public const string TestEmail = "[email protected]";

Src/ProviderTests/Multipart/AbortMultipartTests.cs

@@ -11,7 +11,7 @@ public class AbortMultipartTests : TestBase
     [MultipleProviders(S3Provider.All)]
     public async Task AbortIncompleteUpload(S3Provider _, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(AbortIncompleteUpload);
+        const string objectKey = nameof(AbortIncompleteUpload);
 
         CreateMultipartUploadResponse createResp = await client.CreateMultipartUploadAsync(bucket, objectKey);
         Assert.Equal(200, createResp.StatusCode);

Src/ProviderTests/Multipart/ListMultipartUploadsTests.cs

@@ -17,7 +17,7 @@ public async Task ListMultipartUploads(S3Provider provider, string _, ISimpleCli
         await CreateTempBucketAsync(provider, client, async tempBucket =>
         {
             //The percentage sign at the end is to test if encoding works correctly
-            string objName = nameof(ListMultipartUploads) + "%";
+            const string objName = nameof(ListMultipartUploads) + "%";
 
             CreateMultipartUploadResponse createResp = await client.CreateMultipartUploadAsync(tempBucket, objName);
             Assert.Equal(200, createResp.StatusCode);

Src/ProviderTests/Multipart/ListPartsTests.cs

@@ -18,7 +18,7 @@ public async Task ListParts(S3Provider provider, string _, ISimpleClient client)
         await CreateTempBucketAsync(provider, client, async tempBucket =>
         {
             //We add the special characters at the end to test EncodingType support.
-            string objName = nameof(ListParts) + "%";
+            const string objName = nameof(ListParts) + "%";
 
             CreateMultipartUploadResponse createResp = await client.CreateMultipartUploadAsync(tempBucket, objName);
 

Src/ProviderTests/Multipart/MultipartTests.cs

@@ -18,7 +18,7 @@ public class MultipartTests : TestBase
     [MultipleProviders(S3Provider.GoogleCloudStorage, SseAlgorithm.Aes256)]
     public async Task MultipartWithEncryption(S3Provider provider, string bucket, ISimpleClient client, SseAlgorithm algorithm)
     {
-        string objectKey = nameof(MultipartWithEncryption);
+        const string objectKey = nameof(MultipartWithEncryption);
 
         CreateMultipartUploadResponse createResp = await client.CreateMultipartUploadAsync(bucket, objectKey, req => req.SseAlgorithm = algorithm);
         Assert.Equal(200, createResp.StatusCode);
@@ -54,9 +54,9 @@ public async Task MultipartWithEncryption(S3Provider provider, string bucket, IS
     [MultipleProviders(S3Provider.AmazonS3)]
     public async Task MultipartCustomerEncryption(S3Provider _, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(MultipartCustomerEncryption);
+        const string objectKey = nameof(MultipartCustomerEncryption);
 
-        byte[] key = { 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8 };
+        byte[] key = [1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8, 1, 2, 3, 4, 5, 6, 7, 8];
         byte[] keyMd5 = CryptoHelper.Md5Hash(key);
 
         CreateMultipartUploadResponse initResp = await client.CreateMultipartUploadAsync(bucket, objectKey, r =>
@@ -79,7 +79,7 @@ public async Task MultipartCustomerEncryption(S3Provider _, string bucket, ISimp
         Assert.Equal(SseCustomerAlgorithm.Aes256, uploadResp1.SseCustomerAlgorithm);
         Assert.Equal(keyMd5, uploadResp1.SseCustomerKeyMd5);
 
-        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, new[] { new S3PartInfo(uploadResp1.ETag, 1) });
+        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, [new S3PartInfo(uploadResp1.ETag, 1)]);
         Assert.Equal(200, completeResp.StatusCode);
         Assert.Equal(SseCustomerAlgorithm.Aes256, completeResp.SseCustomerAlgorithm);
     }
@@ -88,7 +88,7 @@ public async Task MultipartCustomerEncryption(S3Provider _, string bucket, ISimp
     [MultipleProviders(S3Provider.AmazonS3 | S3Provider.GoogleCloudStorage)]
     public async Task MultipartLockMode(S3Provider _, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(MultipartLockMode);
+        const string objectKey = nameof(MultipartLockMode);
 
         CreateMultipartUploadResponse initResp = await client.CreateMultipartUploadAsync(bucket, objectKey, r =>
         {
@@ -103,15 +103,15 @@ public async Task MultipartLockMode(S3Provider _, string bucket, ISimpleClient c
         UploadPartResponse uploadResp = await client.UploadPartAsync(bucket, objectKey, 1, initResp.UploadId, ms, r => r.ContentMd5 = CryptoHelper.Md5Hash(file));
         Assert.Equal(200, uploadResp.StatusCode);
 
-        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, new[] { new S3PartInfo(uploadResp.ETag, 1) });
+        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, [new S3PartInfo(uploadResp.ETag, 1)]);
         Assert.Equal(200, completeResp.StatusCode);
     }
 
     [Theory]
     [MultipleProviders(S3Provider.AmazonS3 | S3Provider.GoogleCloudStorage)]
     public async Task MultipartSinglePart(S3Provider provider, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(MultipartSinglePart);
+        const string objectKey = nameof(MultipartSinglePart);
 
         CreateMultipartUploadResponse createResp = await client.CreateMultipartUploadAsync(bucket, objectKey);
         Assert.Equal(200, createResp.StatusCode);
@@ -135,7 +135,7 @@ public async Task MultipartSinglePart(S3Provider provider, string bucket, ISimpl
         Assert.Equal(200, uploadResp.StatusCode);
         Assert.Equal("\"10f74ef02085310ccd1f87150b83e537\"", uploadResp.ETag);
 
-        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, createResp.UploadId, new[] { new S3PartInfo(uploadResp.ETag, 1) });
+        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, createResp.UploadId, [new S3PartInfo(uploadResp.ETag, 1)]);
         Assert.Equal(200, completeResp.StatusCode);
         Assert.Equal("\"bd74e21dfa8678d127240f76e518e9c2-1\"", completeResp.ETag);
 
@@ -151,7 +151,7 @@ public async Task MultipartSinglePart(S3Provider provider, string bucket, ISimpl
     [MultipleProviders(S3Provider.All)]
     public async Task MultipartTooSmall(S3Provider provider, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(MultipartTooSmall);
+        const string objectKey = nameof(MultipartTooSmall);
 
         CreateMultipartUploadResponse initResp = await client.CreateMultipartUploadAsync(bucket, objectKey);
         Assert.Equal(200, initResp.StatusCode);
@@ -172,15 +172,15 @@ public async Task MultipartTooSmall(S3Provider provider, string bucket, ISimpleC
         UploadPartResponse uploadResp2 = await client.UploadPartAsync(bucket, objectKey, 2, initResp.UploadId, ms2);
         Assert.Equal(200, uploadResp2.StatusCode);
 
-        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, new[] { new S3PartInfo(uploadResp1.ETag, 1), new S3PartInfo(uploadResp2.ETag, 2) });
+        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, [new S3PartInfo(uploadResp1.ETag, 1), new S3PartInfo(uploadResp2.ETag, 2)]);
         Assert.Equal(400, completeResp.StatusCode);
     }
 
     [Theory]
     [MultipleProviders(S3Provider.AmazonS3 | S3Provider.GoogleCloudStorage)]
     public async Task MultipartUpload(S3Provider provider, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(MultipartUpload);
+        const string objectKey = nameof(MultipartUpload);
 
         CreateMultipartUploadResponse initResp = await client.CreateMultipartUploadAsync(bucket, objectKey);
         Assert.Equal(200, initResp.StatusCode);
@@ -204,7 +204,7 @@ public async Task MultipartUpload(S3Provider provider, string bucket, ISimpleCli
         Assert.Equal(200, uploadResp2.StatusCode);
         Assert.NotNull(uploadResp2.ETag);
 
-        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, new[] { new S3PartInfo(uploadResp1.ETag, 1), new S3PartInfo(uploadResp2.ETag, 2) });
+        CompleteMultipartUploadResponse completeResp = await client.CompleteMultipartUploadAsync(bucket, objectKey, initResp.UploadId, [new S3PartInfo(uploadResp1.ETag, 1), new S3PartInfo(uploadResp2.ETag, 2)]);
         Assert.Equal(200, completeResp.StatusCode);
         Assert.NotNull(uploadResp2.ETag);
 

Src/ProviderTests/Objects/CopyObjectTests.cs

@@ -13,8 +13,8 @@ public class CopyObjectTests : TestBase
     public async Task CopyObject(S3Provider _, string bucket, ISimpleClient client)
     {
         //Upload an object to copy
-        string sourceKey = nameof(CopyObject);
-        string destinationKey = sourceKey + "2";
+        const string sourceKey = nameof(CopyObject);
+        const string destinationKey = sourceKey + "2";
 
         await client.PutObjectStringAsync(bucket, sourceKey, "test");
 

Src/ProviderTests/Objects/GetObjectTests.cs

@@ -36,7 +36,7 @@ public async Task GetObjectString(S3Provider _, string bucket, ISimpleClient cli
         // - Preserve casing
         // - Preserve encoding
 
-        string stringData = "Hello 你好 ਸਤ ਸ੍ਰੀ ਅਕਾਲ Привет";
+        const string stringData = "Hello 你好 ਸਤ ਸ੍ਰੀ ਅਕਾਲ Привет";
 
         PutObjectResponse putResp = await client.PutObjectStringAsync(bucket, nameof(GetObjectString), stringData);
         Assert.Equal(200, putResp.StatusCode);

Src/ProviderTests/Objects/ListObjectVersionsTests.cs

@@ -185,7 +185,7 @@ public async Task ListObjectVersionsWithEncoding(S3Provider provider, string _,
     {
         await CreateTempBucketAsync(provider, client, async tempBucket =>
         {
-            string tempObjName = "!#/()";
+            const string tempObjName = "!#/()";
 
             await client.PutObjectAsync(tempBucket, tempObjName, null);
 

Src/ProviderTests/Objects/ListObjectsTests.cs

@@ -111,7 +111,7 @@ public async Task ListObjectsWithEncoding(S3Provider provider, string _, ISimple
     {
         await CreateTempBucketAsync(provider, client, async tempBucket =>
         {
-            string tempObjName = "!#/()";
+            const string tempObjName = "!#/()";
 
             PutObjectResponse putResp = await client.PutObjectAsync(tempBucket, tempObjName, null);
             Assert.Equal(200, putResp.StatusCode);

Src/ProviderTests/Objects/ObjectAclTests.cs

@@ -13,7 +13,7 @@ public class ObjectAclTests : TestBase
     [MultipleProviders(S3Provider.AmazonS3 | S3Provider.GoogleCloudStorage)]
     public async Task PutGetObjectAcl(S3Provider provider, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(PutGetObjectAcl);
+        const string objectKey = nameof(PutGetObjectAcl);
 
         //Create an object
         PutObjectResponse putResp1 = await client.PutObjectAsync(bucket, objectKey, null);

Src/ProviderTests/Objects/ObjectLegalHoldTests.cs

@@ -11,7 +11,7 @@ public class ObjectLegalHoldTests : TestBase
     [MultipleProviders(S3Provider.AmazonS3 | S3Provider.BackBlazeB2)]
     public async Task PutGetObjectLegalHold(S3Provider _, string bucket, ISimpleClient client)
     {
-        string objectKey = nameof(PutGetObjectLegalHold);
+        const string objectKey = nameof(PutGetObjectLegalHold);
 
         //Create an object
         await client.PutObjectAsync(bucket, objectKey, null);

Src/ProviderTests/Signed/SignedTests.cs

@@ -1,7 +1,6 @@
 using Genbox.ProviderTests.Misc;
 using Genbox.SimpleS3.Core.Abstracts;
 using Genbox.SimpleS3.Core.Abstracts.Enums;
-using Genbox.SimpleS3.Core.Extensions;
 using Genbox.SimpleS3.Core.Network.Requests.Multipart;
 using Genbox.SimpleS3.Core.Network.Requests.Objects;
 using Genbox.SimpleS3.Core.Network.Requests.S3Types;

Src/SimpleS3.AmazonS3/AmazonS3Client.cs

@@ -18,8 +18,7 @@
 
 namespace Genbox.SimpleS3.AmazonS3;
 
-/// <summary>This class provides a convenient way to access all the functionality related to the S3 service, buckets and
-/// objects at the same time.</summary>
+/// <summary>This class provides a convenient way to access all the functionality related to the S3 service, buckets and objects at the same time.</summary>
 public sealed class AmazonS3Client : ClientBase, ISimpleClient
 {
     /// <summary>Creates a new instance of <see cref="AmazonS3Client" /></summary>

Src/SimpleS3.BackBlazeB2/BackBlazeB2Client.cs

@@ -18,8 +18,7 @@
 
 namespace Genbox.SimpleS3.BackBlazeB2;
 
-/// <summary>This class provides a convenient way to access all the functionality related to the S3 service, buckets and
-/// objects at the same time.</summary>
+/// <summary>This class provides a convenient way to access all the functionality related to the S3 service, buckets and objects at the same time.</summary>
 public sealed class BackBlazeB2Client : ClientBase, ISimpleClient
 {
     /// <summary>Creates a new instance of <see cref="BackBlazeB2Client" /></summary>