feat: Codecleanup for Artifactory uploader

src/AritfactoryUploader.UTest/ArtifactoryUploaderTest.cs

@@ -23,16 +23,16 @@
 using System.Threading.Tasks;
 using UnitTestUtilities;
 
-namespace AritfactoryUploader.UTest
+namespace LCT.ArtifactoryUploader.UTest
 {
     [TestFixture]
-    public class ArtifactoryUploader
+    public class ArtifactoryUploaderTests
     {
         [Test]
         public void GettPathForArtifactoryUpload_ReturnsValidPath()
         {
             // Act
-            var result = ArtfactoryUploader.GettPathForArtifactoryUpload();
+            var result = ArtifactoryUploader.GettPathForArtifactoryUpload();
             // Assert
             Assert.IsNotNull(result);
             Assert.IsTrue(result.Contains("ClearingTool"));
@@ -63,7 +63,7 @@ public void Setup()
 
 
         [Test]
-        public async Task UploadPackageToRepo_InputEmptyCreds_ReturnsPackgeNotFound()
+        public async Task UploadPackageToRepo_InputEmptyCreds_ReturnsPackageNotFound()
         {
             //Arrange
             CommonAppSettings appSettings = new CommonAppSettings();
@@ -72,7 +72,7 @@ public async Task UploadPackageToRepo_InputEmptyCreds_ReturnsPackgeNotFound()
                 URL = UTParams.JFrogURL
             };
 
-            ArtfactoryUploader.JFrogService = GetJfrogService(appSettings);
+            ArtifactoryUploader.JFrogService = GetJfrogService(appSettings);
             DisplayPackagesInfo displayPackagesInfo = PackageUploadInformation.GetComponentsToBePackages();
             var componentsToArtifactory = new ComponentsToArtifactory
             {
@@ -94,7 +94,7 @@ public async Task UploadPackageToRepo_InputEmptyCreds_ReturnsPackgeNotFound()
             };
 
             //Act
-            var responseMessage = await ArtfactoryUploader.UploadPackageToRepo(componentsToArtifactory, 100, displayPackagesInfo);
+            var responseMessage = await ArtifactoryUploader.UploadPackageToRepo(componentsToArtifactory, 100, displayPackagesInfo);
             Assert.AreEqual(HttpStatusCode.NotFound, responseMessage.StatusCode);
             Assert.AreEqual("Package Not Found", responseMessage.ReasonPhrase);
 
@@ -128,9 +128,9 @@ public async Task UploadPackageToRepo_WhenPackageInfoIsNull_ReturnsNotFoundRespo
             var jFrogServiceMock = new Mock<IJFrogService>();
             jFrogServiceMock.Setup(x => x.GetPackageInfo(component))
                 .ReturnsAsync((AqlResult)null);
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.NotFound, response.StatusCode);
@@ -158,10 +158,10 @@ public async Task UploadPackageToRepo_WhenPackageTypeIsClearedThirdPartyOrDevelo
                 .ReturnsAsync(new AqlResult());
             jfrogApicommunicationMock.Setup(x => x.CopyFromRemoteRepo(It.IsAny<ComponentsToArtifactory>()))
                 .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK));
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
-            ArtfactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
             // Act
-            _ = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            _ = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             jfrogApicommunicationMock.Verify(x => x.CopyFromRemoteRepo(component), Times.Once);
@@ -188,10 +188,10 @@ public async Task UploadPackageToRepo_WhenPackageTypeIsInternal_CallsMoveFromRep
                 .ReturnsAsync(new AqlResult());
             jfrogApicommunicationMock.Setup(x => x.MoveFromRepo(It.IsAny<ComponentsToArtifactory>()))
                 .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK));
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
-            ArtfactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             jfrogApicommunicationMock.Verify(x => x.MoveFromRepo(component), Times.Once);
@@ -214,9 +214,9 @@ public async Task UploadPackageToRepo_WhenPackageTypeIsNotSupported_ReturnsNotFo
             var timeout = 10000;
             var displayPackagesInfo = new DisplayPackagesInfo();
             var jFrogServiceMock = new Mock<IJFrogService>();
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.NotFound, response.StatusCode);
@@ -240,11 +240,11 @@ public async Task UploadPackageToRepo_WhenHttpRequestExceptionOccurs_ReturnsErro
             var jfrogApicommunicationMock = new Mock<IJFrogApiCommunication>();
             jFrogServiceMock.Setup(x => x.GetPackageInfo(component))
                 .ThrowsAsync(new HttpRequestException());
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
-            ArtfactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
 
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             Assert.AreEqual(ApiConstant.ErrorInUpload, response.ReasonPhrase);
@@ -269,11 +269,11 @@ public async Task UploadPackageToRepo_WhenInvalidOperationExceptionOccurs_Return
             var jfrogApicommunicationMock = new Mock<IJFrogApiCommunication>();
             jFrogServiceMock.Setup(x => x.GetPackageInfo(component))
                 .ThrowsAsync(new InvalidOperationException());
-            ArtfactoryUploader.JFrogService = jFrogServiceMock.Object;
-            ArtfactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
+            ArtifactoryUploader.JFrogService = jFrogServiceMock.Object;
+            ArtifactoryUploader.JFrogApiCommInstance = jfrogApicommunicationMock.Object;
 
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             Assert.AreEqual(ApiConstant.ErrorInUpload, response.ReasonPhrase);
@@ -313,11 +313,11 @@ public async Task UploadPackageToRepo_WhenDebianOrNugetNameMismatch_UpdatesCopyP
                 .Setup(c => c.CopyFromRemoteRepo(component))
                 .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK));
 
-            ArtfactoryUploader.JFrogService = jfrogServiceMock.Object;
-            ArtfactoryUploader.JFrogApiCommInstance = jfrogApiCommMock.Object;
+            ArtifactoryUploader.JFrogService = jfrogServiceMock.Object;
+            ArtifactoryUploader.JFrogApiCommInstance = jfrogApiCommMock.Object;
 
             // Act
-            var response = await ArtfactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
+            var response = await ArtifactoryUploader.UploadPackageToRepo(component, timeout, displayPackagesInfo);
 
             // Assert
             Assert.AreEqual(HttpStatusCode.OK, response.StatusCode, "Expected successful copy response.");

src/AritfactoryUploader.UTest/PackageUploaderTest.cs

@@ -4,11 +4,10 @@
 //  SPDX-License-Identifier: MIT
 // -------------------------------------------------------------------------------------------------------------------- 
 
-using ArtifactoryUploader;
+using LCT.ArtifactoryUploader;
 using LCT.APICommunications;
 using LCT.APICommunications.Interfaces;
 using LCT.APICommunications.Model;
-using LCT.ArtifactoryUploader;
 using LCT.Common;
 using LCT.Common.Model;
 using LCT.Facade;
@@ -22,7 +21,7 @@
 using System.Threading.Tasks;
 using UnitTestUtilities;
 
-namespace AritfactoryUploader.UTest
+namespace LCT.ArtifactoryUploader.UTest
 {
     [TestFixture]
     public class PackageUploaderTest
@@ -76,7 +75,7 @@ public async Task UploadPackageToArtifactory_GivenAppsettings()
             IJFrogService jFrogService = GetJfrogService(commonAppSettings);
             PackageUploadHelper.JFrogService = jFrogService;
             UploadToArtifactory.JFrogService = jFrogService;
-            ArtfactoryUploader.JFrogService = jFrogService;
+            ArtifactoryUploader.JFrogService = jFrogService;
 
             Program.UploaderStopWatch = new Stopwatch();
             Program.UploaderStopWatch.Start();

src/ArtifactoryUploader/ArtifactoryUploader.cs

@@ -22,13 +22,31 @@
 
 namespace LCT.ArtifactoryUploader
 {
-    public static class ArtfactoryUploader
+    public static class ArtifactoryUploader
     {
-        //ConfigurationAttribute
+        #region Fields
+
         static readonly ILog Logger = LoggerFactory.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+        #endregion
+
+        #region Properties
+
         public static IJFrogService JFrogService { get; set; }
         public static IJFrogApiCommunication JFrogApiCommInstance { get; set; }
 
+        #endregion
+
+        #region Methods
+
+        /// <summary>
+        /// Asynchronously uploads a package to the repository.
+        /// </summary>
+        /// <param name="component">The component to upload.</param>
+        /// <param name="timeout">The timeout value in seconds.</param>
+        /// <param name="displayPackagesInfo">The display information for packages.</param>
+        /// <returns>A task containing the HTTP response message.</returns>
+
         public static async Task<HttpResponseMessage> UploadPackageToRepo(ComponentsToArtifactory component, int timeout, DisplayPackagesInfo displayPackagesInfo)
         {
 
@@ -77,6 +95,11 @@ public static async Task<HttpResponseMessage> UploadPackageToRepo(ComponentsToAr
             return responsemessage;
         }
 
+        /// <summary>
+        /// Gets the operation type for the component based on package type.
+        /// </summary>
+        /// <param name="component">The component to determine operation type for.</param>
+        /// <returns>The operation type as a string ("copy" or "move").</returns>
         private static string GetOperationType(ComponentsToArtifactory component)
         {
             if (component.ComponentType == "CHOCO")
@@ -86,6 +109,11 @@ private static string GetOperationType(ComponentsToArtifactory component)
             return (component.PackageType == PackageType.ClearedThirdParty || component.PackageType == PackageType.Development) ? "copy" : "move";
         }
 
+        /// <summary>
+        /// Asynchronously gets the repository operation response based on package type.
+        /// </summary>
+        /// <param name="component">The component to perform the operation on.</param>
+        /// <returns>A task containing the HTTP response message.</returns>
         private static async Task<HttpResponseMessage> GetRepoOperationResponse(ComponentsToArtifactory component)
         {
             return component.PackageType switch
@@ -98,6 +126,11 @@ await JFrogApiCommInstance.MoveFromRepo(component),
             };
         }
 
+        /// <summary>
+        /// Creates a not found HTTP response message.
+        /// </summary>
+        /// <param name="reasonPhrase">The reason phrase for the response.</param>
+        /// <returns>An HTTP response message with not found status.</returns>
         private static HttpResponseMessage CreateNotFoundResponse(string reasonPhrase)
         {
             return new HttpResponseMessage(HttpStatusCode.NotFound)
@@ -106,13 +139,25 @@ private static HttpResponseMessage CreateNotFoundResponse(string reasonPhrase)
             };
         }
 
+        /// <summary>
+        /// Handles upload exceptions and returns an error response.
+        /// </summary>
+        /// <param name="ex">The exception that occurred.</param>
+        /// <param name="responsemessage">The response message to update.</param>
+        /// <returns>An HTTP response message with error information.</returns>
         private static HttpResponseMessage HandleUploadException(Exception ex, HttpResponseMessage responsemessage)
         {
             Logger.Error("Error has occurred in UploadPackageToArtifactory--{Exception}", ex);
             responsemessage.ReasonPhrase = ApiConstant.ErrorInUpload;
             return responsemessage;
         }
 
+        /// <summary>
+        /// Asynchronously gets package information with retry logic for lowercase names.
+        /// </summary>
+        /// <param name="jFrogService">The JFrog service instance.</param>
+        /// <param name="component">The component to get information for.</param>
+        /// <returns>A task containing the AQL result with package information, or null if not found.</returns>
         private static async Task<AqlResult> GetPackageInfoWithRetry(IJFrogService jFrogService, ComponentsToArtifactory component)
         {
             async Task<AqlResult> TryGetPackageInfo(ComponentsToArtifactory component)
@@ -145,6 +190,11 @@ async Task<AqlResult> TryGetPackageInfo(ComponentsToArtifactory component)
 
             return packageInfo;
         }
+
+        /// <summary>
+        /// Gets the path for Artifactory upload directory.
+        /// </summary>
+        /// <returns>The local path for Artifactory upload.</returns>
         public static string GettPathForArtifactoryUpload()
         {
             string localPathforartifactory = string.Empty;
@@ -169,5 +219,6 @@ public static string GettPathForArtifactoryUpload()
             return localPathforartifactory;
         }
 
+        #endregion
     }
 }

src/ArtifactoryUploader/ArtifactoryValidator.cs

@@ -13,13 +13,31 @@ namespace LCT.ArtifactoryUploader
 {
     public class ArtifactoryValidator
     {
+        #region Fields
+
         private readonly IJfrogAqlApiCommunication _JfrogAqlApiCommunication;
 
+        #endregion
+
+        #region Constructors
+
+        /// <summary>
+        /// Initializes a new instance of the ArtifactoryValidator class.
+        /// </summary>
+        /// <param name="jfrogAqlApiCommunication">The JFrog AQL API communication instance.</param>
         public ArtifactoryValidator(IJfrogAqlApiCommunication jfrogAqlApiCommunication)
         {
             _JfrogAqlApiCommunication = jfrogAqlApiCommunication;
         }
 
+        #endregion
+
+        #region Methods
+
+        /// <summary>
+        /// Asynchronously validates Artifactory credentials by checking the connection.
+        /// </summary>
+        /// <returns>A task containing 0 if validation succeeds, -1 if validation fails.</returns>
         public async Task<int> ValidateArtifactoryCredentials()
         {
             HttpResponseMessage responseMessage = new HttpResponseMessage();
@@ -37,5 +55,7 @@ public async Task<int> ValidateArtifactoryCredentials()
                 return -1;
             }
         }
+
+        #endregion
     }
 }

src/ArtifactoryUploader/Constants/ArtifactoryConstant.cs

@@ -14,6 +14,10 @@ namespace ArtifactoryUploader.Constants
     [ExcludeFromCodeCoverage]
     public static class ArtifactoryConstant
     {
+        #region Fields
+
         public const string Log4netArtifactoryUploaderConfigFileName = "log4netArtifactoryUploader.config";
+
+        #endregion
     }
 }