Merge pull request #59 from IShix-g/release

feat: add Unity test setup for EditMode and PlayMode

Author: IShix-g

.github/workflows/reusable-test-runner.yaml

@@ -0,0 +1,91 @@
+name: (Reusable) Test Runner
+
+on:
+  workflow_call:
+    inputs:
+      unity-version:
+        description: 'Version of Unity to use for testing the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt. ⚠️ If testing a Unity Package, this field is required and cannot be set to "auto". https://game.ci/docs/docker/versions/'
+        required: false
+        type: string
+        default: 'auto'
+      project-path:
+        description: 'Specify the path to your Unity project or package to be tested. The path should be relative to the root of your project.'
+        required: false
+        type: string
+        default: ''
+      test-modes:
+        description: 'Comma-separated test modes (e.g., playmode,editmode,standalone).'
+        required: false
+        type: string
+        default: 'playmode,editmode'
+      custom-parameters:
+        description: 'Custom parameters to configure the test runner.  https://game.ci/docs/github/test-runner/#customparameters'
+        required: false
+        type: string
+        default: ''
+    secrets:
+      UNITY_LICENSE:
+        required: true
+      UNITY_EMAIL:
+        required: true
+      UNITY_PASSWORD:
+        required: true
+
+jobs:
+  prepare-test-modes:
+    runs-on: ubuntu-latest
+    outputs:
+      array: ${{ steps.set-array.outputs.array }}
+    steps:
+      - name: Convert test modes to array
+        id: set-array
+        run: |
+          if [[ "${{ inputs.test-modes }}" == *","* ]]; then
+            echo '::set-output name=array::["'$(echo "${{ inputs.test-modes }}" | sed 's/,/","/g')'"]'
+          else
+            echo '::set-output name=array::["${{ inputs.test-modes }}"]'
+          fi
+
+  test-all:
+    name: Test in ${{ matrix.testMode }}
+    runs-on: ubuntu-22.04
+    timeout-minutes: 20
+    strategy:
+      fail-fast: false
+      matrix:
+        unity-version: ${{ inputs.unity-version }}
+        projectPath: ${{ inputs.project-path }}
+        testMode: ${{ fromJson(needs.prepare-test-modes.outputs.array) }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - uses: actions/cache@v3
+        with:
+          path: ${{ matrix.projectPath }}/Library
+          key: Library-${{ matrix.projectPath }}
+          restore-keys: |
+            Library-
+      - uses: game-ci/unity-test-runner@v4
+        id: tests
+        env:
+          UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+        with:
+          projectPath: ${{ matrix.projectPath }}
+          testMode: ${{ matrix.testMode }}
+          artifactsPath: ${{ matrix.testMode }}-artifacts
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          checkName: ${{ matrix.testMode }} Test Results
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: Test results for ${{ matrix.testMode }}
+          path: ${{ steps.tests.outputs.artifactsPath }}
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: Coverage results for ${{ matrix.testMode }}
+          path: ${{ steps.tests.outputs.coveragePath }}

.github/workflows/test-test-runner.yaml

@@ -0,0 +1,23 @@
+name: (Test) Test Runner
+
+on:
+  workflow_dispatch:
+    inputs:
+      unity-version:
+        description: 'Select the Unity version to use'
+        required: true
+        default: '2021.3.45f1'
+        type: choice
+        options:
+          - '2021.3.45f1'
+          - '2022.3.57f1'
+          - '6000.0.37f1'
+jobs:
+  test-runner:
+    uses: ./.github/workflows/reusable-test-runner.yaml
+    secrets:
+      UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+      UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+      UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
+    inputs:
+      unity-version: ${{ inputs.unity-version }}

Assets/Tests.meta

@@ -0,0 +1,28 @@
+
+using NUnit.Framework;
+using UnityEditor;
+
+namespace Tests
+{
+    public class EditorTests
+    {
+        [Test]
+        public void SampleEditorTest1()
+        {
+            Assert.That(1 + 1, Is.EqualTo(2), "1 + 1 should equal 2");
+        }
+
+        [Test]
+        public void SampleEditorTest2()
+        {
+            var activeScenePath = EditorApplication.currentScene;
+            Assert.That(activeScenePath, Is.Not.Null, "There should be an active scene in the editor.");
+        }
+
+        [Test]
+        public void SampleEditorTest3()
+        {
+            Assert.That(EditorPrefs.HasKey("EditorTests_SampleEditorTest3_TestKey"), Is.False, "EditorPrefs should have a key.");
+        }
+    }
+}

Assets/Tests/EditoMode.meta

@@ -0,0 +1,30 @@
+
+using NUnit.Framework;
+using UnityEditor;
+
+namespace Tests
+{
+    public sealed class EditorTests2
+    {
+        [Test]
+        public void BasicMathTest()
+        {
+            Assert.That(5 * 2, Is.EqualTo(10), "5 multiplied by 2 should equal 10.");
+        }
+        
+        [Test]
+        public void EditorPrefsTest()
+        {
+            var testKey = "SampleTestKey";
+            var testValue = "SampleValue";
+            
+            EditorPrefs.SetString(testKey, testValue);
+
+            Assert.That(EditorPrefs.HasKey(testKey), Is.True, "EditorPrefs should contain the key.");
+            Assert.That(EditorPrefs.GetString(testKey), Is.EqualTo(testValue), "EditorPrefs should return the correct value.");
+
+            EditorPrefs.DeleteKey(testKey);
+            Assert.That(EditorPrefs.HasKey(testKey), Is.False, "EditorPrefs key should be deleted.");
+        }
+    }
+}

Assets/Tests/EditoMode/EditorTests.cs

@@ -0,0 +1,23 @@
+{
+    "name": "Tests.EditMode",
+    "rootNamespace": "",
+    "references": [
+        "UnityEngine.TestRunner",
+        "UnityEditor.TestRunner"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [
+        "nunit.framework.dll"
+    ],
+    "autoReferenced": false,
+    "defineConstraints": [
+        "UNITY_INCLUDE_TESTS"
+    ],
+    "versionDefines": [],
+    "noEngineReferences": false
+}