Merge branch 'main' into v2

Author: justinyoo

.github/workflows/main-actions.yaml

@@ -28,6 +28,11 @@ jobs:
       with:
         dotnet-version: '6.x'
 
+    - name: Setup .NET SDK 7 STS
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '7.x'
+
     - name: Restore NuGet packages
       shell: pwsh
       run: |

.github/workflows/main-build.yaml

@@ -38,21 +38,26 @@ jobs:
       run: |
         npm install -g azure-functions-core-tools@4 --unsafe-perm true
 
-    - name: Setup .NET SDK 3.1 LTS
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.x'
+    # - name: Setup .NET SDK 3.1 LTS
+    #   uses: actions/setup-dotnet@v1
+    #   with:
+    #     dotnet-version: '3.1.x'
 
-    - name: Setup .NET SDK 5
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '5.x'
+    # - name: Setup .NET SDK 5
+    #   uses: actions/setup-dotnet@v1
+    #   with:
+    #     dotnet-version: '5.x'
 
     - name: Setup .NET SDK 6 LTS
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '6.x'
 
+    - name: Setup .NET SDK 7 STS
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '7.x'
+
     # - name: Add MSBuild to PATH
     #   uses: microsoft/[email protected]
 

.github/workflows/pr.yaml

@@ -30,21 +30,26 @@ jobs:
       run: |
         npm install -g azure-functions-core-tools@4 --unsafe-perm true
 
-    - name: Setup .NET SDK 3.1 LTS
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '3.1.x'
+    # - name: Setup .NET SDK 3.1 LTS
+    #   uses: actions/setup-dotnet@v1
+    #   with:
+    #     dotnet-version: '3.1.x'
 
-    - name: Setup .NET SDK 5
-      uses: actions/setup-dotnet@v1
-      with:
-        dotnet-version: '5.x'
+    # - name: Setup .NET SDK 5
+    #   uses: actions/setup-dotnet@v1
+    #   with:
+    #     dotnet-version: '5.x'
 
     - name: Setup .NET SDK 6 LTS
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '6.x'
 
+    - name: Setup .NET SDK 7 STS
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '7.x'
+
     # - name: Add MSBuild to PATH
     #   uses: microsoft/[email protected]
 

Microsoft.Azure.WebJobs.Extensions.OpenApi.sln

@@ -22,8 +22,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Ext
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.OpenApi", "src\Microsoft.Azure.WebJobs.Extensions.OpenApi\Microsoft.Azure.WebJobs.Extensions.OpenApi.csproj", "{D405655F-C8BE-4134-893C-ADB4918B0624}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI", "src\Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI\Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI.csproj", "{7AD094AA-01D6-4644-B9B6-E555A029D6D7}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{66D8DEA8-B477-497F-95BB-E8F9A5BAC352}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.OutOfProc", "samples\Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.OutOfProc\Microsoft.Azure.Functions.Worker.Extensions.OpenApi.FunctionApp.OutOfProc.csproj", "{7FD0AC53-E04D-41C6-9633-924A0D98A114}"
@@ -48,8 +46,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Ext
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.OpenApi.Tests", "test\Microsoft.Azure.WebJobs.Extensions.OpenApi.Tests\Microsoft.Azure.WebJobs.Extensions.OpenApi.Tests.csproj", "{D787694D-B87B-4E11-9455-B5BF9306D8FC}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI.Tests", "test\Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI.Tests\Microsoft.Azure.WebJobs.Extensions.OpenApi.CLI.Tests.csproj", "{65AED6F0-D27E-4D6E-BA42-AD6EE1338082}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test-integration", "test-integration", "{CBD9883B-134F-42CC-A201-EE06EBC48C3E}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Azure.WebJobs.Extensions.OpenApi.TestApp", "test-integration\Microsoft.Azure.WebJobs.Extensions.OpenApi.TestApp\Microsoft.Azure.WebJobs.Extensions.OpenApi.TestApp.csproj", "{7F6EC289-B516-455E-8E5F-324D5C9212B7}"
@@ -78,10 +74,6 @@ Global
 		{D405655F-C8BE-4134-893C-ADB4918B0624}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D405655F-C8BE-4134-893C-ADB4918B0624}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D405655F-C8BE-4134-893C-ADB4918B0624}.Release|Any CPU.Build.0 = Release|Any CPU
-		{7AD094AA-01D6-4644-B9B6-E555A029D6D7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{7AD094AA-01D6-4644-B9B6-E555A029D6D7}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{7AD094AA-01D6-4644-B9B6-E555A029D6D7}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{7AD094AA-01D6-4644-B9B6-E555A029D6D7}.Release|Any CPU.Build.0 = Release|Any CPU
 		{7FD0AC53-E04D-41C6-9633-924A0D98A114}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{7FD0AC53-E04D-41C6-9633-924A0D98A114}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7FD0AC53-E04D-41C6-9633-924A0D98A114}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -122,10 +114,6 @@ Global
 		{D787694D-B87B-4E11-9455-B5BF9306D8FC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D787694D-B87B-4E11-9455-B5BF9306D8FC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D787694D-B87B-4E11-9455-B5BF9306D8FC}.Release|Any CPU.Build.0 = Release|Any CPU
-		{65AED6F0-D27E-4D6E-BA42-AD6EE1338082}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{65AED6F0-D27E-4D6E-BA42-AD6EE1338082}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{65AED6F0-D27E-4D6E-BA42-AD6EE1338082}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{65AED6F0-D27E-4D6E-BA42-AD6EE1338082}.Release|Any CPU.Build.0 = Release|Any CPU
 		{7F6EC289-B516-455E-8E5F-324D5C9212B7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{7F6EC289-B516-455E-8E5F-324D5C9212B7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7F6EC289-B516-455E-8E5F-324D5C9212B7}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -143,7 +131,6 @@ Global
 		{64A22A3C-D0C4-4DE9-A8D5-2CEF766EB500} = {810145E0-41CF-4E24-BD9C-E7517498BA29}
 		{B18937F6-B39F-46BB-BB3C-86C0693993EF} = {810145E0-41CF-4E24-BD9C-E7517498BA29}
 		{D405655F-C8BE-4134-893C-ADB4918B0624} = {810145E0-41CF-4E24-BD9C-E7517498BA29}
-		{7AD094AA-01D6-4644-B9B6-E555A029D6D7} = {810145E0-41CF-4E24-BD9C-E7517498BA29}
 		{66D8DEA8-B477-497F-95BB-E8F9A5BAC352} = {810145E0-41CF-4E24-BD9C-E7517498BA29}
 		{7FD0AC53-E04D-41C6-9633-924A0D98A114} = {66D8DEA8-B477-497F-95BB-E8F9A5BAC352}
 		{1E7232C2-8560-4030-9B5D-AD88A1680F62} = {66D8DEA8-B477-497F-95BB-E8F9A5BAC352}
@@ -155,7 +142,6 @@ Global
 		{1D1A5ED5-A1A1-4082-ACAF-30079AF31AC6} = {8B62E3FB-9062-4716-803A-1FA51FCE68BC}
 		{968CD847-80D0-4740-92D5-F5553461EC04} = {8B62E3FB-9062-4716-803A-1FA51FCE68BC}
 		{D787694D-B87B-4E11-9455-B5BF9306D8FC} = {8B62E3FB-9062-4716-803A-1FA51FCE68BC}
-		{65AED6F0-D27E-4D6E-BA42-AD6EE1338082} = {8B62E3FB-9062-4716-803A-1FA51FCE68BC}
 		{CBD9883B-134F-42CC-A201-EE06EBC48C3E} = {8B62E3FB-9062-4716-803A-1FA51FCE68BC}
 		{7F6EC289-B516-455E-8E5F-324D5C9212B7} = {CBD9883B-134F-42CC-A201-EE06EBC48C3E}
 		{8324C8D1-A9FD-4F98-8ED9-82C3BE572DBB} = {CBD9883B-134F-42CC-A201-EE06EBC48C3E}

README.md

@@ -26,6 +26,9 @@
 
 If you are using GitHub Actions as your preferred CI/CD pipeline, you can run the GitHub Action into your workflow to automatically generate the OpenAPI document. Find more details at the [Build OpenAPI](./actions/build-openapi/) action page.
 
+
+## Generic CI/CD Pipeline Support ##
+
 Alternatively, you can run either PowerShell script or bash shell script to generate the OpenAPI document within your own CI/CD pipeline other than GitHub Actions. Here are two script files:
 
 * PowerShell: [Get-OpenApiDocument.ps1](./actions/Get-OpenApiDocument.ps1)
@@ -43,6 +46,19 @@ Alternatively, you can run either PowerShell script or bash shell script to gene
 
     For more details, run `Get-OpenApiDocument.ps1 -Help`
 
+    You can also remotely invoke this PowerShell script:
+
+    ```powershell
+    & $([Scriptblock]::Create($(Invoke-RestMethod https://aka.ms/azfunc-openapi/generate-openapi.ps1))) `
+        -FunctionAppPath    <function app directory> `
+        -BaseUri            <function app base URI> `
+        -Endpoint           <endpoint for OpenAPI document> `
+        -OutputPath         <output directory for generated OpenAPI document> `
+        -OutputFilename     <OpenAPI document name> `
+        -Delay              <delay in second between run function app and document generation> `
+        -UseWindows         <switch indicating whether to use Windows OS or not>
+    ```
+
 * Bash shell: [get-openapi-document.sh](./actions/get-openapi-document.sh)
 
     ```bash
@@ -57,6 +73,19 @@ Alternatively, you can run either PowerShell script or bash shell script to gene
 
     For more details, run `get-openapi-document.sh --help`
 
+    You can also remotely invoke this bash shell script:
+
+    ```bash
+    curl -fsSL https://aka.ms/azfunc-openapi/generate-openapi.sh \
+        | bash -s -- \
+            -p|--functionapp-path   <function app directory> \
+            -u|--base-uri           <function app base URI> \
+            -e|--endpoint           <endpoint for OpenAPI document> \
+            -o|--output-path        <output directory for generated OpenAPI document> \
+            -f|--output-filename    <OpenAPI document name> \
+            -d|--delay              <delay in second between run function app and document generation>
+    ```
+
 
 ## Sample Azure Function Apps with OpenAPI Document Enabled ##
 

actions/Get-OpenApiDocument.ps1

@@ -2,7 +2,7 @@
 Param(
     [string]
     [Parameter(Mandatory=$false)]
-    $FunctionAppPath = "bin/Debug/net6.0",
+    $FunctionAppPath = ".",
 
     [string]
     [Parameter(Mandatory=$false)]
@@ -25,6 +25,10 @@ Param(
     [Parameter(Mandatory=$false)]
     $Delay = 30,
 
+    [switch]
+    [Parameter(Mandatory=$false)]
+    $UseCodespaces,
+
     [switch]
     [Parameter(Mandatory=$false)]
     $UseWindows,
@@ -43,22 +47,24 @@ function Show-Usage {
             [-OutputPath <output directory for generated OpenAPI document>] ``
             [-OutputFilename <OpenAPI document name>] ``
             [-Delay <delay in second between run function app and document generation>] ``
+            [-UseCodespaces] ``
             [-UseWindows] ``
             [-Help]
     Options:
-        -FunctionAppPath    Function app path. It can be the project directory or compiled app directory.
-                            Default: 'bin/Debug/net6.0'
+        -FunctionAppPath    Function app path, relative to the repository root. It can be the project directory or compiled app directory.
+                            Default: '.'
         -BaseUri            Function app base URI.
                             Default: 'http://localhost:7071/api/'
         -Endpoint           OpenAPI document endpoint.
                             Default: 'swagger.json'
-        -OutputPath         Output directory to store the generated OpenAPI document.
+        -OutputPath         Output directory to store the generated OpenAPI document, relative to the repository root.
                             Default: 'generated'
         -OutputFilename     Output filename for the generated OpenAPI document.
                             Default: 'swagger.json'
         -Delay              Delay in second between the function app run and document generation.
                             Default: 30
-        -UseWindows         Switch that indicates using Windows OS.
+        -UseCodespaces      Switch indicating whether to use GitHub Codespaces or not.
+        -UseWindows         Switch indicating whether to run on Windows OS or not.
         -Help               Show this message.
 "
 
@@ -78,20 +84,27 @@ if ($UseWindows -eq $true) {
     $func = $func.Replace(".ps1", ".cmd")
 }
 
-pushd $FunctionAppPath
+$currentDirectory = $(pwd).Path
+
+$repositoryRoot = $env:GITHUB_WORKSPACE
+if ($UseCodespaces -eq $true) {
+    $repositoryRoot = $env:CODESPACE_VSCODE_FOLDER
+}
+
+cd "$repositoryRoot/$FunctionAppPath"
 
 # Run the function app in the background
 Start-Process -NoNewWindow "$func" @("start","--verbose","false")
 Start-Sleep -s $Delay
 
+# Download the OpenAPI document
 $requestUri = "$($BaseUri.TrimEnd('/'))/$($Endpoint.TrimStart('/'))"
-$filepath = "$($OutputPath.TrimEnd('/'))/$($OutputFilename.TrimStart('/'))"
+$filepath = "$repositoryRoot/$($OutputPath.TrimEnd('/'))/$($OutputFilename.TrimStart('/'))"
 
-if ($(Test-Path -Path "$($OutputPath.TrimEnd('/'))" -PathType Container) -eq $false) {
-    New-Item -Path "$($OutputPath.TrimEnd('/'))" -ItemType Directory
+if ($(Test-Path -Path "$repositoryRoot/$($OutputPath.TrimEnd('/'))" -PathType Container) -eq $false) {
+    New-Item -Path "$repositoryRoot/$($OutputPath.TrimEnd('/'))" -ItemType Directory
 }
 
-# Download the OpenAPI document
 Invoke-RestMethod -Method Get -Uri $requestUri | ConvertTo-Json -Depth 100 | Out-File -FilePath $filepath -Force
 
 # Stop the function app
@@ -100,4 +113,4 @@ if ($process -ne $null) {
     Stop-Process -Id $process.Id
 }
 
-popd
+cd $currentDirectory

actions/Update-LocalSettingsJson.ps1

@@ -0,0 +1,111 @@
+### This add the GitHub Codespaces capability to your local.settings.json
+Param(
+    [switch]
+    [Parameter(Mandatory=$false)]
+    $Help
+)
+
+function Show-Usage {
+    Write-Output "
+    Usage: $(Split-Path $MyInvocation.ScriptName -Leaf) [-Help]
+
+    Options:
+        -Help:      Show this message.
+
+"
+
+    Exit 0
+}
+
+# Show usage
+if ($Help -eq $true) {
+    Show-Usage
+    Exit 0
+}
+
+function Get-CodespaceUrl {
+    param (
+        [string] $CodespaceName
+    )
+
+    # $codespaceUrl = "https://$($CodespaceName)-7071.githubpreview.dev/api"
+    $codespaceUrl = "https://$($CodespaceName)-7071.preview.app.github.dev/api"
+
+    return $codespaceUrl
+}
+
+# Get .csproj files
+$csprojs = Get-ChildItem -Path $env:CODESPACE_VSCODE_FOLDER -Filter *.csproj -Recurse
+
+# Get local.settings.json files
+$localSettingsJsons = @()
+$csprojs | ForEach-Object {
+    $isInProcFunctionApp = $(Get-Content -Path $_.FullName -Raw) -like '*Microsoft.NET.Sdk.Functions*'
+    $isOutOfProcFunctionApp = $(Get-Content -Path $_.FullName -Raw) -like '*Microsoft.Azure.Functions.Worker.Sdk*'
+    $isFunctionApp = ($isInProcFunctionApp -eq $true) -or ($isOutOfProcFunctionApp -eq $true)
+    if ($isFunctionApp -eq $false) {
+        return
+    }
+
+    if ($(Test-Path -Path "$($_.Directory.FullName)/local.settings.json") -eq $true) {
+        $localSettingsJsons += Get-ChildItem -Path $_.Directory.FullName -Filter local.settings.json
+
+        return
+    }
+
+    if ($(Test-Path -Path "$($_.Directory.FullName)/local.settings.sample.json") -eq $true) {
+        Copy-Item -Path "$($_.Directory.FullName)/local.settings.sample.json" -Destination "$($_.Directory.FullName)/local.settings.json"
+        $localSettingsJsons += Get-ChildItem -Path $_.Directory.FullName -Filter local.settings.json
+
+        return
+    }
+
+    $localSettingsJson = @{ IsEncrypted = $false; Values = @{ AzureWebJobsStorage = "UseDevelopmentStorage=true"; FUNCTIONS_WORKER_RUNTIME = "dotnet"; } }
+    if ($isOutOfProcFunctionApp -eq $true) {
+        $localSettingsJson.Values.FUNCTIONS_WORKER_RUNTIME = "dotnet-isolated"
+    }
+
+    $localSettingsJson | `
+        ConvertTo-Json -Depth 10 | `
+        Out-File -FilePath "$($_.Directory.FullName)/local.settings.json" -Force
+    $localSettingsJsons += Get-ChildItem -Path $_.Directory.FullName -Filter local.settings.json
+}
+
+# Update local.settings.json files
+$localSettingsJsons | ForEach-Object {
+    # Get the app settings details.
+    $appSettings = Get-Content -Path $_.FullName | ConvertFrom-Json
+
+    # Add OpenApi__ForceHttps to local.settings.json.
+    if ($appSettings.Values.OpenApi__ForceHttps -eq $null) {
+        $appSettings.Values | Add-Member -NotePropertyName OpenApi__ForceHttps -NotePropertyValue "true"
+    } else {
+        $appSettings.Values.OpenApi__ForceHttps = "true"
+    }
+
+    # Add OpenApi__RunOnCodespaces to local.settings.json.
+    if ($appSettings.Values.OpenApi__RunOnCodespaces -eq $null) {
+        $appSettings.Values | Add-Member -NotePropertyName OpenApi__RunOnCodespaces -NotePropertyValue "true"
+    } else {
+        $appSettings.Values.OpenApi__RunOnCodespaces = "true"
+    }
+
+    # Add OpenApi__HostNames to local.settings.json.
+    $url = Get-CodespaceUrl -CodespaceName $env:CODESPACE_NAME
+    if ($appSettings.Values.OpenApi__HostNames -eq $null) {
+        $appSettings.Values | Add-Member -NotePropertyName OpenApi__HostNames -NotePropertyValue $url
+    } else {
+        $hostNames = $appSettings.Values.OpenApi__HostNames -split ","
+        $hostNames = [System.Collections.ArrayList]$hostNames
+
+        if ($url -ne $null) {
+            $hostNames.Remove($url)
+        }
+        $hostNames.Insert(0, $url)
+
+        $appSettings.Values.OpenApi__HostNames = $($hostNames -join ",").Trim(',')
+    }
+
+    # Overwrite the existing local.settings.json
+    $appSettings | ConvertTo-Json -Depth 100 | Out-File -Path $_.FullName -Force
+}