gsadmin/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2026-10-24 22:48:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
renovate/lib/config/decrypt.spec.ts
T
Sebastian Poxhofer fbedd41e82 test: replace env operation with vi.stubEnv() (#45490) 
* 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.
2026-08-28 09:26:20 +00:00

303 lines
12 KiB
TypeScript
Raw Permalink Blame History

import { logger } from '~test/util.ts';
import {
decryptConfig,
getAzureCollection,
validateDecryptedValue,
} from './decrypt.ts';
import { GlobalConfig } from './global.ts';
import type { RenovateConfig } from './types.ts';
const repository = 'abc/def';
describe('config/decrypt', () => {
describe('decryptConfig()', () => {
let config: RenovateConfig;
beforeEach(() => {
config = {};
GlobalConfig.reset();
vi.stubEnv('MEND_HOSTED', undefined);
vi.stubEnv('RENOVATE_X_ENCRYPTED_STRICT', undefined);
});
it('returns empty with no privateKey', async () => {
delete config.encrypted;
const res = await decryptConfig(config, repository);
expect(res).toMatchObject(config);
});
it('warns if no privateKey found', async () => {
config.encrypted = { a: '1' };
GlobalConfig.set({ encryptedWarning: 'text' });
const res = await decryptConfig(config, repository);
expect(logger.logger.once.warn).toHaveBeenCalledWith('text');
expect(res.encrypted).toBeUndefined();
// @ts-expect-error -- invalid option
expect(res.a).toBeUndefined();
});
it('throws exception if encrypted found but no privateKey', async () => {
config.encrypted = { a: '1' };
vi.stubEnv('RENOVATE_X_ENCRYPTED_STRICT', 'true');
await expect(decryptConfig(config, repository)).rejects.toThrow(
'config-validation',
);
});
// coverage
it('throws exception if encrypted found but no privateKey- Mend Hosted', async () => {
config.encrypted = { a: '1' };
vi.stubEnv('MEND_HOSTED', 'true');
vi.stubEnv('RENOVATE_X_ENCRYPTED_STRICT', 'true');
await expect(decryptConfig(config, repository)).rejects.toMatchObject({
message: 'config-validation',
validationMessage: expect.stringContaining(
'https://docs.renovatebot.com/mend-hosted/migrating-secrets/',
),
});
});
it('uses productLinks.documentation in Mend Hosted error URL', async () => {
config.encrypted = { a: '1' };
GlobalConfig.set({
productLinks: { documentation: 'https://custom.example.com/' },
});
vi.stubEnv('MEND_HOSTED', 'true');
vi.stubEnv('RENOVATE_X_ENCRYPTED_STRICT', 'true');
await expect(decryptConfig(config, repository)).rejects.toMatchObject({
validationMessage: expect.stringContaining(
'https://custom.example.com/mend-hosted/migrating-secrets/',
),
});
});
});
describe('validateDecryptedValue()', () => {
beforeEach(() => {
GlobalConfig.reset();
});
describe('platforms non azure', () => {
it.each`
str | repo | expected
${'{"o":"abcd", "r":"", "v":"123#'} | ${'abcd/edf'} | ${null}
${'{"o":"abcd", "r":"", "v":""}'} | ${'abcd/edf'} | ${null}
${'{"o":"", "r":"", "v":"val"}'} | ${'abcd/edf'} | ${null}
${'{"o":"abcd", "r":"edf", "v":"val-1"}'} | ${'abcd/edf'} | ${'val-1'}
${'{"o":"abcd", "r":"", "v":"val-2"}'} | ${'abcd/edf'} | ${'val-2'}
${'{"o":"abcd/fgh", "r":"ef", "v":"val-3"}'} | ${'abcd/fgh/ef'} | ${'val-3'}
${'{"o":"abcd/fgh", "r":"", "v":"val-4"}'} | ${'abcd/fgh/ef'} | ${'val-4'}
${'{"o":"a/b/c/d", "r":"ef", "v":"val-5"}'} | ${'a/b/c/d/ef'} | ${'val-5'}
${'{"o":"abcd/fgh", "r":"any", "v":"val-6"}'} | ${'abcd/fgh/ef'} | ${null}
${'{"o":"abcd/xy", "r":"", "v":"val-7"}'} | ${'abcd/fgh/ef'} | ${null}
${'{"o":"xy", "r":"", "v":"val-8"}'} | ${'abcd/fgh/ef'} | ${null}
${'{"o":"xy, abcd/fgh", "r":"ef", "v":"val-9"}'} | ${'abcd/fgh/ef'} | ${'val-9'}
${'{"o":"xy ,abcd", "r":"ef", "v":"val-10"}'} | ${'abcd/ef'} | ${'val-10'}
${'{"o":"abcd, xy", "r":"", "v":"val-11"}'} | ${'abcd/fgh/ef'} | ${'val-11'}
${'{"o":"abcd,xy ", "r":"", "v":"val-12"}'} | ${'abcd/ef'} | ${'val-12'}
${'{"o":" xy,abc", "r":"", "v":"val-13"}'} | ${'abcd/fgh/ef'} | ${null}
`('equals("$str", "$repo") === $expected', ({ str, repo, expected }) => {
expect(validateDecryptedValue(str, repo)).toBe(expected);
});
});
describe('azure only platform', () => {
describe('general tests', () => {
it.each`
str | repo | expected
${'{"o":"any", "r":"", "v":"wrong-123#'} | ${'fgh/rp1'} | ${null}
${'{"o":"any", "r":"", "v":""}'} | ${'fgh/rp1'} | ${null}
${'{"o":"", "r":"", "v":"any"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"fgh", "r":"rp1", "v":"zv-1"}'} | ${'fgh/rp1'} | ${'zv-1'}
${'{"o":"fgh", "r":"", "v":"zv-2"}'} | ${'fgh/rp1'} | ${'zv-2'}
${'{"o":"az123/fgh", "r":"rp1", "v":"zv-3"}'} | ${'fgh/rp1'} | ${'zv-3'}
${'{"o":"az123/fgh", "r":"", "v":"zv-4"}'} | ${'fgh/rp1'} | ${'zv-4'}
${'{"o":"az123/*", "r":"", "v":"zv-5"}'} | ${'fgh/rp1'} | ${'zv-5'}
${'{"o":"az123/", "r":"", "v":"zv-6"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123", "r":"", "v":"zv-7"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az1", "r":"", "v":"zv-8"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/any", "r":"rp1", "v":"zv-9"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/any", "r":"", "v":"zv-10"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*", "r":"", "v":"zv-11"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/*,any/*", "r":"", "v":"zv-12"}'} | ${'fgh/rp1'} | ${'zv-12'}
${'{"o":"fgh,any/*", "r":"", "v":"zv-13"}'} | ${'fgh/rp1'} | ${'zv-13'}
${'{"o":"az123/,any/*", "r":"", "v":"zv-14"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*,fgh/", "r":"", "v":"zv-15"}'} | ${'fgh/rp1'} | ${'zv-15'}
${'{"o":"any/*,az123", "r":"", "v":"zv-16"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*,az12", "r":"", "v":"zv-17"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az12,any/*", "r":"", "v":"zv-18"}'} | ${'fgh/rp1'} | ${null}
`(
'equals("$str", "$repo") === $expected',
({ str, repo, expected }) => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/az123',
});
expect(validateDecryptedValue(str, repo)).toBe(expected);
},
);
});
describe('tests self hosted - ignore "tfs/" before collection name', () => {
it.each`
str | repo | expected
${'{"o":"any", "r":"", "v":"wrong-123#'} | ${'fgh/rp1'} | ${null}
${'{"o":"any", "r":"", "v":""}'} | ${'fgh/rp1'} | ${null}
${'{"o":"", "r":"", "v":"any"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"fgh", "r":"rp1", "v":"zv-1"}'} | ${'fgh/rp1'} | ${'zv-1'}
${'{"o":"fgh", "r":"", "v":"zv-2"}'} | ${'fgh/rp1'} | ${'zv-2'}
${'{"o":"az123/fgh", "r":"rp1", "v":"zv-3"}'} | ${'fgh/rp1'} | ${'zv-3'}
${'{"o":"az123/fgh", "r":"", "v":"zv-4"}'} | ${'fgh/rp1'} | ${'zv-4'}
${'{"o":"az123/*", "r":"", "v":"zv-5"}'} | ${'fgh/rp1'} | ${'zv-5'}
${'{"o":"az123/", "r":"", "v":"zv-6"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123", "r":"", "v":"zv-7"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az1", "r":"", "v":"zv-8"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/any", "r":"rp1", "v":"zv-9"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/any", "r":"", "v":"zv-10"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*", "r":"", "v":"zv-11"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az123/*,any/*", "r":"", "v":"zv-12"}'} | ${'fgh/rp1'} | ${'zv-12'}
${'{"o":"fgh,any/*", "r":"", "v":"zv-13"}'} | ${'fgh/rp1'} | ${'zv-13'}
${'{"o":"az123/,any/*", "r":"", "v":"zv-14"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*,fgh/", "r":"", "v":"zv-15"}'} | ${'fgh/rp1'} | ${'zv-15'}
${'{"o":"any/*,az123", "r":"", "v":"zv-16"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"any/*,az12", "r":"", "v":"zv-17"}'} | ${'fgh/rp1'} | ${null}
${'{"o":"az12,any/*", "r":"", "v":"zv-18"}'} | ${'fgh/rp1'} | ${null}
`(
'equals("$str", "$repo") === $expected',
({ str, repo, expected }) => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'http://your-server-name:8080/tfs/az123',
});
expect(validateDecryptedValue(str, repo)).toBe(expected);
},
);
});
it('endpoint URL invalid', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'ht tps://dev.az ure.com/az123',
});
expect(
validateDecryptedValue(
'{"o":"proj", "r":"repo", "v":"any-1"}',
'proj/repo',
),
).toBe('any-1');
expect(
validateDecryptedValue(
'{"o":"proj", "r":"", "v":"any-2"}',
'proj/repo',
),
).toBe('any-2');
expect(
validateDecryptedValue(
'{"o":"col/proj", "r":"", "v":"any"}',
'proj/repo',
),
).toBeNull();
expect(
validateDecryptedValue(
'{"o":"col/*", "r":"", "v":"any"}',
'proj/repo',
),
).toBeNull();
});
it('endpoint URL without collection', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/',
});
expect(
validateDecryptedValue(
'{"o":"proj", "r":"repo", "v":"any-3"}',
'proj/repo',
),
).toBe('any-3');
expect(
validateDecryptedValue(
'{"o":"proj", "r":"", "v":"any-4"}',
'proj/repo',
),
).toBe('any-4');
expect(
validateDecryptedValue(
'{"o":"col/proj", "r":"", "v":"any"}',
'proj/repo',
),
).toBeNull();
expect(
validateDecryptedValue(
'{"o":"col/*", "r":"", "v":"any"}',
'proj/repo',
),
).toBeNull();
});
});
});
describe('getAzureCollection()', () => {
beforeEach(() => {
GlobalConfig.reset();
});
it('no pathname and url ends with slash', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/',
});
expect(getAzureCollection()).toBeUndefined();
});
it('no pathname and no slash at end of URL', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com',
});
expect(getAzureCollection()).toBeUndefined();
});
it('pathname no slash at end', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/aaa',
});
expect(getAzureCollection()).toBe('aaa');
});
it('pathname with slash at end', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/aaa/',
});
expect(getAzureCollection()).toBe('aaa');
});
it('pathname 2 levels no slash at end', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/aaa/bbb',
});
expect(getAzureCollection()).toBe('aaa/bbb');
});
it('pathname 2 levels with slash at end', () => {
GlobalConfig.set({
platform: 'azure',
endpoint: 'https://dev.azure.com/aaa/bbb/',
});
expect(getAzureCollection()).toBe('aaa/bbb');
});
});
});
Reference in New Issue View Git Blame Copy Permalink