-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
artifacts.ts
203 lines (193 loc) · 6.2 KB
/
artifacts.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
import { pipenv as pipenvDetect } from '@renovatebot/detect-tools';
import is from '@sindresorhus/is';
import { TEMPORARY_ERROR } from '../../../constants/error-messages';
import { logger } from '../../../logger';
import type { HostRule } from '../../../types';
import { exec } from '../../../util/exec';
import type { ExecOptions, ExtraEnv, Opt } from '../../../util/exec/types';
import {
deleteLocalFile,
ensureCacheDir,
getParentDir,
localPathExists,
readLocalFile,
writeLocalFile,
} from '../../../util/fs';
import { ensureLocalPath } from '../../../util/fs/util';
import { getRepoStatus } from '../../../util/git';
import { find } from '../../../util/host-rules';
import { regEx } from '../../../util/regex';
import { parseUrl } from '../../../util/url';
import { PypiDatasource } from '../../datasource/pypi';
import type { UpdateArtifact, UpdateArtifactsResult } from '../types';
import { extractPackageFile } from './extract';
export function getMatchingHostRule(url: string): HostRule | null {
const parsedUrl = parseUrl(url);
if (parsedUrl) {
parsedUrl.username = '';
parsedUrl.password = '';
const urlWithoutCredentials = parsedUrl.toString();
return find({ hostType: PypiDatasource.id, url: urlWithoutCredentials });
}
return null;
}
async function findPipfileSourceUrlsWithCredentials(
pipfileContent: string,
pipfileName: string,
): Promise<URL[]> {
const pipfile = await extractPackageFile(pipfileContent, pipfileName);
return (
pipfile?.registryUrls
?.map(parseUrl)
.filter(is.urlInstance)
.filter((url) => is.nonEmptyStringAndNotWhitespace(url.username)) ?? []
);
}
/**
* This will extract the actual variable name from an environment-placeholder:
* ${USERNAME:-defaultvalue} will yield 'USERNAME'
*/
export function extractEnvironmentVariableName(
credential: string,
): string | null {
const match = regEx('([a-z0-9_]+)', 'i').exec(decodeURI(credential));
return match?.length ? match[0] : null;
}
export function addExtraEnvVariable(
extraEnv: ExtraEnv<unknown>,
environmentVariableName: string,
environmentValue: string,
): void {
logger.trace(
`Adding ${environmentVariableName} environment variable for pipenv`,
);
if (
extraEnv[environmentVariableName] &&
extraEnv[environmentVariableName] !== environmentValue
) {
logger.warn(
`Possible misconfiguration, ${environmentVariableName} is already set to a different value`,
);
}
extraEnv[environmentVariableName] = environmentValue;
}
/**
* Pipenv allows configuring source-urls for remote repositories with placeholders for credentials, i.e. http://$USER:$PASS@myprivate.repo
* if a matching host rule exists for that repository, we need to set the corresponding variables.
* Simply substituting them in the URL is not an option as it would impact the hash for the resulting Pipfile.lock
*
*/
async function addCredentialsForSourceUrls(
newPipfileContent: string,
pipfileName: string,
extraEnv: ExtraEnv<unknown>,
): Promise<void> {
const sourceUrls = await findPipfileSourceUrlsWithCredentials(
newPipfileContent,
pipfileName,
);
for (const parsedSourceUrl of sourceUrls) {
logger.trace(`Trying to add credentials for ${parsedSourceUrl.toString()}`);
const matchingHostRule = getMatchingHostRule(parsedSourceUrl.toString());
if (matchingHostRule) {
const usernameVariableName = extractEnvironmentVariableName(
parsedSourceUrl.username,
);
if (matchingHostRule.username && usernameVariableName) {
addExtraEnvVariable(
extraEnv,
usernameVariableName,
matchingHostRule.username,
);
}
const passwordVariableName = extractEnvironmentVariableName(
parsedSourceUrl.password,
);
if (matchingHostRule.password && passwordVariableName) {
addExtraEnvVariable(
extraEnv,
passwordVariableName,
matchingHostRule.password,
);
}
}
}
}
export async function updateArtifacts({
packageFileName: pipfileName,
newPackageFileContent: newPipfileContent,
config,
}: UpdateArtifact): Promise<UpdateArtifactsResult[] | null> {
logger.debug(`pipenv.updateArtifacts(${pipfileName})`);
const lockFileName = pipfileName + '.lock';
if (!(await localPathExists(lockFileName))) {
logger.debug('No Pipfile.lock found');
return null;
}
try {
await writeLocalFile(pipfileName, newPipfileContent);
if (config.isLockFileMaintenance) {
await deleteLocalFile(lockFileName);
}
const cmd = 'pipenv lock';
const pipfileDir = getParentDir(ensureLocalPath(pipfileName));
const tagConstraint =
config.constraints?.python ??
(await pipenvDetect.getPythonConstraint(pipfileDir));
const pipenvConstraint =
config.constraints?.pipenv ??
(await pipenvDetect.getPipenvConstraint(pipfileDir));
const extraEnv: Opt<ExtraEnv> = {
PIPENV_CACHE_DIR: await ensureCacheDir('pipenv'),
PIP_CACHE_DIR: await ensureCacheDir('pip'),
WORKON_HOME: await ensureCacheDir('virtualenvs'),
};
const execOptions: ExecOptions = {
cwdFile: pipfileName,
docker: {},
userConfiguredEnv: config.env,
toolConstraints: [
{
toolName: 'python',
constraint: tagConstraint,
},
{
toolName: 'pipenv',
constraint: pipenvConstraint,
},
],
};
await addCredentialsForSourceUrls(newPipfileContent, pipfileName, extraEnv);
execOptions.extraEnv = extraEnv;
logger.trace({ cmd }, 'pipenv lock command');
await exec(cmd, execOptions);
const status = await getRepoStatus();
if (!status?.modified.includes(lockFileName)) {
return null;
}
logger.debug('Returning updated Pipfile.lock');
return [
{
file: {
type: 'addition',
path: lockFileName,
contents: await readLocalFile(lockFileName, 'utf8'),
},
},
];
} catch (err) {
// istanbul ignore if
if (err.message === TEMPORARY_ERROR) {
throw err;
}
logger.debug({ err }, 'Failed to update Pipfile.lock');
return [
{
artifactError: {
lockFile: lockFileName,
stderr: err.message,
},
},
];
}
}