unity-builder/src/model/image-tag.test.ts

import { describe, it, expect, vi, beforeEach, afterEach, beforeAll, afterAll, test } from 'vitest';
import ImageTag from './image-tag';

describe('ImageTag', () => {
  const testImageParameters = {
    editorVersion: '2099.9.9f9',
    targetPlatform: 'Test',
    builderPlatform: '',
    containerRegistryRepository: 'unityci/editor',
    containerRegistryImageVersion: '3',
  };

  const defaults = {
    image: 'unityci/editor',
  };

  describe('constructor', () => {
    it('can be called', () => {
      expect(() => new ImageTag(testImageParameters)).not.toThrow();
    });

    it('accepts parameters and sets the right properties', () => {
      const image = new ImageTag(testImageParameters);

      expect(image.repository).toStrictEqual('unityci/editor');
      expect(image.editorVersion).toStrictEqual(testImageParameters.editorVersion);
      expect(image.targetPlatform).toStrictEqual(testImageParameters.targetPlatform);
      expect(image.builderPlatform).toStrictEqual(testImageParameters.builderPlatform);
    });

    test.each(['2000.0.0f0', '2011.1.11f1', '6000.0.0f1'])(
      'accepts %p version format',
      (version) => {
        expect(
          () =>
            new ImageTag({
              editorVersion: version,
              targetPlatform: testImageParameters.targetPlatform,
            }),
        ).not.toThrow();
      },
    );

    test.each(['some version', ''])('throws for incorrect version %p', (editorVersion) => {
      const { targetPlatform } = testImageParameters;
      expect(() => new ImageTag({ editorVersion, targetPlatform })).toThrow();
    });

    test.each(['nonExisting'])('throws for unsupported target %p', (targetPlatform) => {
      expect(() => new ImageTag({ targetPlatform })).toThrow();
    });
  });

  describe('toString', () => {
    it('returns the correct version', () => {
      const image = new ImageTag({
        editorVersion: '2099.1.1111f1',
        targetPlatform: testImageParameters.targetPlatform,
        containerRegistryRepository: 'unityci/editor',
        containerRegistryImageVersion: '3',
      });
      switch (process.platform) {
        case 'win32':
          expect(image.toString()).toStrictEqual(`${defaults.image}:windows-2099.1.1111f1-3`);
          break;
        case 'linux':
          expect(image.toString()).toStrictEqual(`${defaults.image}:ubuntu-2099.1.1111f1-3`);
          break;
      }
    });
    it('returns customImage if given', () => {
      const image = new ImageTag({
        editorVersion: '2099.1.1111f1',
        targetPlatform: testImageParameters.targetPlatform,
        customImage: `${defaults.image}:2099.1.1111@347598437689743986`,
        containerRegistryRepository: 'unityci/editor',
        containerRegistryImageVersion: '3',
      });

      expect(image.toString()).toStrictEqual(image.customImage);
    });

    it('returns the specific build platform', () => {
      const image = new ImageTag({
        editorVersion: '2019.2.11f1',
        targetPlatform: 'WebGL',
        containerRegistryRepository: 'unityci/editor',
        containerRegistryImageVersion: '3',
      });

      switch (process.platform) {
        case 'win32':
          expect(image.toString()).toStrictEqual(`${defaults.image}:windows-2019.2.11f1-webgl-3`);
          break;
        case 'linux':
          expect(image.toString()).toStrictEqual(`${defaults.image}:ubuntu-2019.2.11f1-webgl-3`);
          break;
      }
    });

    it('returns no specific build platform for generic targetPlatforms', () => {
      const image = new ImageTag({
        editorVersion: '2019.2.11f1',
        targetPlatform: 'NoTarget',
        containerRegistryRepository: 'unityci/editor',
        containerRegistryImageVersion: '3',
      });

      switch (process.platform) {
        case 'win32':
          expect(image.toString()).toStrictEqual(`${defaults.image}:windows-2019.2.11f1-3`);
          break;
        case 'linux':
          expect(image.toString()).toStrictEqual(`${defaults.image}:ubuntu-2019.2.11f1-3`);
          break;
      }
    });
  });
});