Add some component tests to reference unity project (#86)

* Add some component tests to reference unity project

* Use action/setup-node@v2 to avoid problems with build

.github/workflows/main.yml

@@ -12,14 +12,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1.1.2
+      - uses: actions/setup-node@v2
         with:
           node-version: 12.x
       - run: yarn
       - run: yarn lint
       - run: yarn test
       - run: yarn build || { echo "build command should always succeed" ; exit 61; }
-      - run: yarn build --quiet && git diff --quiet action || { echo "action should be auto generated" ; exit 62; }
+      - run: yarn build --quiet && git diff --quiet action || { echo "ERROR - index.js is different from repository version. Forgot to run `yarn build`?" ; exit 62; }
 
   testAllModesLikeInTheReadme:
     name: Test in ${{ matrix.testMode }} on version ${{ matrix.unityVersion }}
@@ -38,7 +38,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           lfs: true
-      - uses: actions/cache@v1.1.0
+      - uses: actions/cache@v2
         with:
           path: ${{ matrix.projectPath }}/Library
           key: Library-${{ matrix.projectPath }}

.prettierrc.json

@@ -2,5 +2,6 @@
   "semi": true,
   "singleQuote": true,
   "trailingComma": "all",
-  "printWidth": 100
+  "printWidth": 100,
+  "arrowParens": "avoid"
 }

CONTRIBUTING.md

@@ -31,8 +31,8 @@ You have [Node](https://nodejs.org/) installed at v12.2.0+ and [Yarn](https://ya
 Please note that commit hooks will run automatically to perform some tasks;
 
 - format your code
-- run tests
-- build distributable files
+- run tests & lint - `yarn lint && yarn test`
+- build distributable files - `yarn build`
 
 #### License
 

README.md

@@ -1,15 +1,12 @@
-<div align="center">
-<a href="https://github.com/marketplace/actions/unity-test-runner">
-<img width="800" src="media/UnityTestRunner-Logo.png" alt="Unity Test Runner">
-</a>
-<br />
-<br />
+# Unity - Test runner
+
+(Not affiliated with Unity Technologies)
 
 GitHub Action to
 [run tests](https://github.com/marketplace/actions/unity-test-runner)
 for any Unity project.
 
-Part of the <a href="https://unity-ci.com"><img height="30" src="media/UnityCI-ReferenceLogo.png" alt="Unity CI"></a> open source project.
+Part of the <a href="https://game.ci">GameCI</a> open source project.
 <br />
 <br />
 
@@ -17,30 +14,28 @@ Part of the <a href="https://unity-ci.com"><img height="30" src="media/UnityCI-R
 <br />
 <br />
 
-</div>
-
 ## How to use
 
 Find the
-[docs](https://unity-ci.com/docs/github)
-on the Unity CI
-[website](https://unity-ci.com/).
+[docs](https://game.ci/docs)
+on the GameCI
+[website](https://game.ci/).
 
 ## Related actions
 
 Visit the
-<a href="https://github.com/webbertakken/unity-actions"><img height="30" src="media/UnityActions-ReferenceLogo.png" alt="Unity Actions"></a>
+GameCI <a href="https://github.com/game-ci/unity-actions">Unity Actions</a>
 status repository for related Actions.
 
 ## Community
 
 Feel free to join us on
-<a href="http://unity-ci.com/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
+<a href="http://game.ci/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
 and engage with the community.
 
 ## Contributing
 
-To help out sharpen the documentation, please find the docs [repository](https://github.com/Unity-CI/Website).
+To help improve the documentation, please find the docs [repository](https://github.com/game-ci/documentation).
 
 To contribute to this project, kindly read the [contribution guide](./CONTRIBUTING.md).
 

action.yml

@@ -4,8 +4,8 @@ description: 'Run tests for any Unity project.'
 inputs:
   unityVersion:
     required: false
-    default: '2019.2.11f1'
-    description: 'Version of unity to use for testing the project.'
+    default: 'auto'
+    description: 'Version of unity to use for testing the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt'
   customImage:
     required: false
     default: ''

package.json

@@ -13,30 +13,30 @@
     "test": "jest"
   },
   "dependencies": {
-    "@actions/core": "^1.2.1",
-    "@actions/exec": "1.0.3",
-    "@actions/github": "^2.1.1"
+    "@actions/core": "^1.2.6",
+    "@actions/exec": "1.0.4",
+    "@actions/github": "^4.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "7.8.4",
-    "@babel/core": "7.8.7",
-    "@babel/preset-env": "7.8.7",
-    "@zeit/ncc": "0.21.1",
+    "@babel/cli": "7.12.10",
+    "@babel/core": "7.12.10",
+    "@babel/preset-env": "7.12.11",
+    "@zeit/ncc": "0.22.3",
     "babel-eslint": "10.1.0",
-    "eslint": "6.8.0",
-    "eslint-config-airbnb": "18.0.1",
-    "eslint-config-prettier": "6.10.0",
-    "eslint-plugin-flowtype": "4.6.0",
-    "eslint-plugin-import": "2.20.1",
-    "eslint-plugin-jsx-a11y": "6.2.3",
-    "eslint-plugin-prettier": "3.1.2",
-    "eslint-plugin-react": "7.19.0",
-    "eslint-plugin-unicorn": "16.1.1",
-    "husky": "4.2.3",
-    "jest": "25.1.0",
-    "lint-staged": "10.0.8",
-    "lodash-es": "4.17.15",
-    "prettier": "1.19.1"
+    "eslint": "7.17.0",
+    "eslint-config-airbnb": "18.2.1",
+    "eslint-config-prettier": "7.1.0",
+    "eslint-plugin-flowtype": "5.2.0",
+    "eslint-plugin-import": "2.22.1",
+    "eslint-plugin-jsx-a11y": "6.4.1",
+    "eslint-plugin-prettier": "3.3.1",
+    "eslint-plugin-react": "7.22.0",
+    "eslint-plugin-unicorn": "25.0.1",
+    "husky": "4.3.7",
+    "jest": "26.6.3",
+    "lint-staged": "10.5.3",
+    "lodash-es": "4.17.20",
+    "prettier": "2.2.1"
   },
   "husky": {
     "hooks": {

src/model/docker.js

@@ -12,7 +12,7 @@ class Docker {
       --build-arg IMAGE=${baseImage} \
       --tag ${tag}`;
 
-    await exec(command, null, { silent });
+    await exec(command, undefined, { silent });
 
     return tag;
   }
@@ -64,7 +64,7 @@ class Docker {
         ${useHostNetwork ? '--net=host' : ''} \
         ${image}`;
 
-    await exec(command, null, { silent });
+    await exec(command, undefined, { silent });
   }
 }
 

src/model/image-tag.test.js

@@ -1,6 +1,6 @@
 import ImageTag from './image-tag';
 
-describe('UnityImageVersion', () => {
+describe('ImageTag', () => {
   describe('constructor', () => {
     const some = {
       name: 'someName',
@@ -23,7 +23,7 @@ describe('UnityImageVersion', () => {
       expect(() => new ImageTag({ version })).not.toThrow();
     });
 
-    test.each(['some version', '', 1, null])('throws for incorrect versions %p', version => {
+    test.each(['some version', '', 1, undefined])('throws for incorrect versions %p', version => {
       expect(() => new ImageTag({ version })).toThrow();
     });
   });

src/model/input.js

@@ -1,5 +1,6 @@
 import { getInput } from '@actions/core';
 import { includes } from 'lodash-es';
+import UnityVersionParser from './unity-version-parser';
 
 class Input {
   static get testModes() {
@@ -7,14 +8,15 @@ class Input {
   }
 
   static isValidFolderName(folderName) {
-    const validFolderName = new RegExp(/^(\.|\.\/)?(\.?\w+([-_]?\w+)*\/?)*$/);
+    const validFolderName = new RegExp(/^(\.|\.\/)?(\.?\w+([_-]?\w+)*\/?)*$/);
 
     return validFolderName.test(folderName);
   }
 
   static getFromUser() {
     // Input variables specified in workflow using "with" prop.
-    const unityVersion = getInput('unityVersion') || '2019.2.11f1';
+    const rawUnityVersion = getInput('unityVersion') || 'auto';
+    const customImage = getInput('customImage') || '';
     const testMode = getInput('testMode') || 'all';
     const rawProjectPath = getInput('projectPath') || '.';
     const rawArtifactsPath = getInput('artifactsPath') || 'artifacts';
@@ -42,10 +44,13 @@ class Input {
     const projectPath = rawProjectPath.replace(/\/$/, '');
     const artifactsPath = rawArtifactsPath.replace(/\/$/, '');
     const useHostNetwork = rawUseHostNetwork === 'true';
+    const unityVersion =
+      rawUnityVersion === 'auto' ? UnityVersionParser.read(projectPath) : rawUnityVersion;
 
     // Return sanitised input
     return {
       unityVersion,
+      customImage,
       projectPath,
       testMode,
       artifactsPath,

src/model/unity-version-parser.js

@@ -0,0 +1,26 @@
+import fs from 'fs';
+import path from 'path';
+
+class UnityVersionParser {
+  static get versionPattern() {
+    return /20\d{2}\.\d\.\w{3,4}|3/;
+  }
+
+  static parse(projectVersionTxt) {
+    const matches = projectVersionTxt.match(UnityVersionParser.versionPattern);
+    if (!matches || matches.length === 0) {
+      throw new Error(`Failed to parse version from "${projectVersionTxt}".`);
+    }
+    return matches[0];
+  }
+
+  static read(projectPath) {
+    const filePath = path.join(projectPath, 'ProjectSettings', 'ProjectVersion.txt');
+    if (!fs.existsSync(filePath)) {
+      return 'auto';
+    }
+    return UnityVersionParser.parse(fs.readFileSync(filePath, 'utf8'));
+  }
+}
+
+export default UnityVersionParser;

src/model/unity-version-parser.test.js

@@ -0,0 +1,25 @@
+import UnityVersionParser from './unity-version-parser';
+
+describe('UnityVersionParser', () => {
+  describe('parse', () => {
+    it('throws for empty string', () => {
+      expect(() => UnityVersionParser.parse('')).toThrow(Error);
+    });
+
+    it('parses from ProjectVersion.txt', () => {
+      const projectVersionContents = `m_EditorVersion: 2019.2.11f1
+      m_EditorVersionWithRevision: 2019.2.11f1 (5f859a4cfee5)`;
+      expect(UnityVersionParser.parse(projectVersionContents)).toBe('2019.2.11f1');
+    });
+  });
+
+  describe('read', () => {
+    it('does not throw', () => {
+      expect(() => UnityVersionParser.read('')).not.toThrow();
+    });
+
+    it('reads from unity-project-with-correct-tests', () => {
+      expect(UnityVersionParser.read('./unity-project-with-correct-tests')).toBe('2019.2.11f1');
+    });
+  });
+});

unity-project-with-correct-tests/Assets/Scripts/SampleComponent.cs

@@ -0,0 +1,17 @@
+using UnityEngine;
+
+public class SampleComponent : MonoBehaviour
+{
+  public BasicCounter Counter;
+
+  void Start()
+  {
+    Counter = new BasicCounter(5);
+  }
+
+  // Update is called once per frame
+  void Update()
+  {
+    Counter.Increment();
+  }
+}

unity-project-with-correct-tests/Assets/Scripts/SampleComponent.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 7a5f63b9ea4b465194653c4d681faf42
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

unity-project-with-correct-tests/Assets/Scripts/TimerComponent.cs

@@ -0,0 +1,18 @@
+using UnityEngine;
+
+public class TimerComponent : MonoBehaviour
+{
+  public BasicCounter Counter = new BasicCounter();
+  public float Timer = 1f;
+
+  void Update()
+  {
+    Timer -= Time.deltaTime;
+
+    if (Timer > 0)
+      return;
+
+    Counter.Increment();
+    Timer = 1f;
+  }
+}

unity-project-with-correct-tests/Assets/Scripts/TimerComponent.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: b668d68a45bb48108ccda73269e3da7b
+timeCreated: 1610056748

unity-project-with-correct-tests/Assets/Tests/PlayMode/PlayModeTests.asmdef

@@ -2,7 +2,8 @@
     "name": "PlayModeTests",
     "references": [
         "UnityEngine.TestRunner",
-        "UnityEditor.TestRunner"
+        "UnityEditor.TestRunner",
+        "MyScripts"
     ],
     "includePlatforms": [],
     "excludePlatforms": [],
@@ -16,4 +17,4 @@
         "UNITY_INCLUDE_TESTS"
     ],
     "versionDefines": []
-}
+}

unity-project-with-correct-tests/Assets/Tests/PlayMode/SampleComponentTest.cs

@@ -0,0 +1,31 @@
+using System.Collections;
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace Tests
+{
+  public class SampleComponentTest
+  {
+    private GameObject target;
+    private SampleComponent component;
+
+    [SetUp]
+    public void Setup()
+    {
+      target = GameObject.Instantiate(new GameObject());
+      component = target.AddComponent<SampleComponent>();
+    }
+
+    [UnityTest]
+    public IEnumerator TestIncrementOnUpdateAfterNextFrame()
+    {
+      // Save the current value, since it was updated after component Start() method called
+      var count = component.Counter.Count;
+
+      // Skip frame and assert the new value
+      yield return null;
+      Assert.AreEqual(count + 1, component.Counter.Count);
+    }
+  }
+}

unity-project-with-correct-tests/Assets/Tests/PlayMode/SampleComponentTest.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: c688799d17b14d35ad515bff9de8d12c
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

unity-project-with-correct-tests/Assets/Tests/PlayMode/SamplePlayModeTest.cs

@@ -1,7 +1,5 @@
 using System.Collections;
-using System.Collections.Generic;
 using NUnit.Framework;
-using UnityEngine;
 using UnityEngine.TestTools;
 
 namespace Tests
@@ -12,8 +10,14 @@ namespace Tests
     [Test]
     public void NewTestScriptSimplePasses()
     {
-      // Use the Assert class to test conditions
-      Assert.True(true);
+      // Given
+      var counter = new BasicCounter(0);
+
+      // When
+      counter.Increment();
+
+      // Then
+      Assert.AreEqual(1, counter.Count);
     }
 
     // A UnityTest behaves like a coroutine in Play Mode. In Edit Mode you can use
@@ -21,9 +25,18 @@ namespace Tests
     [UnityTest]
     public IEnumerator NewTestScriptWithEnumeratorPasses()
     {
+      // Given
+      var counter = new BasicCounter(3);
+
       // Use the Assert class to test conditions.
       // Use yield to skip a frame.
       yield return null;
+
+      // When
+      counter.Increment();
+
+      // Then
+      Assert.AreEqual(4, counter.Count);
     }
   }
 }

unity-project-with-correct-tests/Assets/Tests/PlayMode/TimerComponentTest.cs

@@ -0,0 +1,66 @@
+using System.Collections;
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace Tests
+{
+  public class TimerComponentTest
+  {
+    private GameObject target;
+    private TimerComponent component;
+
+    [SetUp]
+    public void Setup()
+    {
+      target = GameObject.Instantiate(new GameObject());
+      component = target.AddComponent<TimerComponent>();
+    }
+
+    [UnityTest]
+    public IEnumerator TestIncrementAfterSomeTime()
+    {
+      // Save the current value, since it was updated after component Start() method called
+      var count = component.Counter.Count;
+
+      // Skip frame and assert the new value
+      yield return null;
+      Assert.AreEqual(count, component.Counter.Count);
+
+      yield return new WaitForSeconds(1.1f);
+      Assert.AreEqual(count + 1, component.Counter.Count);
+
+      yield return new WaitForSeconds(1.1f);
+      Assert.AreEqual(count + 2, component.Counter.Count);
+    }
+
+    [UnityTest]
+    public IEnumerator TestTimeScaleIsAffectingIncrement()
+    {
+      // Save the current value, since it was updated after component Start() method called
+      var count = component.Counter.Count;
+      Time.timeScale = .5f;
+
+      // Skip frame and assert the new value
+      yield return null;
+      Assert.AreEqual(count, component.Counter.Count);
+
+      yield return WaitForRealSeconds(1.1f);
+      Assert.AreEqual(count, component.Counter.Count);
+
+      yield return WaitForRealSeconds(1.1f);
+      Assert.AreEqual(count + 1, component.Counter.Count);
+    }
+
+    // Skipping time ignoring Time.scale
+    // https://answers.unity.com/questions/301868/yield-waitforseconds-outside-of-timescale.html
+    public static IEnumerator WaitForRealSeconds(float time)
+    {
+      float start = Time.realtimeSinceStartup;
+      while (Time.realtimeSinceStartup < start + time)
+      {
+        yield return null;
+      }
+    }
+  }
+}

unity-project-with-correct-tests/Assets/Tests/PlayMode/TimerComponentTest.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 818b22370d404398b87b47a922a435c9
+timeCreated: 1610056889