/
extract.ts
225 lines (206 loc) · 6.45 KB
/
extract.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
import { parse } from '@iarna/toml';
import is from '@sindresorhus/is';
import { logger } from '../../../logger';
import type { SkipReason } from '../../../types';
import {
getSiblingFileName,
localPathExists,
readLocalFile,
} from '../../../util/fs';
import { parseGitUrl } from '../../../util/git/url';
import { regEx } from '../../../util/regex';
import { GithubTagsDatasource } from '../../datasource/github-tags';
import { PypiDatasource } from '../../datasource/pypi';
import * as pep440Versioning from '../../versioning/pep440';
import * as poetryVersioning from '../../versioning/poetry';
import type { PackageDependency, PackageFileContent } from '../types';
import { extractLockFileEntries } from './locked-version';
import type { PoetryDependency, PoetryFile, PoetrySection } from './types';
function extractFromDependenciesSection(
parsedFile: PoetryFile,
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[] {
if (!sectionContent) {
return [];
}
const deps: PackageDependency[] = [];
for (const depName of Object.keys(sectionContent)) {
if (depName === 'python' || depName === 'source') {
continue;
}
const pep503NormalizeRegex = regEx(/[-_.]+/g);
let packageName = depName.toLowerCase().replace(pep503NormalizeRegex, '-');
let skipReason: SkipReason | null = null;
let currentValue = sectionContent[depName];
let nestedVersion = false;
let datasource = PypiDatasource.id;
let lockedVersion: string | null = null;
if (packageName in poetryLockfile) {
lockedVersion = poetryLockfile[packageName];
}
if (!is.string(currentValue)) {
const version = currentValue.version;
const path = currentValue.path;
const git = currentValue.git;
if (version) {
currentValue = version;
nestedVersion = true;
if (path || git) {
skipReason = path ? 'path-dependency' : 'git-dependency';
}
} else if (path) {
currentValue = '';
skipReason = 'path-dependency';
} else if (git) {
if (currentValue.tag) {
currentValue = currentValue.tag;
datasource = GithubTagsDatasource.id;
const githubPackageName = extractGithubPackageName(git);
if (githubPackageName) {
packageName = githubPackageName;
} else {
skipReason = 'git-dependency';
}
} else {
currentValue = '';
skipReason = 'git-dependency';
}
} else {
currentValue = '';
skipReason = 'multiple-constraint-dep';
}
}
const dep: PackageDependency = {
depName,
depType,
currentValue,
managerData: { nestedVersion },
datasource,
};
if (lockedVersion) {
dep.lockedVersion = lockedVersion;
}
if (depName !== packageName) {
dep.packageName = packageName;
}
if (skipReason) {
dep.skipReason = skipReason;
} else if (pep440Versioning.isValid(currentValue)) {
dep.versioning = pep440Versioning.id;
} else if (poetryVersioning.isValid(currentValue)) {
dep.versioning = poetryVersioning.id;
} else {
dep.skipReason = 'unknown-version';
}
deps.push(dep);
}
return deps;
}
function extractRegistries(pyprojectfile: PoetryFile): string[] | undefined {
const sources = pyprojectfile.tool?.poetry?.source;
if (!Array.isArray(sources) || sources.length === 0) {
return undefined;
}
const registryUrls = new Set<string>();
for (const source of sources) {
if (source.url) {
registryUrls.add(source.url);
}
}
registryUrls.add(process.env.PIP_INDEX_URL ?? 'https://pypi.org/pypi/');
return Array.from(registryUrls);
}
export async function extractPackageFile(
content: string,
fileName: string
): Promise<PackageFileContent | null> {
logger.trace(`poetry.extractPackageFile(${fileName})`);
let pyprojectfile: PoetryFile;
try {
pyprojectfile = parse(content);
} catch (err) {
logger.debug({ err }, 'Error parsing pyproject.toml file');
return null;
}
if (!pyprojectfile.tool?.poetry) {
logger.debug(`${fileName} contains no poetry section`);
return null;
}
// handle the lockfile
const lockfileName = getSiblingFileName(fileName, 'poetry.lock');
// TODO #7154
const lockContents = (await readLocalFile(lockfileName, 'utf8'))!;
const lockfileMapping = extractLockFileEntries(lockContents);
const deps = [
...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;
}
const extractedConstraints: Record<string, any> = {};
if (is.nonEmptyString(pyprojectfile.tool?.poetry?.dependencies?.python)) {
extractedConstraints.python =
pyprojectfile.tool?.poetry?.dependencies?.python;
}
const res: PackageFileContent = {
deps,
registryUrls: extractRegistries(pyprojectfile),
extractedConstraints,
};
// Try poetry.lock first
let lockFile = getSiblingFileName(fileName, 'poetry.lock');
// istanbul ignore next
if (await localPathExists(lockFile)) {
res.lockFiles = [lockFile];
} else {
// Try pyproject.lock next
lockFile = getSiblingFileName(fileName, 'pyproject.lock');
if (await localPathExists(lockFile)) {
res.lockFiles = [lockFile];
}
}
return res;
}
function extractGithubPackageName(url: string): string | null {
const parsedUrl = parseGitUrl(url);
if (parsedUrl.source !== 'github.com') {
return null;
}
return `${parsedUrl.owner}/${parsedUrl.name}`;
}