우리 팀의 코드 품질은? 정적코드 분석도구, 소나큐브 적용기

sysctl vm.max_map_count sysctl fs.file-max ulimit -n ulimit -u

sysctl -w vm.max_map_count=524288 sysctl -w fs.file-max=131072 ulimit -n 131072 ulimit -u 8192

# EC2 console, docker 설치 및 권한설정 sudo apt-get update && \ sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common && \ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \ sudo apt-key fingerprint 0EBFCD88 && \ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" && \ sudo apt-get update && \ sudo apt-get install -y docker-ce && \ sudo usermod -aG docker ubuntu && \ sudo curl -L "https://github.com/docker/compose/releases/download/1.23.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \ sudo chmod +x /usr/local/bin/docker-compose && \ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

# console vim docker-compose.yml

# docker-compose.yml version: "3" services: sonarqube: image: sonarqube:community depends_on: - db environment: # 소나큐브 DB 연결 설정 SONAR_JDBC_URL: jdbc:postgresql://db:5432/sonar SONAR_JDBC_USERNAME: sonar SONAR_JDBC_PASSWORD: sonar volumes: - sonarqube_data:/opt/sonarqube/data - sonarqube_extensions:/opt/sonarqube/extensions - sonarqube_logs:/opt/sonarqube/logs ports: # 소나큐브의 defaulut 포트는 9000입니다. http 기본 포트로 접속하기위해 들어가면 화면을 보이게 하기 위해 호스트 포트는 80으로 설정 - "80:9000" db: #postgres DB 설치 image: postgres:12 environment: POSTGRES_USER: sonar POSTGRES_PASSWORD: sonar volumes: - postgresql:/var/lib/postgresql - postgresql_data:/var/lib/postgresql/data volumes: sonarqube_data: sonarqube_extensions: sonarqube_logs: postgresql: postgresql_data:

# EC2 console # docker-compose.yml문을 데몬 옵션으로 실행한다는 의미입니다. docker-compose up -d

admin / admin

# build.gradle plugins { ... id 'org.sonarqube' version '3.3' id 'java' id 'jacoco' } group = 'com.myproject.' version = '1.0.0-beta' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { ... implementation 'org.sonarsource.scanner.gradle:sonarqube-gradle-plugin:3.3' } test { useJUnitPlatform() finalizedBy 'jacocoTestReport' } jacoco { toolVersion = "0.8.7" } jacocoTestReport { reports { xml.enabled true // sonarqube 분석에 필요한 xml파일만 생성 csv.enabled false html.enabled false } } sonarqube { properties { property "sonar.host.url", "{서버 url}" property "sonar.login", "{access token}" property "sonar.projectKey", "{프로젝트 ID}" property "sonar.projectName" , "{이번 빌드의 이름 이름}" property "sonar.sources", "src" # 소스 경로 property "sonar.language", "java" # 언어 property "sonar.sourceEncoding", "UTF-8" property "sonar.profile", "Sonar way" # 소나큐브에서 적용할 프로필(분석할 수준 설정) property "sonar.java.binaries", "${buildDir}/classes" # 자바 클래스 파일위치 property "sonar.test.inclusions", "**/*Test.java" # 코드 분석에 사용할 테스트 소스 property "sonar.exclusions", "**/resources/static/**, **/Q*.class, **/test/**" # 테스트커버리지에서 제외할 파일, 예제에선 정적 js 파일과 queryDSL Q파일 제외 property "sonar.coverage.jacoco.xmlReportPaths", "${buildDir}/reports/jacoco/test/jacocoTestReport.xml" # jacoco 플러그인의 결과파일 } }

# console ./gradlew -Dsonar.login={access token}

# workflow의 이름 name: backend-build-test # PR 요청에 대해 on: pull_request: # 특정 브랜치만 branches: - develop # develop 브랜치에서 pr 이벤트가 일어났을 때 실행 # pr이 생성 되었을 때, 담당 유저가 등록되었을 때, PR에 코드가 머지되었을 때, 라벨이 달렸을 때 동작 types: [opened, assigned, synchronize, labeled] # job에 공통된 옵션을 준다 defaults: # build steps의 Run run: # ./backend 경로에서 실행 working-directory: ./backend # 실행 해야할 job jobs: # Job의 이름, 자유롭게 짓습니다. ###### 본문 내용과 관련 없는 Job, 빌드 테스트 build: # label이 [backend] (id: 3141722951) 일때만 동작 if: contains(github.event.pull_request.labels.*.id, 3141722951) # ubuntu 환경에서 실행 (환경은 github이 제공) runs-on: ubuntu-latest # 각 단계 steps: # 소스코드 체크아웃 - name: Checkout source code uses: actions/checkout@v2 # 서브모듈 설정 with: submodules: true # secrets 변수는 github 세팅에서 미리 세팅한 데이터 token: ${{ secrets.SUBMODULE_ACCESS_TOKEN }} # 빌드 - name: Build Test run: ./gradlew bootJar ###### 아래부터 sonarqube와 관련있는 부분 시작 analysis: # label이 [backend] (id: 3141722951) 일때만 동작 if: contains(github.event.pull_request.labels.*.id, 3141722951) # ubuntu 환경에서 실행 (환경은 github이 제공) runs-on: ubuntu-latest # 이 Job에서 사용할 환경변수 env: # KEY - VALUE SONARQUBE_ID: jujeol-pr SONARQUBE_URL: ${{ secrets.SONARQUBE_URL }} PR_NUMBER: ${{ github.event.pull_request.number }} steps: - name: Checkout source code uses: actions/checkout@v2 with: submodules: true token: ${{ secrets.SUBMODULE_ACCESS_TOKEN }} # 위에서 설정했던 정적코드 전송 태스크 실행 - name: Sonaqube Analysis run: ./gradlew test sonarqube -Dsonar.host.url=${{ env.SONARQUBE_URL }} -Dsonar.projectKey=${{ env.SONARQUBE_ID }} # project의 제목을 {프로젝트명}-{pr번호} 형식으로 -Dsonar.projectName=${{ env.SONARQUBE_ID }}-${{ env.PR_NUMBER }} -Dsonar.login=${{ secrets.SONARQUBE_ACCESS_TOKEN }} - name: Comment Sonarqube URL uses: actions/github-script@v4 with: # 이슈에 코멘트를 달아주는 스크립트 실행 script: | const { SONARQUBE_ID, SONARQUBE_URL, PR_NUMBER } = process.env github.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: `📊 ${ SONARQUBE_ID }-${ PR_NUMBER } 분석 결과 확인하기 [링크](${SONARQUBE_URL})`})