From 25f43fd1d7c23a52150d927da39ba267dd3555e5 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Fri, 5 Feb 2021 09:58:48 +0100
Subject: [PATCH] refactor: move post upgrade commands to repo admin config
(#8552)
---
lib/config/common.ts | 4 ++--
lib/workers/branch/index.spec.ts | 26 +++++++++++++++++++-------
lib/workers/branch/index.ts | 16 +++++++++++-----
3 files changed, 32 insertions(+), 14 deletions(-)
diff --git a/lib/config/common.ts b/lib/config/common.ts
index 4fff9774bc..c6f03095dd 100644
--- a/lib/config/common.ts
+++ b/lib/config/common.ts
@@ -64,13 +64,13 @@ export interface RenovateSharedConfig {
}
export interface RepoAdminConfig {
+ allowPostUpgradeCommandTemplating?: boolean;
+ allowedPostUpgradeCommands?: string[];
dockerImagePrefix?: string;
dockerUser?: string;
}
export interface RenovateAdminConfig {
- allowPostUpgradeCommandTemplating?: boolean;
- allowedPostUpgradeCommands?: string[];
autodiscover?: boolean;
autodiscoverFilter?: string;
diff --git a/lib/workers/branch/index.spec.ts b/lib/workers/branch/index.spec.ts
index d73f0ca77d..aa7e5c1b24 100644
--- a/lib/workers/branch/index.spec.ts
+++ b/lib/workers/branch/index.spec.ts
@@ -1,5 +1,6 @@
import * as _fs from 'fs-extra';
import { defaultConfig, git, mocked, platform } from '../../../test/util';
+import { setAdminConfig } from '../../config/admin';
import {
MANAGER_LOCKFILE_ERROR,
REPOSITORY_CHANGED,
@@ -64,6 +65,7 @@ describe('workers/branch', () => {
} as never;
schedule.isScheduledNow.mockReturnValue(true);
commit.commitFilesToBranch.mockResolvedValue('abc123');
+ setAdminConfig({}, []);
});
afterEach(() => {
platform.ensureComment.mockClear();
@@ -693,6 +695,12 @@ describe('workers/branch', () => {
schedule.isScheduledNow.mockReturnValueOnce(false);
commit.commitFilesToBranch.mockResolvedValueOnce(null);
+ const adminConfig = {
+ allowedPostUpgradeCommands: ['^echo {{{versioning}}}$'],
+ allowPostUpgradeCommandTemplating: true,
+ };
+ setAdminConfig(adminConfig, Object.keys(adminConfig));
+
const result = await branchWorker.processBranch({
...config,
postUpgradeTasks: {
@@ -700,8 +708,6 @@ describe('workers/branch', () => {
fileFilters: ['modified_file', 'deleted_file'],
},
localDir: '/localDir',
- allowedPostUpgradeCommands: ['^echo {{{versioning}}}$'],
- allowPostUpgradeCommandTemplating: true,
upgrades: [
{
...defaultConfig,
@@ -757,7 +763,11 @@ describe('workers/branch', () => {
schedule.isScheduledNow.mockReturnValueOnce(false);
commit.commitFilesToBranch.mockResolvedValueOnce(null);
-
+ const adminConfig = {
+ allowedPostUpgradeCommands: ['^echo {{{versioning}}}$'],
+ allowPostUpgradeCommandTemplating: false,
+ };
+ setAdminConfig(adminConfig, Object.keys(adminConfig));
const result = await branchWorker.processBranch({
...config,
postUpgradeTasks: {
@@ -765,8 +775,6 @@ describe('workers/branch', () => {
fileFilters: ['modified_file', 'deleted_file'],
},
localDir: '/localDir',
- allowedPostUpgradeCommands: ['^echo {{{versioning}}}$'],
- allowPostUpgradeCommandTemplating: false,
upgrades: [
{
...defaultConfig,
@@ -833,6 +841,12 @@ describe('workers/branch', () => {
schedule.isScheduledNow.mockReturnValueOnce(false);
commit.commitFilesToBranch.mockResolvedValueOnce(null);
+ const adminConfig = {
+ allowedPostUpgradeCommands: ['^echo {{{depName}}}$'],
+ allowPostUpgradeCommandTemplating: true,
+ };
+ setAdminConfig(adminConfig, Object.keys(adminConfig));
+
const inconfig = {
...config,
postUpgradeTasks: {
@@ -845,8 +859,6 @@ describe('workers/branch', () => {
],
},
localDir: '/localDir',
- allowedPostUpgradeCommands: ['^echo {{{depName}}}$'],
- allowPostUpgradeCommandTemplating: true,
upgrades: [
{
...defaultConfig,
diff --git a/lib/workers/branch/index.ts b/lib/workers/branch/index.ts
index a467aecb9a..9c3ed2135e 100644
--- a/lib/workers/branch/index.ts
+++ b/lib/workers/branch/index.ts
@@ -2,6 +2,7 @@ import is from '@sindresorhus/is';
import { DateTime } from 'luxon';
import minimatch from 'minimatch';
import { RenovateConfig } from '../../config';
+import { getAdminConfig } from '../../config/admin';
import {
CONFIG_VALIDATION,
MANAGER_LOCKFILE_ERROR,
@@ -325,20 +326,25 @@ export async function processBranch(
logger.debug('No updated lock files in branch');
}
+ const {
+ allowedPostUpgradeCommands,
+ allowPostUpgradeCommandTemplating,
+ } = getAdminConfig();
+
if (
/* Only run post-upgrade tasks if there are changes to package files... */
(config.updatedPackageFiles?.length > 0 ||
/* ... or changes to artifacts */
config.updatedArtifacts?.length > 0) &&
global.trustLevel === 'high' &&
- is.nonEmptyArray(config.allowedPostUpgradeCommands)
+ is.nonEmptyArray(allowedPostUpgradeCommands)
) {
for (const upgrade of config.upgrades) {
addMeta({ dep: upgrade.depName });
logger.trace(
{
tasks: upgrade.postUpgradeTasks,
- allowedCommands: config.allowedPostUpgradeCommands,
+ allowedCommands: allowedPostUpgradeCommands,
},
'Checking for post-upgrade tasks'
);
@@ -363,19 +369,19 @@ export async function processBranch(
for (const cmd of commands) {
if (
- !config.allowedPostUpgradeCommands.some((pattern) =>
+ !allowedPostUpgradeCommands.some((pattern) =>
regEx(pattern).test(cmd)
)
) {
logger.warn(
{
cmd,
- allowedPostUpgradeCommands: config.allowedPostUpgradeCommands,
+ allowedPostUpgradeCommands,
},
'Post-upgrade task did not match any on allowed list'
);
} else {
- const compiledCmd = config.allowPostUpgradeCommandTemplating
+ const compiledCmd = allowPostUpgradeCommandTemplating
? template.compile(cmd, upgrade)
: cmd;
--
GitLab