Add action logic

Author: webbertakken

README.md

@@ -1,34 +1,35 @@
 # Unity - Request Activation File
+
 [![Actions status](https://github.com/webbertakken/unity-request-manual-activation-file/workflows/Actions%20%F0%9F%98%8E/badge.svg)](https://github.com/webbertakken/unity-request-manual-activation-file/actions?query=branch%3Amaster+workflow%3A"Actions+😎")
 
 ---
 
 GitHub Action for
 [requesting the manual activation file](https://github.com/marketplace/actions/unity-request-activation-file) for Unity.
 
-Part of the 
-[Unity Actions](https://github.com/webbertakken/unity-actions) 
+Part of the
+[Unity Actions](https://github.com/webbertakken/unity-actions)
 collection.
 
 ---
 
 Use this action to acquire a Unity personal license. Required in order to
-use the 
+use the
 [Activate](https://github.com/webbertakken/unity-actions#activate),
 [Test](https://github.com/webbertakken/unity-actions#test) and
 [Build](https://github.com/webbertakken/unity-actions#build)
 actions.
 
 ### Documentation
 
-See the 
+See the
 [Unity Actions](https://github.com/webbertakken/unity-actions)
 collection repository for workflow documentation and reference implementation.
 
 ## Usage
 
 Create a file called `.github/workflows/activation.yml` and add a job to it.
- 
+
 ```yaml
 name: Acquire activation file
 on: [push]
@@ -42,21 +43,23 @@ jobs:
 To **configure** this action, add this step and set the id.
 
 ```yaml
-      # Request manual activation file
-      - name: Request manual activation file
-        uses: webbertakken/unity-request-manual-activation-file@v1
-        id: getManualLicenseFile
+# Request manual activation file
+- name: Request manual activation file
+  id: getManualLicenseFile
+  uses: webbertakken/unity-request-manual-activation-file@v1
+  with:
+    unityVersion: 2019.2.11f1
 ```
 
-You use the id to **upload the output file** like so:     
+You use the id to **upload the output file** like so:
 
 ```yaml
-      # Upload artifact (Unity_v20XX.X.XXXX.alf)
-      - name: Expose as artifact
-        uses: actions/upload-artifact@v1
-        with:
-          name: ${{ steps.getManualLicenseFile.outputs.filePath }}
-          path: ${{ steps.getManualLicenseFile.outputs.filePath }}
+# Upload artifact (Unity_v20XX.X.XXXX.alf)
+- name: Expose as artifact
+  uses: actions/upload-artifact@v1
+  with:
+    name: ${{ steps.getManualLicenseFile.outputs.filePath }}
+    path: ${{ steps.getManualLicenseFile.outputs.filePath }}
 ```
 
 Commit and push your workflow definition.
@@ -71,20 +74,20 @@ Follow these (one-time) steps for simple activation.
 - Open `Github` > `Your repository` > `Settings` > `Secrets`.
 - Add a new secret called `UNITY_LICENSE` and copy the contents your license file into it.
 
-You can now use the 
+You can now use the
 [Activate](https://github.com/webbertakken/unity-actions#activate),
 [Test](https://github.com/webbertakken/unity-actions#test) and
 [Build](https://github.com/webbertakken/unity-actions#build)
 actions.
 
 ## More actions
 
-Visit 
-[Unity Actions](https://github.com/webbertakken/unity-actions) 
+Visit
+[Unity Actions](https://github.com/webbertakken/unity-actions)
 to find related actions for Unity.
 
 Feel free to contribute.
 
-## Licence 
+## Licence
 
 [MIT](./LICENSE)

action/index.js

@@ -0,0 +1,21 @@
+import { Action, Docker, Input, ImageTag } from './model';
+
+const core = require('@actions/core');
+
+async function action() {
+  Action.checkCompatibility();
+
+  const { dockerfile, workspace, actionFolder } = Action;
+  const { unityVersion } = Input.getFromUser();
+  const baseImage = ImageTag.createForBase(unityVersion);
+
+  // Build docker image
+  const actionImage = await Docker.build({ path: actionFolder, dockerfile, baseImage });
+
+  // Run docker image
+  await Docker.run(actionImage, { workspace, unityVersion });
+}
+
+action().catch(error => {
+  core.setFailed(error.message);
+});

src/index.js

@@ -0,0 +1,48 @@
+import path from 'path';
+
+class Action {
+  static get supportedPlatforms() {
+    return ['linux'];
+  }
+
+  static get isRunningLocally() {
+    return process.env.RUNNER_WORKSPACE === undefined;
+  }
+
+  static get isRunningFromSource() {
+    return path.basename(__dirname) === 'model';
+  }
+
+  static get name() {
+    return 'unity-request-manual-activation-file';
+  }
+
+  static get rootFolder() {
+    if (Action.isRunningFromSource) {
+      return path.dirname(path.dirname(path.dirname(__filename)));
+    }
+
+    return path.dirname(path.dirname(__filename));
+  }
+
+  static get actionFolder() {
+    return `${Action.rootFolder}/action`;
+  }
+
+  static get dockerfile() {
+    return `${Action.actionFolder}/Dockerfile`;
+  }
+
+  static get workspace() {
+    return process.env.GITHUB_WORKSPACE;
+  }
+
+  static checkCompatibility() {
+    const currentPlatform = process.platform;
+    if (!Action.supportedPlatforms.includes(currentPlatform)) {
+      throw new Error(`Currently ${currentPlatform}-platform is not supported`);
+    }
+  }
+}
+
+export default Action;

src/model/action.js

@@ -0,0 +1,36 @@
+import path from 'path';
+import fs from 'fs';
+import Action from './action';
+
+describe('Action', () => {
+  describe('compatibility check', () => {
+    it('throws for anything other than linux', () => {
+      if (process.platform !== 'linux') {
+        expect(() => Action.checkCompatibility()).toThrow();
+      } else {
+        expect(() => Action.checkCompatibility()).not.toThrow();
+      }
+    });
+  });
+
+  it('returns the root folder of the action', () => {
+    const { rootFolder, name } = Action;
+
+    expect(path.basename(rootFolder)).toStrictEqual(name);
+    expect(fs.existsSync(rootFolder)).toStrictEqual(true);
+  });
+
+  it('returns the action folder', () => {
+    const { actionFolder } = Action;
+
+    expect(path.basename(actionFolder)).toStrictEqual('action');
+    expect(fs.existsSync(actionFolder)).toStrictEqual(true);
+  });
+
+  it('returns the docker file', () => {
+    const { dockerfile } = Action;
+
+    expect(path.basename(dockerfile)).toStrictEqual('Dockerfile');
+    expect(fs.existsSync(dockerfile)).toStrictEqual(true);
+  });
+});

src/model/action.test.js

@@ -0,0 +1,53 @@
+import { exec } from '@actions/exec';
+import ImageTag from './image-tag';
+
+class Docker {
+  static async build(buildParameters, silent = false) {
+    const { path, dockerfile, baseImage } = buildParameters;
+    const { version } = baseImage;
+
+    const tag = ImageTag.createForAction(version);
+    const command = `docker build ${path} \
+      --file ${dockerfile} \
+      --build-arg IMAGE=${baseImage} \
+      --tag ${tag}`;
+
+    await exec(command, null, { silent });
+
+    return tag;
+  }
+
+  static async run(image, parameters, silent = false) {
+    const { unityVersion, workspace } = parameters;
+
+    const command = `docker run \
+        --workdir /github/workspace \
+        --rm \
+        --env UNITY_VERSION=${unityVersion} \
+        --env HOME=/github/home \
+        --env GITHUB_REF \
+        --env GITHUB_SHA \
+        --env GITHUB_REPOSITORY \
+        --env GITHUB_ACTOR \
+        --env GITHUB_WORKFLOW \
+        --env GITHUB_HEAD_REF \
+        --env GITHUB_BASE_REF \
+        --env GITHUB_EVENT_NAME \
+        --env GITHUB_WORKSPACE=/github/workspace \
+        --env GITHUB_ACTION \
+        --env GITHUB_EVENT_PATH \
+        --env RUNNER_OS \
+        --env RUNNER_TOOL_CACHE \
+        --env RUNNER_TEMP \
+        --env RUNNER_WORKSPACE \
+        --volume "/var/run/docker.sock":"/var/run/docker.sock" \
+        --volume "/home/runner/work/_temp/_github_home":"/github/home" \
+        --volume "/home/runner/work/_temp/_github_workflow":"/github/workflow" \
+        --volume "${workspace}":"/github/workspace" \
+        ${image}`;
+
+    await exec(command, null, { silent });
+  }
+}
+
+export default Docker;

src/model/docker.js

@@ -0,0 +1,20 @@
+import Action from './action';
+import Docker from './docker';
+import ImageTag from './image-tag';
+
+describe('Docker', () => {
+  it('builds', async () => {
+    const path = Action.actionFolder;
+    const dockerfile = `${path}/Dockerfile`;
+    const baseImage = new ImageTag({
+      repository: '',
+      name: 'alpine',
+      version: '3',
+    });
+
+    const tag = await Docker.build({ path, dockerfile, baseImage }, true);
+
+    expect(tag).toBeInstanceOf(ImageTag);
+    expect(tag.toString()).toStrictEqual('unity-action:3');
+  }, 240000);
+});

src/model/docker.test.js

@@ -1,14 +1,24 @@
 import { trimStart } from 'lodash-es';
 
 class ImageTag {
-  constructor({ version }) {
+  static createForBase(version) {
+    const repository = 'gableroux';
+    const name = 'unity3d';
+    return new this({ repository, name, version });
+  }
+
+  static createForAction(version) {
+    const repository = '';
+    const name = 'unity-action';
+    return new this({ repository, name, version });
+  }
+
+  constructor({ repository = '', name, version }) {
     if (!ImageTag.versionPattern.test(version)) {
       throw new Error(`Invalid version "${version}".`);
     }
 
-    this.repository = 'gableroux';
-    this.name = 'unity3d';
-    this.version = version;
+    Object.assign(this, { repository, name, version });
   }
 
   static get versionPattern() {

src/model/image-tag.js

@@ -3,6 +3,7 @@ import ImageTag from './image-tag';
 describe('UnityImageVersion', () => {
   describe('constructor', () => {
     const some = {
+      name: 'someName',
       version: '2020.0.00f0',
     };
 
@@ -13,8 +14,8 @@ describe('UnityImageVersion', () => {
     it('accepts parameters and sets the right properties', () => {
       const image = new ImageTag(some);
 
-      expect(image.repository).toStrictEqual('gableroux');
-      expect(image.name).toStrictEqual('unity3d');
+      expect(image.repository).toStrictEqual('');
+      expect(image.name).toStrictEqual(some.name);
       expect(image.version).toStrictEqual(some.version);
     });
 
@@ -29,7 +30,7 @@ describe('UnityImageVersion', () => {
 
   describe('toString', () => {
     it('returns the correct version', () => {
-      const image = new ImageTag({ version: '2099.1.1111' });
+      const image = ImageTag.createForBase('2099.1.1111');
 
       expect(image.toString()).toStrictEqual(`gableroux/unity3d:2099.1.1111`);
     });

src/model/image-tag.test.js

@@ -0,0 +1,6 @@
+import Action from './action';
+import Docker from './docker';
+import Input from './input';
+import ImageTag from './image-tag';
+
+export { Action, Docker, Input, ImageTag };