mirror of
https://github.com/astral-sh/setup-uv.git
synced 2026-08-25 19:43:50 +00:00
test / test-act (push) Failing after 29s
test / test-uv-no-modify-path (push) Failing after 42s
test / test-specific-version (map[expected-version:0.3.2 version-input:0.3.2]) (push) Failing after 42s
test / test-specific-version (map[expected-version:0.4.25 resolution-strategy:lowest version-input:>=0.4.25]) (push) Failing after 44s
test / test-specific-version (map[expected-version:0.1.45 resolution-strategy:highest version-input:>=0.1,<0.2]) (push) Failing after 47s
test / test-specific-version (map[expected-version:0.4.25 resolution-strategy:lowest version-input:>=0.4.25,<0.5]) (push) Failing after 50s
test / test-latest-version (latest) (push) Failing after 55s
test / test-default-version (ubuntu-latest) (push) Failing after 57s
test / test-specific-version (map[expected-version:0.1.0 resolution-strategy:lowest version-input:>=0.1.0,<0.2]) (push) Failing after 1m0s
test / test-latest-version (>=0.8) (push) Failing after 1m0s
test / test-specific-version (map[expected-version:0.3.5 version-input:0.3.x]) (push) Failing after 1m2s
test / test-from-working-directory-version (map[expected-version:0.5.15 working-directory:__tests__/fixtures/uv-toml-project]) (push) Failing after 23s
test / test-version-file-version (map[expected-version:0.5.15 version-file:__tests__/fixtures/.tool-versions]) (push) Failing after 28s
test / test-activate-environment (ubuntu-latest) (push) Failing after 31s
test / test-debian-unstable (push) Failing after 35s
test / test-activate-environment-no-project (push) Failing after 37s
test / test-restore-cache-dependency-glob (push) Skipped
test / test-specific-version (map[expected-version:0.3.5 version-input:0.3]) (push) Failing after 56s
test / test-from-working-directory-version (map[expected-version:0.5.14 working-directory:__tests__/fixtures/pyproject-toml-project]) (push) Failing after 56s
test / test-specific-version (map[expected-version:0.4.30 version-input:>=0.4.25,<0.5]) (push) Failing after 57s
test / test-specific-version (map[expected-version:0.3.0 version-input:0.3.0]) (push) Failing after 59s
test / test-version-file-version (map[expected-version:0.6.17 version-file:__tests__/fixtures/uv-in-requirements-txt-project/requirements.txt]) (push) Failing after 24s
test / test-version-file-version (map[expected-version:0.8.3 version-file:__tests__/fixtures/uv-in-requirements-hash-txt-project/requirements.txt]) (push) Failing after 25s
test / test-malformed-pyproject-file-fallback (push) Failing after 23s
test / test-checksum (map[checksum:4d9279ad5ca596b1e2d703901d508430eb07564dc4d8837de9e2fca9c90f8ecd os:ubuntu-latest]) (push) Failing after 27s
test / test-with-explicit-token (push) Failing after 30s
test / test-python-version (ubuntu-latest) (push) Failing after 30s
test / test-uvx (push) Failing after 32s
test / test-tool-install (ubuntu-latest) (push) Failing after 34s
test / test-activate-environment-custom-path (ubuntu-latest) (push) Failing after 32s
test / test-musl (push) Failing after 33s
test / test-setup-cache (auto, ubuntu-latest) (push) Failing after 30s
test / test-setup-cache (true, ubuntu-latest) (push) Failing after 27s
test / test-setup-cache (false, ubuntu-latest) (push) Failing after 30s
test / test-cache-key-os-version (ubuntu-22.04, ubuntu-22.04) (push) Failing after 39s
test / test-cache-prune-force (push) Failing after 31s
CodeQL / Analyze (TypeScript) (push) Failing after 2m20s
test / test-setup-cache-requirements-txt (push) Failing after 31s
test / lint (push) Failing after 1m55s
test / test-restore-cache-requirements-txt (push) Skipped
test / test-setup-cache-dependency-glob (push) Failing after 29s
test / test-setup-cache-save-cache-false (push) Failing after 29s
test / test-restore-cache-save-cache-false (push) Skipped
test / test-setup-cache-restore-cache-false (push) Failing after 31s
test / test-restore-cache-restore-cache-false (push) Skipped
test / test-cache-local (map[expected-cache-dir:/home/runner/work/_temp/setup-uv-cache os:ubuntu-latest]) (push) Failing after 32s
test / test-cache-local-cache-disabled (push) Failing after 32s
test / test-cache-local-cache-disabled-but-explicit-path (push) Failing after 32s
test / test-custom-manifest-file (push) Failing after 31s
test / test-download-from-astral-mirror-false (push) Failing after 31s
test / test-no-python-version (push) Failing after 35s
test / test-cache-dir-from-file (push) Failing after 34s
test / test-python-install-dir (map[expected-python-dir:/home/runner/work/_temp/uv-python-dir os:ubuntu-latest]) (push) Failing after 29s
test / test-absolute-path (push) Failing after 36s
test / test-relative-path (push) Failing after 41s
test / test-cache-python-missing-managed-install-dir (push) Failing after 28s
test / test-workflow-run (push) Failing after 27s
test / test-cache-python-installs (push) Failing after 34s
test / test-restore-python-installs (push) Skipped
test / validate-typings (push) Successful in 37s
test / test-default-version (macos-14) (push) Canceled after 0s
test / test-default-version (macos-latest) (push) Canceled after 0s
test / test-default-version (windows-latest) (push) Canceled after 0s
test / test-checksum (map[checksum:a70cbfbf3bb5c08b2f84963b4f12c94e08fbb2468ba418a3bfe1066fbe9e7218 os:macos-latest]) (push) Canceled after 0s
test / test-tool-install (macos-14) (push) Canceled after 0s
test / test-tool-install (macos-latest) (push) Canceled after 0s
test / test-tool-install (windows-latest) (push) Canceled after 0s
test / test-python-version (macos-latest) (push) Canceled after 0s
test / test-python-version (windows-latest) (push) Canceled after 0s
test / test-activate-environment (macos-latest) (push) Canceled after 0s
test / test-activate-environment (windows-latest) (push) Canceled after 0s
test / test-activate-environment-custom-path (macos-latest) (push) Canceled after 0s
test / test-activate-environment-custom-path (windows-latest) (push) Canceled after 0s
test / test-cache-key-os-version (macos-14, macos-14) (push) Canceled after 0s
test / test-cache-key-os-version (macos-15, macos-15) (push) Canceled after 0s
test / test-cache-key-os-version (ubuntu-24.04, ubuntu-24.04) (push) Canceled after 0s
test / test-cache-key-os-version (windows-2022, windows-2022) (push) Canceled after 0s
test / test-cache-key-os-version (windows-2025, windows-2025) (push) Canceled after 0s
test / test-setup-cache (auto, windows-latest) (push) Canceled after 0s
test / test-setup-cache (false, windows-latest) (push) Canceled after 0s
test / test-setup-cache (true, windows-latest) (push) Canceled after 0s
test / test-restore-cache (auto, ubuntu-latest) (push) Canceled after 0s
test / test-restore-cache (auto, windows-latest) (push) Canceled after 0s
test / test-restore-cache (false, ubuntu-latest) (push) Canceled after 0s
test / test-restore-cache (false, windows-latest) (push) Canceled after 0s
test / test-restore-cache (true, windows-latest) (push) Canceled after 0s
test / test-python-install-dir (map[expected-python-dir:D:\a\_temp\uv-python-dir os:windows-latest]) (push) Canceled after 0s
test / test-restore-cache (true, ubuntu-latest) (push) Canceled after 0s
test / test-cache-local (map[expected-cache-dir:D:\a\_temp\setup-uv-cache os:windows-latest]) (push) Canceled after 0s
test / all-tests-passed (push) Canceled after 0s
Release Drafter / ✏️ Draft release (push) Canceled after 0s
## Summary - disable `enable-cache: auto` for `pull_request_target`, `workflow_run`, and `release` events - disable automatic caching for tag pushes while leaving branch pushes unchanged - preserve explicit `enable-cache: true` as an override - run a `workflow_run` integration fixture with `act` in pull request CI and verify caching is disabled - document the behavior and update the published bundles ## Testing - `npm run all` - `actionlint .github/workflows/test.yml __tests__/workflows/workflow-run.yml` - `uvx zizmor __tests__/workflows/workflow-run.yml` Closes #984 Refs: pi-session 019fec42-9b26-714e-a359-830ac4401ecd
358 lines
11 KiB
TypeScript
358 lines
11 KiB
TypeScript
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import {
|
|
afterEach,
|
|
beforeEach,
|
|
describe,
|
|
expect,
|
|
it,
|
|
jest,
|
|
} from "@jest/globals";
|
|
|
|
let mockInputs: Record<string, string> = {};
|
|
const tempDirs: string[] = [];
|
|
const ORIGINAL_GITHUB_EVENT_NAME = process.env.GITHUB_EVENT_NAME;
|
|
const ORIGINAL_GITHUB_REF = process.env.GITHUB_REF;
|
|
const ORIGINAL_HOME = process.env.HOME;
|
|
const ORIGINAL_RUNNER_ENVIRONMENT = process.env.RUNNER_ENVIRONMENT;
|
|
const ORIGINAL_RUNNER_TEMP = process.env.RUNNER_TEMP;
|
|
const ORIGINAL_UV_CACHE_DIR = process.env.UV_CACHE_DIR;
|
|
const ORIGINAL_UV_PYTHON_INSTALL_DIR = process.env.UV_PYTHON_INSTALL_DIR;
|
|
|
|
const mockDebug = jest.fn();
|
|
const mockGetBooleanInput = jest.fn(
|
|
(name: string) => (mockInputs[name] ?? "") === "true",
|
|
);
|
|
const mockGetInput = jest.fn((name: string) => mockInputs[name] ?? "");
|
|
const mockInfo = jest.fn();
|
|
const mockWarning = jest.fn();
|
|
|
|
jest.unstable_mockModule("@actions/core", () => ({
|
|
debug: mockDebug,
|
|
getBooleanInput: mockGetBooleanInput,
|
|
getInput: mockGetInput,
|
|
info: mockInfo,
|
|
warning: mockWarning,
|
|
}));
|
|
|
|
const { CacheLocalSource, loadInputs } = await import("../../src/utils/inputs");
|
|
|
|
function createTempProject(files: Record<string, string> = {}): string {
|
|
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "setup-uv-inputs-test-"));
|
|
tempDirs.push(dir);
|
|
|
|
for (const [relativePath, content] of Object.entries(files)) {
|
|
const filePath = path.join(dir, relativePath);
|
|
fs.mkdirSync(path.dirname(filePath), { recursive: true });
|
|
fs.writeFileSync(filePath, content);
|
|
}
|
|
|
|
return dir;
|
|
}
|
|
|
|
function resetEnvironment(): void {
|
|
jest.clearAllMocks();
|
|
mockInputs = {};
|
|
delete process.env.GITHUB_EVENT_NAME;
|
|
delete process.env.GITHUB_REF;
|
|
process.env.HOME = "/home/testuser";
|
|
delete process.env.RUNNER_ENVIRONMENT;
|
|
delete process.env.RUNNER_TEMP;
|
|
delete process.env.UV_CACHE_DIR;
|
|
delete process.env.UV_PYTHON_INSTALL_DIR;
|
|
}
|
|
|
|
function restoreEnvironment(): void {
|
|
for (const dir of tempDirs.splice(0)) {
|
|
fs.rmSync(dir, { force: true, recursive: true });
|
|
}
|
|
|
|
process.env.GITHUB_EVENT_NAME = ORIGINAL_GITHUB_EVENT_NAME;
|
|
process.env.GITHUB_REF = ORIGINAL_GITHUB_REF;
|
|
process.env.HOME = ORIGINAL_HOME;
|
|
process.env.RUNNER_ENVIRONMENT = ORIGINAL_RUNNER_ENVIRONMENT;
|
|
process.env.RUNNER_TEMP = ORIGINAL_RUNNER_TEMP;
|
|
process.env.UV_CACHE_DIR = ORIGINAL_UV_CACHE_DIR;
|
|
process.env.UV_PYTHON_INSTALL_DIR = ORIGINAL_UV_PYTHON_INSTALL_DIR;
|
|
}
|
|
|
|
beforeEach(resetEnvironment);
|
|
afterEach(restoreEnvironment);
|
|
|
|
describe("loadInputs", () => {
|
|
it("loads defaults for a github-hosted runner", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["enable-cache"] = "auto";
|
|
process.env.RUNNER_ENVIRONMENT = "github-hosted";
|
|
process.env.RUNNER_TEMP = "/runner-temp";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.enableCache).toBe(true);
|
|
expect(inputs.cacheLocalPath).toEqual({
|
|
path: "/runner-temp/setup-uv-cache",
|
|
source: CacheLocalSource.Default,
|
|
});
|
|
expect(inputs.pythonDir).toBe("/runner-temp/uv-python-dir");
|
|
expect(inputs.venvPath).toBe("/workspace/.venv");
|
|
expect(inputs.manifestFile).toBeUndefined();
|
|
expect(inputs.resolutionStrategy).toBe("highest");
|
|
});
|
|
|
|
it.each([
|
|
"pull_request_target",
|
|
"workflow_run",
|
|
"release",
|
|
])("disables automatic caching for the %s event", (eventName) => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["enable-cache"] = "auto";
|
|
process.env.RUNNER_ENVIRONMENT = "github-hosted";
|
|
process.env.RUNNER_TEMP = "/runner-temp";
|
|
process.env.GITHUB_EVENT_NAME = eventName;
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.enableCache).toBe(false);
|
|
expect(mockInfo).toHaveBeenCalledWith(
|
|
`Caching is disabled for the ${eventName} event`,
|
|
);
|
|
});
|
|
|
|
it("disables automatic caching for tag pushes", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["enable-cache"] = "auto";
|
|
process.env.RUNNER_ENVIRONMENT = "github-hosted";
|
|
process.env.RUNNER_TEMP = "/runner-temp";
|
|
process.env.GITHUB_EVENT_NAME = "push";
|
|
process.env.GITHUB_REF = "refs/tags/v1.0.0";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.enableCache).toBe(false);
|
|
expect(mockInfo).toHaveBeenCalledWith("Caching is disabled for tag pushes");
|
|
});
|
|
|
|
it("enables automatic caching for branch pushes", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["enable-cache"] = "auto";
|
|
process.env.RUNNER_ENVIRONMENT = "github-hosted";
|
|
process.env.RUNNER_TEMP = "/runner-temp";
|
|
process.env.GITHUB_EVENT_NAME = "push";
|
|
process.env.GITHUB_REF = "refs/heads/main";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.enableCache).toBe(true);
|
|
});
|
|
|
|
it("honors explicitly enabled caching for sensitive events", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["enable-cache"] = "true";
|
|
process.env.RUNNER_ENVIRONMENT = "github-hosted";
|
|
process.env.RUNNER_TEMP = "/runner-temp";
|
|
process.env.GITHUB_EVENT_NAME = "release";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.enableCache).toBe(true);
|
|
});
|
|
|
|
it("uses cache-dir from pyproject.toml when present", () => {
|
|
mockInputs["working-directory"] = createTempProject({
|
|
"pyproject.toml": `[project]
|
|
name = "uv-project"
|
|
version = "0.1.0"
|
|
|
|
[tool.uv]
|
|
cache-dir = "/tmp/pyproject-toml-defined-cache-path"
|
|
`,
|
|
});
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheLocalPath).toEqual({
|
|
path: "/tmp/pyproject-toml-defined-cache-path",
|
|
source: CacheLocalSource.Config,
|
|
});
|
|
expect(mockInfo).toHaveBeenCalledWith(
|
|
expect.stringContaining("Found cache-dir in"),
|
|
);
|
|
});
|
|
|
|
it("uses UV_CACHE_DIR from the environment", () => {
|
|
mockInputs["working-directory"] = createTempProject();
|
|
process.env.UV_CACHE_DIR = "/env/cache-dir";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheLocalPath).toEqual({
|
|
path: "/env/cache-dir",
|
|
source: CacheLocalSource.Env,
|
|
});
|
|
expect(mockInfo).toHaveBeenCalledWith(
|
|
"UV_CACHE_DIR is already set to /env/cache-dir",
|
|
);
|
|
});
|
|
|
|
it("uses UV_PYTHON_INSTALL_DIR from the environment", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
process.env.UV_PYTHON_INSTALL_DIR = "/env/python-dir";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.pythonDir).toBe("/env/python-dir");
|
|
expect(mockInfo).toHaveBeenCalledWith(
|
|
"UV_PYTHON_INSTALL_DIR is already set to /env/python-dir",
|
|
);
|
|
});
|
|
|
|
it("warns when parsing a malformed pyproject.toml for cache-dir", () => {
|
|
mockInputs["working-directory"] = createTempProject({
|
|
"pyproject.toml": `[project]
|
|
name = "malformed-pyproject-toml-project"
|
|
version = "0.1.0"
|
|
|
|
[malformed-toml
|
|
`,
|
|
});
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheLocalPath).toBeUndefined();
|
|
expect(mockWarning).toHaveBeenCalledWith(
|
|
expect.stringContaining("Error while parsing pyproject.toml:"),
|
|
);
|
|
});
|
|
|
|
it("throws for an invalid resolution strategy", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["resolution-strategy"] = "middle";
|
|
|
|
expect(() => loadInputs()).toThrow(
|
|
"Invalid resolution-strategy: middle. Must be 'highest' or 'lowest'.",
|
|
);
|
|
});
|
|
});
|
|
|
|
describe("cacheDependencyGlob", () => {
|
|
it("returns empty string when input not provided", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheDependencyGlob).toBe("");
|
|
});
|
|
|
|
it.each([
|
|
["requirements.txt", "/workspace/requirements.txt"],
|
|
["./uv.lock", "/workspace/uv.lock"],
|
|
])("resolves %s to %s", (globInput, expected) => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["cache-dependency-glob"] = globInput;
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheDependencyGlob).toBe(expected);
|
|
});
|
|
|
|
it("handles multiple lines, trimming whitespace, tilde expansion and absolute paths", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["cache-dependency-glob"] =
|
|
" ~/.cache/file1\n ./rel/file2 \nfile3.txt";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheDependencyGlob).toBe(
|
|
[
|
|
"/home/testuser/.cache/file1",
|
|
"/workspace/rel/file2",
|
|
"/workspace/file3.txt",
|
|
].join("\n"),
|
|
);
|
|
});
|
|
|
|
it.each([
|
|
[
|
|
"/abs/path.lock\nrelative.lock",
|
|
["/abs/path.lock", "/workspace/relative.lock"].join("\n"),
|
|
],
|
|
[
|
|
"!/abs/path.lock\n!relative.lock",
|
|
["!/abs/path.lock", "!/workspace/relative.lock"].join("\n"),
|
|
],
|
|
])("normalizes multiline glob %s", (globInput, expected) => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["cache-dependency-glob"] = globInput;
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheDependencyGlob).toBe(expected);
|
|
});
|
|
});
|
|
|
|
describe("tool directories", () => {
|
|
it("expands tilde for tool-bin-dir and tool-dir", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["tool-bin-dir"] = "~/tool-bin-dir";
|
|
mockInputs["tool-dir"] = "~/tool-dir";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.toolBinDir).toBe("/home/testuser/tool-bin-dir");
|
|
expect(inputs.toolDir).toBe("/home/testuser/tool-dir");
|
|
});
|
|
});
|
|
|
|
describe("cacheLocalPath", () => {
|
|
it("expands tilde in cache-local-path", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["cache-local-path"] = "~/uv-cache/cache-local-path";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.cacheLocalPath).toEqual({
|
|
path: "/home/testuser/uv-cache/cache-local-path",
|
|
source: CacheLocalSource.Input,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("venvPath", () => {
|
|
it("defaults to .venv in the working directory", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.venvPath).toBe("/workspace/.venv");
|
|
});
|
|
|
|
it.each([
|
|
["custom-venv", "/workspace/custom-venv"],
|
|
["custom-venv/", "/workspace/custom-venv"],
|
|
["/tmp/custom-venv", "/tmp/custom-venv"],
|
|
["~/.venv", "/home/testuser/.venv"],
|
|
])("resolves venv-path %s to %s", (venvPathInput, expected) => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["activate-environment"] = "true";
|
|
mockInputs["venv-path"] = venvPathInput;
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.venvPath).toBe(expected);
|
|
});
|
|
|
|
it("warns when venv-path is set but activate-environment is false", () => {
|
|
mockInputs["working-directory"] = "/workspace";
|
|
mockInputs["venv-path"] = "custom-venv";
|
|
|
|
const inputs = loadInputs();
|
|
|
|
expect(inputs.activateEnvironment).toBe(false);
|
|
expect(inputs.venvPath).toBe("/workspace/custom-venv");
|
|
expect(mockWarning).toHaveBeenCalledWith(
|
|
"venv-path is only used when activate-environment is true",
|
|
);
|
|
});
|
|
});
|