Merge pull request #961 from crazy-max/esm

switch to ESM and update config/test wiring

Author: crazy-max

src/types/git.ts __tests__/.helpers/os.tssrc/types/git.ts renamed to __tests__/.helpers/os.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023 actions-toolkit authors
+ * Copyright 2025 actions-toolkit authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,6 +14,17 @@
  * limitations under the License.
  */
 
-import {Context as GitHubContext} from '@actions/github/lib/context';
+import {jest} from '@jest/globals';
+import os from 'os';
 
-export type Context = GitHubContext;
+export const mockPlatform = (platform: NodeJS.Platform) => {
+  return jest.spyOn(os, 'platform').mockImplementation(() => platform);
+};
+
+export const mockArch = (arch: string) => {
+  return jest.spyOn(os, 'arch').mockImplementation(() => arch);
+};
+
+export const mockHomedir = (dir: string) => {
+  return jest.spyOn(os, 'homedir').mockImplementation(() => dir);
+};

__tests__/buildx/install.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, afterEach} from '@jest/globals';
+import {describe, expect, it, test, afterEach} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install} from '../../src/buildx/install';
 
@@ -85,8 +86,8 @@ describe('download', () => {
     ['linux', 's390x'],
   ])(
   'acquires buildx for %s/%s', async (os, arch) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const install = new Install();
     const buildxBin = await install.download('latest');
     expect(fs.existsSync(buildxBin)).toBe(true);

__tests__/compose/install.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, afterEach} from '@jest/globals';
+import {describe, expect, it, test, afterEach} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install} from '../../src/compose/install';
 
@@ -85,8 +86,8 @@ describe('download', () => {
     ['linux', 's390x'],
   ])(
   'acquires compose for %s/%s', async (os, arch) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const install = new Install();
     const composeBin = await install.download('latest');
     expect(fs.existsSync(composeBin)).toBe(true);

__tests__/cosign/install.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, afterEach} from '@jest/globals';
+import {describe, expect, it, test, afterEach} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install} from '../../src/cosign/install';
 
@@ -80,8 +81,8 @@ describe('download', () => {
     ['linux', 'arm64']
   ])(
   'acquires undock for %s/%s', async (os, arch) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const install = new Install();
     const cosignBin = await install.download({
       version: 'latest'

__tests__/docker/docker.test.ts

@@ -19,9 +19,10 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as io from '@actions/io';
-import osm = require('os');
 import * as rimraf from 'rimraf';
 
+import {mockHomedir} from '../.helpers/os';
+
 import {Docker} from '../../src/docker/docker';
 
 import {ConfigFile} from '../../src/types/docker/docker';
@@ -47,7 +48,7 @@ describe('configDir', () => {
   });
   it('returns default', async () => {
     process.env.DOCKER_CONFIG = '';
-    jest.spyOn(osm, 'homedir').mockImplementation(() => path.join('/tmp', 'home'));
+    mockHomedir(path.join('/tmp', 'home'));
     expect(Docker.configDir).toEqual(path.join('/tmp', 'home', '.docker'));
   });
   it('returns from env', async () => {

__tests__/docker/install.test.ts

@@ -19,7 +19,8 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install, InstallSourceArchive, InstallSourceImage} from '../../src/docker/install';
 
@@ -60,8 +61,8 @@ describe('download', () => {
     [image('27.3.1'), 'win32'],
   ])(
   'acquires %p of docker (%s)', async (source, platformOS) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => platformOS as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => 'x64');
+    mockPlatform(platformOS as NodeJS.Platform);
+    mockArch('x64');
     const install = new Install({
       source: source,
       runDir: tmpDir

__tests__/oci/oci.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {afterEach, describe, expect, jest, test} from '@jest/globals';
+import {afterEach, describe, expect, test} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {OCI} from '../../src/oci/oci';
 
@@ -44,8 +45,8 @@ describe('defaultPlatform', () => {
     ['linux', 'ppc64', {architecture: 'ppc64le', os: 'linux'}],
     ['linux', 's390x', {architecture: 's390x', os: 'linux'}]
   ])('default platform for %s/%s', async (os: string, arch: string, expected: Platform) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const res = OCI.defaultPlatform();
     expect(res).toEqual(expected);
   });

__tests__/regclient/install.test.ts

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, afterEach} from '@jest/globals';
+import {describe, expect, it, test, afterEach} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install} from '../../src/regclient/install';
 
@@ -75,8 +76,8 @@ describe('download', () => {
     ['linux', 's390x'],
   ])(
   'acquires regclient for %s/%s', async (os, arch) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const install = new Install();
     const regclientBin = await install.download('latest');
     expect(fs.existsSync(regclientBin)).toBe(true);

__tests__/testResultsProcessor.js __tests__/testResultsProcessor.cjs__tests__/testResultsProcessor.js renamed to __tests__/testResultsProcessor.cjs

@@ -14,12 +14,13 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, afterEach} from '@jest/globals';
+import {describe, expect, it, test, afterEach} from '@jest/globals';
 import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as rimraf from 'rimraf';
-import osm = require('os');
+
+import {mockArch, mockPlatform} from '../.helpers/os';
 
 import {Install} from '../../src/undock/install';
 
@@ -80,8 +81,8 @@ describe('download', () => {
     ['linux', 's390x'],
   ])(
   'acquires undock for %s/%s', async (os, arch) => {
-    jest.spyOn(osm, 'platform').mockImplementation(() => os as NodeJS.Platform);
-    jest.spyOn(osm, 'arch').mockImplementation(() => arch);
+    mockPlatform(os as NodeJS.Platform);
+    mockArch(arch);
     const install = new Install();
     const undockBin = await install.download('latest');
     expect(fs.existsSync(undockBin)).toBe(true);