Merge pull request #4 from vtex/add-comment

Add Sonarqube status in the summary

Author: thayannevls

dist/index.js

@@ -3,6 +3,7 @@ import { context, getOctokit } from '@actions/github'
 import type { GitHub } from '@actions/github/lib/utils'
 import * as exec from '@actions/exec'
 
+import type { ProjectStatus } from './sonarqube'
 import Sonarqube from './sonarqube'
 import type { Annotation } from './utils'
 import { issuesToAnnotations } from './utils'
@@ -13,12 +14,12 @@ const MAX_ANNOTATIONS_PER_REQUEST = 50
 const createCheckRun = async ({
   octokit,
   repo,
-  SQDetailsURL,
+  summary,
   annotations,
 }: {
   octokit: InstanceType<typeof GitHub>
   repo: { owner: string; repo: string }
-  SQDetailsURL: string
+  summary: string
   annotations?: Annotation[]
 }) => {
   info('Creating check')
@@ -34,10 +35,9 @@ const createCheckRun = async ({
       head_sha: ref,
       status: 'completed',
       conclusion: 'neutral',
-      details_url: SQDetailsURL,
       output: {
         title: 'SonarQube',
-        summary: `See more details in [SonarQube](${SQDetailsURL})`,
+        summary,
         annotations,
       },
     })
@@ -48,21 +48,60 @@ const createCheckRun = async ({
   }
 }
 
+const generateSummary = (status: ProjectStatus, url: string) => {
+  const conditions = status.conditions.reduce<string>((acc, current) => {
+    switch (current.metricKey) {
+      case 'reliability_rating':
+        return `${acc}Reability ${
+          current.status === 'ERROR' ? ':x:' : ':white_check_mark:'
+        } \n`
+
+      case 'security_rating':
+        return `${acc}Security ${
+          current.status === 'ERROR' ? ':x:' : ':white_check_mark:'
+        } \n`
+
+      case 'sqale_rating':
+        return `${acc}Security review ${
+          current.status === 'ERROR' ? ':x:' : ':white_check_mark:'
+        } \n`
+
+      case 'security_hotspots_reviewed':
+        return `${acc}Security hotspots ${
+          current.status === 'ERROR' ? ':x:' : ':white_check_mark:'
+        } \n`
+
+      default:
+        return ''
+    }
+  }, '')
+
+  return `
+### Quality Gate ${
+    status.status === 'ERROR' ? 'failed :x:' : 'passed :white_check_mark:'
+  }.
+See more details in [SonarQube](${url}).
+
+### Conditions
+${conditions}
+
+`
+}
+
 const updateCheckRun = async ({
   octokit,
   repo,
   checkRunId,
   annotations,
-  SQDetailsURL,
+  summary,
 }: {
   octokit: InstanceType<typeof GitHub>
   repo: { owner: string; repo: string }
   checkRunId: number
   annotations: Annotation[]
-  SQDetailsURL: string
+  summary: string
 }) => {
   info('Updating check with annotations')
-
   try {
     await octokit.checks.update({
       ...repo,
@@ -71,7 +110,7 @@ const updateCheckRun = async ({
       conclusion: 'neutral',
       output: {
         title: 'SonarQube',
-        summary: `See more details in [SonarQube](${SQDetailsURL})`,
+        summary,
         annotations,
       },
     })
@@ -99,7 +138,12 @@ async function run() {
 
   const SQDetailsURL = `${sonarqube.host}/dashboard?id=${sonarqube.project.projectKey}`
 
-  const checkRunId = await createCheckRun({ octokit, repo, SQDetailsURL })
+  const status = await sonarqube.getStatus()
+  const summary = status
+    ? generateSummary(status, SQDetailsURL)
+    : `See more details in [SonarQube](${SQDetailsURL})`
+
+  const checkRunId = await createCheckRun({ octokit, repo, summary })
 
   issues.map(async (batch) => {
     const annotations = issuesToAnnotations(batch)
@@ -109,7 +153,7 @@ async function run() {
       repo,
       checkRunId,
       annotations,
-      SQDetailsURL,
+      summary,
     })
   })
 }

dist/index.js.map

@@ -42,6 +42,21 @@ interface IssuesResponseAPI {
   debtTotal: number
   issues: [Issue]
 }
+
+export interface ProjectStatus {
+  status: 'OK' | 'ERROR'
+  conditions: Array<{
+    status: 'OK' | 'ERROR'
+    metricKey: string
+    comparator: string
+    errorThreshold: number
+    actualValue: number
+  }>
+}
+
+export interface ProjectStatusResponseAPI {
+  projectStatus: ProjectStatus
+}
 export default class Sonarqube {
   private http: AxiosInstance
   public host: string
@@ -120,6 +135,22 @@ export default class Sonarqube {
         : ''
     }`
 
+  public getStatus = async (): Promise<ProjectStatus | null> => {
+    const response = await this.http.get<ProjectStatusResponseAPI>(
+      `/api/qualitygates/project_status?projectKey=${this.project.projectKey}`
+    )
+
+    if (response.status !== 200 || !response.data) {
+      return null
+    }
+
+    const {
+      data: { projectStatus },
+    } = response
+
+    return projectStatus
+  }
+
   private getInfo = (repo: { owner: string; repo: string }) => ({
     project: {
       projectKey: getInput('projectKey')