-
Notifications
You must be signed in to change notification settings - Fork 127
/
prepare-task.ts
154 lines (141 loc) · 5.9 KB
/
prepare-task.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
import * as path from "path";
import * as semver from "semver";
import * as tl from "azure-pipelines-task-lib/task";
import { Guid } from "guid-typescript";
import Endpoint, { EndpointType } from "./sonarqube/Endpoint";
import Scanner, { ScannerMode } from "./sonarqube/Scanner";
import { toCleanJSON } from "./helpers/utils";
import { getServerVersion } from "./helpers/request";
import * as azdoApiUtils from "./helpers/azdo-api-utils";
import { REPORT_TASK_NAME, SONAR_TEMP_DIRECTORY_NAME } from "./sonarqube/TaskReport";
const REPO_NAME_VAR = "Build.Repository.Name";
export default async function prepareTask(endpoint: Endpoint, rootPath: string) {
if (
endpoint.type === EndpointType.SonarQube &&
(endpoint.url.startsWith("https://sonarcloud.io") ||
endpoint.url.startsWith("https://sonarqube.com"))
) {
tl.warning(
"There is a dedicated extension for SonarCloud: https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud"
);
}
const scannerMode: ScannerMode = ScannerMode[tl.getInput("scannerMode")];
const scanner = Scanner.getPrepareScanner(rootPath, scannerMode);
const props: { [key: string]: string } = {};
if (await branchFeatureSupported(endpoint)) {
await populateBranchAndPrProps(props);
/* branchFeatureSupported method magically checks everything we need for the support of the below property,
so we keep it like that for now, waiting for a hardening that will refactor this (at least by renaming the method name) */
tl.debug(
"SonarCloud or SonarQube version >= 7.2.0 detected, setting report-task.txt file to its newest location."
);
props["sonar.scanner.metadataFilePath"] = reportPath();
tl.debug(`[SQ] Branch and PR parameters: ${JSON.stringify(props)}`);
}
tl.getDelimitedInput("extraProperties", "\n")
.filter((keyValue) => !keyValue.startsWith("#"))
.map((keyValue) => keyValue.split(/=(.+)/))
.forEach(([k, v]) => (props[k] = v));
tl.setVariable("SONARQUBE_SCANNER_MODE", scannerMode);
tl.setVariable("SONARQUBE_ENDPOINT", endpoint.toJson(), true);
tl.setVariable(
"SONARQUBE_SCANNER_PARAMS",
toCleanJSON({
...endpoint.toSonarProps(),
...scanner.toSonarProps(),
...props,
})
);
await scanner.runPrepare();
}
async function branchFeatureSupported(endpoint) {
if (endpoint.type === EndpointType.SonarCloud) {
return true;
}
const serverVersion = await getServerVersion(endpoint);
return serverVersion >= semver.parse("7.2.0");
}
export async function populateBranchAndPrProps(props: { [key: string]: string }) {
const collectionUrl = tl.getVariable("System.TeamFoundationCollectionUri");
const prId = tl.getVariable("System.PullRequest.PullRequestId");
const provider = tl.getVariable("Build.Repository.Provider");
if (prId) {
props["sonar.pullrequest.key"] = prId;
props["sonar.pullrequest.base"] = branchName(tl.getVariable("System.PullRequest.TargetBranch"));
props["sonar.pullrequest.branch"] = branchName(
tl.getVariable("System.PullRequest.SourceBranch")
);
if (provider === "TfsGit") {
props["sonar.pullrequest.provider"] = "vsts";
props["sonar.pullrequest.vsts.instanceUrl"] = collectionUrl;
props["sonar.pullrequest.vsts.project"] = tl.getVariable("System.TeamProject");
props["sonar.pullrequest.vsts.repository"] = tl.getVariable(REPO_NAME_VAR);
} else if (provider === "GitHub" || provider === "GitHubEnterprise") {
props["sonar.pullrequest.key"] = tl.getVariable("System.PullRequest.PullRequestNumber");
props["sonar.pullrequest.provider"] = "github";
props["sonar.pullrequest.github.repository"] = tl.getVariable(REPO_NAME_VAR);
} else if (provider === "Bitbucket") {
props["sonar.pullrequest.provider"] = "bitbucketcloud";
} else {
tl.warning(`Unsupported PR provider '${provider}'`);
props["sonar.scanner.skip"] = "true";
}
} else {
let isDefaultBranch = true;
const currentBranch = tl.getVariable("Build.SourceBranch");
if (provider === "TfsGit") {
isDefaultBranch = currentBranch === (await getDefaultBranch(collectionUrl));
} else if (provider === "Git" || provider === "GitHub") {
// TODO for GitHub we should get the default branch configured on the repo
isDefaultBranch = currentBranch === "refs/heads/master";
} else if (provider === "Bitbucket") {
// TODO for Bitbucket Cloud we should get the main branch configured on the repo
isDefaultBranch = currentBranch === "refs/heads/master";
} else if (provider === "Svn") {
isDefaultBranch = currentBranch === "trunk";
}
if (!isDefaultBranch) {
// VSTS-165 don't use Build.SourceBranchName
props["sonar.branch.name"] = branchName(tl.getVariable("Build.SourceBranch"));
}
}
}
/**
* Waiting for https://github.com/Microsoft/vsts-tasks/issues/7591
*/
function branchName(fullName: string) {
if (fullName.startsWith("refs/heads/")) {
return fullName.substring("refs/heads/".length);
}
return fullName;
}
export function reportPath(): string {
return path.join(
tl.getVariable("Agent.TempDirectory"),
SONAR_TEMP_DIRECTORY_NAME,
tl.getVariable("Build.BuildNumber"),
Guid.create().toString(),
REPORT_TASK_NAME
);
}
/**
* Waiting for https://github.com/Microsoft/vsts-tasks/issues/7592
* query the repo to get the full name of the default branch.
* @param collectionUrl
*/
export async function getDefaultBranch(collectionUrl: string) {
const DEFAULT = "refs/heads/master";
try {
const vsts = azdoApiUtils.getWebApi(collectionUrl);
const gitApi = await vsts.getGitApi();
const repo = await gitApi.getRepository(
tl.getVariable(REPO_NAME_VAR),
tl.getVariable("System.TeamProject")
);
tl.debug(`Default branch of this repository is '${repo.defaultBranch}'`);
return repo.defaultBranch;
} catch (e) {
tl.warning("Unable to get default branch, defaulting to 'master': " + e);
return DEFAULT;
}
}