Merge pull request #271 from Microsoft/sarif-logger-version

Populate tool.sarifLoggerVersion property.
microsoft · May 13, 2016 · e346750 · e346750
2 parents 939c28f + b36184f
commit e346750
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/src/Sarif.UnitTests/Writers/SarifLoggerTests.cs b/src/Sarif.UnitTests/Writers/SarifLoggerTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Reflection;
 using System.Text;
@@ -69,6 +70,32 @@ public void SarifLogger_RedactedCommandLine()
             }
         }
 
+        [TestMethod]
+        public void SarifLogger_WritesSarifLoggerVersion()
+        {
+            var sb = new StringBuilder();
+
+            using (var textWriter = new StringWriter(sb))
+            {
+                using (var sarifLogger = new SarifLogger(
+                    textWriter,
+                    analysisTargets: new string[] { @"foo.cpp" },
+                    verbose: false,
+                    computeTargetsHash: false,
+                    logEnvironment: false,
+                    prereleaseInfo: null,
+                    invocationTokensToRedact: null)) { }
+            }
+
+            string result = sb.ToString();
+            var sarifLog = JsonConvert.DeserializeObject<SarifLog>(result);
+
+            string sarifLoggerLocation = typeof(SarifLogger).Assembly.Location;
+            string expectedVersion = FileVersionInfo.GetVersionInfo(sarifLoggerLocation).FileVersion;
+
+            sarifLog.Runs[0].Tool.SarifLoggerVersion.Should().Be(expectedVersion);
+        }
+
         [TestMethod]
         public void SarifLogger_WritesFileData()
         {

diff --git a/src/Sarif/Autogenerated/Run.cs b/src/Sarif/Autogenerated/Run.cs
@@ -44,7 +44,7 @@ public SarifNodeKind SarifNodeKind
         public Invocation Invocation { get; set; }
 
         /// <summary>
-        /// The file that the analysis tool was instructed to scan. This member is only populated if the run is directated against a single analysis target.
+        /// The file that the analysis tool was instructed to scan. This member is only populated if the run is directed against a single analysis target.
         /// </summary>
         [DataMember(Name = "analysisTarget", IsRequired = false, EmitDefaultValue = false)]
         public PhysicalLocation AnalysisTarget { get; set; }

diff --git a/src/Sarif/Writers/SarifLogger.cs b/src/Sarif/Writers/SarifLogger.cs
@@ -150,8 +150,7 @@ public SarifLogger(
         private void SetSarifLoggerVersion(Tool tool)
         {
             string sarifLoggerLocation = typeof(SarifLogger).Assembly.Location;
-
-            tool.SetProperty("SarifLoggerVersion", FileVersionInfo.GetVersionInfo(sarifLoggerLocation).FileVersion);
+            tool.SarifLoggerVersion = FileVersionInfo.GetVersionInfo(sarifLoggerLocation).FileVersion;
         }
 
         public SarifLogger(TextWriter textWriter, bool verbose)