Как извлечь данные (количество файлов) из таблицы MSI «Файл»

Question

В нашем процессе сборки в настоящее время существует вероятность того, что файлы, не основанные на коде (например, файлы изображений), могут быть добавлены в наш веб-проект, но не включены в установщик MSI, созданный WiX.

Чтобы предотвратить это, я хочу выполнить следующее в цели AfterBuild для нашего проекта WiX:

• Получить количество всех созданных файлов (выходные данные проекта веб-развертывания)
• Получите количество всех файлов, встроенных в MSI (из таблицы «Файл» в MSI).
• Сравните счетчики и завершите сборку неудачно, если они не совпадают.

Если я запущу Orca, я смогу легко увидеть таблицу файлов и посчитать ее, но я не знаю, как автоматизировать это из MSBuild.Есть ли какой-то API или другой механизм для получения этой информации из MSI?

Я не против написать специальную задачу MSBuild для извлечения количества таблиц файлов MSI.

Answer 1

Создайте новый проект Visual Studio, добавьте ссылку на c:\windows\system32\msi.dll и используйте следующий код, чтобы прочитать количество файлов в файле MSI:

Type installerType = Type.GetTypeFromProgID("WindowsInstaller.Installer");
var installer =
   (WindowsInstaller.Installer)Activator.CreateInstance(installerType);
var msi = installer.OpenDatabase(@"path\to\some\file.msi", 0);
var fileView = msi.OpenView("SELECT FileName FROM File");
fileView.Execute(null);
int fileCount = 0;
while (fileView.Fetch() != null)
{
   fileCount++;
}
Console.WriteLine(fileCount);

Этот код использует WindowsInstaller.Installer COM-объект, который является точкой входа для API автоматизации установщика Windows.Взгляните на полная справочная документация.

редактировать:очевидно, Wix поставляется с управляемыми сборками (в C:\program files\Windows Installer XML v3\sdk), которые обертывают msi.dll.Я думаю, именно это Роб имеет в виду под «DTF» в своем ответе.Использование типов в сборке Microsoft.Deployment.WindowsInstaller и пространстве имен упростит пример кода до следующего:

var database = new Database(@"\path\to\some\file.msi");
var list = database.ExecuteQuery("SELECT FileName FROM File");
Console.WriteLine(list.Count);

Answer 2

Файлы MSI представляют собой маленькие базы данных со специальным механизмом SQL.Вам просто нужно запустить запрос:

SELECT `File` FROM `File` 

и подсчитайте количество возвращающихся строк.Самый простой способ интеграции в задачу MSBuild, вероятно, — использовать DTF WiX, который предоставляет управляемые оболочки для всех API-интерфейсов MSI.

Решение будет очень простым, если вы подготовите все инструменты.

Answer 3

Поскольку существует несколько способов реализовать это, я отвечаю на свой вопрос результатами, которые сейчас использую, благодаря ответам Вкоенена и Роба.

Это пользовательская задача MSBuild:

public class VerifyMsiFileCount : Task
{
    [Required]
    public string MsiFile { get; set; }

    [Required]
    public string Directory { get; set; }

    public override bool Execute()
    {
       Database database = new Database(MsiFile, DatabaseOpenMode.ReadOnly);
        IList msiFiles = database.ExecuteQuery("SELECT FileName FROM File", new Record(0));
        IList<string> files = new List<string>(
            System.IO.Directory.GetFiles(Directory, "*", SearchOption.AllDirectories));
        return compareContents(msiFiles, files);
    }

    bool compareContents(IList msiFiles, IList<string> files)
    {
        // Always false if count mismatch, but helpful to know which file(s) are missing
        bool result = msiFiles.Count == files.Count;

        StringBuilder sb = new StringBuilder(msiFiles.Count);
        foreach (string msiFile in msiFiles)
        {
            sb.AppendLine(msiFile.ToUpper());
        }
        string allMsiFiles = sb.ToString();

        // Could be optimized using regex - each non-matched line in allMsiFiles
        string filename;
        foreach (string file in files)
        {
            filename = file.ToUpper();
            // Strip directory as File table in MSI does funky things with directory prefixing
            if (filename.Contains(Path.DirectorySeparatorChar.ToString()))
            {
                filename = filename.Substring(file.LastIndexOf(Path.DirectorySeparatorChar) + 1);
            }
            if (!allMsiFiles.Contains(filename))
            {
                result = false;
                MSBuildHelper.Log(this, file + " appears to be missing from MSI File table",
                    MessageImportance.High);
            }
        }
        return result;
    }
}

Несколько вещей, на которые стоит обратить внимание:

• Я пропустил документацию для краткости.
• MSBuildHelper.Log — это простая оболочка для ITask.BuildEngine.LogMessageEvent, позволяющая перехватывать исключение NullReferenceException при выполнении модульных тестов.
• Еще есть возможности для улучшения, например.использование ITaskItem вместо строки для свойств и регулярного выражения для сравнения.
• Логика сравнения может выглядеть немного странно, но таблица файлов делает некоторые странные вещи с префиксом каталога, и я также хотел избежать крайнего случая, когда файл может быть удален и добавлен новый файл, поэтому количество файлов правильное, но содержимое msi неверно :)

Вот соответствующие модульные тесты. Предполагается, что у вас есть Тест.msi в вашем тестовом проекте, который копируется в выходной каталог.

[TestFixture]
public class VerifyMsiFileCountFixture
{
    VerifyMsiFileCount verify;

    [SetUp]
    public void Setup()
    {
        verify = new VerifyMsiFileCount();
    }

    [Test]
    [ExpectedException(typeof(InstallerException))]
    public void Execute_ThrowsInstallerException_InvalidMsiFilePath()
    {
        verify.Directory = Environment.CurrentDirectory;
        verify.MsiFile = "Bogus";
        verify.Execute();
    }

    [Test]
    [ExpectedException(typeof(DirectoryNotFoundException))]
    public void Execute_ThrowsDirectoryNotFoundException_InvalidDirectoryPath()
    {
        verify.Directory = "Bogus";
        verify.MsiFile = "Test.msi";
        verify.Execute();
    }

    [Test]
    public void Execute_ReturnsTrue_ValidDirectoryAndFile()
    {
        string directory = Path.Combine(Environment.CurrentDirectory, "Temp");
        string file = Path.Combine(directory, "Test.txt");
        Directory.CreateDirectory(directory);
        File.WriteAllText(file, "Temp");
        try
        {
            verify.Directory = directory;
            verify.MsiFile = "Test.msi";
            Assert.IsTrue(verify.Execute());
        }
        finally
        {
            File.Delete(file);
            Directory.Delete(directory);
        }
    }

    [Test]
    public void Execute_ReturnsFalse_NoFileDefined()
    {
        string directory = Path.Combine(Environment.CurrentDirectory, "Temp");
        Directory.CreateDirectory(directory);
        try
        {
            verify.Directory = directory;
            verify.MsiFile = "Test.msi";
            Assert.IsFalse(verify.Execute());
        }
        finally
        {
            Directory.Delete(directory);
        }
    }

    [Test]
    public void Execute_ReturnsFalse_IncorrectFilename()
    {
        string directory = Path.Combine(Environment.CurrentDirectory, "Temp");
        string file = Path.Combine(directory, "Bogus.txt");
        Directory.CreateDirectory(directory);
        File.WriteAllText(file, "Temp");
        try
        {
            verify.Directory = directory;
            verify.MsiFile = "Test.msi";
            Assert.IsFalse(verify.Execute());
        }
        finally
        {
            File.Delete(file);
            Directory.Delete(directory);
        }
    }

    [Test]
    public void Execute_ReturnsFalse_ExtraFileDefined()
    {
        string directory = Path.Combine(Environment.CurrentDirectory, "Temp");
        string file1 = Path.Combine(directory, "Test.txt");
        string file2 = Path.Combine(directory, "Bogus.txt");
        Directory.CreateDirectory(directory);
        File.WriteAllText(file1, "Temp");
        File.WriteAllText(file2, "Temp");
        try
        {
            verify.Directory = directory;
            verify.MsiFile = "Test.msi";
            Assert.IsFalse(verify.Execute());
        }
        finally
        {
            File.Delete(file1);
            File.Delete(file2);
            Directory.Delete(directory);
        }
    }
}

Answer 4

WinRAR идентифицирует MSI как самораспаковывающийся CAB-архив (после присвоения ему расширения .rar).Я полагаю, вы могли бы скопировать файл куда-нибудь, переименовать его, распаковать с помощью WinRAR, а затем посчитать файлы.Однако файлы не будут иметь своих первоначальных имен.

Этот кажется немного устаревшим, и я не знаю, может ли это чем-то помочь.