mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-24 22:48:06 +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.
51 lines
1.4 KiB
TypeScript
51 lines
1.4 KiB
TypeScript
import { beforeEach, describe, expect, it } from 'vitest';
|
|
import * as httpMock from '~test/http-mock.ts';
|
|
import { logger } from '~test/util.ts';
|
|
import { configureRejectUnauth, fetch, normalize } from './got.ts';
|
|
import { keepAliveAgents } from './keep-alive.ts';
|
|
|
|
describe('util/http/got', () => {
|
|
// silence codeql warnings about unhandled promise rejections in got tests
|
|
const rejectUnauth = 'NODE_TLS_REJECT_UNAUTHORIZED';
|
|
|
|
beforeEach(() => {
|
|
vi.stubEnv(rejectUnauth, undefined);
|
|
});
|
|
|
|
it('configures rejectUnauthorized when forced', () => {
|
|
vi.stubEnv(rejectUnauth, '0');
|
|
const opts = {};
|
|
configureRejectUnauth(opts);
|
|
expect(opts).toEqual({ https: { rejectUnauthorized: false } });
|
|
expect(logger.logger.once.warn).toHaveBeenCalledExactlyOnceWith(
|
|
'NODE_TLS_REJECT_UNAUTHORIZED=0 found, this is strongly discouraged.',
|
|
);
|
|
});
|
|
|
|
it('does a flat clone of options', async () => {
|
|
httpMock.scope('https://example.com').get('/test').reply(200, 'ok');
|
|
|
|
expect(normalize({ agent: keepAliveAgents }, []).agent).toStrictEqual(
|
|
keepAliveAgents,
|
|
);
|
|
|
|
const resp = await fetch(
|
|
'https://example.com/test',
|
|
normalize(
|
|
{
|
|
method: 'GET',
|
|
agent: keepAliveAgents,
|
|
responseType: 'text',
|
|
noAuth: true,
|
|
},
|
|
[],
|
|
),
|
|
{
|
|
queueMs: 0,
|
|
},
|
|
);
|
|
|
|
expect(resp.body).toEqual('ok');
|
|
});
|
|
});
|