feat: add .NET 6 support (#489)

Finbuckle · Nov 8, 2021 · a2d0416 · a2d0416
1 parent 52ce1df
commit a2d0416
Show file tree

Hide file tree

Showing 26 changed files with 234 additions and 158 deletions.
diff --git a/.github/workflows/linux-3.1.yml b/.github/workflows/linux-3.1.yml
@@ -11,10 +11,13 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 3.1.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 3.1.x
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: /usr/share/dotnet
       - name: test Finbuckle.MultiTenanant
         run: dotnet test -f netcoreapp3.1
         working-directory: ./test/Finbuckle.MultiTenant.Test

diff --git a/.github/workflows/linux-5.0.yml b/.github/workflows/linux-5.0.yml
@@ -11,17 +11,20 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 5.0.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: /usr/share/dotnet
       - name: test Finbuckle.MultiTenanant
         run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.Test
       - name: test Finbuckle.MultiTenanant.AspNetCore
-        run: dotnet test -f .net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
       - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
-        run: dotnet test -f .net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
 
diff --git a/.github/workflows/pr-check.yml → .github/workflows/linux-6.0.yml b/.github/workflows/pr-check.yml → .github/workflows/linux-6.0.yml
@@ -1,31 +1,30 @@
-name: Pull Request Checks
+name: Linux (.NET 6.0)
 
-on: [workflow_dispatch]
+on:
+  push:
+    branches: [main]
+  pull_request:
 
 jobs:
   os-tests:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ubuntu-latest
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 5.0.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
-      - name: setup dotnet 3.1.x
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: 3.1.x
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: /usr/share/dotnet
       - name: test Finbuckle.MultiTenanant
-        run: dotnet test
+        run: dotnet test -f net6.0
         working-directory: ./test/Finbuckle.MultiTenant.Test
       - name: test Finbuckle.MultiTenanant.AspNetCore
-        run: dotnet test
+        run: dotnet test -f net6.0
         working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
       - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
-        run: dotnet test
+        run: dotnet test -f net6.0
         working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
 
diff --git a/.github/workflows/macos-3.1.yml b/.github/workflows/macos-3.1.yml
@@ -11,10 +11,11 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 3.1.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 3.1.x
+          dotnet-version: '6.0'
+          include-prerelease: true
       - name: test Finbuckle.MultiTenanant
         run: dotnet test -f netcoreapp3.1
         working-directory: ./test/Finbuckle.MultiTenant.Test

diff --git a/.github/workflows/macos-5.0.yml b/.github/workflows/macos-5.0.yml
@@ -11,16 +11,17 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 5.0.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: '6.0'
+          include-prerelease: true
       - name: test Finbuckle.MultiTenanant
-        run: dotnet test -f .net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.Test
       - name: test Finbuckle.MultiTenanant.AspNetCore
-        run: dotnet test -f .net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
       - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
-        run: dotnet test -f .net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
diff --git a/.github/workflows/macos-6.0.yml b/.github/workflows/macos-6.0.yml
@@ -0,0 +1,27 @@
+name: MacOS (.NET 6.0)
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  os-tests:
+    runs-on: macos-latest
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v2
+      - name: setup dotnet
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0'
+          include-prerelease: true
+      - name: test Finbuckle.MultiTenanant
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.Test
+      - name: test Finbuckle.MultiTenanant.AspNetCore
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
+      - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
diff --git a/.github/workflows/windows-3.1.yml b/.github/workflows/windows-3.1.yml
@@ -11,10 +11,13 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 3.1.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 3.1.x
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: 'C:\Program Files\dotnet'
       - name: test Finbuckle.MultiTenanant
         run: dotnet test -f netcoreapp3.1
         working-directory: ./test/Finbuckle.MultiTenant.Test

diff --git a/.github/workflows/windows-5.0.yml b/.github/workflows/windows-5.0.yml
@@ -11,16 +11,19 @@ jobs:
     steps:
       - name: checkout repo
         uses: actions/checkout@v2
-      - name: setup dotnet 5.0.x
+      - name: setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: 'C:\Program Files\dotnet'
       - name: test Finbuckle.MultiTenanant
         run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.Test
       - name: test Finbuckle.MultiTenanant.AspNetCore
-        run: dotnet test  -f net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
       - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
-        run: dotnet test  -f net5.0
+        run: dotnet test -f net5.0
         working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
diff --git a/.github/workflows/windows-6.0.yml b/.github/workflows/windows-6.0.yml
@@ -0,0 +1,29 @@
+name: Windows (.NET 6.0)
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  os-tests:
+    runs-on: windows-latest
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v2
+      - name: setup dotnet
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0'
+          include-prerelease: true
+        env:
+          DOTNET_INSTALL_DIR: 'C:\Program Files\dotnet'
+      - name: test Finbuckle.MultiTenanant
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.Test
+      - name: test Finbuckle.MultiTenanant.AspNetCore
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.AspNetCore.Test
+      - name: test Finbuckle.MultiTenanant.EntityFrameworkCore
+        run: dotnet test -f net6.0
+        working-directory: ./test/Finbuckle.MultiTenant.EntityFrameworkCore.Test
diff --git a/README.md b/README.md
@@ -4,17 +4,20 @@
 
 Finbuckle.MultiTenant is open source multitenancy middleware library for .NET. It enables tenant resolution, per-tenant app behavior, and per-tenant data isolation. See [https://www.finbuckle.com/multitenant](https://www.finbuckle.com/multitenant) for more details and documentation.
 
-
 ## Main Build and Test Status
 
-![Build Status Linux 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/linux-3.1.yml/badge.svg)  
-![Build Status MacOS 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/macos-3.1.yml/badge.svg?)  
-![Build Status Windows 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/windows-3.1.yml/badge.svg)
+![Build Status Linux 6.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/linux-6.0.yml/badge.svg)  
+![Build Status MacOS 6.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/macos-6.0.yml/badge.svg)  
+![Build Status Windows 6.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/windows-6.0.yml/badge.svg)
 
 ![Build Status Linux 5.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/linux-5.0.yml/badge.svg)  
 ![Build Status MacOS 5.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/macos-5.0.yml/badge.svg)  
 ![Build Status Windows 5.0](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/windows-5.0.yml/badge.svg)
 
+![Build Status Linux 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/linux-3.1.yml/badge.svg)  
+![Build Status MacOS 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/macos-3.1.yml/badge.svg?)  
+![Build Status Windows 3.1](https://github.com/Finbuckle/Finbuckle.MultiTenant/actions/workflows/windows-3.1.yml/badge.svg)
+
 ## License
 
 This project uses the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). See [LICENSE](LICENSE) file for license information.
@@ -71,10 +74,9 @@ Finally, in the `Configure` method call `UseMultiTenant()` to register the middl
 public void Configure(IApplicationBuilder app)
 {
     ...
-    app.UseMultiTenant(); // Before UseMvc!
+    app.UseMultiTenant(); // Before UseEndpoints!
     ...
-    //app.UseMvc(); // for .NET Core 3.1
-    app.UseEndpoints(...); // for .NET 5.0+
+    app.UseEndpoints(...);
 }
 ```
 
@@ -102,13 +104,13 @@ See [Stores](https://www.finbuckle.com/MultiTenant/Docs/Stores) for more informa
 
 Finbuckle.MultiTenant comes with a collection of strategies and store types that can be mixed and matched in various ways.
 
-`app.UseEndPoints`
+`app.MultiTenant()`
 
-This line configures the middleware which resolves the tenant using the registered strategies, stores, and other settings. Be sure to call it before calling `UseEndpoints` and other middleware which will use per-tenant functionality, e.g. `UseAuthentication`.
+This line configures the middleware which resolves the tenant using the registered strategies, stores, and other settings. Be sure to call it before calling `UseEndpoints()` and other middleware which will use per-tenant functionality, e.g. `UseAuthentication()`.
 
 ### Basic Usage
 
-With the services and middleware configured, access information for the current tenant from the `TenantInfo` property on the `MultiTenantContext` object accessed from the `GetMultiTenantContext<T>` extension method:
+With the services and middleware configured, access information for the current tenant from the `TenantInfo` property on the `MultiTenantContext<T>` object accessed from the `GetMultiTenantContext<T>` extension method:
 
 ```cs
 var tenantInfo = HttpContext.GetMultiTenantContext<TenantInfo>().TenantInfo;

diff --git a/docs/EFCore.md b/docs/EFCore.md
@@ -193,7 +193,7 @@ for the current tenant.
 
 ## Deriving from MultiTenantDbContext
 This approach is easier bit requires inheriting from `MultiTenantDbContext` which
-may not alway be possible. It is simply a pre-configured implementation of
+may not always be possible. It is simply a pre-configured implementation of
 `IMultiTenantDbContext` with the helper methods as described below in
 (Adding MultiTenant Functionality to an Existing DbContext)
 [#adding-multitenant-functionality-to-an-existing-dbcontext]
@@ -359,7 +359,7 @@ By default attempting to add or update an entity with a different `TenantId` pro
 
 ## Tenant Not Set Mode
 
-If the `TenantId` on an entity is manually set to null the default behavior is to overwrite the `TenantId` for adde entities or to throw a `MultiTenantException` for updated entities. This occurs during a call to `SaveChanges` or `SaveChangesAsync`. This behavior can be changed by setting the `TenantNotSetMode' property on the database context:
+If the `TenantId` on an entity is manually set to null the default behavior is to overwrite the `TenantId` for added entities or to throw a `MultiTenantException` for updated entities. This occurs during a call to `SaveChanges` or `SaveChangesAsync`. This behavior can be changed by setting the `TenantNotSetMode' property on the database context:
 
 * TenantNotSetMode.Throw - For added entities the null `TenantId` will be overwritten to match the database context's current `TenantInfo`. For updated entities a `MultiTenantException` is thrown (default).
 * TenantNotSetMode.Overwrite - The entity's `TenantId` is overwritten to match the database context's current `TenantInfo`.
diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md
@@ -64,13 +64,13 @@ See [Stores](Stores) for more information.
 
 Finbuckle.MultiTenant comes with a collection of strategies and store types that can be mixed and matched in various ways.
 
-`app.UseEndPoints`
+`app.UseMultiTenant()`
 
-This line configures the middleware which resolves the tenant using the registered strategies, stores, and other settings. Be sure to call it before calling `UseEndpoints` and other middleware which will use per-tenant functionality, e.g. `UseAuthentication`.
+This line configures the middleware which resolves the tenant using the registered strategies, stores, and other settings. Be sure to call it before calling `UseEndpoints()` and other middleware which will use per-tenant functionality, e.g. `UseAuthentication()`.
 
 ## Basic Usage
 
-With the services and middleware configured, access information for the current tenant from the `TenantInfo` property on the `MultiTenantContext` object accessed from the `GetMultiTenantContext<T>` extension method:
+With the services and middleware configured, access information for the current tenant from the `TenantInfo` property on the `MultiTenantContext<T>` object accessed from the `GetMultiTenantContext<T>` extension method:
 
 ```cs
 var tenantInfo = HttpContext.GetMultiTenantContext<TenantInfo>().TenantInfo;

diff --git a/docs/Stores.md b/docs/Stores.md
@@ -132,7 +132,7 @@ The configuration section should use this JSON format shown below. Any fields in
       },
     "Tenants": [
       {
-        "Id": "unique-id-0ff4adaf",
+        "Id": "unique-id-0ff4daf",
         "Identifier": "tenant-1",
         "Name": "Tenant 1 Company Name",
         "ACustomProperty": "VIP Customer"
@@ -278,7 +278,7 @@ deserialization.
 Each tenant info instance is actually stored twice in the cache, once using the
 Tenant Id as the key and another using the Tenant Identifier as the key. Calls
 to `TryAddAsync`, `TryUpdateAsync`, and `TryRemoveAsync` will keep these dual
-cache entries synched.
+cache entries synced.
 
 This store does not implement `GetAllAsync`.