Solution proposal to Issue Add customImage parameter #150 (#151)

* add customImage attribute

* add one more test for input passing && check for customImage == ''

Author: caiusno1

action.yml

@@ -6,6 +6,10 @@ inputs:
     required: false
     default: ''
     description: 'Version of unity to use for building the project.'
+  customImage:
+    required: false
+    default: ''
+    description: 'Specific docker image that should be used for building the project'
   targetPlatform:
     required: false
     default: ''

action/index.js

@@ -25,6 +25,7 @@ class BuildParameters {
 
     return {
       version: Input.unityVersion,
+      customImage: Input.customImage,
       uid,
       gid,
       runnerTempPath: process.env.RUNNER_TEMP,

src/model/build-parameters.js

@@ -8,6 +8,7 @@ class ImageTag {
       name = 'unity3d',
       version = '2019.2.11f1',
       platform,
+      customImage,
     } = imageProperties;
 
     if (!ImageTag.versionPattern.test(version)) {
@@ -24,7 +25,7 @@ class ImageTag {
       ImageTag.imageSuffixes.generic,
     );
 
-    Object.assign(this, { repository, name, version, platform, builderPlatform });
+    Object.assign(this, { repository, name, version, platform, builderPlatform, customImage });
   }
 
   static get versionPattern() {
@@ -82,6 +83,10 @@ class ImageTag {
   toString() {
     const { image, tag } = this;
 
+    if (this.customImage && this.customImage !== '') {
+      return this.customImage;
+    }
+
     return `${image}:${tag}`;
   }
 }

src/model/image-tag.js

@@ -51,6 +51,15 @@ describe('UnityImageVersion', () => {
 
       expect(image.toString()).toStrictEqual(`${defaults.image}:2099.1.1111`);
     });
+    it('returns customImage if given', () => {
+      const image = new ImageTag({
+        version: '2099.1.1111',
+        platform: some.platform,
+        customImage: `${defaults.image}:2099.1.1111@347598437689743986`,
+      });
+
+      expect(image.toString()).toStrictEqual(image.customImage);
+    });
 
     it('returns the specific build platform', () => {
       const image = new ImageTag({ version: '2019.2.11f1', platform: 'WebGL' });

src/model/image-tag.test.js

@@ -12,6 +12,10 @@ class Input {
     return core.getInput('unityVersion');
   }
 
+  static get customImage() {
+    return core.getInput('customImage');
+  }
+
   static get targetPlatform() {
     return core.getInput('targetPlatform') || Platform.default;
   }

src/model/input.js

@@ -20,6 +20,18 @@ describe('Input', () => {
       expect(spy).toHaveBeenCalledTimes(1);
     });
   });
+  describe('customImage', () => {
+    it('returns the default value', () => {
+      expect(Input.customImage).toStrictEqual('');
+    });
+
+    it('takes input from the users workflow', () => {
+      const mockValue = '2020.4.99f9';
+      const spy = jest.spyOn(core, 'getInput').mockReturnValue(mockValue);
+      expect(Input.customImage).toStrictEqual(mockValue);
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+  });
 
   describe('targetPlatform', () => {
     it('returns the default value', () => {