Merge pull request #123 from mslukebo/user/lukebo/aboutInfo

mslukebo · web-flow · commit 2fd34171197f · 2024-06-04T15:20:28.000-07:00
Include required properties on all ProcessingSourceInfo instances returned by processing sources
diff --git a/LTTngCds/LTTngCds.csproj b/LTTngCds/LTTngCds.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.3.0</Version>
+	<Version>1.3.1</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>
@@ -33,6 +33,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\CtfPlayback\CtfPlayback.csproj" />
+    <ProjectReference Include="..\Utilities\Utilities.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/LTTngCds/LTTngDataSource.cs b/LTTngCds/LTTngDataSource.cs
@@ -7,6 +7,7 @@
 using System.Linq;
 using Microsoft.Performance.SDK;
 using Microsoft.Performance.SDK.Processing;
+using Utilities;
 
 namespace LTTngCds
 {
@@ -22,7 +23,7 @@ public class LTTngDataSource
         private IApplicationEnvironment applicationEnvironment;
 
         /// <inheritdoc />
-        public override IEnumerable<Option> CommandLineOptions => new List<Option> { new Option("LTTngOffsetTime", "offsetTime", 1, 1) };
+        public override IEnumerable<Option> CommandLineOptions => new List<Option> { new Option("LTTngOffsetTime", "offsetTime", 1, 1) };
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
         {
@@ -36,23 +37,23 @@ protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            info.CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year;
+            info.AdditionalInformation = new[]
             {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-                CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year,
-                AdditionalInformation = new[]
-                {
-                    "Built using Antlr 4\n" +
-                    "Copyright (c) 2012 Terence Parr and Sam Harwell\n" +
-                    "All rights reserved.\n" +
-                    "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n" +
-                    "\n" +
-                    "Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n" +
-                    "Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n" +
-                    "Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.\n" +
-                    "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
-                },
+                "Built using Antlr 4\n" +
+                "Copyright (c) 2012 Terence Parr and Sam Harwell\n" +
+                "All rights reserved.\n" +
+                "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:\n" +
+                "\n" +
+                "Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.\n" +
+                "Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.\n" +
+                "Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.\n" +
+                "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
             };
+
+            return info;
         }
 
         /// <inheritdoc />
diff --git a/LTTngDataExtensions/LTTngDataExtensions.csproj b/LTTngDataExtensions/LTTngDataExtensions.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.3.0</Version>
+	<Version>1.3.1</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>
@@ -72,8 +72,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="pluginManifest.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    <None Update="pluginManifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Update="Resources\DiskActivityPrebuiltConfiguration.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
diff --git a/LTTngDataExtensions/pluginManifest.json b/LTTngDataExtensions/pluginManifest.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/microsoft-performance-toolkit-sdk/main/src/PluginsSystem/Tools/Microsoft.Performance.Toolkit.Plugins.Cli/Manifest/PluginManifestSchema.json",
   "identity": {
     "id": "Microsoft.Performance.Toolkit.Plugins.LTTngDataExtensions",
-    "version": "1.3.0"
+    "version": "1.3.1"
   },
   "displayName": "Linux - LTTng",
   "description": "Enables processing LTTng performance trace files that contain key Linux performance indicators, such as kernel CPU scheduling, system calls, file events, and userspace applications",
diff --git a/PerfDataExtension/PerfDataExtension.csproj b/PerfDataExtension/PerfDataExtension.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <OutputType>Library</OutputType>
-    <Version>0.1.2</Version>
+    <Version>0.1.3</Version>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft</Company>
@@ -59,6 +59,10 @@
     </Compile>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\Utilities\Utilities.csproj" />
+  </ItemGroup>
+
   <Target Name="CopyToTargetDirTarget" AfterTargets="Build">
     <Copy SourceFiles="@(CopyToTargetDir)" DestinationFolder="$(TargetDir)" />
   </Target>
diff --git a/PerfDataExtension/PerfDataProcessingSource.cs b/PerfDataExtension/PerfDataProcessingSource.cs
@@ -1,6 +1,8 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using Utilities;
+
 namespace Microsoft.Performance.Toolkit.Plugins.PerfDataExtension
 {
     using Microsoft.LinuxTracepoints.Decode;
@@ -21,13 +23,14 @@ public sealed class PerfDataProcessingSource
     {
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo
-            {
-                CopyrightNotice = "Copyright (c) Microsoft Corporation. All rights reserved.",
-                LicenseInfo = new LicenseInfo { Name = "MIT" },
-                Owners = Array.Empty<ContactInfo>(),
-                ProjectInfo = new ProjectInfo { Uri = "https://github.com/microsoft/LinuxTracepoints-Net" },
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+
+            info.CopyrightNotice = "Copyright (c) Microsoft Corporation. All rights reserved.";
+            info.LicenseInfo = new LicenseInfo { Name = "MIT" };
+            info.Owners = Array.Empty<ContactInfo>();
+            info.ProjectInfo = new ProjectInfo { Uri = "https://github.com/microsoft/LinuxTracepoints-Net" };
+
+            return info;
         }
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
diff --git a/PerfDataExtension/pluginManifest.json b/PerfDataExtension/pluginManifest.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/microsoft-performance-toolkit-sdk/main/src/PluginsSystem/Tools/Microsoft.Performance.Toolkit.Plugins.Cli/Manifest/PluginManifestSchema.json",
   "identity": {
     "id": "Microsoft.Performance.Toolkit.Plugins.PerfDataExtension",
-    "version": "0.1.2"
+    "version": "0.1.3"
   },
   "displayName": "Linux - Perf",
   "description": "Enables loading Linux events from perf.data files (e.g. generated by the perf tool)",
diff --git a/PerfDataTxtExtension/PerfDataTxtExtension.csproj b/PerfDataTxtExtension/PerfDataTxtExtension.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.2.3</Version>
+	<Version>1.2.5</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>
@@ -60,8 +60,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <None Update="pluginManifest.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    <None Update="pluginManifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Update="Resources\DiskActivityPrebuiltConfiguration.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
diff --git a/PerfDataTxtExtension/SourceDataCookers/PerfDataProcessingSource.cs b/PerfDataTxtExtension/SourceDataCookers/PerfDataProcessingSource.cs
@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using Microsoft.Performance.SDK.Processing;
+using Utilities;
 
 namespace PerfDataProcessingSource
 {
@@ -44,10 +45,9 @@ public class PerfDataProcessingSource
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
-            {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            return info;
         }
 
         protected override void SetApplicationEnvironmentCore(IApplicationEnvironment applicationEnvironment)
diff --git a/PerfDataTxtExtension/pluginManifest.json b/PerfDataTxtExtension/pluginManifest.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/microsoft-performance-toolkit-sdk/main/src/PluginsSystem/Tools/Microsoft.Performance.Toolkit.Plugins.Cli/Manifest/PluginManifestSchema.json",
   "identity": {
     "id": "Microsoft.Performance.Toolkit.Plugins.PerfDataTxtExtension",
-    "version": "1.2.4"
+    "version": "1.2.5"
   },
   "displayName": "Linux - Perf",
   "description": "Enables viewing Linux CPU Sampling events recorded with the kernel perf profiling utility",
diff --git a/PerfettoCds/PerfettoCds.csproj b/PerfettoCds/PerfettoCds.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.5.5</Version>
+	<Version>1.5.6</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>
@@ -50,10 +50,10 @@
       <PackagePath></PackagePath>
     </None>
   </ItemGroup>
-  <ItemGroup>
-    <None Update="pluginManifest.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
+  <ItemGroup>
+    <None Update="pluginManifest.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
   <Target Name="CopyRulesToTarget" AfterTargets="Build">
diff --git a/PerfettoCds/Pipeline/PerfettoDataSource.cs b/PerfettoCds/Pipeline/PerfettoDataSource.cs
@@ -5,13 +5,14 @@
 using System.IO;
 using System.Linq;
 using Microsoft.Performance.SDK.Processing;
+using Utilities;
 
 namespace PerfettoCds
 {
-    public static class PerfettoCds
-    {
-        public static string[] PerfettoCopyrightLicense = new string[]
-        {
+    public static class PerfettoCds
+    {
+        public static string[] PerfettoCopyrightLicense = new string[]
+        {
             "Built using Google Perfetto 4\n" +
             "Copyright (C) 2020 The Android Open Source Project\n" +
             "\n" +
@@ -25,8 +26,8 @@ public static class PerfettoCds
             "distributed under the License is distributed on an \"AS IS\" BASIS,\n" +
             "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n" +
             "See the License for the specific language governing permissions and\n" +
-            "limitations under the License.\n"
-        };
+            "limitations under the License.\n"
+        };
     }
 
     [ProcessingSource("9fc8515e-9206-4690-b14a-3e7b54745c5f", "PerfettoTraceDataSource", "Processes Perfetto trace files")]
@@ -47,12 +48,13 @@ protected override ICustomDataProcessor CreateProcessorCore(IEnumerable<IDataSou
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
-            {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-                CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year,
-                AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense,
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            info.CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year;
+            info.AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense;
+
+            return info;
         }
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
@@ -91,12 +93,13 @@ protected override ICustomDataProcessor CreateProcessorCore(IEnumerable<IDataSou
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
-            {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-                CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year,
-                AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense,
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            info.CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year;
+            info.AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense;
+
+            return info;
         }
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
@@ -135,12 +138,13 @@ protected override ICustomDataProcessor CreateProcessorCore(IEnumerable<IDataSou
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
-            {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-                CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year,
-                AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense,
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            info.CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year;
+            info.AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense;
+
+            return info;
         }
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
@@ -179,12 +183,13 @@ protected override ICustomDataProcessor CreateProcessorCore(IEnumerable<IDataSou
 
         public override ProcessingSourceInfo GetAboutInfo()
         {
-            return new ProcessingSourceInfo()
-            {
-                ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },
-                CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year,
-                AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense,
-            };
+            var info = ProcessingSourceInfoGenerator.GetEmpty();
+
+            info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };
+            info.CopyrightNotice = "Copyright (C) " + DateTime.UtcNow.Year;
+            info.AdditionalInformation = PerfettoCds.PerfettoCopyrightLicense;
+
+            return info;
         }
 
         protected override bool IsDataSourceSupportedCore(IDataSource dataSource)
diff --git a/PerfettoCds/pluginManifest.json b/PerfettoCds/pluginManifest.json
@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/microsoft-performance-toolkit-sdk/main/src/PluginsSystem/Tools/Microsoft.Performance.Toolkit.Plugins.Cli/Manifest/PluginManifestSchema.json",
   "identity": {
     "id": "Microsoft.Performance.Toolkit.Plugins.PerfettoPlugin",
-    "version": "1.5.5"
+    "version": "1.5.6"
   },
   "displayName": "Perfetto for Android and Chromium",
   "description": "Processes Android system and user traces, as well as Chromium based browser performance trace files",
diff --git a/PerfettoProcessor/PerfettoProcessor.csproj b/PerfettoProcessor/PerfettoProcessor.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	  <Version>1.5.5</Version>
+	  <Version>1.5.6</Version>
       <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
       <Authors>Microsoft</Authors>
       <Company>Microsoft Corp.</Company>
diff --git a/Utilities/ProcessingSourceInfoGenerator.cs b/Utilities/ProcessingSourceInfoGenerator.cs
@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using Microsoft.Performance.SDK.Processing;
+
+namespace Utilities
+{
+    public static class ProcessingSourceInfoGenerator
+    {
+        public static ProcessingSourceInfo GetEmpty()
+        {
+            return new ProcessingSourceInfo()
+            {
+                Owners = Array.Empty<ContactInfo>(),
+                ProjectInfo = null,
+                LicenseInfo = null,
+                CopyrightNotice = null,
+                AdditionalInformation = Array.Empty<string>(),
+            };
+        }
+    }
+}
diff --git a/Utilities/Utilities.csproj b/Utilities/Utilities.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
-	<Version>1.2.2</Version>
+	<Version>1.2.3</Version>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <Authors>Microsoft</Authors>
     <Company>Microsoft Corp.</Company>

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using System.IO;`
`7`	`7`	`using System.Linq;`
`8`	`8`	`using Microsoft.Performance.SDK.Processing;`
	`9`	`+using Utilities;`
`9`	`10`
`10`	`11`	`namespace PerfDataProcessingSource`
`11`	`12`	`{`
`@@ -44,10 +45,9 @@ public class PerfDataProcessingSource`
`44`	`45`
`45`	`46`	`public override ProcessingSourceInfo GetAboutInfo()`
`46`	`47`	`{`
`47`		`- return new ProcessingSourceInfo()`
`48`		`- {`
`49`		`- ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" },`
`50`		`- };`
	`48`	`+ var info = ProcessingSourceInfoGenerator.GetEmpty();`
	`49`	`+ info.ProjectInfo = new ProjectInfo() { Uri = "https://aka.ms/linuxperftools" };`
	`50`	`+ return info;`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`protected override void SetApplicationEnvironmentCore(IApplicationEnvironment applicationEnvironment)`