Merge pull request #68 from AikidoSec/Reported-version-fix

cleanup version before reporting to zen

Author: Yannis-S-Standaert

Aikido.Zen.Core/Helpers/AgentInfoHelper.cs

@@ -1,47 +1,59 @@
 using Aikido.Zen.Core.Models;
 using System;
+using System.Linq;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
 [assembly: InternalsVisibleTo("Aikido.Zen.Tests")]
 namespace Aikido.Zen.Core.Helpers
 {
-	/// <summary>
-	/// Helper class for retrieving agent information about the current runtime environment.
-	/// </summary>
-	internal class AgentInfoHelper
-	{
-		// Cache the AgentInfo object to avoid repeated creation
-		private static readonly AgentInfo _cachedAgentInfo = new AgentInfo
-		{
-			Hostname = Environment.MachineName,
-			Os = new Os
-			{
-				Version = Environment.OSVersion.VersionString,
-				Name = Environment.OSVersion.Platform.ToString()
-			},
-			Platform = new Platform
-			{
-				Version = Environment.Version.ToString(),
-				Arch = RuntimeInformation.ProcessArchitecture.ToString()
-			},
-			IpAddress = IPHelper.Server,
-			Library = "firewall-dotnet",
-			Version = typeof(AgentInfoHelper).Assembly.GetName().Version.ToString(),
-			// Determine if running in a serverless environment
-			Serverless = Environment.GetEnvironmentVariable("AWS_LAMBDA_FUNCTION_NAME") != null || Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID") != null
-		};
+    /// <summary>
+    /// Helper class for retrieving agent information about the current runtime environment.
+    /// </summary>
+    internal class AgentInfoHelper
+    {
+        // Cache the AgentInfo object to avoid repeated creation
+        private static readonly AgentInfo _cachedAgentInfo = new AgentInfo
+        {
+            Hostname = Environment.MachineName,
+            Os = new Os
+            {
+                Version = Environment.OSVersion.VersionString,
+                Name = Environment.OSVersion.Platform.ToString()
+            },
+            Platform = new Platform
+            {
+                Version = Environment.Version.ToString(),
+                Arch = RuntimeInformation.ProcessArchitecture.ToString()
+            },
+            IpAddress = IPHelper.Server,
+            Library = "firewall-dotnet",
+            Version = CleanVersion(typeof(AgentInfoHelper).Assembly.GetName().Version.ToString()),
+            // Determine if running in a serverless environment
+            Serverless = Environment.GetEnvironmentVariable("AWS_LAMBDA_FUNCTION_NAME") != null || Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID") != null
+        };
 
-		/// <summary>
-		/// Gets information about the current runtime environment including OS, platform, and configuration details.
-		/// </summary>
-		/// <returns>An AgentInfo object containing the environment information.</returns>
-		public static AgentInfo GetInfo()
-		{
-			// Update only the fields that can change
-			_cachedAgentInfo.DryMode = EnvironmentHelper.DryMode;
-			_cachedAgentInfo.Serverless = Environment.GetEnvironmentVariable("AWS_LAMBDA_FUNCTION_NAME") != null || Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID") != null;
+        /// <summary>
+        /// Gets information about the current runtime environment including OS, platform, and configuration details.
+        /// </summary>
+        /// <returns>An AgentInfo object containing the environment information.</returns>
+        public static AgentInfo GetInfo()
+        {
+            // Update only the fields that can change
+            _cachedAgentInfo.DryMode = EnvironmentHelper.DryMode;
+            _cachedAgentInfo.Serverless = Environment.GetEnvironmentVariable("AWS_LAMBDA_FUNCTION_NAME") != null || Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID") != null;
 
-			return _cachedAgentInfo;
-		}
-	}
+            return _cachedAgentInfo;
+        }
+
+        internal static string CleanVersion(string version)
+        {
+            // remove the build number
+            version = version.Split('+')[0];
+            // remove 4th version number, not used by nuget
+            version = string.Join(".", version.Split('.').Take(3));
+            // remove the prerelease version
+            version = version.Split('-')[0];
+            return version;
+        }
+    }
 }

Aikido.Zen.Test/AgentInfoHelperTests.cs

@@ -131,5 +131,32 @@ private void SetEnvironmentVariable(string variable, string value)
                 Environment.SetEnvironmentVariable(variable, value);
             }
         }
+
+        [Test]
+        public void CleanVersion_ShouldRemoveBuildNumber()
+        {
+            var version = "1.2.3+4";
+            var otherVersion = "1.2.3.0";
+            var cleanedVersion = AgentInfoHelper.CleanVersion(version);
+            var cleanedOtherVersion = AgentInfoHelper.CleanVersion(otherVersion);
+            Assert.That(cleanedVersion, Is.EqualTo("1.2.3"));
+            Assert.That(cleanedOtherVersion, Is.EqualTo("1.2.3"));
+        }
+
+        [Test]
+        public void CleanVersion_ShouldRemovePrereleaseVersion()
+        {
+            var version = "1.2.3-alpha";
+            var cleanedVersion = AgentInfoHelper.CleanVersion(version);
+            Assert.That(cleanedVersion, Is.EqualTo("1.2.3"));
+        }
+
+        [Test]
+        public void CleanVersion_ShouldRemoveBuildNumberAndPrereleaseVersion()
+        {
+            var version = "1.2.3+4-alpha";
+            var cleanedVersion = AgentInfoHelper.CleanVersion(version);
+            Assert.That(cleanedVersion, Is.EqualTo("1.2.3"));
+        }
     }
 }