feat(sonar-services): add rule list and detail

Author: AMorgaut

shared/sonar-services/src/api/constants.js

@@ -0,0 +1,11 @@
+/**
+ * Sustainability tags used to filter issues or rules
+ * 
+ * - `sustainability`: generic tag used on some sonar rules
+ * - `greensight`: tag used by the Capgemini Greensight plugin
+ * - `ecocode`: tag occasionaly used when creedengo was called ecocode
+ * - `creedengo`: tag identifying rules provided by Creedengo plugins
+ * 
+ * @type {string}
+ */
+export const SUSTAINABILITY_TAGS = 'sustainability,greensight,ecocode,creedengo'

shared/sonar-services/src/api/issues/sonar.issues.search.api.js

@@ -1,12 +1,13 @@
 //import sonarRequestAPI from '@sonar/sonar-request'
 import sonarRequestAPI from '../polyfills/sonar-request.js'
+import { SUSTAINABILITY_TAGS } from '../constants.js'
 
 const API = 'api/issues'
 const routeUrl = `${API}/search`
 const sustainabilitySearchParams = {
   issueStatuses: 'OPEN,CONFIRMED',
   statuses: 'OPEN,CONFIRMED,REOPENED', // legacy support 
-  tags: 'sustainability,greensight,ecocode,creedengo',
+  tags: SUSTAINABILITY_TAGS,
 }
 
 /**
@@ -39,18 +40,19 @@ function facetFormater(result, severity) {
  * Get an issues facet for a given project, branch, and facet name.
  * 
  * @param {string} facetName 
- * @param {Object} options
- * @param {string} options.project key of the project
- * @param {string} options.branch 
+ * @param {Object} config
+ * @param {string} config.project key of the project
+ * @param {string} config.branch 
  * @returns Promise<{[key: string]: number}>
  */
-export async function getIssuesFacet(facetName, { project, branch}) {
+export async function getIssuesFacet(facetName, { project, branch, severity }) {
   const searchParams = {
     ...sustainabilitySearchParams,
     componentKeys: project,
     branch,
+    severity,
     facets: facetName,
-    ps: 1, // no issues parsing, we only want the facets
+    ps: 0, // no issues parsing, we only want the facets
   }
   const { facets } = await sonarRequestAPI.getJSON(routeUrl, searchParams);
 

shared/sonar-services/src/api/rules/index.js

@@ -0,0 +1,7 @@
+import * as search from './sonar.rules.search.api.js'
+import * as show from './sonar.rules.show.api.js'
+
+export default {
+    ...search,
+    ...show
+}

shared/sonar-services/src/api/rules/sonar.rules.search.api.js

@@ -0,0 +1,32 @@
+//import sonarRequestAPI from '@sonar/sonar-request'
+import sonarRequestAPI from '../polyfills/sonar-request.js'
+import { SUSTAINABILITY_TAGS } from '../constants.js'
+
+const API = 'api/rules'
+const routeUrl = `${API}/search`
+const sustainabilitySearchParams = { tags: SUSTAINABILITY_TAGS }
+
+/**
+ * Return Sonarqube rules
+ * !! only gather sustainability rules !!
+ *
+ * @param {Object} params
+ * @param {string} params.rule_key
+ * @param {string} params.languages
+ * @param {string} params.qprofile
+ * @param {'true'|'false'|'yes'|'no'} params.prioritizedRule
+ * @param {'INFO'|'MINOR'|'MAJOR'|'CRITICAL'|'BLOCKER'} params.severities
+ * @param {'INFO'|'LOW'|'MEDIUM'|'HIGH'|'BLOCKER'} params.impactSeverities
+ * @param {'MAINTAINABILITY'|'RELIABILITY'|'SECURITY'} params.impactSoftwareQualities
+ * @returns Promise<Array<{[key: string]: any}>>
+ */
+export async function findRules({ project, branch }) {
+  const searchParams = {
+    ...sustainabilitySearchParams,
+    componentKeys: project,
+    branch,
+  }
+  const page = await sonarRequestAPI.getJSON(routeUrl, searchParams)
+  const { rules = [] } = page
+  return rules
+}

shared/sonar-services/src/api/rules/sonar.rules.search.api.spec.js

@@ -0,0 +1,25 @@
+import { setupServer } from 'msw/node'
+import { HttpResponse, http } from 'msw'
+import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest'
+
+import mockRuleList from './sonar.rules.search.mock'
+import { findRules } from './sonar.rules.search.api'
+
+export const restHandlers = [
+  http.get('/api/rules/search', () => HttpResponse.json(mockRuleList))
+]
+
+const server = setupServer(...restHandlers)
+// Start server before all tests
+beforeAll(() => server.listen({ onUnhandledRequest: 'error' }))
+//  Close server after all tests
+afterAll(() => server.close())
+// Reset handlers after each test `important for test isolation`
+afterEach(() => server.resetHandlers())
+
+describe('findRules', () => {
+  test('findRules retrieve 1 rule', async () => {
+    const issues = await findRules({ project: 'foo', branch: 'master' })
+    expect(issues).toStrictEqual(mockRuleList.rules)
+  })
+})