Net4x.DapperLibrary.Installation 1.9.9.8

DapperLibrary.Installation

Helpers to detect and perform basic installation tasks for native components (MSI installers) and to assist Docker installation checks on supported runtimes.

Overview

This project contains small utilities used by the DapperLibraries to ensure required native components or tools are available on the host (for example, LocalDB, Docker, or other MSI-packaged dependencies). It provides a minimal download abstraction, a registry-based installed-apps enumerator and an installer orchestrator that can invoke MSIs silently.

Main types

• InstallationEnsurer / InstallationEnsurerInternal

  • Entry point: InstallationEnsurer.GetInstance(ILogger? logger) returns an IInstallationEnsurer.
  • EnsureIsInstalled(IFileDownloader fileDownloader, string urlOrPath, bool useDocker, params string[] keywords) attempts to detect a previously installed product by scanning the Windows uninstall registry for display names that contain all provided keywords.
  • If the product is not found, the method will copy or download the provided installer (urlOrPath) to a temporary .msi file and invoke msiexec.exe with quiet install arguments.
  • On .NET 6+ builds and on Windows the implementation may attempt Docker installer actions if useDocker is true (calls into DapperLibrary.Docker helpers conditionally).

• IFileDownloader / FileDownloader / InstallationWebClient

  • IFileDownloader is a tiny abstraction: void DownloadFile(string urlOrPath, string fileName).
  • FileDownloader.Instance uses InstallationWebClient (a thin wrapper around System.Net.WebClient) to download the installer when urlOrPath is a remote URI.

Key behaviors

• Installed-apps detection is Windows-specific and reads:

  • HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall (32-bit view) and, on 64-bit OS, the 64-bit view as well.
  • It collects DisplayName values and checks whether the provided keywords all appear in a display name.

• Installer execution

  • When no matching installed product is found the installer file (remote URL or local path) is copied to a temporary .msi location and executed via msiexec.exe with a /i ... /q argument to perform a quiet install.
  • The temporary file is deleted after the installer process exits (best-effort; deletion failures are logged but do not fail the method).

• Docker support

  • When compiled for modern runtimes (NET6_0_OR_GREATER) the internal ensurer checks RuntimeInformation and will attempt to invoke DockerInstaller.Instance.EnsureIsInstalled() when useDocker is requested on Windows. The Docker installation flow is platform-specific and may require elevation.

Usage example

var logger = /* obtain logger or null */;
var ensurer = InstallationEnsurer.GetInstance(logger);
var downloader = FileDownloader.Instance; // implements IFileDownloader

// Ensure a component is installed by providing a URL or local path to an MSI
bool installed = ensurer.EnsureIsInstalled(downloader, "https://example.com/mycomponent.msi", useDocker: false, "Component", "Vendor");

Important notes and safety

• The registry-based detection only works on Windows. GetInstalledApps() relies on the Windows registry and will not function on non-Windows platforms.
• Running installers programmatically requires caution: the library invokes msiexec.exe and executes downloaded binaries. Only use trusted installer URLs/paths.
• The code attempts best-effort cleanup of temporary files; antivirus or permission issues may prevent deletion.
• Docker installer flows (automatic download/installation) require administrator privileges and are platform-specific. On macOS the code will recommend manual installation.

Compatibility

• The project contains conditional compilation for multiple target frameworks. The registry/msiexec flow is intended for Windows/.NET Framework and modern .NET builds running on Windows.
• For cross-platform scenarios, prefer using platform-appropriate package management or container-based alternatives rather than invoking MSIs.

Extensibility

• Implement IFileDownloader to provide custom download behavior (proxy, authenticated downloads, local caching).
• Swap the IFile/InputOutput.Instance implementation used by the internal ensurer if you need custom I/O behavior in tests.

License / Contributing

See repository root for license and contribution guidelines.