feat(poetry): handle dependency groups (#17964)

renovatebot · Oct 6, 2022 · 4c1b3e5 · 4c1b3e5
1 parent 72371cb
commit 4c1b3e5
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 9 deletions.
diff --git a/lib/modules/manager/poetry/extract.spec.ts b/lib/modules/manager/poetry/extract.spec.ts
@@ -132,6 +132,32 @@ describe('modules/manager/poetry/extract', () => {
       });
     });
 
+    it('extracts dependencies from dependency groups', async () => {
+      const content =
+        '[tool.poetry.dependencies]\ndep = "^2.0"\n\n[tool.poetry.group.dev.dependencies]\ndev_dep = "^3.0"\n\n[tool.poetry.group.typing.dependencies]\ntyping_dep = "^4.0"';
+      const res = await extractPackageFile(content, filename);
+      expect(res?.deps).toMatchObject([
+        {
+          currentValue: '^2.0',
+          datasource: 'pypi',
+          depName: 'dep',
+          depType: 'dependencies',
+        },
+        {
+          currentValue: '^3.0',
+          datasource: 'pypi',
+          depName: 'dev_dep',
+          depType: 'dev',
+        },
+        {
+          currentValue: '^4.0',
+          datasource: 'pypi',
+          depName: 'typing_dep',
+          depType: 'typing',
+        },
+      ]);
+    });
+
     it('resolves lockedVersions from the lockfile', async () => {
       fs.readLocalFile.mockResolvedValue(pyproject11tomlLock);
       const res = await extractPackageFile(pyproject11toml, filename);

diff --git a/lib/modules/manager/poetry/extract.ts b/lib/modules/manager/poetry/extract.ts
@@ -12,19 +12,43 @@ import * as pep440Versioning from '../../versioning/pep440';
 import * as poetryVersioning from '../../versioning/poetry';
 import type { PackageDependency, PackageFile } from '../types';
 import { extractLockFileEntries } from './locked-version';
-import type { PoetryFile, PoetrySection } from './types';
+import type { PoetryDependency, PoetryFile, PoetrySection } from './types';
 
-function extractFromSection(
+function extractFromDependenciesSection(
   parsedFile: PoetryFile,
-  section: keyof Omit<PoetrySection, 'source'>,
+  section: keyof Omit<PoetrySection, 'source' | 'group'>,
+  poetryLockfile: Record<string, string>
+): PackageDependency[] {
+  return extractFromSection(
+    parsedFile.tool?.poetry?.[section],
+    section,
+    poetryLockfile
+  );
+}
+
+function extractFromDependenciesGroupSection(
+  parsedFile: PoetryFile,
+  group: string,
+  poetryLockfile: Record<string, string>
+): PackageDependency[] {
+  return extractFromSection(
+    parsedFile.tool?.poetry?.group[group]?.dependencies,
+    group,
+    poetryLockfile
+  );
+}
+
+function extractFromSection(
+  sectionContent: Record<string, PoetryDependency | string> | undefined,
+  depType: string,
   poetryLockfile: Record<string, string>
 ): PackageDependency[] {
-  const deps: PackageDependency[] = [];
-  const sectionContent = parsedFile.tool?.poetry?.[section];
   if (!sectionContent) {
     return [];
   }
 
+  const deps: PackageDependency[] = [];
+
   for (const depName of Object.keys(sectionContent)) {
     if (depName === 'python' || depName === 'source') {
       continue;
@@ -56,7 +80,7 @@ function extractFromSection(
     }
     const dep: PackageDependency = {
       depName,
-      depType: section,
+      depType,
       currentValue,
       managerData: { nestedVersion },
       datasource: PypiDatasource.id,
@@ -121,10 +145,22 @@ export async function extractPackageFile(
   const lockfileMapping = extractLockFileEntries(lockContents);
 
   const deps = [
-    ...extractFromSection(pyprojectfile, 'dependencies', lockfileMapping),
-    ...extractFromSection(pyprojectfile, 'dev-dependencies', lockfileMapping),
-    ...extractFromSection(pyprojectfile, 'extras', lockfileMapping),
+    ...extractFromDependenciesSection(
+      pyprojectfile,
+      'dependencies',
+      lockfileMapping
+    ),
+    ...extractFromDependenciesSection(
+      pyprojectfile,
+      'dev-dependencies',
+      lockfileMapping
+    ),
+    ...extractFromDependenciesSection(pyprojectfile, 'extras', lockfileMapping),
+    ...Object.keys(pyprojectfile.tool?.poetry?.group ?? []).flatMap((group) =>
+      extractFromDependenciesGroupSection(pyprojectfile, group, lockfileMapping)
+    ),
   ];
+
   if (!deps.length) {
     return null;
   }

diff --git a/lib/modules/manager/poetry/readme.md b/lib/modules/manager/poetry/readme.md
@@ -7,3 +7,4 @@ The following `depTypes` are supported by the Poetry manager:
 - `dependencies`
 - `dev-dependencies`
 - `extras`
+- `<group-name>` (dynamic, based on the group name, per [dependency groups documentation](https://python-poetry.org/docs/managing-dependencies/#dependency-groups))
diff --git a/lib/modules/manager/poetry/types.ts b/lib/modules/manager/poetry/types.ts
@@ -2,6 +2,7 @@ export interface PoetrySection {
   dependencies: Record<string, PoetryDependency | string>;
   'dev-dependencies': Record<string, PoetryDependency | string>;
   extras: Record<string, PoetryDependency | string>;
+  group: Record<string, PoetryGroup>;
   source?: PoetrySource[];
 }
 
@@ -27,6 +28,10 @@ export interface PoetrySource {
   url?: string;
 }
 
+export interface PoetryGroup {
+  dependencies: Record<string, PoetryDependency | string>;
+}
+
 export interface PoetryLockSection {
   name?: string;
   version?: string;