Provide managed CA and Embedded UI DTF libraries via NuGet

Lots of refactoring to bring the SFX tooling back into the 'dtf'
layer since they are (in the end) tightly coupled to some DTF
assemblies. Also refactored the DTF tests into their own folder
and added a couple integration tests to build using the new CA/UI
NuGet package.

Closes wixtoolset/issues#6080

1 files changed, 409 insertions, 0 deletions

diff --git a/src/dtf/test/WixToolsetTests.Dtf.WindowsInstaller/WindowsInstallerTest.cs b/src/dtf/test/WixToolsetTests.Dtf.WindowsInstaller/WindowsInstallerTest.cs
new file mode 100644
index 00000000..f994dfef
--- /dev/null
+++ b/src/dtf/test/WixToolsetTests.Dtf.WindowsInstaller/WindowsInstallerTest.cs
@@ -0,0 +1,409 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
+
+namespace WixToolset.Dtf.Test
+{
+    using System;
+    using System.IO;
+    using System.Windows.Forms;
+    using System.Globalization;
+    using System.Collections.Generic;
+    using Microsoft.VisualStudio.TestTools.UnitTesting;
+    using WixToolset.Dtf.WindowsInstaller;
+    using View = WixToolset.Dtf.WindowsInstaller.View;
+
+    [TestClass]
+    public class WindowsInstallerTest
+    {
+        public WindowsInstallerTest()
+        {
+        }
+
+        [TestInitialize()]
+        public void Initialize()
+        {
+        }
+
+        [TestCleanup()]
+        public void Cleanup()
+        {
+        }
+
+        [TestMethod]
+        [Ignore] // Currently fails.
+        public void InstallerErrorMessages()
+        {
+            string msg3002 = Installer.GetErrorMessage(3002);
+            Console.WriteLine("3002=" + msg3002);
+            Assert.IsNotNull(msg3002);
+            Assert.IsTrue(msg3002.Length > 0);
+        }
+
+        [TestMethod]
+        public void InstallerDatabaseSchema()
+        {
+            string dbFile = "InstallerDatabaseSchema.msi";
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                db.Commit();
+            }
+
+            Assert.IsTrue(File.Exists(dbFile), "Checking whether created database file " + dbFile + " exists.");
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.ReadOnly))
+            {
+                TableCollection tables = db.Tables;
+                Assert.AreEqual<int>(Schema.Tables.Count, tables.Count, "Counting tables.");
+                Assert.AreEqual<int>(Schema.Property.Columns.Count, tables["Property"].Columns.Count, "Counting columns in Property table.");
+
+                foreach (TableInfo tableInfo in tables)
+                {
+                    Console.WriteLine(tableInfo.Name);
+                    foreach (ColumnInfo columnInfo in tableInfo.Columns)
+                    {
+                        Console.WriteLine("\t{0} {1}", columnInfo.Name, columnInfo.ColumnDefinitionString);
+                    }
+                }
+            }
+        }
+
+        [TestMethod]
+        public void InstallerViewTables()
+        {
+            string dbFile = "InstallerViewTables.msi";
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                db.Commit();
+
+                using (View view1 = db.OpenView("SELECT `Property`, `Value` FROM `Property` WHERE `Value` IS NOT NULL"))
+                {
+                    IList<TableInfo> viewTables = view1.Tables;
+                    Assert.IsNotNull(viewTables);
+                    Assert.AreEqual<int>(1, viewTables.Count);
+                    Assert.AreEqual<String>("Property", viewTables[0].Name);
+                }
+
+                using (View view2 = db.OpenView("INSERT INTO `Property` (`Property`, `Value`) VALUES ('TestViewTables', 1)"))
+                {
+                    IList<TableInfo> viewTables = view2.Tables;
+                    Assert.IsNotNull(viewTables);
+                    Assert.AreEqual<int>(1, viewTables.Count);
+                    Assert.AreEqual<String>("Property", viewTables[0].Name);
+                }
+
+                using (View view3 = db.OpenView("UPDATE `Property` SET `Value` = 2 WHERE `Property` = 'TestViewTables'"))
+                {
+                    IList<TableInfo> viewTables = view3.Tables;
+                    Assert.IsNotNull(viewTables);
+                    Assert.AreEqual<int>(1, viewTables.Count);
+                    Assert.AreEqual<String>("Property", viewTables[0].Name);
+                }
+
+                using (View view4 = db.OpenView("alter table Property hold"))
+                {
+                    IList<TableInfo> viewTables = view4.Tables;
+                    Assert.IsNotNull(viewTables);
+                    Assert.AreEqual<int>(1, viewTables.Count);
+                    Assert.AreEqual<String>("Property", viewTables[0].Name);
+                }
+            }
+        }
+
+        [TestMethod]
+        public void InstallerInstallProduct()
+        {
+            string dbFile = "InstallerInstallProduct.msi";
+            string productCode;
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                WindowsInstallerUtils.CreateTestProduct(db);
+
+                productCode = db.ExecuteStringQuery("SELECT `Value` FROM `Property` WHERE `Property` = 'ProductCode'")[0];
+
+                db.Commit();
+            }
+
+            ProductInstallation installation = new ProductInstallation(productCode);
+            Assert.IsFalse(installation.IsInstalled, "Checking that product is not installed before starting.");
+
+            Installer.SetInternalUI(InstallUIOptions.Silent);
+            ExternalUIHandler prevHandler = Installer.SetExternalUI(WindowsInstallerTest.ExternalUILogger,
+                InstallLogModes.FatalExit |
+                InstallLogModes.Error |
+                InstallLogModes.Warning |
+                InstallLogModes.User |
+                InstallLogModes.Info |
+                InstallLogModes.ResolveSource |
+                InstallLogModes.OutOfDiskSpace |
+                InstallLogModes.ActionStart |
+                InstallLogModes.ActionData |
+                InstallLogModes.CommonData |
+                InstallLogModes.Progress |
+                InstallLogModes.Initialize |
+                InstallLogModes.Terminate |
+                InstallLogModes.ShowDialog);
+            Assert.IsNull(prevHandler, "Checking that returned previous UI handler is null.");
+
+            Exception caughtEx = null;
+            try
+            {
+                Installer.InstallProduct(dbFile, String.Empty);
+            }
+            catch (Exception ex) { caughtEx = ex; }
+            Assert.IsNull(caughtEx, "Exception thrown while installing product: " + caughtEx);
+
+            prevHandler = Installer.SetExternalUI(prevHandler, InstallLogModes.None);
+            Assert.AreEqual<ExternalUIHandler>(WindowsInstallerTest.ExternalUILogger, prevHandler, "Checking that previously-set UI handler is returned.");
+
+            Assert.IsTrue(installation.IsInstalled, "Checking that product is installed.");
+            Console.WriteLine();
+            Console.WriteLine();
+            Console.WriteLine();
+            Console.WriteLine("===================================================================");
+            Console.WriteLine();
+            Console.WriteLine();
+            Console.WriteLine();
+
+            ExternalUIRecordHandler prevRecHandler = Installer.SetExternalUI(WindowsInstallerTest.ExternalUIRecordLogger,
+                InstallLogModes.FatalExit |
+                InstallLogModes.Error |
+                InstallLogModes.Warning |
+                InstallLogModes.User |
+                InstallLogModes.Info |
+                InstallLogModes.ResolveSource |
+                InstallLogModes.OutOfDiskSpace |
+                InstallLogModes.ActionStart |
+                InstallLogModes.ActionData |
+                InstallLogModes.CommonData |
+                InstallLogModes.Progress |
+                InstallLogModes.Initialize |
+                InstallLogModes.Terminate |
+                InstallLogModes.ShowDialog);
+            Assert.IsNull(prevRecHandler, "Checking that returned previous UI record handler is null.");
+
+            try
+            {
+                Installer.InstallProduct(dbFile, "REMOVE=All");
+            }
+            catch (Exception ex) { caughtEx = ex; }
+            Assert.IsNull(caughtEx, "Exception thrown while installing product: " + caughtEx);
+
+            Assert.IsFalse(installation.IsInstalled, "Checking that product is not installed after removing.");
+
+            prevRecHandler = Installer.SetExternalUI(prevRecHandler, InstallLogModes.None);
+            Assert.AreEqual<ExternalUIRecordHandler>(WindowsInstallerTest.ExternalUIRecordLogger, prevRecHandler, "Checking that previously-set UI record handler is returned.");
+        }
+
+        public static MessageResult ExternalUILogger(
+            InstallMessage messageType,
+            string message,
+            MessageButtons buttons,
+            MessageIcon icon,
+            MessageDefaultButton defaultButton)
+        {
+            Console.WriteLine("{0}: {1}", messageType, message);
+            return MessageResult.None;
+        }
+
+        public static MessageResult ExternalUIRecordLogger(
+            InstallMessage messageType,
+            Record messageRecord,
+            MessageButtons buttons,
+            MessageIcon icon,
+            MessageDefaultButton defaultButton)
+        {
+            if (messageRecord != null)
+            {
+                if (messageRecord.FormatString.Length == 0 && messageRecord.FieldCount > 0)
+                {
+                    messageRecord.FormatString = "1: [1]   2: [2]   3: [3]   4: [4]  5: [5]";
+                }
+                Console.WriteLine("{0}: {1}", messageType, messageRecord.ToString());
+            }
+            else
+            {
+                Console.WriteLine("{0}: (null)", messageType);
+            }
+            return MessageResult.None;
+        }
+
+        [TestMethod]
+        [Ignore] // Currently fails.
+        public void InstallerMessageResources()
+        {
+            string message1101 = Installer.GetErrorMessage(1101);
+            Console.WriteLine("Message 1101: " + message1101);
+            Assert.IsNotNull(message1101);
+            Assert.IsTrue(message1101.Contains("file"));
+            
+            message1101 = Installer.GetErrorMessage(1101, CultureInfo.GetCultureInfo(1033));
+            Console.WriteLine("Message 1101: " + message1101);
+            Assert.IsNotNull(message1101);
+            Assert.IsTrue(message1101.Contains("file"));
+
+            string message2621 = Installer.GetErrorMessage(2621);
+            Console.WriteLine("Message 2621: " + message2621);
+            Assert.IsNotNull(message2621);
+            Assert.IsTrue(message2621.Contains("DLL"));
+
+            string message3002 = Installer.GetErrorMessage(3002);
+            Console.WriteLine("Message 3002: " + message3002);
+            Assert.IsNotNull(message3002);
+            Assert.IsTrue(message3002.Contains("sequencing"));
+        }
+
+        [TestMethod]
+        public void EnumComponentQualifiers()
+        {
+            foreach (ComponentInstallation comp in ComponentInstallation.AllComponents)
+            {
+                bool qualifiers = false;
+                foreach (ComponentInstallation.Qualifier qualifier in comp.Qualifiers)
+                {
+                    if (!qualifiers)
+                    {
+                        Console.WriteLine(comp.Path);
+                        qualifiers = true;
+                    }
+
+                    Console.WriteLine("\t{0}: {1}", qualifier.QualifierCode, qualifier.Data);
+                }
+            }
+        }
+
+        [TestMethod]
+        public void DeleteRecord()
+        {
+            string dbFile = "DeleteRecord.msi";
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                WindowsInstallerUtils.CreateTestProduct(db);
+
+                string query = "SELECT `Property`, `Value` FROM `Property` WHERE `Property` = 'UpgradeCode'";
+
+                using (View view = db.OpenView(query))
+                {
+                    view.Execute();
+
+                    Record rec = view.Fetch();
+
+                    Console.WriteLine("Calling ToString() : " + rec);
+
+                    view.Delete(rec);
+                }
+
+                Assert.AreEqual(0, db.ExecuteStringQuery(query).Count);
+            }
+        }
+
+        [TestMethod]
+        public void InsertRecordThenTryFormatString()
+        {
+            string dbFile = "InsertRecordThenTryFormatString.msi";
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                WindowsInstallerUtils.CreateTestProduct(db);
+
+                string parameterFormatString = "[1]";
+                string[] properties = new string[]
+                {
+                    "SonGoku", "Over 9000",
+                };
+
+                string query = "SELECT `Property`, `Value` FROM `Property`";
+
+                using (View view = db.OpenView(query))
+                {
+                    using (Record rec = new Record(2))
+                    {
+                        rec[1] = properties[0];
+                        rec[2] = properties[1];
+                        rec.FormatString = parameterFormatString;
+                        Console.WriteLine("Format String before inserting: " + rec.FormatString);
+                        view.Insert(rec);
+
+                        Console.WriteLine("Format String after inserting: " + rec.FormatString);
+                        // After inserting, the format string is invalid.
+                        Assert.AreEqual(String.Empty, rec.ToString());
+
+                        // Setting the format string manually makes it valid again.
+                        rec.FormatString = parameterFormatString;
+                        Assert.AreEqual(properties[0], rec.ToString());
+                    }
+                }
+            }
+        }
+
+        [TestMethod]
+        public void SeekRecordThenTryFormatString()
+        {
+            string dbFile = "SeekRecordThenTryFormatString.msi";
+
+            using (Database db = new Database(dbFile, DatabaseOpenMode.CreateDirect))
+            {
+                WindowsInstallerUtils.InitializeProductDatabase(db);
+                WindowsInstallerUtils.CreateTestProduct(db);
+
+                string parameterFormatString = "[1]";
+                string[] properties = new string[]
+                {
+                    "SonGoku", "Over 9000",
+                };
+
+                string query = "SELECT `Property`, `Value` FROM `Property`";
+
+                using (View view = db.OpenView(query))
+                {
+                    using (Record rec = new Record(2))
+                    {
+                        rec[1] = properties[0];
+                        rec[2] = properties[1];
+                        rec.FormatString = parameterFormatString;
+                        Console.WriteLine("Record fields before seeking: " + rec[0] + " " + rec[1] + " " + rec[2]);
+                        view.Seek(rec);
+
+                        //TODO: Why does view.Seek remove the record fields?
+                        Console.WriteLine("Record fields after seeking: " + rec[0] + " " + rec[1] + " " + rec[2]);
+                        // After inserting, the format string is invalid.
+                        Assert.AreEqual(String.Empty, rec.ToString());
+                    }
+                }
+            }
+        }
+        
+        [TestMethod]
+        public void TestToString()
+        {
+            string defaultString = "1:  ";
+            string vegetaShout = "It's OVER 9000!!";
+            string gokuPowerLevel = "9001";
+            string nappaInquiry = "Vegeta, what's the Scouter say about his power level?";
+            string parameterFormatString = "[1]";
+
+            Record rec = new Record(1);
+            Assert.AreEqual(defaultString, rec.ToString(), "Testing default FormatString");
+
+            rec.FormatString = String.Empty;
+            Assert.AreEqual(defaultString, rec.ToString(), "Explicitly set the FormatString to the empty string.");
+
+            rec.FormatString = vegetaShout;
+            Assert.AreEqual(vegetaShout, rec.ToString(), "Testing text only (empty FormatString)");
+
+            rec.FormatString = gokuPowerLevel;
+            Assert.AreEqual(gokuPowerLevel, rec.ToString(), "Testing numbers only from a record that wasn't fetched.");
+
+            Record rec2 = new Record(nappaInquiry);
+            rec2.FormatString = parameterFormatString;
+            Assert.AreEqual(nappaInquiry, rec2.ToString(), "Testing text with a FormatString set.");
+        }
+    }
+}