fix(gomod): preserve go/toolchain directives

lib/modules/manager/gomod/artifacts.spec.ts

@@ -2105,7 +2105,7 @@ describe('modules/manager/gomod/artifacts', () => {
           ' bash -l -c "' +
           'install-tool golang 1.23.3' +
           ' && ' +
-          'go get -d -t ./...' +
+          'go get -t ./...' +
           ' && ' +
           'go install github.com/marwan-at-work/mod/cmd/mod@latest' +
           ' && ' +
@@ -2134,6 +2134,14 @@ describe('modules/manager/gomod/artifacts', () => {
       .mockResolvedValueOnce('New go.sum')
       .mockResolvedValueOnce('New go.mod');
 
+    datasource.getPkgReleases.mockResolvedValueOnce({
+      releases: [
+        { version: '1.17.0' },
+        { version: '1.23.3' },
+        { version: '1.23.6' },
+      ],
+    });
+
     const res = await gomod.updateArtifacts({
       packageFileName: 'go.mod',
       updatedDeps: [{ depName: 'golang.org/x/crypto', newVersion: '0.35.0' }],
@@ -2156,8 +2164,6 @@ describe('modules/manager/gomod/artifacts', () => {
         cmd: 'go get -d -t ./...',
       },
     ]);
-
-    expect(datasource.getPkgReleases).toBeCalledTimes(0);
   });
 
   it('go.mod file contains full go version without toolchain', async () => {
@@ -2174,9 +2180,21 @@ describe('modules/manager/gomod/artifacts', () => {
       .mockResolvedValueOnce('New go.sum')
       .mockResolvedValueOnce('New go.mod');
 
+    datasource.getPkgReleases.mockResolvedValueOnce({
+      releases: [
+        { version: '1.17.0' },
+        { version: '1.23.3' },
+        { version: '1.24.1' },
+      ],
+    });
+
     const res = await gomod.updateArtifacts({
       packageFileName: 'go.mod',
-      updatedDeps: [{ depName: 'golang.org/x/crypto', newVersion: '0.35.0' }],
+      updatedDeps: [
+        { depName: 'golang.org/x/crypto', newVersion: 'v0.35.0' },
+        { depName: 'go', newVersion: '1.23.5' },
+        { newVersion: '1.23.5' },
+      ],
       newPackageFileContent: `someText\n\ngo 1.23.5\n\n${gomod1}`,
       config: {
         updateType: 'minor',
@@ -2190,14 +2208,153 @@ describe('modules/manager/gomod/artifacts', () => {
 
     expect(execSnapshots).toMatchObject([
       {
-        cmd: 'install-tool golang 1.23.5',
+        cmd: 'install-tool golang 1.24.1',
       },
       {
-        cmd: 'go get -d -t ./...',
+        cmd: 'go get -t ./... toolchain@none [email protected] golang.org/x/[email protected]',
       },
     ]);
+  });
 
-    expect(datasource.getPkgReleases).toBeCalledTimes(0);
+  it('preserve go.mod file without toolchain', async () => {
+    GlobalConfig.set({ ...adminConfig, binarySource: 'install' });
+    fs.readLocalFile.mockResolvedValueOnce('Current go.sum');
+    fs.readLocalFile.mockResolvedValueOnce(null); // vendor modules filename
+    const execSnapshots = mockExecAll();
+    git.getRepoStatus.mockResolvedValueOnce(
+      partial<StatusResult>({
+        modified: ['go.sum'],
+      }),
+    );
+    fs.readLocalFile
+      .mockResolvedValueOnce('New go.sum')
+      .mockResolvedValueOnce('New go.mod');
+
+    datasource.getPkgReleases.mockResolvedValueOnce({
+      releases: [
+        { version: '1.17.0' },
+        { version: '1.23.3' },
+        { version: '1.24.1' },
+      ],
+    });
+
+    const res = await gomod.updateArtifacts({
+      packageFileName: 'go.mod',
+      updatedDeps: [{ depName: 'golang.org/x/crypto', newVersion: 'v0.35.0' }],
+      newPackageFileContent: `someText\n\ngo 1.23\n\n${gomod1}`,
+      config: {
+        updateType: 'minor',
+      },
+    });
+
+    expect(res).toEqual([
+      { file: { type: 'addition', path: 'go.sum', contents: 'New go.sum' } },
+      { file: { type: 'addition', path: 'go.mod', contents: 'New go.mod' } },
+    ]);
+
+    expect(execSnapshots).toMatchObject([
+      {
+        cmd: 'install-tool golang 1.24.1',
+      },
+      {
+        cmd: 'go get -t ./... toolchain@none [email protected] golang.org/x/[email protected]',
+      },
+    ]);
+  });
+
+  it('preserve work with major upgrade', async () => {
+    GlobalConfig.set({ ...adminConfig, binarySource: 'install' });
+    fs.readLocalFile.mockResolvedValueOnce('Current go.sum');
+    fs.readLocalFile.mockResolvedValueOnce(null); // vendor modules filename
+    const execSnapshots = mockExecAll();
+    git.getRepoStatus.mockResolvedValueOnce(
+      partial<StatusResult>({
+        modified: ['go.sum'],
+      }),
+    );
+    fs.readLocalFile
+      .mockResolvedValueOnce('New go.sum')
+      .mockResolvedValueOnce('New go.mod');
+
+    datasource.getPkgReleases.mockResolvedValueOnce({
+      releases: [
+        { version: '1.17.0' },
+        { version: '1.23.3' },
+        { version: '1.24.1' },
+      ],
+    });
+
+    const res = await gomod.updateArtifacts({
+      packageFileName: 'go.mod',
+      updatedDeps: [
+        {
+          datasource: 'go',
+          depName: 'gopkg.in/yaml.v2',
+          fixedVersion: 'v2.4.0',
+          currentVersion: 'v2.4.0',
+          currentValue: 'v2.4.0',
+          newValue: 'v3.0.1',
+          newVersion: 'v3.0.1',
+          packageFile: 'go.mod',
+          updateType: 'major',
+          packageName: 'gopkg.in/yaml.v2',
+        },
+        {
+          depName: 'github.com/google/go-github/v24',
+          packageName: 'github.com/google/go-github/v24',
+          newVersion: 'v28.0.0',
+          datasource: 'go',
+          fixedVersion: 'v24.0.0',
+          currentVersion: 'v24.0.0',
+          currentValue: 'v24.0.0',
+          newValue: 'v28.0.0',
+          packageFile: 'go.mod',
+          updateType: 'major',
+        },
+        {
+          depName: 'github.com/renovatebot/renovate',
+          packageName: 'github.com/renovatebot/renovate',
+          newVersion: 'v1.0.0',
+          datasource: 'go',
+          fixedVersion: 'v0.0.1',
+          currentVersion: 'v0.0.1',
+          currentValue: 'v0.0.1',
+          newValue: 'v1.0.0',
+          packageFile: 'go.mod',
+          updateType: 'major',
+        },
+        {
+          depName: 'github.com/some/lib',
+          packageName: 'github.com/some/lib',
+          datasource: 'go',
+          fixedVersion: 'v0.0.1',
+          currentVersion: 'v0.0.1',
+          currentValue: 'v0.0.1',
+          newVersion: 'v2.0.0',
+          newValue: 'v2.0.0',
+          packageFile: 'go.mod',
+          updateType: 'major',
+        },
+      ],
+      newPackageFileContent: `someText\n\ngo 1.23\n\n${gomod1}`,
+      config: {
+        updateType: 'minor',
+      },
+    });
+
+    expect(res).toEqual([
+      { file: { type: 'addition', path: 'go.sum', contents: 'New go.sum' } },
+      { file: { type: 'addition', path: 'go.mod', contents: 'New go.mod' } },
+    ]);
+
+    expect(execSnapshots).toMatchObject([
+      {
+        cmd: 'install-tool golang 1.24.1',
+      },
+      {
+        cmd: 'go get -t ./... toolchain@none [email protected] gopkg.in/[email protected] github.com/google/go-github/[email protected] github.com/renovatebot/[email protected] github.com/some/lib/[email protected]',
+      },
+    ]);
   });
 
   it('returns artifact notices', async () => {

lib/modules/manager/gomod/artifacts.ts

@@ -190,8 +190,38 @@ export async function updateArtifacts({
       );
     }
   }
-  const goConstraints =
-    config.constraints?.go ?? getGoConstraints(newGoModContent);
+
+  const goMod = getGoConfig(newGoModContent);
+  const goConstraints = config.constraints?.go ?? `^${goMod.minimalGoVersion}`;
+
+  const getFlags = ['-t'];
+  if (!semver.satisfies(goMod.minimalGoVersion, '>=1.17.0')) {
+    getFlags.unshift('-d');
+  }
+
+  const extraGetArguments: string[] = [];
+  if (semver.satisfies(goMod.minimalGoVersion, '>=1.21.0')) {
+    extraGetArguments.push(`toolchain@${goMod.toolchainDirective ?? 'none'}`);
+    extraGetArguments.push(`go@${goMod.goDirective}`);
+    // add package@version to go get command to let golang check if it work with current go directive
+    // if some package requires a too new go version,
+    // the go get command will fail and user get a "artifact update problem" notice.
+    for (const pkg of updatedDeps) {
+      const name = pkg.packageName ?? pkg.depName ?? pkg.name;
+      if (name === 'go' || !name) {
+        continue;
+      }
+
+      if (pkg.updateType === 'major') {
+        const newMajor = major(pkg.newVersion!);
+        extraGetArguments.push(
+          `${upgradePackageMajorVersion(name, newMajor)}@${pkg.newVersion}`,
+        );
+      } else {
+        extraGetArguments.push(`${name}@${pkg.newVersion}`);
+      }
+    }
+  }
 
   try {
     await writeLocalFile(goModFileName, massagedGoMod);
@@ -241,7 +271,13 @@ export async function updateArtifacts({
       }
     }
 
-    let args = `get -d -t ${goGetDirs ?? './...'}`;
+    let args = [
+      'get',
+      ...getFlags,
+      goGetDirs ?? './...',
+      ...extraGetArguments,
+    ].join(' ');
+
     logger.trace({ cmd, args }, 'go get command included');
     execCommands.push(`${cmd} ${args}`);
 
@@ -442,37 +478,59 @@ export async function updateArtifacts({
   }
 }
 
-function getGoConstraints(content: string): string | undefined {
-  // prefer toolchain directive when go.mod has one
+function getGoConfig(content: string): {
+  toolchainDirective?: string;
+  minimalGoVersion: string;
+  goDirective: string;
+} {
   const toolchainMatch = regEx(/^toolchain\s*go(?<gover>\d+\.\d+\.\d+)$/m).exec(
     content,
   );
   const toolchainVer = toolchainMatch?.groups?.gover;
-  if (toolchainVer) {
-    logger.debug(
-      `Using go version ${toolchainVer} found in toolchain directive`,
-    );
-    return toolchainVer;
+
+  const goMatch = regEx(/^go\s*(?<gover>\d+(\.\d+)+)$/m).exec(content);
+
+  // go mod spec says if go directive is missing it's 1.16
+  const goDirective = goMatch?.groups?.gover ?? '1.16';
+  let goVersion = goDirective;
+
+  // partial semver version without patch
+  if (/^\d+\.\d+$/.test(goVersion)) {
+    goVersion = `${goVersion}.0`;
+  }
+
+  return {
+    toolchainDirective: toolchainVer,
+    minimalGoVersion: goVersion,
+    goDirective,
+  };
+}
+
+function upgradePackageMajorVersion(name: string, newMajor: number): string {
+  if (name.startsWith('gopkg.in/')) {
+    const s = name.split('.');
+    return `${s.slice(0, -1).join('.')}.v${newMajor}`;
+  }
+
+  // v0 => v1, no need to handle it
+  if (newMajor === 1) {
+    return name;
   }
 
-  // If go.mod doesn't have toolchain directive and has a full go version spec,
-  // for example `go 1.23.6`, pick this version, this doesn't match major.minor version spec.
-  //
-  // This is because when go.mod have same version defined in go directive and toolchain directive,
-  // go will remove toolchain directive from go.mod.
-  //
-  // For example, go will rewrite `go 1.23.5\ntoolchain go1.23.5` to `go 1.23.5` by default,
-  // in this case, the go directive is the toolchain directive.
-  const goFullVersion = regEx(/^go\s*(?<gover>\d+\.\d+\.\d+)$/m).exec(content)
-    ?.groups?.gover;
-  if (goFullVersion) {
-    return goFullVersion;
+  const s = name.split('/');
+  const last = s.at(-1);
+
+  // there is no valid case that a go pakcage name doesn't contain slash.
+  /* v8 ignore next 5 -- typescript strict null check */
+  if (!last) {
+    throw new Error(
+      `unreadable: go package name ${name} doesn't contain any slash`,
+    );
   }
 
-  const re = regEx(/^go\s*(?<gover>\d+\.\d+)$/m);
-  const match = re.exec(content);
-  if (!match?.groups?.gover) {
-    return undefined;
+  if (/^v\d+$/.test(last)) {
+    return `${s.slice(0, -1).join('/')}/v${newMajor}`;
   }
-  return `^${match.groups.gover}`;
+
+  return `${name}/v${newMajor}`;
 }