[SG] Add support for Source Generator

.github/templates/build.lib.yml

@@ -104,6 +104,24 @@ test-net-core:
     framework: #@ frameworks
 #@ end
 
+#@ def runWovenClassesTests():
+test-weaved-classes:
+  if: #@ ignoreSkippedJobsCondition
+  name: Test
+  needs:
+    - build-packages
+  uses: "./.github/workflows/test-woven-classes.yml"
+  with:
+    version: ${{ needs.build-packages.outputs.package_version }}
+#@ end
+
+#@ def runSourceGenerationTests():
+test-source-generation:
+  if: #@ ignoreSkippedJobsCondition
+  name: Test
+  uses: "./.github/workflows/test-source-generation.yml"
+#@ end
+
 #@ def buildUnity():
 build-unity:
   uses: ./.github/workflows/build-unity.yml

.github/templates/common.lib.yml

@@ -1,7 +1,7 @@
 #@ load("@ytt:template", "template")
 
 #@ configuration = "Release"
-#@ nugetPackages = [ 'Realm.Fody', 'Realm', 'Realm.UnityUtils', 'Realm.UnityWeaver' ]
+#@ nugetPackages = [ 'Realm.Fody', 'Realm', 'Realm.UnityUtils', 'Realm.UnityWeaver', 'Realm.SourceGenerator' ]
 #@ actionCheckout = "actions/checkout@v3"
 #@ actionCache = "nirinchev/cache@29e8e4dd9148ea81f9e188480132072cb6cc92d8"
 #@ actionUploadArtifact = "actions/upload-artifact@v3"

.github/templates/pr.yml

@@ -1,5 +1,5 @@
 #@ load("@ytt:template", "template")
-#@ load("build.lib.yml", "deployBaas", "cleanupBaas", "runTests", "runNetCoreTests", "buildUnity", "testUnity")
+#@ load("build.lib.yml", "deployBaas", "cleanupBaas", "runTests", "runNetCoreTests", "runWovenClassesTests", "runSourceGenerationTests", "buildUnity", "testUnity")
 ---
 name: PR Build
 "on":
@@ -40,6 +40,8 @@ jobs:
   _: #@ template.replace(runTests("macOS", runSyncTests = False))
   _: #@ template.replace(runTests("iOS", runSyncTests = False))
   _: #@ template.replace(runTests("Android", runSyncTests = False, additionalSecrets=["AWS_DEVICEFARM_ACCESS_KEY_ID", "AWS_DEVICEFARM_SECRET_ACCESS_KEY", "DEVICEFARM_PROJECT_ARN", "DEVICEFARM_ANDROID_POOL_ARN"]))
+  _: #@ template.replace(runWovenClassesTests())
+  _: #@ template.replace(runSourceGenerationTests())
   test-weaver:
     uses: ./.github/workflows/test-weaver.yml
     name: Test

.github/templates/test-source-generation.yml

@@ -0,0 +1,22 @@
+#@ load("@ytt:template", "template")
+#@ load("common.lib.yml", "checkoutCode", "actionSetupDotnet", "dotnetPublish")
+#@ load("test.lib.yml", "publishTestsResults")
+
+---
+name: test-source-generation
+"on":
+  workflow_call:
+jobs:
+  run-tests:
+    runs-on: windows-latest
+    name: Source Generation
+    timeout-minutes: 45
+    steps:
+      - #@ template.replace(checkoutCode())
+      - uses: #@ actionSetupDotnet
+        with:
+          dotnet-version: '6.0.x'
+      - #@ template.replace(dotnetPublish("Tests/SourceGenerators/Realm.SourceGenerator.Tests", "net6.0", "win-x64"))
+      - name: Run the tests
+        run: #@ "${{ steps.dotnet-publish.outputs.executable-path }}/Realm.SourceGenerator.Tests --result=TestResults.SourceGeneration.xml"
+      - #@ publishTestsResults("TestResults.SourceGeneration.xml", "Source Generation")

.github/templates/test-woven-classes.yml

@@ -0,0 +1,22 @@
+#@ load("@ytt:template", "template")
+#@ load("common.lib.yml", "checkoutCode", "actionSetupDotnet")
+#@ load("test.lib.yml", "fetchPackageArtifacts", "baasTestArgs", "publishTestsResults", "testDefinition", "buildTests", "wovenClassesBuildTests")
+
+---
+name: test-woven-classes
+_: #@ template.replace(testDefinition())
+jobs:
+  run-tests:
+    runs-on: windows-latest
+    name: Woven classes
+    timeout-minutes: 45
+    steps:
+      - #@ template.replace(checkoutCode())
+      - uses: #@ actionSetupDotnet
+        with:
+          dotnet-version: '6.0.x'
+      - #@ template.replace(fetchPackageArtifacts())
+      - #@ template.replace(wovenClassesBuildTests("Tests/Realm.Tests", "net6.0", "win-x64"))
+      - name: Run the tests
+        run: #@ "${{ steps.dotnet-publish.outputs.executable-path }}/Realm.Tests --result=TestResults.WovenClasses.xml --labels=After" + baasTestArgs("weaved-classes")
+      - #@ publishTestsResults("TestResults.WovenClasses.xml", "Woven classes")

.github/templates/test.lib.yml

@@ -1,7 +1,7 @@
 #@ load("@ytt:template", "template")
 #@ load("common.lib.yml", "actionDownloadArtifact", "msbuild", "dotnetPublish", "fetchWrapperBinaries", "checkoutCode")
 
-#@ def fetchPackageArtifacts(versionExpression = "inputs.version", packages = [ "Realm", "Realm.Fody" ]):
+#@ def fetchPackageArtifacts(versionExpression = "inputs.version", packages = [ "Realm", "Realm.Fody", "Realm.SourceGenerator" ]):
 #@ for pkg in packages:
   - name: #@ "Fetch " + pkg
     uses: #@ actionDownloadArtifact
@@ -80,6 +80,16 @@ env:
 #@ }
 #@ return dotnetPublish(projectPath, framework, runtime, properties)
 #@ end
+
+#@ def wovenClassesBuildTests(projectPath, framework, runtime, version = "inputs.version"):
+#@ properties = {
+#@   "RestoreConfigFile": "Tests/Test.NuGet.Config",
+#@   "UseRealmNupkgsWithVersion": "${{ " + version + " }}",
+#@   "TestWeavedClasses": "true",
+#@   "RealmTestsStandaloneExe": "true"
+#@ }
+#@ return dotnetPublish(projectPath, framework, runtime, properties)
+#@ end
 ---
 #@ def prepareTest(fetchWrappers = False, cleanupWorkspace = False):
 - #@ template.replace(checkoutCode())

.github/workflows/build-packages.yml

@@ -136,6 +136,8 @@ jobs:
       run: msbuild Realm/Realm.UnityUtils -t:Pack -p:Configuration=Release -restore -p:PackageOutputPath=${{ github.workspace }}/Realm/packages -p:VersionSuffix=${{ steps.set-version-suffix.outputs.build_suffix }}
     - name: Build Realm/Realm.UnityWeaver
       run: msbuild Realm/Realm.UnityWeaver -t:Pack -p:Configuration=Release -restore -p:PackageOutputPath=${{ github.workspace }}/Realm/packages -p:VersionSuffix=${{ steps.set-version-suffix.outputs.build_suffix }}
+    - name: Build Realm/Realm.SourceGenerator
+      run: msbuild Realm/Realm.SourceGenerator -t:Pack -p:Configuration=Release -restore -p:PackageOutputPath=${{ github.workspace }}/Realm/packages -p:VersionSuffix=${{ steps.set-version-suffix.outputs.build_suffix }}
     - name: Read version
       id: get-version
       run: |
@@ -171,6 +173,13 @@ jobs:
         path: ${{ github.workspace }}/Realm/packages/Realm.UnityWeaver.${{ steps.get-version.outputs.version }}.*nupkg
         retention-days: ${{ github.event_name != 'pull_request' && 30 || 1 }}
         if-no-files-found: error
+    - name: Store artifacts for Realm.SourceGenerator.${{ steps.get-version.outputs.version }}
+      uses: actions/upload-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ steps.get-version.outputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/Realm.SourceGenerator.${{ steps.get-version.outputs.version }}.*nupkg
+        retention-days: ${{ github.event_name != 'pull_request' && 30 || 1 }}
+        if-no-files-found: error
     - name: Store artifacts for ExtractedChangelog
       uses: actions/upload-artifact@v3
       with:

.github/workflows/build-unity.yml

@@ -43,6 +43,11 @@ jobs:
       with:
         name: Realm.UnityWeaver.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Build Unity
       run: dotnet run --project Tools/SetupUnityPackage/ -- realm --packages-path Realm/packages --pack
     - name: Store artifacts for io.realm.unity-${{ inputs.version }}.tgz

.github/workflows/codeql.yml

@@ -46,5 +46,7 @@ jobs:
       run: msbuild Realm/Realm.UnityUtils -p:UseSharedCompilation=false -restore -p:Configuration=Release
     - name: Build Realm.UnityWeaver
       run: msbuild Realm/Realm.UnityWeaver -p:UseSharedCompilation=false -restore -p:Configuration=Release
+    - name: Build Realm.SourceGenerator
+      run: msbuild Realm/Realm.SourceGenerator -p:UseSharedCompilation=false -restore -p:Configuration=Release
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@40542d38bc4936c2ca7da883aeb050a6081b4b31

.github/workflows/pr.yml

@@ -117,6 +117,18 @@ jobs:
       AWS_DEVICEFARM_SECRET_ACCESS_KEY: ${{ secrets.AWS_DEVICEFARM_SECRET_ACCESS_KEY }}
       DEVICEFARM_PROJECT_ARN: ${{ secrets.DEVICEFARM_PROJECT_ARN }}
       DEVICEFARM_ANDROID_POOL_ARN: ${{ secrets.DEVICEFARM_ANDROID_POOL_ARN }}
+  test-weaved-classes:
+    if: always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
+    name: Test
+    needs:
+    - build-packages
+    uses: ./.github/workflows/test-woven-classes.yml
+    with:
+      version: ${{ needs.build-packages.outputs.package_version }}
+  test-source-generation:
+    if: always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled')
+    name: Test
+    uses: ./.github/workflows/test-source-generation.yml
   test-weaver:
     uses: ./.github/workflows/test-weaver.yml
     name: Test

.github/workflows/test-android.yml

@@ -57,6 +57,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with:
@@ -120,6 +125,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Configure .NET
       uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
       with:

.github/workflows/test-ios.yml

@@ -49,6 +49,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with:
@@ -104,6 +109,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Configure .NET
       uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
       with:

.github/workflows/test-macos.yml

@@ -49,6 +49,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with:
@@ -99,6 +104,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - name: Configure .NET
       uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
       with:

.github/workflows/test-net-core.yml

@@ -72,6 +72,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with:

.github/workflows/test-net-framework.yml

@@ -49,6 +49,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with:

.github/workflows/test-source-generation.yml

@@ -0,0 +1,39 @@
+name: test-source-generation
+"on":
+  workflow_call: null
+jobs:
+  run-tests:
+    runs-on: windows-latest
+    name: Source Generation
+    timeout-minutes: 45
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        submodules: false
+        ref: ${{ github.event.pull_request.head.sha }}
+    - name: Register csc problem matcher
+      run: echo "::add-matcher::.github/problem-matchers/csc.json"
+    - name: Register msvc problem matcher
+      run: echo "::add-matcher::.github/problem-matchers/msvc.json"
+    - uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
+      with:
+        dotnet-version: 6.0.x
+    - name: Publish Tests/SourceGenerators/Realm.SourceGenerator.Tests
+      run: dotnet publish Tests/SourceGenerators/Realm.SourceGenerator.Tests -c Release -f net6.0 -r win-x64 --no-self-contained
+    - name: Output executable path
+      id: dotnet-publish
+      run: echo '::set-output name=executable-path::./Tests/SourceGenerators/Realm.SourceGenerator.Tests/bin/Release/net6.0/win-x64'
+    - name: Run the tests
+      run: ${{ steps.dotnet-publish.outputs.executable-path }}/Realm.SourceGenerator.Tests --result=TestResults.SourceGeneration.xml
+    - name: Publish Unit Test Results
+      uses: LaPeste/test-reporter@b8a650f4490e7472b930f56bbb92c7b42dc5db15
+      if: always()
+      with:
+        name: Results Source Generation
+        path: TestResults.SourceGeneration.xml
+        reporter: java-junit
+        list-suites: failed
+        list-tests: failed
+        path-replace-backslashes: true
+        fail-on-error: false

.github/workflows/test-uwp-managed.yml

@@ -53,6 +53,11 @@ jobs:
       with:
         name: Realm.Fody.${{ inputs.version }}
         path: ${{ github.workspace }}/Realm/packages/
+    - name: Fetch Realm.SourceGenerator
+      uses: actions/download-artifact@v3
+      with:
+        name: Realm.SourceGenerator.${{ inputs.version }}
+        path: ${{ github.workspace }}/Realm/packages/
     - uses: realm/ci-actions/mdb-realm/deploy@91ef434f7407cbdbd878f340b96f1dfb498e3010
       if: ${{ inputs.realmUrl }}
       with: