Default unityVersion to auto to use ProjectSettings/ProjectVersion.txt (#162) (#188)

action.yml

@@ -4,8 +4,8 @@ description: 'Build Unity projects for different platforms.'
 inputs:
   unityVersion:
     required: false
-    default: ''
+    default: 'auto'
-    description: 'Version of unity to use for building the project.'
+    description: 'Version of unity to use for building the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt'
   customImage:
     required: false
     default: ''

src/model/build-parameters.js

@@ -1,6 +1,7 @@
 import AndroidVersioning from './android-versioning';
 import Input from './input';
 import Platform from './platform';
+import UnityVersioning from './unity-versioning';
 import Versioning from './versioning';
 
 class BuildParameters {
@@ -10,6 +11,12 @@ class BuildParameters {
       Input.targetPlatform,
       Input.androidAppBundle,
     );
+
+    const unityVersion = UnityVersioning.determineUnityVersion(
+      Input.projectPath,
+      Input.unityVersion,
+    );
+
     const buildVersion = await Versioning.determineVersion(
       Input.versioningStrategy,
       Input.specifiedVersion,
@@ -21,7 +28,7 @@ class BuildParameters {
     );
 
     return {
-      version: Input.unityVersion,
+      version: unityVersion,
       customImage: Input.customImage,
 
       runnerTempPath: process.env.RUNNER_TEMP,

src/model/build-parameters.test.js

@@ -1,4 +1,5 @@
 import Versioning from './versioning';
+import UnityVersioning from './unity-versioning';
 import BuildParameters from './build-parameters';
 import Input from './input';
 import Platform from './platform';
@@ -7,6 +8,10 @@ const determineVersion = jest
   .spyOn(Versioning, 'determineVersion')
   .mockImplementation(() => '1.3.37');
 
+const determineUnityVersion = jest
+  .spyOn(UnityVersioning, 'determineUnityVersion')
+  .mockImplementation(() => '2019.2.11f1');
+
 afterEach(() => {
   jest.clearAllMocks();
 });
@@ -22,12 +27,9 @@ describe('BuildParameters', () => {
       expect(determineVersion).toHaveBeenCalledTimes(1);
     });
 
-    it('returns the version', async () => {
+    it('determines the unity version only once', async () => {
-      const mockValue = 'someVersion';
+      await BuildParameters.create();
-      jest.spyOn(Input, 'unityVersion', 'get').mockReturnValue(mockValue);
+      expect(determineUnityVersion).toHaveBeenCalledTimes(1);
-      await expect(BuildParameters.create()).resolves.toEqual(
-        expect.objectContaining({ version: mockValue }),
-      );
     });
 
     it('returns the android version code with provided input', async () => {

src/model/image-tag.test.js

@@ -1,6 +1,6 @@
 import ImageTag from './image-tag';
 
-describe('UnityImageVersion', () => {
+describe('ImageTag', () => {
   const some = {
     repository: 'test1',
     name: 'test2',

src/model/input.js

@@ -9,7 +9,7 @@ const core = require('@actions/core');
  */
 class Input {
   static get unityVersion() {
-    return core.getInput('unityVersion');
+    return core.getInput('unityVersion') || 'auto';
   }
 
   static get customImage() {

src/model/input.test.js

@@ -10,7 +10,7 @@ afterEach(() => {
 describe('Input', () => {
   describe('unityVersion', () => {
     it('returns the default value', () => {
-      expect(Input.unityVersion).toStrictEqual('');
+      expect(Input.unityVersion).toStrictEqual('auto');
     });
 
     it('takes input from the users workflow', () => {

src/model/unity-versioning.js

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

src/model/unity-versioning.test.js

@@ -0,0 +1,35 @@
+import UnityVersioning from './unity-versioning';
+
+describe('Unity Versioning', () => {
+  describe('parse', () => {
+    it('throws for empty string', () => {
+      expect(() => UnityVersioning.parse('')).toThrow(Error);
+    });
+
+    it('parses from ProjectVersion.txt', () => {
+      const projectVersionContents = `m_EditorVersion: 2019.2.11f1
+      m_EditorVersionWithRevision: 2019.2.11f1 (5f859a4cfee5)`;
+      expect(UnityVersioning.parse(projectVersionContents)).toBe('2019.2.11f1');
+    });
+  });
+
+  describe('read', () => {
+    it('does not throw', () => {
+      expect(() => UnityVersioning.read('')).not.toThrow();
+    });
+
+    it('reads from test-project', () => {
+      expect(UnityVersioning.read('./test-project')).toBe('2019.2.11f1');
+    });
+  });
+
+  describe('determineUnityVersion', () => {
+    it('defaults to parsed version', () => {
+      expect(UnityVersioning.determineUnityVersion('./test-project', 'auto')).toBe('2019.2.11f1');
+    });
+
+    it('use specified unityVersion', () => {
+      expect(UnityVersioning.determineUnityVersion('./test-project', '1.2.3')).toBe('1.2.3');
+    });
+  });
+});