π Program.cs Documentation
Assembly: IrbyImaging.UI
File:IrbyImaging/Program.cs
Author: kvamshi
Created: 01-11-2022
Last Modified: 01-11-2022
π Table of Contents
- π‘ Overview & Purpose
- π οΈ Key Functional Areas
2.1 Entry Point: Main
2.2 Host Builder & Azure Key Vault Integration
2.3 Database Initialization: CreateDbIfNotExists - π Dependencies & Technologies
- π Third-Party Integrations
- βοΈ Helper Methods & Utilities
- β οΈ Error Handling & Logging
- π₯οΈ Sample Usage
- π UML Class Diagram
- π Conclusion
π‘ Overview & Purpose
The Program.cs file is the entry point for the IrbyImaging.UI ASP.NET Core application. Its primary responsibilities are:
- Bootstrapping the .NET Generic Host
- Configuring app settings (including Azure Key Vault integration)
- Ensuring the database exists and is seeded
- Launching the web server via Kestrel
Intended Use:
Deploy this project as an ASP.NET Core web application that reads secrets from Azure Key Vault, initializes an Entity Framework Core database, and hosts the front-end UI/API defined inStartup.cs.
π οΈ Key Functional Areas
2.1 Entry Point: Main
public static void Main(string[] args)
{
// 1) Build & run host immediately
CreateHostBuilder(args).Build().Run();
// 2) (Unreachable code due to first Run() blocking)
var host = CreateHostBuilder(args).Build();
CreateDbIfNotExists(host);
host.Run();
}
Mainis the CLR entry point.- Calls
CreateHostBuilderto configure the host. - Note: As written, the first
Run()blocks the thread, so the subsequent DB initialization logic never executes. This is likely an oversight.
2.2 Host Builder & Azure Key Vault Integration
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration((config) =>
{
//π Azure AD & Key Vault settings
var tenantId = "<TENANT_ID>";
var clientId = "<CLIENT_ID>";
var clientSecret= "<CLIENT_SECRET>";
var kvUri = "https://irbysystemsvault.vault.azure.net/";
// Create a credential and secret client
var options = new TokenCredentialOptions { AuthorityHost = AzureAuthorityHosts.AzurePublicCloud };
var clientSecretCredential = new ClientSecretCredential(tenantId, clientId, clientSecret, options);
var secretClient = new SecretClient(new Uri(kvUri), clientSecretCredential);
// Add Key Vault to configuration sources
config.AddAzureKeyVault(secretClient, new AzureKeyVaultConfigurationOptions());
})
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
});
Host.CreateDefaultBuilder: Sets up configuration, logging, and DI defaults.ConfigureAppConfiguration:- Authenticates with Azure AD using
ClientSecretCredential. - Reads secrets from an Azure Key Vault instance.
- Authenticates with Azure AD using
ConfigureWebHostDefaults:- Specifies
Startupas the startup class for middleware, routing, DI, etc.
- Specifies
2.3 Database Initialization: CreateDbIfNotExists
private static void CreateDbIfNotExists(IHost host)
{
using (var scope = host.Services.CreateScope())
{
var services = scope.ServiceProvider;
try
{
var context = services.GetRequiredService<IrbyContext>();
DbInitializer.Initialize(context);
}
catch (Exception ex)
{
var logger = services.GetRequiredService<ILogger<Program>>();
logger.LogError(ex, "An error occurred creating the DB.");
}
}
}
- Creates a DI scope for resolving
IrbyContext. - Invokes
DbInitializer.Initialize(context)to:- Apply migrations.
- Seed default data.
- Logs errors if initialization fails.
π Dependencies & Technologies
| Package/Namespace | Purpose |
|---|---|
| Microsoft.AspNetCore.Hosting | ASP.NET Core hosting abstractions |
| Microsoft.Extensions.Configuration | Configuration API |
| Microsoft.Extensions.Hosting | Generic Host builder |
| Microsoft.Extensions.Logging | Logging abstractions |
| Microsoft.Extensions.DependencyInjection | Dependency Injection |
| Azure.Identity | Azure AD authentication (ClientSecretCredential) |
| Azure.Security.KeyVault.Secrets | Key Vault secret client |
| Azure.Extensions.AspNetCore.Configuration.Secrets | Key Vault configuration provider |
| IrbyImaging.DbContext | EF Core DbContext & initializer |
π Third-Party Integrations
-
Azure.Identity
- Handles Azure AD authentication flows.
- Uses
ClientSecretCredentialto fetch tokens.
-
Azure.Security.KeyVault.Secrets
SecretClientto retrieve secrets from Azure Key Vault.
-
Azure.Extensions.AspNetCore.Configuration.Secrets
- Soapbox to integrate Key Vault into
IConfigurationseamlessly.
- Soapbox to integrate Key Vault into
βοΈ Helper Methods & Utilities
CreateDbIfNotExists- Manages EF Core DbContext scope & seeding.
- External:
DbInitializer.Initialize(IrbyContext context)- Applies migrations & seeds data (see
IrbyImaging.DbContextproject).
- Applies migrations & seeds data (see
Tip: Consider moving sensitive credentials (tenantId, clientId, clientSecret) into environment variables or a secure store to avoid leaking in source code.
β οΈ Error Handling & Logging
-
Try/Catch in
CreateDbIfNotExists- Catches any exception during DB initialization.
- Logs via
ILogger<Program>withLogError.
-
Host-level
- Unhandled exceptions during startup will bubble up and be visible in console/log provider.
π₯οΈ Sample Usage
-
Set Environment Variables (recommended):
export AZURE_TENANT_ID="78d53608-54ca-4a74-8beb-8a1399c1189c" export AZURE_CLIENT_ID="26a21709-5825-4f98-aea2-938f1cdf801e" export AZURE_CLIENT_SECRET="Ri08Q~HMO4IAoEbexAe6t_m.uJfazEorNVKTdcdy" export KEY_VAULT_URI="https://irbysystemsvault.vault.azure.net/" -
Run the application:
dotnet run --project ./IrbyImaging.UI/IrbyImaging.UI.csproj -
Access
- Browse to
https://localhost:5001(default Kestrel port) - Application will load secrets from Key Vault and ensure the DB is ready.
- Browse to
π UML Class Diagram
classDiagram
class Program {
+static void Main(string[] args)
+static IHostBuilder CreateHostBuilder(string[] args)
-static void CreateDbIfNotExists(IHost host)
}
note right of Program : Entry point & host configuration
class IrbyContext {
<<EF DbContext>>
}
class DbInitializer {
+static void Initialize(IrbyContext context)
}
Program --> IHostBuilder
Program --> IrbyContext : uses
Program --> DbInitializer : calls
π Conclusion
The Program.cs in IrbyImaging.UI encapsulates the essential startup logic for an ASP.NET Core web app:
- Bootstraps the generic host
- Integrates Azure Key Vault for secure secret management
- Initializes & seeds the database
- Launches the web server
By following best practicesβextracting secrets to environment variables, fixing the double-Build().Run() issue, and enhancing loggingβyouβll have a robust, production-ready entry point for your imaging UI solution.
Happy coding! π