resolved conflicts

Author: Sridhar, NIVETHA (ext) (FT D AA IN SGI EA EBT BE)

src/ArtifactoryUploader/ArtifactoryUploader.cs

@@ -31,7 +31,8 @@ public static class ArtfactoryUploader
 
         public static async Task<HttpResponseMessage> UploadPackageToRepo(ComponentsToArtifactory component, int timeout, DisplayPackagesInfo displayPackagesInfo)
         {
-            Logger.Debug("Starting UploadPackageToArtifactory method");
+
+            Logger.Debug("UploadPackageToRepo(): Starting the upload package to Artifactory.");
             string operationType = GetOperationType(component);
             string dryRunSuffix = component.DryRun ? " dry-run" : "";
             HttpResponseMessage responsemessage = new HttpResponseMessage();
@@ -45,7 +46,9 @@ public static async Task<HttpResponseMessage> UploadPackageToRepo(ComponentsToAr
                 }
 
                 // Perform Copy or Move operation
+
                 responsemessage = await GetRepoOperationResponse(component);
+                await LogHandlingHelper.HttpResponseHandling("Upload Package To Repo", $"MethodName:UploadPackageToRepo()", responsemessage, "");
 
                 // Check status code and handle errors
                 if (responsemessage.StatusCode != HttpStatusCode.OK)
@@ -58,15 +61,17 @@ public static async Task<HttpResponseMessage> UploadPackageToRepo(ComponentsToAr
             }
             catch (HttpRequestException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling("UploadPackageToRepo", $"MethodName:UploadPackageToRepo(), ComponentName: {component.Name}", ex, "An HTTP request error occurred while uploading the package to Artifactory.");
                 return HandleUploadException(ex, responsemessage);
             }
             catch (InvalidOperationException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling("UploadPackageToRepo", $"MethodName:UploadPackageToRepo(), ComponentName: {component.Name}", ex, "An invalid operation occurred while uploading the package to Artifactory.");
                 return HandleUploadException(ex, responsemessage);
             }
             finally
             {
-                Logger.Debug("Ending UploadPackageToArtifactory method");
+                Logger.DebugFormat("UploadPackageToRepo(): Ending the upload process for component: {0}.", component.Name);
             }
 
             return responsemessage;
@@ -154,11 +159,11 @@ public static string GettPathForArtifactoryUpload()
             }
             catch (IOException ex)
             {
-                Logger.Error($"GettPathForArtifactoryUpload() ", ex);
+                LogHandlingHelper.ExceptionErrorHandling("GettPathForArtifactoryUpload", $"Failed to create directory ", ex, "IOException occurred while creating the directory.");
             }
             catch (UnauthorizedAccessException ex)
             {
-                Logger.Error($"GettPathForArtifactoryUpload() ", ex);
+                LogHandlingHelper.ExceptionErrorHandling("GettPathForArtifactoryUpload", $"Unauthorized access while creating directory", ex, "UnauthorizedAccessException occurred while creating the directory.");
             }
 
             return localPathforartifactory;

src/ArtifactoryUploader/ArtifactoryValidator.cs

@@ -26,11 +26,13 @@ public async Task<int> ValidateArtifactoryCredentials()
             try
             {
                 responseMessage = await _JfrogAqlApiCommunication.CheckConnection();
+                await LogHandlingHelper.HttpResponseHandling("JFrog Connection Validation", $"Methodname-ValidateArtifactoryCredentials()", responseMessage, "");
                 responseMessage.EnsureSuccessStatusCode();
                 return 0;
             }
             catch (HttpRequestException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling("Get sw360 Project details for validating", $"MethodName-GetProjectById()", ex, "");
                 ExceptionHandling.HttpException(ex, responseMessage, "Artifactory");
                 return -1;
             }

src/ArtifactoryUploader/PackageUploadHelper.cs

@@ -41,14 +41,15 @@ public static class PackageUploadHelper
         private static bool SetWarningCode;
         public static Bom GetComponentListFromComparisonBOM(string comparisonBomFilePath, IEnvironmentHelper environmentHelper)
         {
-            Logger.Debug("Starting GetComponentListFromComparisonBOM() method");
+            Logger.Debug("GetComponentListFromComparisonBOM(): Reading bom file for components.");
             Bom componentsToBoms = null;
             try
             {
                 if (File.Exists(comparisonBomFilePath))
                 {
                     string json = File.ReadAllText(comparisonBomFilePath);
                     componentsToBoms = CycloneDX.Json.Serializer.Deserialize(json);
+                    LogHandlingHelper.ListOfBomFileComponents(comparisonBomFilePath, componentsToBoms.Components ?? new List<Component>());
                 }
                 else
                 {
@@ -58,9 +59,11 @@ public static Bom GetComponentListFromComparisonBOM(string comparisonBomFilePath
             }
             catch (JsonReaderException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling("GetComponentListFromComparisonBOM", $"Failed to deserialize the comparison BOM file at path: {comparisonBomFilePath}", ex, "JsonReaderException occurred while deserializing the comparison BOM.");
                 Logger.Error($"Exception occurred in reading the comparison BOM: {ex.Message}");
                 environmentHelper.CallEnvironmentExit(-1);
             }
+            Logger.Debug("GetComponentListFromComparisonBOM(): Completed the reading and identifying components from bom file.");
             return componentsToBoms;
         }
 
@@ -240,7 +243,7 @@ private static void AddToChocoList(ComponentsToArtifactory component, DisplayPac
         // Properly wrap UploadingThePackages as a method
         public static async Task UploadingThePackages(List<ComponentsToArtifactory> componentsToUpload, int timeout, DisplayPackagesInfo displayPackagesInfo)
         {
-            Logger.Debug("Starting UploadingThePackages() method");
+            Logger.Debug("UploadingThePackages(): Starting the package upload process.");
             foreach (var item in componentsToUpload)
             {
                 await PackageUploadToArtifactory(PackageUploader.uploaderKpiData, item, timeout, displayPackagesInfo);
@@ -253,7 +256,7 @@ public static async Task UploadingThePackages(List<ComponentsToArtifactory> comp
                 Logger.Debug("Setting ExitCode to 2");
             }
 
-            Logger.Debug("Ending UploadingThePackages() method");
+            Logger.Debug("UploadingThePackages(): Package upload process completed.");
             Program.UploaderStopWatch?.Stop();
         }
 
@@ -269,19 +272,22 @@ private static async Task PackageUploadToArtifactory(UploaderKpiData uploaderKpi
             {
                 if (!(item.SrcRepoName.Contains("Not Found in JFrog")))
                 {
+                    Logger.DebugFormat("PackageUploadToArtifactory():{0} and {1}  contains Source repository:{2} and Destination Repository:{3} ,So now started upload package process .", item.Name, item.Version, item.SrcRepoName, item.DestRepoName);
                     await SourceRepoFoundToUploadArtifactory(packageType, uploaderKpiData, item, timeout, displayPackagesInfo);
                 }
                 else
                 {
                     uploaderKpiData.PackagesNotExistingInRemoteCache++;
                     item.DestRepoName = null;
                     await JfrogNotFoundPackagesAsync(item, displayPackagesInfo);
+                    Logger.DebugFormat("PackageUploadToArtifactory(): {0} and {1} is not found in any jfrog repository.", item.Name, item.Version);
                 }
             }
             else
             {
                 IncrementCountersBasedOnPackageType(uploaderKpiData, packageType, true);
                 await SucessfullPackagesAsync(item, displayPackagesInfo);
+                Logger.DebugFormat("PackageUploadToArtifactory(): {0} and {1} is identified in source: {2} and destination: {3} repositories",item.Name, item.Version, item.SrcRepoName, item.DestRepoName);
                 item.DestRepoName = null;
             }
         }

src/ArtifactoryUploader/PackageUploader.cs

@@ -32,8 +32,10 @@ public static class PackageUploader
 
         public static async Task UploadPackageToArtifactory(CommonAppSettings appSettings)
         {
+            Logger.Debug($"UploadPackageToArtifactory():Upload package to artifactory process has started");
             //Reading the CycloneBOM data
             var bomFilePath = Path.Combine(appSettings.Directory.OutputFolder, appSettings.SW360.ProjectName + "_" + FileConstant.BomFileName);
+            Logger.DebugFormat("UploadPackageToArtifactory(): Identified bom file with path: {0}", bomFilePath);
             Bom m_ComponentsInBOM = PackageUploadHelper.GetComponentListFromComparisonBOM(bomFilePath, environmentHelper);
 
             LoggerHelper.DisplayAllSettings(m_ComponentsInBOM.Components, appSettings);
@@ -72,7 +74,7 @@ public static async Task UploadPackageToArtifactory(CommonAppSettings appSetting
                 (int)Program.UploaderStopWatch.Elapsed.TotalSeconds;
             PackageUploadHelper.WriteCreatorKpiDataToConsole(uploaderKpiData);
 
-            Logger.Debug($"UploadPackageToArtifactory():End");
+            Logger.Debug($"UploadPackageToArtifactory():Upload package to artifactory process has completed");
 
             // set the error code
             if (uploaderKpiData.PackagesNotUploadedDueToError > 0 || uploaderKpiData.PackagesNotExistingInRemoteCache > 0)

src/ArtifactoryUploader/Program.cs

@@ -49,13 +49,17 @@ static async Task Main(string[] args)
             // do not change the order of getting ca tool information
             CatoolInfo caToolInformation = GetCatoolVersionFromProjectfile();
             Log4Net.CatoolCurrentDirectory = System.IO.Directory.GetParent(caToolInformation.CatoolRunningLocation).FullName;
-            CommonHelper.DefaultLogFolderInitialisation(FileConstant.ArtifactoryUploaderLog, m_Verbose);
-            CommonAppSettings appSettings = settingsManager.ReadConfiguration<CommonAppSettings>(args, FileConstant.appSettingFileName);
+            string logFileNameWithTimestamp = $"{FileConstant.ArtifactoryUploaderLog}_{DateTime.Now:yyyyMMdd_HHmmss}.log";
+            CommonHelper.DefaultLogFolderInitialization(logFileNameWithTimestamp, m_Verbose);
+            Logger.Debug($"====================<<<<< Artifactory Uploader >>>>>====================");            
+            CommonAppSettings appSettings = settingsManager.ReadConfiguration<CommonAppSettings>(args, FileConstant.appSettingFileName, environmentHelper);
+            Log4Net.AppendVerboseValue(appSettings);
             Console.OutputEncoding = System.Text.Encoding.UTF8;
-            string _ = CommonHelper.LogFolderInitialisation(appSettings, FileConstant.ArtifactoryUploaderLog, m_Verbose);
+            string _ = CommonHelper.LogFolderInitialization(appSettings, logFileNameWithTimestamp, m_Verbose);
 
             settingsManager.CheckRequiredArgsToRun(appSettings, Dataconstant.Uploader);
             string bomFilePath = GetBomFilePath(appSettings);
+            Logger.DebugFormat("Main(): Identified bom file with path: {0}", bomFilePath);
             LoggerHelper.SpectreConsoleInitialMessage("Artifactory Uploader");
             ListofPerametersForCli listofPerameters = new ListofPerametersForCli();
             LoggerHelper.LogInputParameters(caToolInformation, appSettings, listofPerameters, exeType: Dataconstant.Uploader, bomFilePath: bomFilePath);

src/ArtifactoryUploader/UploadToArtifactory.cs

@@ -34,11 +34,12 @@ public async static Task<List<ComponentsToArtifactory>> GetComponentsToBeUploade
                                                                                                       CommonAppSettings appSettings,
                                                                                                       DisplayPackagesInfo displayPackagesInfo)
         {
-            Logger.Debug("Starting GetComponentsToBeUploadedToArtifactory() method");
+            Logger.Debug("GetComponentsToBeUploadedToArtifactory():Starting to get component data for upload to artifactory");
             List<ComponentsToArtifactory> componentsToBeUploaded = new List<ComponentsToArtifactory>();
 
             foreach (var item in comparisonBomData)
             {
+                Logger.DebugFormat("GetComponentsToBeUploadedToArtifactory(): Identifying data for this component name-{0}, version-{1}", item.Name, item.Version);
                 var packageType = GetPackageType(item);
 
                 if (packageType != PackageType.Unknown)
@@ -76,6 +77,7 @@ public async static Task<List<ComponentsToArtifactory>> GetComponentsToBeUploade
                     components.JfrogPackageName = GetJfrogPackageName(components);
                     components.JfrogRepoPath = GetJfrogRepPath(components);
                     componentsToBeUploaded.Add(components);
+                    Logger.DebugFormat("GetComponentsToBeUploadedToArtifactory(): Component identified as unknown package type, name-{0}, version-{1}", item.Name, item.Version);
                 }
                 else
                 {
@@ -84,10 +86,34 @@ public async static Task<List<ComponentsToArtifactory>> GetComponentsToBeUploade
                     await AddUnknownPackagesAsync(item, displayPackagesInfo);
                 }
             }
-            Logger.Debug("Ending GetComponentsToBeUploadedToArtifactory() method");
+            ValidComponentsIdentifiedToBeUpload(componentsToBeUploaded);
+            Logger.Debug("GetComponentsToBeUploadedToArtifactory():Completed to getting component data for upload to artifactory");
             return componentsToBeUploaded;
         }
+        private static void ValidComponentsIdentifiedToBeUpload(List<ComponentsToArtifactory> componentsToBeUploaded)
+        {
+            if (componentsToBeUploaded == null || componentsToBeUploaded.Count == 0)
+            {
+                Logger.Debug("No components to be uploaded to Artifactory.");
+                return;
+            }
 
+            var logBuilder = new System.Text.StringBuilder();
+            logBuilder.AppendLine($"\n================================================================================================================");
+            logBuilder.AppendLine(" Components to be Uploaded to Artifactory");
+            logBuilder.AppendLine("================================================================================================================");
+            logBuilder.AppendLine($"| {"Name",-50} | {"Version",-15} | {"ComponentType",-15} | {"PackageType",-20} | {"SrcRepoName",-20} | {"DestRepoName",-20} |");
+            logBuilder.AppendLine("----------------------------------------------------------------------------------------------------------------");
+
+            foreach (var component in componentsToBeUploaded)
+            {
+                logBuilder.AppendLine($"| {component.Name,-50} | {component.Version,-15} | {component.ComponentType,-15} | {component.PackageType,-20} | {component.SrcRepoName,-20} | {component.DestRepoName,-20} |");
+            }
+
+            logBuilder.AppendLine("================================================================================================================");
+
+            Logger.Debug(logBuilder.ToString());
+        }
         private static string GetComponentType(Component item)
         {
             var projectTypeProp = item.Properties
@@ -591,20 +617,23 @@ string GetPropertyValue(string propertyName) =>
                         .Find(p => p.Name == propertyName)?
                         .Value?
                         .ToUpperInvariant();
-
+            Logger.DebugFormat("GetPackageType(): Determining package type for Component - Name: {0}, Version: {1}", item.Name, item.Version);
             if (GetPropertyValue(Dataconstant.Cdx_ClearingState) == "APPROVED")
             {
+                Logger.Debug($"GetPackageType(): Package type determined as Clearing state is APPROVED");
                 return PackageType.ClearedThirdParty;
             }
             else if (GetPropertyValue(Dataconstant.Cdx_IsInternal) == "TRUE")
             {
+                Logger.Debug($"GetPackageType(): Package type determined as Internal");
                 return PackageType.Internal;
             }
             else if (GetPropertyValue(Dataconstant.Cdx_IsDevelopment) == "TRUE")
             {
+                Logger.Debug($"GetPackageType(): Package type determined as Development");
                 return PackageType.Development;
             }
-
+            Logger.Debug($"GetPackageType(): Package type determined as Unknown");
             return PackageType.Unknown;
         }       
 

src/LCT.APICommunications/AttachmentHelper.cs

@@ -33,7 +33,7 @@ public class AttachmentHelper
 
         private const string fileMimeType = "application /x-compressed";
         private const string fileFormKey = "file";
-
+        private const string AttachmentErrorMessage = "Not able to attachment";
         public AttachmentHelper(string sw360TokenType, string sw360Token, string releaseApi)
         {
             sw360AuthToken = sw360Token;
@@ -86,19 +86,23 @@ public string AttachComponentSourceToSW360(AttachReport attachReport, Comparison
                     byte[] endBytes = System.Text.Encoding.UTF8.GetBytes($"--{boundary}--");
                     requestStream.Write(endBytes, 0, endBytes.Length);
                     requestStream.Close();
+                    LogHandlingHelper.LogHttpWebRequest("Attach Component Source", $"Uploading component source for ReleaseId: {attachReport.ReleaseId}", request);
                     using WebResponse response = request.GetResponse();
                     HttpWebResponse httpResponse = (HttpWebResponse)response;
                     HandleAcceptedStatus(httpResponse, comparisonBomData);
                     using StreamReader reader = new StreamReader(response.GetResponseStream());
                     reader.ReadToEnd();
+                    LogHandlingHelper.LogHttpWebResponse("Attach Component Source", $"Response for attaching component source for ReleaseId: {attachReport.ReleaseId}", httpResponse);
                 }
             }
             catch (UriFormatException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling(AttachmentErrorMessage, $"AttachComponentSourceToSW360():Failed to attach component source for ReleaseId: {attachReport.ReleaseId}", ex, $"Invalid URI format: {url.AbsoluteUri}");
                 Logger.Error($"   └── AttachComponentSourceToSW360:", ex);
             }
             catch (SecurityException ex)
             {
+                LogHandlingHelper.ExceptionErrorHandling(AttachmentErrorMessage, $"AttachComponentSourceToSW360():Failed to attach component source for ReleaseId: {attachReport.ReleaseId}", ex, "A security exception occurred. Ensure the application has the required permissions.");
                 Logger.Error($"   └── AttachComponentSourceToSW360:", ex);
             }
             catch (WebException webex)
@@ -110,15 +114,15 @@ public string AttachComponentSourceToSW360(AttachReport attachReport, Comparison
                     {
                         StreamReader reader = new StreamReader(respStream);
                         string text = reader.ReadToEnd();
-                        Logger.Debug($"Web exception: {text}", webex);
+                        LogHandlingHelper.ExceptionErrorHandling(AttachmentErrorMessage, $"Failed to attach component source for ReleaseId: {attachReport.ReleaseId}", webex, $"Web exception occurred. Details: {text}");
                         Logger.Warn($"   └── Web exception: {text}", webex);
                     }
                 }
             }
             catch (IOException ex)
             {
                 Logger.Error($"   └── AttachComponentSourceToSW360:Failed attach source for release = {attachReport.ReleaseId}");
-                Logger.Debug($"AttachComponentSourceToSW360:", ex);
+                LogHandlingHelper.ExceptionErrorHandling(AttachmentErrorMessage, $"AttachComponentSourceToSW360():Failed to attach component source for ReleaseId: {attachReport.ReleaseId}", ex, "An I/O error occurred while processing the attachment.");
             }
             return releaseAttachementApi;
         }