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
|
/*
* SonarQube
* Copyright (C) 2009-2021 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import throwGlobalError from '../app/utils/throwGlobalError';
import { getJSON, post, postJSON } from '../helpers/request';
import { GetRulesAppResponse, SearchRulesResponse } from '../types/coding-rules';
import { RuleActivation, RuleDetails } from '../types/types';
export function getRulesApp(): Promise<GetRulesAppResponse> {
return getJSON('/api/rules/app').catch(throwGlobalError);
}
export function searchRules(data: {
activation?: boolean | string;
active_severities?: string;
asc?: boolean | string;
available_since?: string;
cwe?: string;
f?: string;
facets?: string;
include_external?: boolean | string;
inheritance?: string;
is_template?: boolean | string;
languages?: string;
owaspTop10?: string;
p?: number;
ps?: number;
q?: string;
qprofile?: string;
repositories?: string;
rule_key?: string;
s?: string;
sansTop25?: string;
severities?: string;
sonarsourceSecurity?: string;
statuses?: string;
tags?: string;
template_key?: string;
types?: string;
}): Promise<SearchRulesResponse> {
return getJSON('/api/rules/search', data).catch(throwGlobalError);
}
export function takeFacet(response: SearchRulesResponse, property: string) {
const facet = response.facets?.find(f => f.property === property);
return facet ? facet.values : [];
}
export function getRuleRepositories(parameters: {
q: string;
}): Promise<Array<{ key: string; language: string; name: string }>> {
return getJSON('api/rules/repositories', parameters).then(
({ repositories }) => repositories,
throwGlobalError
);
}
export function getRuleDetails(parameters: {
actives?: boolean;
key: string;
}): Promise<{ actives?: RuleActivation[]; rule: RuleDetails }> {
return getJSON('/api/rules/show', parameters).catch(throwGlobalError);
}
export function getRuleTags(parameters: { ps?: number; q: string }): Promise<string[]> {
return getJSON('/api/rules/tags', parameters).then(r => r.tags, throwGlobalError);
}
export function createRule(data: {
custom_key: string;
markdown_description: string;
name: string;
params?: string;
prevent_reactivation?: boolean;
severity?: string;
status?: string;
template_key: string;
type?: string;
}): Promise<RuleDetails> {
return postJSON('/api/rules/create', data).then(
r => r.rule,
response => {
// do not show global error if the status code is 409
// this case should be handled inside a component
if (response && response.status === 409) {
return Promise.reject(response);
} else {
return throwGlobalError(response);
}
}
);
}
export function deleteRule(parameters: { key: string }) {
return post('/api/rules/delete', parameters).catch(throwGlobalError);
}
export function updateRule(data: {
key: string;
markdown_description?: string;
markdown_note?: string;
name?: string;
params?: string;
remediation_fn_base_effort?: string;
remediation_fn_type?: string;
remediation_fy_gap_multiplier?: string;
severity?: string;
status?: string;
tags?: string;
}): Promise<RuleDetails> {
return postJSON('/api/rules/update', data).then(r => r.rule, throwGlobalError);
}
|
