[Jenkins Plugin] Jenkins Plugin 개발 환경 Setting

이번 연계 프로젝트에서 Jenkins Plugin을 직접 개발해 사용해야 하는 부분이 생겼다.

 

자세하게는 언급할 수 없지만 간단하게 이야기하면 앞으로 개발할 플러그인의 기능은 화면단에서 원하는 input 값을 받아 그 input 값으로 Jenkins Pipeline을 구축해 Job으로 등록한다.

 

input 값의 형태는 String 값을 받고, jenkins plugin documentation을 최대한 참고하여 제작할 계획이다.

 

https://www.jenkins.io/doc/developer/tutorial/

Plugin Tutorial

 

 

0. 들어가면서...

• 시작하기에 앞서 앞으로의 진행과정은 Jenkins Plugin 공식문서에 기반하여 어떻게 진행했는지 흐름을 작성해나갈 계획이다.
• 위의 Document를 보며 진행하면 도움이 될 것 같다라고라고라파덕.

 

 

1. Java 및 Maven 설치

• Java Version은 Jenkins 에서의 권장버전인 11버전을 설치했다.
• Maven Version 또한 권장 버전인 3버전을 사용했다.
  • (Jenkins에서는 Maven 버전의 경우 3.8.3 보다 최신버전을 사용하는 것을 이상적이라고 한다.)

각각의 설치 이후 버전을 확인해준다.

$ java --version
$ mvn --version

 

2. IDE 준비

• Jenkins에서 추천하는 IDE로는 크게 NetBeans IntelliJ IDEA Eclipse 가 있다.
• 인텔리제이를 선택했다.(Ultimate 버전을 사용한다.)

 

3. Skeleton 코드를 포함한 프로젝트 생성

• 본인은 혼자 진행하는 과정에서 여기서 애를 좀 먹었다.
• 이전 튜토리얼에서는 IDE 를 설치 후 간단하게 프로젝트를 생성하는 예제가 있었는데 해당 예제 프로젝트 경로에서 아래의 명령어를 치면 pom.xml 파일의 중복으로 에러가 발생한다.
• 정리하자면 그냥 새로 생성할 디렉토리를 잡아 그곳에서 아래의 명령어를 통해 Jenkins Plugin Skeleton 프로젝트를 생성하자.

mvn -U archetype:generate -Dfilter="io.jenkins.archetypes:"

• 위의 명령어를 입력하면 archetype을 설정하라는 내용이 나타나는데 본인은 4번 타입(Skeleton of a Jenkins plugin with a POM and an example build step.) 을 선택했고 버전의 경우 가장 최신버전으로 나타나는 17버전을 사용했다.
• 이후 프로젝트가 생성되는데 아래의 명령어를 따라 mvn verify를 실행한다.
  • 혹시 mvn verify 가 궁금하다면 아래의 더보기를 클릭해보도록 하자.

 

mvn verify 명령어를 실행하면 다음과 같은 일들이 발생한다.

1. Maven은 프로젝트의 소스 코드를 가져와 컴파일한다.
2. 컴파일된 코드에 대해 단위 테스트를 수행한다.
3. 단위 테스트를 통과한 코드에 대해 패키징을 수행한다.
4. 패키징된 코드에 대해 통합 테스트를 수행한다.
5. 통합 테스트를 통과한 코드에 대해 검증을 수행한다. 이 과정에서는 코드의 정적 분석, 문서 생성, 리소스 복사 등의 작업이 수행된다.
6. 검증을 마친 후, 빌드 결과물이 로컬 레파지토리에 설치된다.

즉, mvn verify 명령어를 실행하면, 프로젝트의 소스 코드가 올바르게 빌드되고 검증되어 완전하고 신뢰성 높은 빌드 결과물이 생성된다.

 

 

- 아래의 명령어를 순차적으로 입력한다.

 

$ mv demo demo-plugin 
$ cd demo-plugin
$ mvn verify

 

 

4. 빌드 및 실행

• 3번 과정을 통해 mvn verify 까지 성공했다면 이후 아래 명령어를 통해 프로젝트를 실행한다.

$ mvn hpi:run

• 위의 명령어에 있어서 옵션을 통해 노출할 포트를 변경할 수 있다. Ex) mvn hpi:run -Dport=5000
• 해당 과정이 정상적으로 이루어졌다면 젠킨스 플러그인을 통해 개발할 준비가 완료된 것이다.

 

5. 정리 및 이후의 과제

• 젠킨스는 기본적으로 실행하거나 작업하는 Java version이 11버전으로 고정된 느낌이 든다.(물론 나중에 변경될 수도 있겠지만)
• Jenkins Plugin Docs를 보면 이후의 과정은 어떻게 젠킨스 플러그인을 제작할 수 있고 UI를 추가할 수 있는지에 대한 내용이 나타난다.
• 현재 프로젝트를 진행하면서 앞으로의 개발일지를 작성해 나갈 계획인데 끝까지 프로젝트가 잘마무리 되었으면 좋겠다.