feat!: Use chrome for testing as default (#632)

This PR introduces significant changes to improve stability and
maintainability by switching to Chrome for Testing as the default
browser.

### 1. Installer Changes on Channel Name Installs

This update replaces previous Chromium builds with the official Chrome
for Testing browser on channel name installs. The installation process
is simplified by using a standardized Chrome for Testing distribution.
The action previously installed the browser to `C:\Program Files` using
the official installer on Windows, or to `$RUNNER_TOOL_CACHE` on Linux
and macOS with the official archive. Now, the action will install the
browser to `$RUNNER_TOOL_CACHE` from [Chrome for Testing][].

[Chrome for Testing]:
https://googlechromelabs.github.io/chrome-for-testing/

### 2. Cache Directory Changes

This update introduces a new cache directory structure for the Chrome
for Testing browser. The cache directory is now named `chrome` instead
of `chromium`.

### 3. Default Version Changes

Previously, the action installed the *latest* snapshot version. Now, the
action will install the *stable* version of Chrome for Testing by
default.

## Migration Guide

### 1. Installer Changes on Channel Name Installs

If you are using the channel name (`stable`, `beta`, `dev`, or `canary`)
to install the browser, the new version of the action installs the
browser from [Chrome for Testing][] instead of the official installer.
Please check if your workflow is using the expected browser binary
version with the new version of the action.

The installed browser binary with the channel name is as follows:

| Platform | New Binary Path |
|----------|----------------|
| Linux    | `chrome` |
| macOS    | `Google Chrome for Testing` |
| Windows  | `chrome.exe` |

On Windows runner, the installed location is changed from `C:\Program
Files` to `$RUNNER_TOOL_CACHE`.

### 2. Cache Directory Changes

If you are self-hosted runner and installing the browser with the
channel name to speed up the runner setup, please update your cache
directory on your runners. The cache directory has been changed from
`chromium` to `chrome` and ensure that your workflow is using the new
cache directory.

### 3. Default Version Changes

If you don't specify `chrome-version` parameter in your workflow, please
ensure that your workflow will install the expected version of Chrome
for Testing. The default version is the *stable* channel version of
Chrome for Testing instead of the *latest* version. To install the
*latest* version, you need to specify `chrome-version: latest` in your
workflow.

```yaml
# v1
- name: Install the stable version of Chrome for Testing
  uses: browser-actions/setup-chrome@v1
  with:
    chrome-version: stable
- name: Install the latest version of Chrome for Testing
  uses: browser-actions/setup-chrome@v1

# v2
- name: Install the stable version of Chrome for Testing
  uses: browser-actions/setup-chrome@v2

- name: Install the latest version of Chrome for Testing
  uses: browser-actions/setup-chrome@v2
  with:
    chrome-version: latest
```

Author: ueokande

.github/workflows/build.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu, macos, windows]
-        version: ["", 1295939, 120, dev]
+        version: ["", 1295939, 120, dev, latest]
     runs-on: ${{ matrix.os }}-latest
     steps:
       - uses: actions/download-artifact@v4

README.md

@@ -14,7 +14,7 @@ This action sets-up Google Chrome/Chromium for GitHub Actions. This action suppo
 ## Usage
 
 Here is a basic usage.
-The action installs the latest build by default.
+The action installs the stable version of Chrome for Testing by default.
 
 ```yaml
 steps:
@@ -58,9 +58,9 @@ steps:
 
 The action supports the following version formats:
 
-- The latest snapshot `latest` (default).
+- The latest snapshot `latest`.
 - Commit positions like `1295939`.  You can find commit positions from [here][snapshots].
-- Google Chrome release channels: `stable`, `beta`, `dev` and `canary`
+- Google Chrome release channels: `stable` (default), `beta`, `dev` and `canary`
 - Specific versions: `119`, `120.0.6099`, `121.0.6100.0`.  The version are resolved by [Chrome for Testing][].
 
 [Chrome for Testing]: https://googlechromelabs.github.io/chrome-for-testing/

__test__/channel_linux.test.ts

@@ -1,5 +1,3 @@
-import * as fs from "node:fs";
-import * as exec from "@actions/exec";
 import * as tc from "@actions/tool-cache";
 import { afterEach, describe, expect, test, vi } from "vitest";
 import * as cache from "../src/cache";
@@ -9,9 +7,6 @@ const cacheFindSpy = vi.spyOn(cache, "find");
 const cacheCacheDirSpy = vi.spyOn(cache, "cacheDir");
 const tcDownloadToolSpy = vi.spyOn(tc, "downloadTool");
 const tcExtractZipSpy = vi.spyOn(tc, "extractZip");
-const execSpy = vi.spyOn(exec, "exec");
-const fsMkdtempSpy = vi.spyOn(fs.promises, "mkdtemp");
-const fsUnlinkSpy = vi.spyOn(fs.promises, "unlink");
 
 afterEach(() => {
   vi.resetAllMocks();
@@ -30,11 +25,11 @@ describe("LinuxChannelInstaller", () => {
     });
 
     test("return install result if installed", async () => {
-      cacheFindSpy.mockResolvedValue("/path/to/chromium");
+      cacheFindSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.checkInstalledBrowser("stable");
 
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
     });
   });
 
@@ -45,12 +40,6 @@ describe("LinuxChannelInstaller", () => {
       );
     });
 
-    test("throw error if version is canary", async () => {
-      await expect(installer.downloadBrowser("canary")).rejects.toThrowError(
-        "Chrome canary not supported for platform linux amd64",
-      );
-    });
-
     test("download stable version", async () => {
       tcDownloadToolSpy.mockResolvedValue("/path/to/downloaded.deb");
 
@@ -64,31 +53,23 @@ describe("LinuxChannelInstaller", () => {
   describe("installBrowser", () => {
     test("throw error if version is not release channel", async () => {
       await expect(
-        installer.installBrowser("foo", "/path/to/downloaded.deb"),
+        installer.installBrowser("foo", "/path/to/downloaded.zip"),
       ).rejects.toThrowError("Unexpected version: foo");
     });
 
-    test("throw error if version is canary", async () => {
-      await expect(
-        installer.installBrowser("canary", "/path/to/downloaded.deb"),
-      ).rejects.toThrowError("Chrome canary not supported for Linux");
-    });
-
     test("install stable version", async () => {
-      fsMkdtempSpy.mockResolvedValue("/deb-abcdef");
-      fsUnlinkSpy.mockResolvedValue(undefined);
-      execSpy.mockResolvedValue(0);
-      cacheCacheDirSpy.mockResolvedValue("/path/to/chromium");
+      tcExtractZipSpy.mockResolvedValue("/deb-abcdef");
+      cacheCacheDirSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.installBrowser(
         "stable",
         "/path/to/downloaded.deb",
       );
 
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
       expect(cacheCacheDirSpy).toHaveBeenCalledWith(
-        "/deb-abcdef",
-        "chromium",
+        "/deb-abcdef/chrome-linux64",
+        "chrome",
         "stable",
       );
     });

__test__/channel_macos.test.ts

@@ -1,5 +1,3 @@
-import * as fs from "node:fs";
-import * as exec from "@actions/exec";
 import * as tc from "@actions/tool-cache";
 import { afterEach, describe, expect, test, vi } from "vitest";
 import * as cache from "../src/cache";
@@ -9,8 +7,6 @@ const cacheFindSpy = vi.spyOn(cache, "find");
 const cacheCacheDirSpy = vi.spyOn(cache, "cacheDir");
 const tcDownloadToolSpy = vi.spyOn(tc, "downloadTool");
 const tcExtractZipSpy = vi.spyOn(tc, "extractZip");
-const fsSymlinkSpy = vi.spyOn(fs.promises, "symlink");
-const execSpy = vi.spyOn(exec, "exec");
 
 afterEach(() => {
   vi.resetAllMocks();
@@ -38,7 +34,7 @@ describe("MacOSChannelInstaller", () => {
 
       expect(result).toEqual({
         root: "/path/to/Chromium.app",
-        bin: "Contents/MacOS/chrome",
+        bin: "Contents/MacOS/Google Chrome for Testing",
       });
     });
   });
@@ -67,22 +63,21 @@ describe("MacOSChannelInstaller", () => {
     });
 
     test("install stable version", async () => {
-      execSpy.mockResolvedValue(0);
-      fsSymlinkSpy.mockResolvedValue();
-      cacheCacheDirSpy.mockResolvedValue("/path/to/Chromium.app");
+      tcExtractZipSpy.mockResolvedValue("/path/to/archive");
+      cacheCacheDirSpy.mockResolvedValue("/path/to/Chromium for Testing.app");
 
       const result = await installer.installBrowser(
         "stable",
         "/path/to/downloaded.dmg",
       );
 
       expect(result).toEqual({
-        root: "/path/to/Chromium.app",
-        bin: "Contents/MacOS/chrome",
+        root: "/path/to/Chromium for Testing.app",
+        bin: "Contents/MacOS/Google Chrome for Testing",
       });
       expect(cacheCacheDirSpy).toHaveBeenCalledWith(
-        "/Volumes/downloaded.dmg/Google Chrome.app",
-        "chromium",
+        "/path/to/archive/chrome-mac-x64/Google Chrome for Testing.app",
+        "chrome",
         "stable",
       );
     });

__test__/channel_windows.test.ts

@@ -1,17 +1,14 @@
 import * as fs from "node:fs";
-import * as exec from "@actions/exec";
 import * as tc from "@actions/tool-cache";
 import { afterEach, describe, expect, test, vi } from "vitest";
 import * as cache from "../src/cache";
 import { WindowsChannelInstaller } from "../src/channel_windows";
 
-const fsStatSpy = vi.spyOn(fs.promises, "stat");
 const fsRenameSpy = vi.spyOn(fs.promises, "rename");
 const tcDownloadToolSpy = vi.spyOn(tc, "downloadTool");
 const tcExtractZipSpy = vi.spyOn(tc, "extractZip");
 const cacheFindSpy = vi.spyOn(cache, "find");
 const cacheCacheDirSpy = vi.spyOn(cache, "cacheDir");
-const execSpy = vi.spyOn(exec, "exec");
 
 afterEach(() => {
   vi.resetAllMocks();
@@ -25,21 +22,20 @@ describe("WindowsChannelInstaller", () => {
 
   describe("checkInstalledBrowser", () => {
     test("returns undefined if the root directory does not exist", async () => {
+      cacheFindSpy.mockResolvedValue(undefined);
+
       const result = await installer.checkInstalledBrowser("stable");
       expect(result).toBe(undefined);
     });
 
     test("returns the root directory and bin path if the root directory exists", async () => {
-      fsStatSpy.mockResolvedValue(undefined);
+      cacheFindSpy.mockResolvedValue("C:\\path\\to\\chrome");
 
       const result = await installer.checkInstalledBrowser("stable");
       expect(result).toEqual({
-        root: "C:\\Program Files\\Google\\Chrome\\Application",
+        root: "C:\\path\\to\\chrome",
         bin: "chrome.exe",
       });
-      expect(fsStatSpy).toHaveBeenCalledWith(
-        "C:\\Program Files\\Google\\Chrome\\Application",
-      );
     });
   });
 
@@ -70,21 +66,17 @@ describe("WindowsChannelInstaller", () => {
     });
 
     test("install the stable version of Chrome", async () => {
-      execSpy.mockResolvedValue(undefined);
-      fsRenameSpy.mockResolvedValue(undefined);
+      tcExtractZipSpy.mockResolvedValue("C:\\path\\to\\extract\\directory");
+      cacheCacheDirSpy.mockResolvedValue("C:\\path\\to\\chrome");
 
       const result = await installer.installBrowser(
         "stable",
-        "C:\\path\\to\\downloaded\\installer.exe",
+        "C:\\path\\to\\downloaded\\file.zip",
       );
       expect(result).toEqual({
-        root: "C:\\Program Files\\Google\\Chrome\\Application",
+        root: "C:\\path\\to\\chrome",
         bin: "chrome.exe",
       });
-      expect(execSpy).toHaveBeenCalledWith(
-        "C:\\path\\to\\downloaded\\installer.exe",
-        ["/silent", "/install"],
-      );
     });
   });
 
@@ -97,11 +89,11 @@ describe("WindowsChannelInstaller", () => {
     });
 
     test("return install result if installed", async () => {
-      cacheFindSpy.mockResolvedValue("/path/to/chromedriver");
+      cacheFindSpy.mockResolvedValue("C:\\path\\to\\chromedriver");
 
       const result = await installer.checkInstalledDriver("stable");
       expect(result).toEqual({
-        root: "/path/to/chromedriver",
+        root: "C:\\path\\to\\chromedriver",
         bin: "chromedriver",
       });
     });

__test__/latest_installer.test.ts

@@ -26,14 +26,14 @@ describe("LatestInstaller", () => {
 
       const result = await installer.checkInstalledBrowser("latest");
       expect(result).toBe(undefined);
-      expect(cacheFindSpy).toHaveBeenCalledWith("chromium", "123456");
+      expect(cacheFindSpy).toHaveBeenCalledWith("chrome", "123456");
     });
 
     test("returns install result if installed", async () => {
-      cacheFindSpy.mockResolvedValue("/path/to/chromium");
+      cacheFindSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.checkInstalledBrowser("latest");
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
     });
   });
 
@@ -52,17 +52,17 @@ describe("LatestInstaller", () => {
   describe("installBrowser", () => {
     test("installs the browser", async () => {
       tcExtractZipSpy.mockResolvedValue("/path/to/ext");
-      cacheCacheDirSpy.mockResolvedValue("/path/to/chromium");
+      cacheCacheDirSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.installBrowser(
         "latest",
         "/tmp/chrome.zip",
       );
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
       expect(tcExtractZipSpy).toHaveBeenCalled();
       expect(cacheCacheDirSpy).toHaveBeenCalledWith(
         "/path/to/ext/chrome-linux",
-        "chromium",
+        "chrome",
         "123456",
       );
     });

__test__/snapshot_installer.test.ts

@@ -24,10 +24,10 @@ describe("SnapshotInstaller", () => {
     });
 
     test("returns install result if installed", async () => {
-      cacheFindSpy.mockResolvedValue("/path/to/chromium");
+      cacheFindSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.checkInstalledBrowser("123456");
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
     });
   });
 
@@ -44,13 +44,13 @@ describe("SnapshotInstaller", () => {
   describe("installBrowser", () => {
     test("installs the browser", async () => {
       tcExtractZipSpy.mockResolvedValue("/path/to/ext");
-      cacheCacheDirSpy.mockResolvedValue("/path/to/chromium");
+      cacheCacheDirSpy.mockResolvedValue("/path/to/chrome");
 
       const result = await installer.installBrowser(
         "123456",
         "/tmp/chrome.zip",
       );
-      expect(result).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+      expect(result).toEqual({ root: "/path/to/chrome", bin: "chrome" });
       expect(tcExtractZipSpy).toHaveBeenCalled();
       expect(cacheCacheDirSpy).toHaveBeenCalled();
     });

__test__/version_installer.test.ts

@@ -42,36 +42,36 @@ describe("KnownGoodVersionInstaller", () => {
 
   test("checkInstalledBrowser should return installed path if installed", async () => {
     cacheFindSpy.mockResolvedValue(
-      "/opt/hostedtoolcache/setup-chrome/chromium/120.0.6099.56/x64",
+      "/opt/hostedtoolcache/setup-chrome/chrome/120.0.6099.56/x64",
     );
 
     const installed = await installer.checkInstalledBrowser("120.0.6099.x");
     expect(installed?.root).toEqual(
-      "/opt/hostedtoolcache/setup-chrome/chromium/120.0.6099.56/x64",
+      "/opt/hostedtoolcache/setup-chrome/chrome/120.0.6099.56/x64",
     );
-    expect(cacheFindSpy).toHaveBeenCalledWith("chromium", "120.0.6099.x");
+    expect(cacheFindSpy).toHaveBeenCalledWith("chrome", "120.0.6099.x");
   });
 
   test("downloadBrowser should download browser archive", async () => {
-    tcDownloadToolSpy.mockImplementation(async () => "/tmp/chromium.zip");
+    tcDownloadToolSpy.mockImplementation(async () => "/tmp/chrome.zip");
 
     const downloaded = await installer.downloadBrowser("120.0.6099.x");
-    expect(downloaded?.archive).toEqual("/tmp/chromium.zip");
+    expect(downloaded?.archive).toEqual("/tmp/chrome.zip");
     expect(tcDownloadToolSpy).toHaveBeenCalled();
   });
 
   test("installDriver should install browser", async () => {
     tcExtractZipSpy.mockImplementation(async () => "/tmp/extracted");
-    cacheCacheDirSpy.mockImplementation(async () => "/path/to/chromium");
+    cacheCacheDirSpy.mockImplementation(async () => "/path/to/chrome");
 
     const installed = await installer.installBrowser(
       "120.0.6099.x",
-      "/tmp/chromium.zip",
+      "/tmp/chrome.zip",
     );
-    expect(installed).toEqual({ root: "/path/to/chromium", bin: "chrome" });
+    expect(installed).toEqual({ root: "/path/to/chrome", bin: "chrome" });
     expect(cacheCacheDirSpy).toHaveBeenCalledWith(
       "/tmp/extracted/chrome-linux64",
-      "chromium",
+      "chrome",
       "120.0.6099.56",
     );
   });

action.yml

@@ -5,7 +5,7 @@ inputs:
   chrome-version:
     description: |-
       The Google Chrome/Chromium version to install and use.
-    default: latest
+    default: stable
     required: false
   install-dependencies:
     description: |-