feat(core): centralize sidecar image usage (#19545)

renovatebot · Dec 23, 2022 · 73be295 · 73be295
1 parent f5548af
commit 73be295
Show file tree

Hide file tree

Showing 28 changed files with 70 additions and 165 deletions.
diff --git a/lib/modules/manager/bundler/artifacts.ts b/lib/modules/manager/bundler/artifacts.ts
@@ -166,7 +166,7 @@ export async function updateArtifacts(
         ...bundlerHostRulesVariables,
         GEM_HOME: await ensureCacheDir('bundler'),
       },
-      docker: { image: 'sidecar' },
+      docker: {},
       toolConstraints: [
         {
           toolName: 'ruby',

diff --git a/lib/modules/manager/cargo/artifacts.ts b/lib/modules/manager/cargo/artifacts.ts
@@ -23,9 +23,7 @@ async function cargoUpdate(
   }
 
   const execOptions: ExecOptions = {
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
     toolConstraints: [{ toolName: 'rust', constraint }],
   };
   await exec(cmd, execOptions);

diff --git a/lib/modules/manager/cocoapods/artifacts.ts b/lib/modules/manager/cocoapods/artifacts.ts
@@ -75,7 +75,7 @@ export async function updateArtifacts({
     extraEnv: {
       CP_HOME_DIR: await ensureCacheDir('cocoapods'),
     },
-    docker: { image: 'sidecar' },
+    docker: {},
     toolConstraints: [
       {
         toolName: 'ruby',

diff --git a/lib/modules/manager/composer/artifacts.ts b/lib/modules/manager/composer/artifacts.ts
@@ -117,9 +117,7 @@ export async function updateArtifacts({
         COMPOSER_AUTH: getAuthJson(),
       },
       toolConstraints: [phpToolConstraint, composerToolConstraint],
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
     };
 
     const commands: string[] = [];

diff --git a/lib/modules/manager/flux/artifacts.ts b/lib/modules/manager/flux/artifacts.ts
@@ -24,9 +24,7 @@ export async function updateArtifacts({
     }
     const cmd = `flux install ${args.join(' ')} > ${quote(packageFileName)}`;
     const execOptions: ExecOptions = {
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints: [
         {
           toolName: 'flux',

diff --git a/lib/modules/manager/gomod/artifacts.ts b/lib/modules/manager/gomod/artifacts.ts
@@ -259,9 +259,7 @@ export async function updateArtifacts({
         CGO_ENABLED: GlobalConfig.get('binarySource') === 'docker' ? '0' : null,
         ...getGitEnvironmentVariables(),
       },
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints: [
         {
           toolName: 'golang',

diff --git a/lib/modules/manager/gradle-wrapper/artifacts.ts b/lib/modules/manager/gradle-wrapper/artifacts.ts
@@ -147,9 +147,7 @@ export async function updateArtifacts({
     logger.debug(`Updating gradle wrapper: "${cmd}"`);
     const execOptions: ExecOptions = {
       cwdFile: gradlewFile,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       extraEnv,
       toolConstraints: [
         {

diff --git a/lib/modules/manager/gradle/artifacts.ts b/lib/modules/manager/gradle/artifacts.ts
@@ -136,9 +136,7 @@ export async function updateArtifacts({
     let cmd = `${gradlewName} --console=plain -q`;
     const execOptions: ExecOptions = {
       cwdFile: gradlewFile,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       extraEnv,
       toolConstraints: [
         {

diff --git a/lib/modules/manager/helmv3/artifacts.ts b/lib/modules/manager/helmv3/artifacts.ts
@@ -157,9 +157,7 @@ export async function updateArtifacts({
     };
 
     const execOptions: ExecOptions = {
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       extraEnv: {
         HELM_EXPERIMENTAL_OCI: '1',
       },

diff --git a/lib/modules/manager/hermit/artifacts.ts b/lib/modules/manager/hermit/artifacts.ts
@@ -205,9 +205,7 @@ async function updateHermitPackage(update: UpdateArtifact): Promise<void> {
   }
 
   const execOptions: ExecOptions = {
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
     cwdFile: update.packageFileName,
   };
 

diff --git a/lib/modules/manager/jsonnet-bundler/artifacts.ts b/lib/modules/manager/jsonnet-bundler/artifacts.ts
@@ -41,9 +41,7 @@ export async function updateArtifacts(
 
   const execOptions: ExecOptions = {
     cwdFile: packageFileName,
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
     toolConstraints: [jsonnetBundlerToolConstraint],
   };
 

diff --git a/lib/modules/manager/mix/artifacts.ts b/lib/modules/manager/mix/artifacts.ts
@@ -75,9 +75,7 @@ export async function updateArtifacts({
 
   const execOptions: ExecOptions = {
     cwdFile: packageFileName,
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
     toolConstraints: [
       {
         toolName: 'erlang',

diff --git a/lib/modules/manager/nix/artifacts.ts b/lib/modules/manager/nix/artifacts.ts
@@ -46,9 +46,7 @@ export async function updateArtifacts({
         constraint: config.constraints?.nix,
       },
     ],
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
   };
 
   try {

diff --git a/lib/modules/manager/npm/post-update/lerna.ts b/lib/modules/manager/npm/post-update/lerna.ts
@@ -91,9 +91,7 @@ export async function generateLockFiles(
     const execOptions: ExecOptions = {
       cwdFile: upath.join(lockFileDir, 'package.json'),
       extraEnv,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints,
     };
     // istanbul ignore if

diff --git a/lib/modules/manager/npm/post-update/npm.ts b/lib/modules/manager/npm/post-update/npm.ts
@@ -66,9 +66,7 @@ export async function generateLockFile(
         await getNodeToolConstraint(config, upgrades, lockFileDir),
         npmToolConstraint,
       ],
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
     };
     // istanbul ignore if
     if (GlobalConfig.get('exposeAllEnv')) {

diff --git a/lib/modules/manager/npm/post-update/pnpm.ts b/lib/modules/manager/npm/post-update/pnpm.ts
@@ -42,9 +42,7 @@ export async function generateLockFile(
     const execOptions: ExecOptions = {
       cwdFile: lockFileName,
       extraEnv,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints: [
         await getNodeToolConstraint(config, upgrades, lockFileDir),
         pnpmToolConstraint,

diff --git a/lib/modules/manager/npm/post-update/yarn.ts b/lib/modules/manager/npm/post-update/yarn.ts
@@ -187,9 +187,7 @@ export async function generateLockFile(
     const execOptions: ExecOptions = {
       cwdFile: lockFileName,
       extraEnv,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints,
     };
     // istanbul ignore if

diff --git a/lib/modules/manager/nuget/artifacts.ts b/lib/modules/manager/nuget/artifacts.ts
@@ -68,9 +68,7 @@ async function runDotnetRestore(
   const nugetCacheDir = join(privateCacheDir(), 'nuget');
 
   const execOptions: ExecOptions = {
-    docker: {
-      image: 'sidecar',
-    },
+    docker: {},
     extraEnv: {
       NUGET_PACKAGES: join(nugetCacheDir, 'packages'),
       MSBUILDDISABLENODEREUSE: '1',

diff --git a/lib/modules/manager/pip-compile/artifacts.ts b/lib/modules/manager/pip-compile/artifacts.ts
@@ -125,9 +125,7 @@ export async function updateArtifacts({
     const pipToolsConstraint = getPipToolsConstraint(config);
     const execOptions: ExecOptions = {
       cwdFile: inputFileName,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       preCommands: [
         `pip install --user ${quote(`pip-tools${pipToolsConstraint}`)}`,
       ],

diff --git a/lib/modules/manager/pip_requirements/artifacts.ts b/lib/modules/manager/pip_requirements/artifacts.ts
@@ -68,9 +68,7 @@ export async function updateArtifacts({
     }
     const execOptions: ExecOptions = {
       cwdFile: '.',
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       preCommands: ['pip install --user hashin'],
       toolConstraints: [
         { toolName: 'python', constraint: config.constraints?.python },

diff --git a/lib/modules/manager/pipenv/artifacts.ts b/lib/modules/manager/pipenv/artifacts.ts
@@ -101,9 +101,7 @@ export async function updateArtifacts({
         PIPENV_CACHE_DIR: await ensureCacheDir('pipenv'),
         PIP_CACHE_DIR: await ensureCacheDir('pip'),
       },
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       preCommands: [`pip install --user ${quote(`pipenv${pipenvConstraint}`)}`],
       toolConstraints: [
         {

diff --git a/lib/modules/manager/poetry/artifacts.ts b/lib/modules/manager/poetry/artifacts.ts
@@ -184,9 +184,7 @@ export async function updateArtifacts({
     const execOptions: ExecOptions = {
       cwdFile: packageFileName,
       extraEnv,
-      docker: {
-        image: 'sidecar',
-      },
+      docker: {},
       toolConstraints: [{ toolName: 'python', constraint }],
       preCommands: [
         `pip install --user ${quote(`poetry${poetryVersion ?? ''}`)}`,

diff --git a/lib/util/exec/docker/index.spec.ts b/lib/util/exec/docker/index.spec.ts
@@ -11,6 +11,7 @@ import {
   removeDanglingContainers,
   removeDockerContainer,
   resetPrefetchedImages,
+  sideCarImage,
 } from '.';
 
 const getPkgReleases: jest.Mock<typeof _getPkgReleases> =
@@ -202,15 +203,14 @@ describe('util/exec/docker/index', () => {
     const preCommands = [null as never, 'foo', undefined as never];
     const commands = ['bar'];
     const envVars = ['FOO', 'BAR'];
-    const image = 'sample_image';
+    const image = sideCarImage;
     const dockerOptions = {
-      image,
       cwd: '/tmp/foobar',
       envVars,
     };
     const command = (img: string, vol?: string): string =>
       `docker run --rm ` +
-      `--name=renovate_sample_image ` +
+      `--name=renovate_${img} ` +
       `--label=renovate_child ` +
       `--user=some-user ` +
       (vol ? `${vol} ` : '') +
@@ -289,30 +289,15 @@ describe('util/exec/docker/index', () => {
       );
     });
 
-    it('handles tag parameter', async () => {
-      mockExecAll();
-      const res = await generateDockerCommand(commands, preCommands, {
-        ...dockerOptions,
-        tag: '1.2.3',
-      });
-      expect(res).toBe(command(`${image}:1.2.3`));
-    });
-
-    it('handles tag constraint', async () => {
-      mockExecAll();
-      getPkgReleases.mockResolvedValueOnce({
-        releases: [
-          { version: '1.2.3' },
-          { version: '1.2.4' },
-          { version: '2.0.0' },
-        ],
-      } as never);
-      const res = await generateDockerCommand(commands, preCommands, {
-        ...dockerOptions,
-        tagScheme: 'npm',
-        tagConstraint: '^1.2.3',
-      });
-      expect(res).toBe(command(`${image}:1.2.4`));
-    });
+    // TODO: it('handles tag constraint', async () => {
+    //   mockExecAll();
+    //   getPkgReleases.mockResolvedValueOnce({
+    //     releases: [{ version: '5.5.5' }, { version: '6.0.0' }],
+    //   } as never);
+    //   const res = await generateDockerCommand(commands, preCommands, {
+    //     ...dockerOptions,
+    //   });
+    //   expect(res).toBe(command(`${image}:5.5.5`));
+    // });
   });
 });
diff --git a/lib/util/exec/docker/index.ts b/lib/util/exec/docker/index.ts
@@ -13,6 +13,8 @@ const prefetchedImages = new Map<string, string>();
 
 const digestRegex = regEx('Digest: (.*?)\n');
 
+export const sideCarImage = 'sidecar';
+
 export async function prefetchDockerImage(taggedImage: string): Promise<void> {
   if (prefetchedImages.has(taggedImage)) {
     logger.debug(
@@ -211,8 +213,8 @@ export async function generateDockerCommand(
   preCommands: string[],
   options: DockerOptions
 ): Promise<string> {
-  const { envVars, cwd, tagScheme, tagConstraint } = options;
-  let image = options.image;
+  const { envVars, cwd } = options;
+  let image = sideCarImage;
   const volumes = options.volumes ?? [];
   const {
     localDir,
@@ -259,21 +261,13 @@ export async function generateDockerCommand(
 
   image = `${ensureTrailingSlash(dockerImagePrefix ?? 'renovate')}${image}`;
 
-  let tag: string | null = null;
-  if (options.tag) {
-    tag = options.tag;
-  } else if (tagConstraint) {
-    const tagVersioning = tagScheme ?? 'semver';
-    tag = await getDockerTag(image, tagConstraint, tagVersioning);
-    logger.debug(
-      { image, tagConstraint, tagVersioning, tag },
-      'Resolved tag constraint'
-    );
-  } else {
-    logger.debug(`No tag or tagConstraint specified for image: ${image}`);
-  }
+  // TODO: add constraint: const tag = getDockerTag(image, sideCarImageVersion, 'semver');
+  logger.debug(
+    { image /*, tagConstraint: sideCarImageVersion, tag */ },
+    'Resolved tag constraint'
+  );
 
-  const taggedImage = tag ? `${image}:${tag}` : `${image}`;
+  const taggedImage = image; // TODO: tag ? `${image}:${tag}` : `${image}`;
   await prefetchDockerImage(taggedImage);
   result.push(taggedImage);