mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-24 14:34:21 +00:00
Sebastian Poxhofer
fbedd41e82
* test: replace manual process.env mutation with vi.stubEnv
Enable Vitest's `unstubEnvs` so env stubs are reverted automatically
before every test, and convert the manual `process.env.X = ...` /
`delete process.env.X` pairs in specs to `vi.stubEnv()`.
This removes the hand-written `afterEach` cleanup blocks and the
`const OLD_ENV = process.env` / `process.env = { ...OLD_ENV }`
save-restore dance, which silently leaked state between tests when a
test set a variable without a matching delete.
Left as-is (incompatible with `unstubEnvs`, which unstubs before each
test, not after):
- module top-level env writes (cocoapods, gomod, post-update, pip-compile
and bundler artifacts specs)
- `beforeAll` env writes -- the two in `util/http` moved to `beforeEach`
* test: stop asserting on ambient environment variables
Three specs asserted on values that the surrounding environment can
override, so they only passed on a machine that happened not to set them:
- `util/exec/env`: `getChildProcessEnv()` forwards every entry of
`basicEnvVars`, but the spec only seeded a subset. Any other forwarded
variable that was set ambiently (e.g. a lowercase `http_proxy`) leaked
into the `toEqual` assertion. Clear all of them first.
- `util/git/index`: `process.env.GIT_SSH_COMMAND` deliberately overrides
the default that the two env-inheritance tests assert on. Clear it.
- `logger/pretty-stdout`: the colorized level strings are built at import
time, so the `beforeEach` setting `FORCE_COLOR` could never affect them
-- it was dead code, and the test silently assumed a terminal without
colour support. Derive the expectation the same way the module does.
* test(datasource/nuget): use a throwaway cache dir for nupkg downloads
The `determine source URL from nupkg` tests do not mock the filesystem,
so they really wrote downloaded packages into a fixed `/tmp/cache` path.
That fails wherever the system tmpdir is not writable, and two checkouts
running the suite at once would share the same directory.
Use `tmp.dir({ unsafeCleanup: true })` and clean it up afterwards, which
is the pattern the other specs that touch disk already use.
* feat(lint): add renovate/prefer-stub-env rule
Enforces in specs what the migration to `vi.stubEnv` established:
- assigning to or deleting `process.env.X` inside `beforeEach`, `afterEach`,
`it` or `test` is reported, with a fixer that rewrites it to `vi.stubEnv()`
- module scope, `describe` bodies and `beforeAll` / `afterAll` are left alone:
`unstubEnvs` reverts stubs *before* each test, so a stub created there is
gone by the time the first test runs, and those must keep assigning directly
- replacing the `process.env` object is reported everywhere and never fixed.
`vi.stubEnv()` captures the original object when the worker starts, so after
a reassignment its deletes silently target the old object
The rule found 28 further violations in specs the earlier sweep missed, since
that one was anchored on `delete process.env`. Twelve were auto-fixed; the
rest replaced `process.env` wholesale and are now `clearEnv()` from test/util.
`util/exec/index.spec.ts` opts out with a comment: it asserts on the whole
child env, and `vi.stubEnv()` cannot express that because it maps `PROD`,
`DEV` and `SSR` onto '' instead of deleting them.
94 lines
3.0 KiB
TypeScript
94 lines
3.0 KiB
TypeScript
import { bootstrap, hasProxy } from './proxy.ts';
|
|
import * as sanitize from './util/sanitize.ts';
|
|
|
|
const addSecretForSanitizing = vi.spyOn(sanitize, 'addSecretForSanitizing');
|
|
|
|
describe('proxy', () => {
|
|
const httpProxy = 'http://example.org/http-proxy';
|
|
const httpsProxy = 'http://example.org/https-proxy';
|
|
const noProxy = 'http://example.org/no-proxy';
|
|
|
|
beforeEach(() => {
|
|
vi.stubEnv('HTTP_PROXY', undefined);
|
|
vi.stubEnv('http_proxy', undefined);
|
|
vi.stubEnv('HTTPS_PROXY', undefined);
|
|
vi.stubEnv('https_proxy', undefined);
|
|
vi.stubEnv('NO_PROXY', undefined);
|
|
vi.stubEnv('no_proxy', undefined);
|
|
});
|
|
|
|
it('respects HTTP_PROXY', () => {
|
|
vi.stubEnv('HTTP_PROXY', httpProxy);
|
|
bootstrap();
|
|
expect(hasProxy()).toBeTrue();
|
|
});
|
|
|
|
it('copies upper case HTTP_PROXY to http_proxy', () => {
|
|
vi.stubEnv('HTTP_PROXY', httpProxy);
|
|
bootstrap();
|
|
expect(hasProxy()).toBeTrue();
|
|
expect(process.env.HTTP_PROXY).toBeDefined();
|
|
expect(process.env.http_proxy).toBeDefined();
|
|
|
|
expect(process.env.HTTPS_PROXY).toBeUndefined();
|
|
expect(process.env.https_proxy).toBeUndefined();
|
|
expect(process.env.NO_PROXY).toBeUndefined();
|
|
expect(process.env.no_proxy).toBeUndefined();
|
|
});
|
|
|
|
it('respects HTTPS_PROXY', () => {
|
|
vi.stubEnv('HTTPS_PROXY', httpsProxy);
|
|
bootstrap();
|
|
expect(hasProxy()).toBeTrue();
|
|
});
|
|
|
|
it('copies upper case HTTPS_PROXY to https_proxy', () => {
|
|
vi.stubEnv('HTTPS_PROXY', httpsProxy);
|
|
bootstrap();
|
|
expect(hasProxy()).toBeTrue();
|
|
expect(process.env.HTTPS_PROXY).toBeDefined();
|
|
expect(process.env.https_proxy).toBeDefined();
|
|
|
|
expect(process.env.HTTP_PROXY).toBeUndefined();
|
|
expect(process.env.http_proxy).toBeUndefined();
|
|
expect(process.env.NO_PROXY).toBeUndefined();
|
|
expect(process.env.no_proxy).toBeUndefined();
|
|
});
|
|
|
|
it('does nothing', () => {
|
|
vi.stubEnv('no_proxy', noProxy);
|
|
bootstrap();
|
|
expect(hasProxy()).toBeFalse();
|
|
});
|
|
|
|
it('sanitizes password from HTTP_PROXY credentials', () => {
|
|
vi.stubEnv('HTTP_PROXY', 'http://user:s3cr3t@example.org');
|
|
bootstrap();
|
|
expect(addSecretForSanitizing).toHaveBeenCalledWith('s3cr3t', 'global');
|
|
});
|
|
|
|
it('sanitizes password from HTTPS_PROXY credentials', () => {
|
|
vi.stubEnv('HTTPS_PROXY', 'http://user:s3cr3t@example.org');
|
|
bootstrap();
|
|
expect(addSecretForSanitizing).toHaveBeenCalledWith('s3cr3t', 'global');
|
|
});
|
|
|
|
it('does not sanitize username-only proxy credentials', () => {
|
|
vi.stubEnv('HTTP_PROXY', 'http://user@example.org');
|
|
bootstrap();
|
|
expect(addSecretForSanitizing).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('sanitizes password-only proxy credentials', () => {
|
|
vi.stubEnv('HTTP_PROXY', 'http://:s3cr3t@example.org');
|
|
bootstrap();
|
|
expect(addSecretForSanitizing).toHaveBeenCalledWith('s3cr3t', 'global');
|
|
});
|
|
|
|
it('does not sanitize when proxy has no credentials', () => {
|
|
vi.stubEnv('HTTP_PROXY', httpProxy);
|
|
bootstrap();
|
|
expect(addSecretForSanitizing).not.toHaveBeenCalled();
|
|
});
|
|
});
|