Gradle 프로젝트에 JaCoCo & SonarQube 적용

plugins {
    id 'jacoco'
}

jacoco {
    toolVersion = '0.8.7'
}

test {
    useJUnitPlatform()
    finalizedBy jacocoTestReport
}

jacocoTestReport {
    dependsOn test
    reports {
        html.enabled true
        xml.enabled true
        csv.enabled true

        html.destination file("src/jacoco/jacoco.html")
        xml.destination file("src/jacoco/jacoco.xml")
    }
    finalizedBy 'jacocoTestCoverageVerification'
}

jacocoTestCoverageVerification {
    violationRules {
        rule {
            element = 'CLASS'
            enabled = true

            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.60
            }

            limit {
                counter = 'METHOD'
                value = 'COVEREDRATIO'
                minimum = 0.60
            }
        }
    }
}

jacocoTestReport {
    dependsOn test
    reports {
        html.enabled true
        xml.enabled true
        csv.enabled true

        html.destination file("src/jacoco/jacoco.html")
        xml.destination file("src/jacoco/jacoco.xml")
    }

    def Qdomains = []
    for (qPattern in '**/QA'..'**/QZ') {
        Qdomains.add(qPattern + '*')
    }

    afterEvaluate {
        classDirectories.setFrom(
                files(classDirectories.files.collect {
                    fileTree(dir: it, excludes: [
                            '**/BlogApplication*',
                            '**/*Request*',
                            '**/*Response*',
                            '**/*Dto*',
                            '**/*OAuthClient*',
                            '**/*Interceptor*',
                            '**/*Exception*',
                            '**/*Storage*',
                            '**/*BaseDate*',
                            '**/*PageController*'
                    ] + Qdomains)
                })
        )
    }
    finalizedBy 'jacocoTestCoverageVerification'
}

jacocoTestCoverageVerification {
    def Qdomains = []
    for (qPattern in '*.QA'..'*.QZ') {
        Qdomains.add(qPattern + '*')
    }

    violationRules {
        rule {
            element = 'CLASS'
            enabled = true

            limit {
                counter = 'LINE'
                value = 'COVEREDRATIO'
                minimum = 0.60
            }

            limit {
                counter = 'METHOD'
                value = 'COVEREDRATIO'
                minimum = 0.60
            }

            excludes = [
                    '**.*BlogApplication*',
                    '**.*Request*',
                    '**.*Response*',
                    '**.*Dto*',
                    '**.*OAuthClient*',
                    '**.*Interceptor*',
                    '**.*Exception*',
                    '**.*Storage*',
                    '**.*BaseDate*',
                    '**.*PageController*',
            ] + Qdomains
        }
    }
}

pipeline {
    agent any

    stages {
        stage('Checkout') {
            steps {
                checkout([$class: 'GitSCM', branches: [[name: '${sha1}']], extensions: [[$class: 'SubmoduleOption', disableSubmodules: false, parentCredentials: true, recursiveSubmodules: true, reference: '서브모듈 레포 주소', trackingSubmodules: true]], userRemoteConfigs: [[credentialsId: '액세스토큰 지정값', refspec: '+refs/pull/*:refs/remotes/origin/pr/*', url: '프로젝트 레포 주소']]])
            }
        }

        stage('Build & Test') {
            steps {
                sh'''
                   cd backend/ && ./gradlew clean build || IS_FAIL=true
                   if [[ $IS_FAIL = "true" ]]; then
                      echo "Build Failure"
                      /* 원한다면 GitHub API PR에 댓글다는 기능을 여기에 작성하여 실패 사유 알람을 보낼 수 있다. */
                      exit 1
                   else
                      echo "Build Success"
                   fi
                '''
            }
        }

        stage('JaCoCo Report') {
            steps {
                sh'''
                    cd backend/ && ./gradlew jacocoTestReport || IS_FAIL=true
                    if [[ $IS_FAIL = "true" ]]; then
                        echo "JaCoCo Report Failure"
                        /* 원한다면 GitHub API PR에 댓글다는 기능을 여기에 작성하여 실패 사유 알람을 보낼 수 있다. */
                        exit 1
                    else
                        echo "JaCoCo Report Success"
                    fi
                '''
            }
        }

        stage('SonarQube Analysis') {
            steps {
                withSonarQubeEnv('환경설정에서 지정한 소나큐브 서버 이름') {
                    sh'''
                        cd backend/
                        /var/jenkins_home/tools/hudson.plugins.sonar.SonarRunnerInstallation/지정한 소나큐브 스캐너 이름/bin/sonar-scanner \
                        -D sonar.host.url=소나큐브 서버 주소 \
                        -D sonar.login=소나큐브 토큰 \
                        -D sonar.projectKey=소나큐브 프로젝트 키 \
                        -D sonar.projectName=소나큐브 프로젝트 이름 \
                        -D sonar.projectVersion=0.0.1-SNAPSHOT \
                        -D sonar.sources=src/main/java \
                        -D sonar.tests=src/test \
                        -D sonar.java.binaries=build/classes \
                        -D sonar.java.libraries= \
                        -D sonar.java.libraries.empty=true \
                        -D sonar.sourceEncoding=UTF-8 \
                        -D sonar.java.coveragePlugin=jacoco \
                        -D sonar.coverage.jacoco.xmlReportPaths=src/jacoco/jacoco.xml \
                        -D sonar.test.inclusions=**/*Test.java \
                        -D sonar.exclusions=**/dto/**,**/*OAuthClient.java,**/S3*.java \
                    '''
                }
            }
        }

        stage('SonarQube') {
            steps {
                script {
                    def qg = waitForQualityGate();
                    if (qg.status != 'OK') {
                       sh'''
                          echo "SonarQube Quality Failure"
                          /* 원한다면 GitHub API PR에 댓글다는 기능을 여기에 작성하여 실패 사유 알람을 보낼 수 있다. */
                       '''
                       error "Pipeline aborted due to quality gate failure"
                    }
                    echo "All Passed!"
                    /* 원한다면 GitHub API PR에 댓글다는 기능을 여기에 작성하여 성공 사유 알람을 보낼 수 있다. */
                }
            }
        }
    }
}

branches: [[name: '${sha1}']]
refspec: '+refs/pull/*:refs/remotes/origin/pr/*'

stage('JaCoCo Report') {
    steps {
        sh'''
            cd backend/ && ./gradlew jacocoTestReport || IS_FAIL=true
            if [[ $IS_FAIL = "true" ]]; then
                echo "JaCoCo Report Failure"
                exit 1
            else
                echo "JaCoCo Report Success"
            fi
        '''
    }
}

stage('SonarQube Analysis') {
    steps {
        withSonarQubeEnv('환경설정에서 지정한 소나큐브 서버 이름') {
            sh'''
                cd backend/
                /var/jenkins_home/tools/hudson.plugins.sonar.SonarRunnerInstallation/지정한 소나큐브 스캐너 이름/bin/sonar-scanner \
                -D sonar.host.url=소나큐브 서버 주소 \
                -D sonar.login=소나큐브 토큰 \
                -D sonar.projectKey=소나큐브 프로젝트 키 \
                -D sonar.projectName=소나큐브 프로젝트 이름 \
                -D sonar.projectVersion=0.0.1-SNAPSHOT \
                -D sonar.sources=src/main/java \
                -D sonar.tests=src/test \
                -D sonar.java.binaries=build/classes \
                -D sonar.java.libraries= \
                -D sonar.java.libraries.empty=true \
                -D sonar.sourceEncoding=UTF-8 \
                -D sonar.java.coveragePlugin=jacoco \
                -D sonar.coverage.jacoco.xmlReportPaths=src/jacoco/jacoco.xml \
                -D sonar.test.inclusions=**/*Test.java \
                -D sonar.exclusions=**/dto/**,**/*OAuthClient.java,**/S3*.java \
            '''
        }
    }
}

stage('SonarQube analysis') {
  // requires SonarQube Scanner 2.8+
  def scannerHome = tool 'SonarQube Scanner 2.8';
  withSonarQubeEnv('My SonarQube Server') {
    sh "${scannerHome}/bin/sonar-scanner"
  }
}

stage('SonarQube') {
    steps {
        script {
            def qg = waitForQualityGate();
            if (qg.status != 'OK') {
               sh'''
                  echo "SonarQube Quality Failure"
               '''
               error "Pipeline aborted due to quality gate failure"
            }
            echo "All Passed!"
        }
    }
}

stage("SonarQube analysis") {
        steps {
            script {
                def scannerHome = tool 'SonarQube Scanner';
                withSonarQubeEnv('지정한 소나 큐브 서버 이름') {
                    sh 'mvn clean package sonar:sonar'
                }
            }
        }
}

stage('SonarQube analysis') {
  withSonarQubeEnv('지정한 소나 큐브 서버 이름') {
    // requires SonarQube Scanner for Maven 3.2+
    sh 'mvn org.sonarsource.scanner.maven:sonar-maven-plugin:3.2:sonar'
  }
}