feat: allow configFileNames to be set through env (#39144)

* test: add failing test for reading configFileNames from env

* fix: move configFileNames handling to shared config parsing

* feat: allow configFileNames to be set through env

* fix: move unit test from file to index

* test: add test for setting configFileNames through cli

* fix: fix merge

* test: use multiple config file names in tests

* test: add a length check after adding custom filenames

Author: scootermon

lib/config/options/index.ts

@@ -246,8 +246,6 @@ const options: RenovateOptions[] = [
     default: null,
     globalOnly: true,
     inheritConfigSupport: true,
-    cli: false,
-    env: false,
   },
   {
     name: 'onboardingConfigFileName',

lib/workers/global/config/parse/file.spec.ts

@@ -4,7 +4,6 @@ import type { DirectoryResult } from 'tmp-promise';
 import { dir } from 'tmp-promise';
 import upath from 'upath';
 import { expect } from 'vitest';
-import { getConfigFileNames } from '../../../../config/app-strings';
 import { logger } from '../../../../logger';
 import customConfig from './__fixtures__/config';
 import * as file from './file';
@@ -202,23 +201,6 @@ describe('workers/global/config/parse/file', () => {
       delete process.env.SOME_KEY;
       delete process.env.valid_Key;
     });
-
-    it('appends files from configFileNames to config filenames list', async () => {
-      const configFile = upath.resolve(tmp.path, 'config4.js');
-      const fileContent1 = `module.exports = {
-        "configFileNames": ["myrenovate.json"]
-      }`;
-      fs.writeFileSync(configFile, fileContent1, {
-        encoding: 'utf8',
-      });
-      const fileConfig = await file.getConfig({
-        RENOVATE_CONFIG_FILE: configFile,
-      });
-
-      expect(fileConfig.configFileNames).toBeUndefined();
-      expect(getConfigFileNames()[0]).toBe('myrenovate.json');
-      fs.unlinkSync(configFile);
-    });
   });
 
   describe('deleteConfigFile()', () => {

lib/workers/global/config/parse/file.ts

@@ -1,12 +1,10 @@
 import {
   isEmptyStringOrWhitespace,
-  isNonEmptyArray,
   isNonEmptyObject,
   isNonEmptyString,
   isUndefined,
 } from '@sindresorhus/is';
 import fs from 'fs-extra';
-import { setUserConfigFileNames } from '../../../../config/app-strings';
 import type { AllConfig } from '../../../../config/types';
 import { logger } from '../../../../logger';
 import { getParsedContent, migrateAndValidateConfig } from './util';
@@ -71,15 +69,6 @@ export async function getConfig(env: NodeJS.ProcessEnv): Promise<AllConfig> {
     delete config.processEnv;
   }
 
-  if (isNonEmptyArray(config.configFileNames)) {
-    logger.debug(
-      { configFileNames: config.configFileNames },
-      'Updated the config filenames list',
-    );
-    setUserConfigFileNames(config.configFileNames);
-    delete config.configFileNames;
-  }
-
   return migrateAndValidateConfig(config, configFile);
 }
 

lib/workers/global/config/parse/index.spec.ts

@@ -1,4 +1,5 @@
 import upath from 'upath';
+import { getConfigFileNames } from '../../../../config/app-strings';
 import * as _decrypt from '../../../../config/decrypt';
 import { CONFIG_PRESETS_INVALID } from '../../../../constants/error-messages';
 import { getCustomEnv } from '../../../../util/env';
@@ -351,5 +352,45 @@ describe('workers/global/config/parse/index', () => {
       );
       expect(parsedConfig.extends).toMatchObject([':pinDigests']);
     });
+
+    it('appends files from configFileNames to config filenames list', async () => {
+      // Capture the length we add our custom filenames.
+      const lengthBefore = getConfigFileNames().length;
+      fileConfigParser.getConfig.mockResolvedValue({
+        configFileNames: ['myrenovate.json', '.github/myrenovate.json'],
+      });
+      const parsedConfig = await configParser.parseConfigs(
+        defaultEnv,
+        defaultArgv,
+      );
+      expect(parsedConfig.configFileNames).toBeUndefined();
+      expect(getConfigFileNames()[0]).toBe('myrenovate.json');
+      expect(getConfigFileNames()[1]).toBe('.github/myrenovate.json');
+      // Ensure we added exactly two filenames.
+      expect(getConfigFileNames().length).toBe(lengthBefore + 2);
+    });
+
+    it('supports setting configFileNames through cli', async () => {
+      fileConfigParser.getConfig.mockResolvedValue({});
+      defaultArgv = defaultArgv.concat([
+        '--config-file-names=myrenovate.json,.github/myrenovate.json',
+      ]);
+      const parsed = await configParser.parseConfigs(defaultEnv, defaultArgv);
+      expect(parsed.configFileNames).toBeUndefined();
+      expect(getConfigFileNames()[0]).toBe('myrenovate.json');
+      expect(getConfigFileNames()[1]).toBe('.github/myrenovate.json');
+    });
+
+    it('supports setting configFileNames through env', async () => {
+      fileConfigParser.getConfig.mockResolvedValue({});
+      const env: NodeJS.ProcessEnv = {
+        RENOVATE_CONFIG_FILE_NAMES:
+          '["myrenovate.json", ".github/myrenovate.json"]',
+      };
+      const parsedConfig = await configParser.parseConfigs(env, defaultArgv);
+      expect(parsedConfig.configFileNames).toBeUndefined();
+      expect(getConfigFileNames()[0]).toBe('myrenovate.json');
+      expect(getConfigFileNames()[1]).toBe('.github/myrenovate.json');
+    });
   });
 });

lib/workers/global/config/parse/index.ts

@@ -1,4 +1,5 @@
 import { isNonEmptyArray, isNonEmptyObject } from '@sindresorhus/is';
+import { setUserConfigFileNames } from '../../../../config/app-strings';
 import { setPrivateKeys } from '../../../../config/decrypt';
 import * as defaultsParser from '../../../../config/defaults';
 import { resolveConfigPresets } from '../../../../config/presets';
@@ -182,5 +183,14 @@ export async function parseConfigs(
     setCustomEnv(config.customEnvVariables);
   }
 
+  if (isNonEmptyArray(config.configFileNames)) {
+    logger.debug(
+      { configFileNames: config.configFileNames },
+      'Updated the config filenames list',
+    );
+    setUserConfigFileNames(config.configFileNames);
+    delete config.configFileNames;
+  }
+
   return config;
 }