Jenkins 2 소개 및 파이프 라인의 힘

1. 개요

이 기사에서는 Jenkins를 사용한 지속적 배포의 예를 통해 파이프 라인의 사용을 보여줄 것입니다.

샘플 프로젝트를 위해 간단하지만 매우 유용한 파이프 라인을 구축 할 것입니다.

  • 편집
  • 단순 정적 분석 (컴파일과 병렬)
  • 단위 테스트
  • 통합 테스트 (단위 테스트와 병렬)
  • 전개

2. Jenkins 설정

먼저 Jenkins의 안정적인 최신 버전 (이 기사 작성 시점의 2.73.3)을 다운로드해야합니다.

파일이있는 폴더로 이동하여 java -jar jenkins.war 명령을 사용하여 실행 해 보겠습니다 . 초기 사용자 설정 없이는 Jenkins를 사용할 수 없습니다.

초기 관리자 생성 비밀번호를 사용하여 Jenkins를 잠금 해제 한 후 첫 번째 관리자의 프로필 정보를 입력하고 모든 권장 플러그인을 설치해야합니다.

이제 사용할 준비가 된 Jenkins를 새로 설치했습니다.

사용 가능한 모든 Jenkins 버전은 여기에서 찾을 수 있습니다.

3. 파이프 라인

Jenkins 2에는 프로젝트에 대한 지속적인 통합 환경을 정의해야 할 때 매우 확장 가능한 Pipelines 라는 훌륭한 기능 이 있습니다.

파이프 라인은 코드를 사용하여 일부 Jenkins 단계를 정의 하고 소프트웨어 배포 프로세스를 자동화 하는 또 다른 방법입니다 .

두 가지 구문이있는 DSL (Domain Specific Language)을 사용하고 있습니다.

  • 선언적 파이프 라인
  • 스크립팅 된 파이프 라인

우리의 예에서, 우리는 사용하는거야 스크립트로 파이프 라인 그루비로 만든 더 명령형 프로그래밍 모델을 따르고있다 .

Pipeline 플러그인 의 몇 가지 특성을 살펴 보겠습니다 .

  • 파이프 라인은 텍스트 파일에 작성되고 코드로 처리됩니다. 즉, 버전 관리에 추가하고 나중에 수정할 수 있습니다.
  • Jenkins 서버를 다시 시작한 후에도 유지됩니다.
  • 선택적으로 파이프 라인을 일시 중지 할 수 있습니다.
  • 병렬 작업 수행과 같은 복잡한 요구 사항을 지원합니다.
  • 파이프 라인 플러그인은 확장되거나 다른 플러그인과 통합 될 수도 있습니다.

즉, 파이프 라인 프로젝트를 설정한다는 것은 우리가 수행하려는 프로세스의 일부 단계를 순차적으로 적용 할 스크립트를 작성하는 것을 의미합니다.

파이프 라인 사용을 시작하려면 간단하고 복잡한 자동화를 구성 할 수 있는 Pipeline 플러그인을 설치해야합니다 .

빌드를 실행할 때 구성한 모든 단계를 볼 수 있도록 파이프 라인 단계보기도 선택적으로 가질 수 있습니다.

4. 빠른 예

이 예에서는 작은 Spring Boot 애플리케이션을 사용합니다. 그런 다음 프로젝트를 복제하고 빌드하고 여러 테스트를 실행 한 다음 애플리케이션을 실행하는 파이프 라인을 생성합니다.

Checkstyle 결과 를 수집하는 데 각각 유용한 Checkstyle , Static Analysis CollectorJUnit 플러그인 을 설치하고 테스트 보고서의 결합 된 분석 그래프를 작성하며 성공적으로 실행 된 테스트와 실패한 테스트를 설명해 보겠습니다 .

먼저 Checkstyle의 이유를 이해합시다. 이것은 프로그래머가 잘 알려진 표준에 따라 더 나은 Java 코드를 작성하는 데 도움이되는 개발 도구입니다.

Static Analysis Collector는 다양한 분석 출력을 수집하고 결과를 결합 된 추세 그래프로 인쇄하는 추가 기능입니다. 또한 플러그인은 이러한 그룹화 된 결과를 기반으로 상태보고 및 빌드 안정성을 제공합니다.

마지막으로 JUnit 플러그인은 빌드 중에 생성 된 XML 테스트 보고서를 사용하고 프로젝트의 테스트와 관련된 상세하고 의미있는 정보를 출력하는 게시자를 제공합니다.

또한 애플리케이션의 pom.xml 에서 Checkstyle 을 구성합니다 .

 org.apache.maven.plugins maven-checkstyle-plugin 2.17 

5. 파이프 라인 스크립트 생성

먼저 새 Jenkins 작업을 만들어야합니다. 이 스크린 샷에 설명 된대로 확인 버튼을 누르기 전에 파이프 라인 을 유형 으로 선택해야합니다 .

다음 화면에서는 설명 , 트리거 , 일부 고급 프로젝트 옵션 과 같은 Jenkins 작업의 여러 단계에 대한 세부 정보를 입력 할 수 있습니다.

파이프 라인 탭 을 클릭하여 이러한 종류의 작업에서 가장 중요한 부분을 살펴 보겠습니다 .

그런 다음 정의에 대해 파이프 라인 스크립트를 선택 하고 Groovy Sandbox 사용을 선택 하십시오.

다음은 Unix 환경에 대한 작업 스크립트입니다.

node { stage 'Clone the project' git '//github.com/eugenp/tutorials.git' dir('spring-jenkins-pipeline') { stage("Compilation and Analysis") { parallel 'Compilation': { sh "./mvnw clean install -DskipTests" }, 'Static Analysis': { stage("Checkstyle") { sh "./mvnw checkstyle:checkstyle" step([$class: 'CheckStylePublisher', canRunOnFailed: true, defaultEncoding: '', healthy: '100', pattern: '**/target/checkstyle-result.xml', unHealthy: '90', useStableBuildAsReference: true ]) } } } stage("Tests and Deployment") { parallel 'Unit tests': { stage("Runing unit tests") { try { sh "./mvnw test -Punit" } catch(err) { step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-*UnitTest.xml']) throw err } step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-*UnitTest.xml']) } }, 'Integration tests': { stage("Runing integration tests") { try { sh "./mvnw test -Pintegration" } catch(err) { step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-' + '*IntegrationTest.xml']) throw err } step([$class: 'JUnitResultArchiver', testResults: '**/target/surefire-reports/TEST-' + '*IntegrationTest.xml']) } } stage("Staging") { sh "pid=\$(lsof -i:8989 -t); kill -TERM \$pid " + "|| kill -KILL \$pid" withEnv(['JENKINS_NODE_COOKIE=dontkill']) { sh 'nohup ./mvnw spring-boot:run -Dserver.port=8989 &' } } } } }

먼저 GitHub에서 저장소를 복제 한 다음 디렉토리를 spring-jenkins-pipeline 이라는 프로젝트로 변경합니다 .

다음으로 프로젝트를 컴파일하고 Checkstyle 분석을 병렬 방식으로 적용합니다.

다음 단계는 단위 테스트 및 통합 테스트의 병렬 실행과 앱 배포를 나타냅니다.

병렬 처리는 파이프 라인을 최적화하는 데 사용되며 작업이 더 빠르게 실행됩니다. Jenkins에서는 많은 시간이 걸릴 수있는 몇 가지 독립적 인 작업을 동시에 실행하는 것이 모범 사례입니다.

예를 들어 실제 프로젝트에서는 일반적으로 더 오래 걸릴 수있는 많은 단위 및 통합 테스트가 있습니다.

테스트가 실패하면 BUILD도 FAILED로 표시되고 배포가 발생하지 않습니다.

또한 파이프 라인이 끝날 때 애플리케이션이 즉시 종료되는 것을 방지하기 위해 JENKINS_NODE_COOKIE 를 사용 하고 있습니다.

다른 시스템에서 작동하는보다 일반적인 스크립트를 보려면 GitHub 저장소를 확인하세요.

6. 분석 보고서

작업을 만든 후 스크립트를 저장 하고 Jenkins 대시 보드의 프로젝트 홈에서 지금 빌드를 누릅니다 .

다음은 빌드 개요입니다.

조금 더 내려 가면 각 단계의 결과와 함께 파이프 라인의 단계보기가 있습니다.

각 출력은 스테이지 셀 위로 마우스를 이동하고 로그 버튼을 클릭하여 해당 단계에서 인쇄 된 로그 메시지를 볼 때 액세스 할 수 있습니다 .

We can also find more details of the code analysis. Let's click on the desired build from the Build History on the right menu and hit Checkstyle Warnings.

Here we see 60 high priority warnings browsable by clicking:

The Details tab displays pieces of information that highlight warnings and enable the developer to understand the causes behind them.

In the same way, the full test report is accessible by clicking on Test Result link. Let's see the results of the com.baeldung package:

Here we can see each test file with its duration and status.

7. Conclusion

이 기사에서는 파이프 라인 작업을 통해 Jenkins에서 정적 코드 분석 및 테스트 보고서를 실행하고 표시하는 간단한 지속적 배포 환경을 설정했습니다 .

항상 그렇듯이이 기사의 소스 코드는 GitHub에서 찾을 수 있습니다.