Merge pull request #773 from Excel-DNA/PackPdb

Added support for ExcelAddInIncludePdb project property

Author: govert

Package/ExcelDna.AddIn/build/ExcelDna.AddIn.targets

@@ -265,6 +265,7 @@
 	  ExplicitRegistration="$(ExcelAddInExplicitRegistration)"
 		ComServer="$(ExcelAddInComServer)"
 		LoadFromBytes="$(ExcelAddInLoadFromBytes)"
+		IncludePdb="$(ExcelAddInIncludePdb)"
 	  IntegrationDllPath="$(ExcelDnaRuntimeToolsPath)ExcelDna.Integration.dll"
 	  TemplateDnaPath="$(MSBuildThisFileDirectory)..\content\ExcelDna-Template.dna">
       <Output TaskParameter="DnaFilesToPack" ItemName="ExcelDnaFilesToPack" />

Source/ExcelDna.AddIn.Tasks/CreateExcelAddIn.cs

@@ -390,8 +390,9 @@ private string GetDefaultDnaText()
             if (!string.IsNullOrWhiteSpace(AddInInclude))
             {
                 string includes = "";
+                string IncludePdbValue = IncludePdb ? "true" : "false";
                 foreach (string path in SplitDlls(AddInInclude))
-                    includes += $"  <Reference Path=\"{path}\" Pack=\"true\" />" + Environment.NewLine;
+                    includes += $"  <Reference Path=\"{path}\" Pack=\"true\" IncludePdb=\"{IncludePdbValue}\" />" + Environment.NewLine;
                 result = result.Replace("</DnaLibrary>", includes + "</DnaLibrary>");
             }
 
@@ -473,6 +474,9 @@ private string UpdateExternalLibrary(string template, string dllFileName)
             if (!LoadFromBytes)
                 result = result.Replace("LoadFromBytes=\"true\"", "LoadFromBytes=\"false\"");
 
+            if (IncludePdb)
+                result = result.Replace("IncludePdb=\"false\"", "IncludePdb=\"true\"");
+
             return result.Replace("%OutputFileName%", dllFileName);
         }
 
@@ -800,6 +804,11 @@ public string FileSuffix64Bit
         /// </summary>
         public bool LoadFromBytes { get; set; }
 
+        /// <summary>
+        /// Enable/disable including pdb files in packed add-in
+        /// </summary>
+        public bool IncludePdb { get; set; }
+
         /// <summary>
         /// The list of .dna files copied to the output
         /// </summary>

Source/Tests/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget.sln

@@ -132,6 +132,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NET8RuntimeFrameworkVersion
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NET8.Dna", "NET8.Dna\NET8.Dna.csproj", "{33B20965-1561-1FF1-FA16-5B5CCFB3D171}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NET6PackPdb", "NET6PackPdb\NET6PackPdb.csproj", "{153C8664-D61C-77D7-A300-8CED54D130EA}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -394,6 +396,10 @@ Global
 		{33B20965-1561-1FF1-FA16-5B5CCFB3D171}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{33B20965-1561-1FF1-FA16-5B5CCFB3D171}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{33B20965-1561-1FF1-FA16-5B5CCFB3D171}.Release|Any CPU.Build.0 = Release|Any CPU
+		{153C8664-D61C-77D7-A300-8CED54D130EA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{153C8664-D61C-77D7-A300-8CED54D130EA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{153C8664-D61C-77D7-A300-8CED54D130EA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{153C8664-D61C-77D7-A300-8CED54D130EA}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

Source/Tests/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget/NET6PackPdb/AddIn.cs

@@ -0,0 +1,27 @@
+using System;
+using System.IO;
+using System.Runtime.InteropServices;
+using System.Windows.Forms;
+using ExcelDna.Integration;
+
+namespace NET6PackPdb
+{
+    public class AddIn : IExcelAddIn
+    {
+        public void AutoOpen()
+        {
+            var thisAddInName = Path.GetFileName((string)XlCall.Excel(XlCall.xlGetName));
+            var message = string.Format("Excel-DNA Add-In '{0}' loaded!", thisAddInName);
+
+            message += Environment.NewLine;
+            message += Environment.NewLine;
+            message += CallStackLibrary.Class1.GetCallStack();
+
+            MessageBox.Show(message, thisAddInName, MessageBoxButtons.OK, MessageBoxIcon.Information);
+        }
+
+        public void AutoClose()
+        {
+        }
+    }
+}

Source/Tests/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget/NET6PackPdb/CallStackLibrary.dll

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0-windows</TargetFramework>
+    <UseWindowsForms>True</UseWindowsForms>
+
+    <ExcelAddInIncludePdb>True</ExcelAddInIncludePdb>
+    <ExcelAddInInclude>CallStackLibrary.dll</ExcelAddInInclude>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Reference Include="CallStackLibrary">
+      <HintPath>CallStackLibrary.dll</HintPath>
+    </Reference>
+    <Reference Include="ExcelDna.Integration">
+      <HintPath>..\..\.exceldna.addin\tools\net6.0-windows7.0\ExcelDna.Integration.dll</HintPath>
+    </Reference>
+  </ItemGroup>
+
+  <Import Project="$(ProjectDir)..\..\.exceldna.addin\build\ExcelDna.AddIn.targets" />
+
+</Project>

Source/Tests/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget/NET6PackPdb/CallStackLibrary.pdb

@@ -177,6 +177,10 @@
     <!-- Default value: true -->
     <ExcelAddInLoadFromBytes></ExcelAddInLoadFromBytes>
 
+    <!-- Enable/disable including pdb files in packed add-in. -->
+    <!-- Default value: false -->
+    <ExcelAddInIncludePdb></ExcelAddInIncludePdb>
+
     <!-- We don't need the extra 'ref' directory and reference assemblies for the Excel add-in -->
     <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
 

Source/Tests/ExcelDna.AddIn.Tasks.IntegrationTests.TestTarget/NET6PackPdb/NET6PackPdb.csproj

@@ -0,0 +1,23 @@
+using NUnit.Framework;
+using System.IO;
+
+namespace ExcelDna.AddIn.Tasks.IntegrationTests
+{
+    [TestFixture]
+    public class NET6PackPdbTests : IntegrationTestBase
+    {
+        [Test]
+        public void NET6PackPdbTest()
+        {
+            const string projectBasePath = @"NET6PackPdb\";
+            const string projectOutDir = projectBasePath + @"bin\Release\";
+
+            Clean(projectOutDir);
+
+            MsBuild(projectBasePath + "NET6PackPdb.csproj /t:Restore,Build /p:Configuration=Release /v:m " + MsBuildParam("OutputPath", @"bin\Release\"));
+
+            AssertFileContains(Path.Combine(projectOutDir, "NET6PackPdb-AddIn64.dna"), "ExternalLibrary Path=\"NET6PackPdb.dll\" ExplicitExports=\"false\" LoadFromBytes=\"false\" Pack=\"true\" IncludePdb=\"true\"");
+            AssertFileContains(Path.Combine(projectOutDir, "NET6PackPdb-AddIn64.dna"), "Reference Path=\"CallStackLibrary.dll\" Pack=\"true\" IncludePdb=\"true\"");
+        }
+    }
+}