Merge pull request #257 from siemens/feature/DecouplingSW360andJfrogConnection

Modify the package identifier  to make the JFROG and SW360 connections optional

Author: crvreddy

doc/UsageDoc/CA_UsageDocument.md

@@ -94,6 +94,7 @@ Currently LTA support is not provided for SBOM, hence until that is implemented
 
    - [NPM/NUGET/MAVEN/PYTHON/CONAN](../usagedocimg/packageIdentifiernpmnuget.PNG)
    - [Debian/Alpine](../usagedocimg/packageIdentifierdebianalpine.PNG)
+   - [BasicSBOM](../usagedocimg/PackageidentifierBasicSBOMflowdiagram.png)
 - SW360 Package Creator
   - [NPM/NUGET/MAVEN/PYTHON/CONAN](../usagedocimg/packageCreatirnpmnuget.PNG)
   - [Debian](../usagedocimg/packagecreatordebian.PNG)
@@ -162,6 +163,8 @@ Currently LTA support is not provided for SBOM, hence until that is implemented
    > **1. Package Identifier**
       - Processes the input file and generates CycloneDX BOM file. The input file can be package file or a cycloneDx BOM file generated using the standard tool. If there are multiple input files, it can be processed by just passing the path to the directory in the argument
 
+      **Functionality Without Connections:**
+      Provide users the flexibility to generate a basic SBOM even when connections to SW360, JFrog, or both are unavailable. The tool would support limited capabilities in such scenarios, ensuring essential SBOM generation functionality is maintained.      
 
    >**2. SW360 Package Creator**
       - Process the SBOM file(i.e., output of the first dll) and creates the missing components/releases in SW360 and links all the components to the project in the SW360 portal. This exe also triggers the upload of the components to Fossology and automatically updates the clearing state in SW360.

doc/usagedocimg/PackageidentifierBasicSBOMflowdiagram.png

@@ -62,5 +62,17 @@ public void MavenJfrogApiCommunication_GetApiKey_ReturnsInvalidOperationExceptio
             //Assert
             Assert.ThrowsAsync<InvalidOperationException>(async () => await jfrogApicommunication.GetApiKey());
         }
+        [Test]
+        public void MavenJfrogApiCommunication_MoveFromRepo_ReturnsInvalidOperationException()
+        {
+            //Arrange
+            ArtifactoryCredentials repoCredentials = new ArtifactoryCredentials();
+
+            //Act
+            JfrogApicommunication jfrogApicommunication = new MavenJfrogApiCommunication("", "", repoCredentials, 100);
+
+            //Assert
+            Assert.ThrowsAsync<InvalidOperationException>(async () => await jfrogApicommunication.MoveFromRepo(new ComponentsToArtifactory()));
+        }
     }
 }

src/LCT.APICommunications.UTest/MavenJFrogApiCommunicationUTest.cs

@@ -263,7 +263,15 @@ public void SW360Apicommunication_GetComponentDetailsByUrl_ReturnsInvalidOperati
             //Assert
             Assert.ThrowsAsync<InvalidOperationException>(async () => await sW360Apicommunication.GetComponentDetailsByUrl(""));
         }
+        [Test]
+        public void SW360Apicommunication_GetComponentByName_ReturnsInvalidOperationException()
+        {
+            //Arrange & Act
+            SW360Apicommunication sW360Apicommunication = new SW360Apicommunication(connectionSettings);
 
+            //Assert
+            Assert.ThrowsAsync<InvalidOperationException>(async () => await sW360Apicommunication.GetComponentByName(""));
+        }
         [Test]
         public void SW360Apicommunication_UpdateComponent_ReturnsInvalidOperationException()
         {

src/LCT.APICommunications.UTest/SW360ApicommunicationUTest.cs

@@ -4,6 +4,8 @@
 //  SPDX-License-Identifier: MIT
 // -------------------------------------------------------------------------------------------------------------------- 
 
+using log4net.Appender;
+using log4net.Config;
 using NUnit.Framework;
 using System;
 using System.IO;
@@ -14,6 +16,7 @@ namespace LCT.Common.UTest
     public class PipelineArtifactUploaderTests
     {
         private StringWriter consoleOutput;
+        private MemoryAppender memoryAppender;
 
         [SetUp]
         public void SetUp()
@@ -58,13 +61,19 @@ public void UploadLogs_ShouldNotUpload_WhenInUnknownEnvironment()
         {
             // Arrange
             Environment.SetEnvironmentVariable("Build_BuildId", null); // No pipeline detected
-
+            memoryAppender = new MemoryAppender();
+            BasicConfigurator.Configure(memoryAppender);
             // Act
             PipelineArtifactUploader.UploadLogs();
-            string output = consoleOutput.ToString().Trim();
+
+            string expectedlogmessage = "Uploading of logs is not supported.";
+
+            var logEvents = memoryAppender.GetEvents();
 
             // Assert
-            Assert.AreNotEqual(output, "Uploading of SBOM is not supported.");
+            Assert.IsNotEmpty(logEvents);
+            var actualLogMessage = logEvents[0].RenderedMessage;
+            Assert.AreEqual(expectedlogmessage, actualLogMessage);
         }
 
         [Test]
@@ -91,13 +100,18 @@ public void UploadBom_ShouldNotUpload_WhenInUnknownEnvironment()
         {
             // Arrange
             Environment.SetEnvironmentVariable("Build_BuildId", null); // No pipeline detected
-
+            memoryAppender = new MemoryAppender();
+            BasicConfigurator.Configure(memoryAppender);
             // Act
             PipelineArtifactUploader.UploadBom();
-            string output = consoleOutput.ToString().Trim();
+            string expectedlogmessage = "Uploading of SBOM is not supported.";
+
+            var logEvents = memoryAppender.GetEvents();
 
             // Assert
-            Assert.AreEqual(output, "Uploading of SBOM is not supported.");
+            Assert.IsNotEmpty(logEvents);
+            var actualLogMessage = logEvents[0].RenderedMessage;
+            Assert.AreEqual(expectedlogmessage, actualLogMessage);
         }
     }
 }

src/LCT.Common.UTests/PipelineArtifactUploaderTest.cs

@@ -0,0 +1,53 @@
+using Microsoft.VisualStudio.TestPlatform.Utilities;
+using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace LCT.Common.UTest
+{
+    [TestFixture]
+    public class TelemetryHelperTests
+    {
+        private TelemetryHelper telemetryHelper;
+        private CommonAppSettings appSettings;
+        private readonly StringWriter consoleOutput;
+        [SetUp]
+        public void Setup()
+        {
+            // Initialize real instances of your services
+            appSettings = new CommonAppSettings
+            {
+                Telemetry=new Telemetry { ApplicationInsightInstrumentKey= "R1WvRUkY0I6Z" },
+                SW360 = new SW360
+                {
+                    ProjectName = "ProjectName",
+                    ProjectID = "ProjectID"
+                },
+                ProjectType = "ProjectType"
+            };
+
+            // Initialize your telemetry service (this will be the class under test)
+            telemetryHelper = new TelemetryHelper(appSettings);
+        }        
+        [Test]
+        public void StartTelemetry_ShouldInitializeAndTrackEvent_WhenTelemetryIsEnabled()
+        {
+            // Arrange
+            string catoolVersion = "1.0.0";
+            var kpiData = new { Metric1 = 100, Metric2 = 200 }; // Example KPI data
+            string telemetryFor = "TestEvent";
+            var consoleOutput = new System.IO.StringWriter();
+            Console.SetOut(consoleOutput);
+            // Act
+            // This would normally start telemetry tracking in your system
+            telemetryHelper.StartTelemetry(catoolVersion, kpiData, telemetryFor);
+
+            string output = consoleOutput.ToString();
+            Assert.AreEqual(output, "");
+        }
+    }
+}

src/LCT.Common.UTests/TelemetryHelperTests.cs

@@ -115,11 +115,7 @@ public string URL
             }
             set
             {
-                if (string.IsNullOrEmpty(value))
-                {
-                    throw new ArgumentNullException($"Provide a sw360 url - {value}");
-                }
-                else
+                if (!string.IsNullOrEmpty(value))
                 {
                     m_URL = value.TrimEnd(Dataconstant.ForwardSlash);
                 }
@@ -133,7 +129,6 @@ public string ProjectName
             }
             set
             {
-                CommonHelper.CheckNullOrEmpty(nameof(ProjectName), value);
                 m_ProjectName = value;
             }
         }
@@ -145,7 +140,6 @@ public string ProjectID
             }
             set
             {
-                CommonHelper.CheckNullOrEmpty(nameof(ProjectID), value);
                 m_ProjectID = value;
             }
         }
@@ -157,8 +151,7 @@ public string Token
                 return m_Token;
             }
             set
-            {
-                CommonHelper.CheckNullOrEmpty(nameof(Token), value);
+            {                
                 m_Token = value;
             }
         }

src/LCT.Common/CommonAppSettings.cs

@@ -117,7 +117,7 @@ public static void WriteToConsoleTable(Dictionary<string, int> printData, Dictio
             Logger.Info("Summary :\n");
             if (!string.IsNullOrWhiteSpace(ProjectSummaryLink)) { Logger.Info($"{ProjectSummaryLink}"); }
             Logger.Info($"{"=",5}{string.Join("", Enumerable.Repeat("=", 88)),5}");
-            Logger.Info($"{"|",5}{Feature,70} {"|",5} {Count,5} {"|",5}");
+            Logger.Info($"{"|",5}{Feature,-70} {"|",5} {Count,5} {"|",5}");
             Logger.Info($"{"=",5}{string.Join("", Enumerable.Repeat("=", 88)),5}");
             foreach (var item in printData)
             {
@@ -253,8 +253,6 @@ public static string AddSpecificValuesToBOMFormat(Bom listOfComponentsToBom)
 
             return formattedString;
         }
-       
-      
         public static string[] GetRepoList(CommonAppSettings appSettings)
         {
             var projectTypeMappings = new Dictionary<string, Func<Artifactory>>

src/LCT.Common/CommonHelper.cs

@@ -53,5 +53,6 @@ public static class FileConstant
         public const string NugetAssetFile = "project.assets.json";
         public const string multipleversionsFileName = "Multipleversions.json";
         public const string artifactoryReportNotApproved = "ReportNotApproved.json";
+        public const string basicSBOMName = "ContinuousClearing";
     }
 }

src/LCT.Common/Constants/FileConstant.cs

@@ -42,7 +42,7 @@ public T ReadConfiguration<T>(string[] args, string jsonSettingsFileName)
             if (args?.Length == 0)
             {
                 Logger.Debug($"Argument Count : {args.Length}");
-                DisplayHelp();                
+                DisplayHelp();
                 environmentHelper.CallEnvironmentExit(0);
             }
             string settingsFilePath = GetConfigFilePathFromArgs(args, jsonSettingsFileName);
@@ -122,19 +122,28 @@ public void CheckRequiredArgsToRun(CommonAppSettings appSettings, string current
                 //Required parameters to run Package Identifier
                 List<string> identifierReqParameters = new List<string>()
                 {
-                    "SW360.ProjectID",
-                    "SW360.Token",
-                    "Jfrog.Token",
-                    "SW360.URL",
-                    "Jfrog.URL",
                     "Directory.InputFolder",
                     "Directory.OutputFolder",
                     "ProjectType"
                 };
+
+                if (appSettings.SW360 != null)
+                {
+                    identifierReqParameters.Add($"SW360.ProjectID");
+                    identifierReqParameters.Add($"SW360.Token");
+                    identifierReqParameters.Add($"SW360.URL");
+                }
+                if (appSettings.Jfrog != null)
+                {
+                    identifierReqParameters.Add($"Jfrog.Token");
+                    identifierReqParameters.Add($"Jfrog.URL");
+                }
+
+
                 //Check if ProjectType contains a value and add InternalRepos key accordingly
                 if (!string.IsNullOrWhiteSpace(appSettings.ProjectType))
                 {
-                    if (!appSettings.ProjectType.Equals("ALPINE", StringComparison.InvariantCultureIgnoreCase))
+                    if (appSettings.Jfrog != null && !appSettings.ProjectType.Equals("ALPINE", StringComparison.InvariantCultureIgnoreCase))
                     {
                         identifierReqParameters.Add($"{appSettings.ProjectType}.Artifactory.InternalRepos");
                     }
@@ -212,7 +221,7 @@ private static void CheckForMissingParameter(CommonAppSettings appSettings, Prop
             }
 
             if (!string.IsNullOrWhiteSpace(missingParameters.ToString()))
-            {                
+            {
                 ExceptionHandling.ArgumentException(missingParameters.ToString());
                 environmentHelper.CallEnvironmentExit(-1);
             }

src/LCT.Common/SettingsManager.cs

@@ -5,11 +5,11 @@
 // --------------------------------------------------------------------------------------------------------------------
 
 {
-  "TimeOut": 400,
+  "TimeOut": 400,  
   "ProjectType": "<Insert ProjectType>",
   "MultipleProjectType": false,
   "Telemetry": {
-    "Enable": true,
+    "Enable": false,
     "ApplicationInsightInstrumentKey": "" //From Application Insight to enable Telemetry
   },
   "SW360": {

src/LCT.Common/appSettings.json

@@ -8,6 +8,8 @@
 using LCT.APICommunications.Model.AQL;
 using System.Collections.Generic;
 using LCT.PackageIdentifier;
+using LCT.Common.Constants;
+using LCT.Common;
 
 namespace LCT.PackageIdentifier.UTest
 {
@@ -66,5 +68,67 @@ public void GetRepodetailsFromPerticularOrder_NoSpecificRepo_ReturnsFirstRepo()
             var result = CommonIdentiferHelper.GetRepodetailsFromPerticularOrder(aqlResults);
             Assert.AreEqual("generic-repo", result);
         }
+        [Test]
+        public void GetBomFileName_WhenBasicSBOMIsFalse_ReturnsProjectNameBomFileName()
+        {
+            // Arrange
+            var appSettings = new CommonAppSettings
+            {                
+                SW360=new SW360() { ProjectName= "TestProject" }
+            };
+
+            // Act
+            string result = CommonIdentiferHelper.GetBomFileName(appSettings);
+
+            // Assert
+            Assert.AreEqual("TestProject_Bom.cdx.json", result);
+        }
+
+        [Test]
+        public void GetBomFileName_WhenBasicSBOMIsTrue_ReturnsBasicSBOMNameBomFileName()
+        {
+            // Arrange
+            var appSettings = new CommonAppSettings
+            {
+                
+            };
+
+            // Act
+            string result = CommonIdentiferHelper.GetBomFileName(appSettings);
+
+            // Assert
+            Assert.AreEqual(FileConstant.basicSBOMName, result);
+        }
+
+        [Test]
+        public void GetDefaultProjectName_WhenBasicSBOMIsFalse_ReturnsProjectName()
+        {
+            // Arrange
+            var appSettings = new CommonAppSettings
+            {                
+                SW360 = new SW360() { ProjectName = "TestProject" }
+            };
+
+            // Act
+            string result = CommonIdentiferHelper.GetDefaultProjectName(appSettings);
+
+            // Assert
+            Assert.AreEqual("TestProject", result);
+        }
+
+        [Test]
+        public void GetDefaultProjectName_WhenBasicSBOMIsTrue_ReturnsBasicSBOMName()
+        {
+            // Arrange
+            var appSettings = new CommonAppSettings
+            {                
+            };
+
+            // Act
+            string result = CommonIdentiferHelper.GetDefaultProjectName(appSettings);
+
+            // Assert
+            Assert.AreEqual(FileConstant.basicSBOMName, result);
+        }
     }
 }