dan/per-11119-add-rebac-native-support-for-dotnet-sdk (#31)

* Changed .net to 9 * Changed test token to env variable * Changed OpenAPI generation flow * Added workflow to generate OpenAPI specs * Added tests on PR * Added skip commit when no changes * Fixed tests * Added kwarg based bypass to OpenAPI calls * Added relationship tuple APIs * Changed SyncUser to use Replace_userAsync (aka PUT method) * Added docs to APIs * Changed test sleep to 10 sec * Fixed PDP run command * Fixed PDP run command
permitio · Dec 15, 2024 · 66a014d · 66a014d
1 parent 4544aee
commit 66a014d
Show file tree

Hide file tree

Showing 23 changed files with 65,484 additions and 5,695 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "csharpier": {
+      "version": "0.30.3",
+      "commands": [
+        "dotnet-csharpier"
+      ],
+      "rollForward": false
+    }
+  }
+}
diff --git a/.github/workflows/dotnet-sdk-publish.yml b/.github/workflows/dotnet-sdk-publish.yml
@@ -8,6 +8,14 @@ jobs:
   test-dotnet-sdk:
     runs-on: ubuntu-latest
     timeout-minutes: 15
+    services: 
+      pdp:
+        image: permitio/pdp-v2:latest
+        ports:
+          - 7766:7000
+        env:
+          PDP_API_KEY: ${{ secrets.PERMIT_API_KEY }}
+          PDP_DEBUG: true
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -16,29 +24,16 @@ jobs:
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: |
-            8.0.x
+            9.0.x
 
       - name: Restore dependencies
         working-directory: ./src/permit
         run: dotnet restore
 
-      - name: Insert Token to tests file by secret API key
-        run: |
-          sed -i 's/private string testToken = "";/private string testToken = "${{ secrets.PERMIT_API_KEY }}";/' ./tests/PermitTests/PermitClientTests.cs
-          cat ./tests/PermitTests/PermitClientTests.cs
-
-      - name: Install Docker
-        uses: docker-practice/actions-setup-docker@master
-
-      - name: Run local PDP
-        env:
-          PDP_API_KEY: ${{ secrets.PERMIT_API_KEY }}
-          PERMIT_API_KEY: ${{ secrets.PERMIT_API_KEY }}
-          PDP_DEBUG: true
-        run: docker run -d -p 7766:7000 permitio/pdp-v2:latest
-
       - name: Run Tests
         working-directory: ./tests/PermitTests
+        env: 
+          PERMIT_API_KEY: ${{ secrets.PERMIT_API_KEY }}
         run: dotnet test
 
   # Job for building and publishing the NuGet package
@@ -54,7 +49,7 @@ jobs:
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: |
-            8.0.x
+            9.0.x
 
       - name: Restore dependencies
         working-directory: ./src/permit

diff --git a/.github/workflows/generate-openapi.yml b/.github/workflows/generate-openapi.yml
@@ -0,0 +1,58 @@
+name: Generate SDK and Open PR
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 12 * * 0' # Runs every Sunday at 12:00 UTC
+
+
+jobs:
+  generate-sdk:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Run SDK generation script
+        run: generate_openapi.sh
+
+      - name: Check for changes
+        id: check_changes
+        run: |
+          git diff --exit-code || echo "changes"
+          
+      - name: Commit changes
+        if: steps.check_changes.outputs.changes == 'changes'
+        run: |
+          git config user.name "github-actions"
+          git config user.email "[email protected]"
+          git checkout -b feat/sdk-update-$(date +'%Y%m%d')
+          git add .
+          git commit -m "Update SDK from OpenAPI specs"
+
+      - name: Push changes to a new branch
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git push origin feat/sdk-update-$(date +'%Y%m%d')
+
+      - name: Create a pull request
+        id: create_pr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: sdk-update-$(date +'%Y%m%d')
+          title: "OpenAPI SDK Update"
+          body: "This PR updates the SDK based on the latest OpenAPI specifications."
+
+      - name: Output PR URL
+        if: steps.create_pr.outputs.pull-request-url != ''
+        run: |
+          echo "Pull Request URL: ${{ steps.create_pr.outputs.pull-request-url }}"
+        
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,42 @@
+name: Run tests
+
+on:
+  push:
+      branches:
+      - main
+  pull_request:
+      branches:
+      - main
+
+jobs:
+  test-dotnet-sdk:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    services:
+      pdp:
+        image: permitio/pdp-v2:latest
+        ports:
+          - 7766:7000
+        env:
+          PDP_API_KEY: ${{ secrets.PERMIT_API_KEY }}
+          PDP_DEBUG: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup .NET Core SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            9.0.x
+
+      - name: Restore dependencies
+        working-directory: ./src/permit
+        run: dotnet restore
+
+
+      - name: Run Tests
+        working-directory: ./tests/PermitTests
+        env:
+          PERMIT_API_KEY: ${{ secrets.PERMIT_API_KEY }}
+        run: dotnet test
diff --git a/examples/PermitOnboardingApp/PermitOnboardingApp.csproj b/examples/PermitOnboardingApp/PermitOnboardingApp.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/generate_openapi.sh b/generate_openapi.sh
@@ -0,0 +1,17 @@
+echo "Downloading OpenAPI schema files"
+curl https://api.permit.io/v2/openapi.json -o openapi.json
+curl https://pdp-api.permit.io/openapi.json -o pdp-openapi.json
+
+echo "Transforming OpenAPI union types to simple types"
+python transform_openapi.py openapi.json openapi.json
+python transform_openapi.py pdp-openapi.json pdp-openapi.json 
+
+echo "Generating OpenAPI client"
+npm run update-api
+npm run update-pdp-api
+
+echo "Fixing status code checks"
+sed -i '' -f update_status_check.sed ./src/permit/PermitOpenAPI.cs
+sed -i '' -f update_status_check.sed ./src/permit/PermitPDPOpenAPI.cs
+
+echo "Done"
diff --git a/nswag-pdp.json b/nswag-pdp.json
@@ -1,5 +1,5 @@
 {
-  "runtime": "Net70",
+  "runtime": "Net90",
   "defaultVariables": "Configuration=Debug",
   "documentGenerator": {
     "fromDocument": {
@@ -8,6 +8,7 @@
   },
   "codeGenerators": {
     "openApiToCSharpClient": {
+      "output": "./src/permit/PermitPDPOpenAPI.cs",
       "generateClientInterfaces": false,
       "exceptionClass": "PermitApiException",
       "useBaseUrl": true,
@@ -18,7 +19,6 @@
       "className": "PermitClient",
       "operationGenerationMode": "SingleClientFromOperationId",
       "namespace": "PermitSDK.PDP.OpenAPI",
-      "output": "src/permit/PermitPDPOpenAPI.cs",
       "classStyle": "poco",
       "generateOptionalParameters": true,
       "generateOptionalPropertiesAsNullable": true,

diff --git a/nswag.json b/nswag.json
@@ -1,5 +1,5 @@
 {
-  "runtime": "Net60",
+  "runtime": "Net90",
   "defaultVariables": "Configuration=Debug",
   "documentGenerator": {
     "fromDocument": {
@@ -18,11 +18,19 @@
       "className": "PermitClient",
       "operationGenerationMode": "SingleClientFromOperationId",
       "namespace": "PermitSDK.OpenAPI",
-      "output": "src/permit/PermitOpenAPI.cs",
+      "output": "./src/permit/PermitOpenAPI.cs",
       "classStyle": "poco",
       "generateOptionalParameters": true,
       "generateOptionalPropertiesAsNullable": true,
-      "generateNullableReferenceTypes": true
+      "generateNullableReferenceTypes": true,
+      "nullableReferenceTypes": true,
+      "requiredPropertiesMustBeDefined": false,
+      "generateNullableProperties": true,
+      "generateResponseClasses": false,
+      "responseClass": "SwaggerResponse",
+      "generateContractsOutput": true,
+      "contractsOutputFilePath": "./src/permit/PermitOpenAPIModels.cs",
+      "contractsNamespace": "PermitSDK.OpenAPI.Models"
     }
   }
-}
+}
diff --git a/openapi.json b/openapi.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -6,12 +6,8 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepare": "husky install",
-    "update-openapi.json": "curl https://api.permit.io/v2/openapi.json -o openapi.json",
     "update-api": "nswag run nswag.json",
-    "update-status-check": "pwd; sed -i -f update_status_check.sed PermitOpenAPI.cs", 
-    "update-pdp-openapi": "curl https://pdp-api.permit.io/openapi.json -o pdp-openapi.json",
-    "update-pdp-api": "nswag run nswag-pdp.json",
-    "update-status-check-pdp": "pwd; sed -i -f update_status_check.sed PermitPDPOpenAPI.cs"
+    "update-pdp-api": "nswag run nswag-pdp.json"
   },
   "lint-staged": {
     "*.cs": "dotnet csharpier "
@@ -32,6 +28,6 @@
     "lint-staged": "^12.2.2"
   },
   "dependencies": {
-    "nswag": "^13.1.0"
+    "nswag": "^14.2.0"
   }
 }
diff --git a/pdp-openapi.json b/pdp-openapi.json