privacy.sexy/tests/unit/application/Environment/Environment.spec.ts

import { describe, it, expect } from 'vitest';
import { IBrowserOsDetector } from '@/application/Environment/BrowserOs/IBrowserOsDetector';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { Environment, IEnvironmentVariables } from '@/application/Environment/Environment';
import { DesktopOsTestCases } from './DesktopOsTestCases';

interface EnvironmentVariables {
  window?: unknown;
  process?: unknown;
  navigator?: unknown;
}

class SystemUnderTest extends Environment {
  constructor(variables: EnvironmentVariables, browserOsDetector?: IBrowserOsDetector) {
    super(variables as unknown as IEnvironmentVariables, browserOsDetector);
  }
}

describe('Environment', () => {
  describe('isDesktop', () => {
    it('returns true if process type is renderer', () => {
      // arrange
      const window = {
        process: {
          type: 'renderer',
        },
      };
      // act
      const sut = new SystemUnderTest({ window });
      // assert
      expect(sut.isDesktop).to.equal(true);
    });
    it('returns true if electron is defined as process version', () => {
      // arrange
      const process = {
        versions: {
          electron: true,
        },
      };
      // act
      const sut = new SystemUnderTest({ process });
      // assert
      expect(sut.isDesktop).to.equal(true);
    });
    it('returns true if navigator user agent has electron', () => {
      // arrange
      const navigator = {
        userAgent: 'Electron',
      };
      // act
      const sut = new SystemUnderTest({ navigator });
      // assert
      expect(sut.isDesktop).to.equal(true);
    });
    it('returns false as default', () => {
      const sut = new SystemUnderTest({});
      expect(sut.isDesktop).to.equal(false);
    });
  });
  describe('os', () => {
    it('returns undefined without user agent', () => {
      // arrange
      const expected = undefined;
      const mock: IBrowserOsDetector = {
        detect: () => {
          throw new Error('should not reach here');
        },
      };
      const sut = new SystemUnderTest({}, mock);
      // act
      const actual = sut.os;
      // assert
      expect(actual).to.equal(expected);
    });
    it('browser os from BrowserOsDetector', () => {
      // arrange
      const givenUserAgent = 'testUserAgent';
      const expected = OperatingSystem.macOS;
      const window = {
        navigator: {
          userAgent: givenUserAgent,
        },
      };
      const mock: IBrowserOsDetector = {
        detect: (agent) => {
          if (agent !== givenUserAgent) {
            throw new Error('Unexpected user agent');
          }
          return expected;
        },
      };
      // act
      const sut = new SystemUnderTest({ window }, mock);
      const actual = sut.os;
      // assert
      expect(actual).to.equal(expected);
    });
    describe('desktop os', () => {
      const navigator = {
        userAgent: 'Electron',
      };
      for (const testCase of DesktopOsTestCases) {
        it(testCase.processPlatform, () => {
          // arrange
          const process = {
            platform: testCase.processPlatform,
          };
          // act
          const sut = new SystemUnderTest({ navigator, process });
          // assert
          expect(sut.os).to.equal(testCase.expectedOs, printMessage());
          function printMessage(): string {
            return `Expected: "${OperatingSystem[testCase.expectedOs]}"\n`
              + `Actual: "${OperatingSystem[sut.os]}"\n`
              + `Platform: "${testCase.processPlatform}"`;
          }
        });
      }
    });
  });
});