@databricks-solutions/lakebase-scm-utils 0.2.50 → 0.3.0

package/templates/project/dotnet/tests/App.Tests/HealthTests.cs

@@ -0,0 +1,18 @@
+using System.Net;
+using System.Net.Http.Json;
+using Microsoft.AspNetCore.Mvc.Testing;
+
+namespace App.Tests;
+
+public class HealthTests(WebApplicationFactory<Program> factory) : IClassFixture<WebApplicationFactory<Program>>
+{
+    [Fact]
+    public async Task Health_ReturnsOk()
+    {
+        var response = await factory.CreateClient().GetAsync("/health");
+
+        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+        var body = await response.Content.ReadFromJsonAsync<Dictionary<string, string>>();
+        Assert.Equal("ok", body!["status"]);
+    }
+}

package/templates/project/dotnet/tests/App.Tests/OpenApiTests.cs

@@ -0,0 +1,23 @@
+using System.Net;
+using Microsoft.AspNetCore.Mvc.Testing;
+
+namespace App.Tests;
+
+public class OpenApiTests(WebApplicationFactory<Program> factory) : IClassFixture<WebApplicationFactory<Program>>
+{
+    [Fact]
+    public async Task OpenApiDocument_ListsEndpoints()
+    {
+        var body = await factory.CreateClient().GetStringAsync("/openapi.json");
+
+        Assert.Contains("\"/health\"", body);
+    }
+
+    [Fact]
+    public async Task Docs_ServesSwaggerUi()
+    {
+        var response = await factory.CreateClient().GetAsync("/docs/index.html");
+
+        Assert.Equal(HttpStatusCode.OK, response.StatusCode);
+    }
+}

package/templates/project/dotnet-efcore/.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-ef": {
+      "version": "10.0.4",
+      "commands": [
+        "dotnet-ef"
+      ],
+      "rollForward": false
+    }
+  }
+}

package/templates/project/dotnet-efcore/src/App/App.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <RootNamespace>App</RootNamespace>
+    <!-- {{PROJECT_NAME}} -->
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="10.0.3" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.12" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.3.0" />
+    <!-- Marks this project as the EF Core migrations owner for lakebase-schema-migrate. -->
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="10.0.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+</Project>

package/templates/project/dotnet-efcore/src/App/Data/DesignTimeDbContextFactory.cs

@@ -0,0 +1,24 @@
+using App.Lakebase;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Design;
+
+namespace App.Data;
+
+/// <summary>
+/// Used by `dotnet ef` (and the kit's lakebase-schema-migrate) to build the
+/// DbContext without starting the web host. It reads the same connection
+/// settings as the app: DATABASE_URL when set (the kit passes the target
+/// branch DSN this way, so no password appears on a command line), otherwise
+/// the Lakebase metadata in .env with a runtime-minted credential.
+/// </summary>
+public class DesignTimeDbContextFactory : IDesignTimeDbContextFactory<AppDbContext>
+{
+    public AppDbContext CreateDbContext(string[] args)
+    {
+        DotEnv.LoadFromRepoRoot();
+        var options = new DbContextOptionsBuilder<AppDbContext>()
+            .UseNpgsql(LakebaseConnection.CreateDataSource())
+            .Options;
+        return new AppDbContext(options);
+    }
+}

package/templates/project/dotnet-efcore/src/App/Migrations/README.md

@@ -0,0 +1,23 @@
+# EF Core migrations
+
+Create a migration with the kit's tool-agnostic command (run in the project
+root):
+
+```bash
+./scripts/lk lakebase-new-migration --name "<description>"
+```
+
+This runs `dotnet ef migrations add`, which generates the migration from the
+difference between your `AppDbContext` model and the last snapshot. Review the
+generated `Up()` / `Down()` before committing. You can also run
+`dotnet ef migrations add <Name> --project src/App` directly.
+
+EF Core names migrations `<UTC timestamp>_<Name>.cs`, so sibling feature
+branches never collide on an id. Commit the migration, its `.Designer.cs`, and
+the updated `AppDbContextModelSnapshot.cs` together.
+
+You do not run migrations by hand: the kit applies them to each paired Lakebase
+branch through CI (`pr.yml` on the feature branch, `merge.yml` on staging /
+production) via `lakebase-schema-migrate`, which passes the branch connection to
+`dotnet ef` in `DATABASE_URL` (read by `Data/DesignTimeDbContextFactory.cs`).
+To migrate your paired branch locally, run `./scripts/flyway-migrate.sh`.

package/templates/project/dotnet-flyway/db/migrations/README.md

@@ -0,0 +1,23 @@
+# Flyway migrations
+
+Create a migration with the kit's tool-agnostic command (run in the project
+root):
+
+```bash
+./scripts/lk lakebase-new-migration --name "<description>"
+```
+
+This writes a timestamp-versioned skeleton (`V<timestamp>__<slug>.sql`, a UTC
+`YYYYMMDDHHMMSS` version); then author the DDL/DML. Timestamps are globally
+unique and sort chronologically, so sibling feature branches never collide on a
+version. Flyway runs with `-baselineOnMigrate=true -baselineVersion=0`, so every
+`V<n>` file is applied as a pending migration.
+
+Flyway owns the schema; EF Core is used only as the runtime ORM. Keep your
+`AppDbContext` model in step with the SQL here, and do not add EF Core
+migrations to this project.
+
+You do not run migrations by hand: the kit applies them to each paired Lakebase
+branch through CI (`pr.yml` on the feature branch, `merge.yml` on staging /
+production) via `lakebase-schema-migrate`. To migrate your paired branch
+locally, run `./scripts/flyway-migrate.sh`.

package/templates/project/dotnet-flyway/src/App/App.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <RootNamespace>App</RootNamespace>
+    <!-- {{PROJECT_NAME}} -->
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="10.0.3" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.12" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="10.3.0" />
+  </ItemGroup>
+
+</Project>