레드마인에서 소스코드에 주석을 달아 활용할 수 있는 플러그인 Code Review
레드마인은 공식 플러그인 페이지에서만 800여 개가 넘는 플러그인이 제공되고 있습니다. 물론 레드마인 버전에 따라 적용을 할 수 없는 플러그인들도 있지만 그럼에도 상당히 많은 기능을 확장할 수 있는데 이번 포스트에서는 코드 리뷰 플러그인에 대해 설명하고 설치 방법에 대해 알아보겠습니다.
Code Review(이하 코드리뷰) 플러그인은 2010년 11월 6일 최초 등록되었고 2015년 3월 9일에 등록된 0.7.0 버전이 현재 최신 버전으로 공식적으로는 레드마인 3.0.x 까지 지원을 합니다.
코드리뷰 플러그인이 정상적으로 설치되었다면 관리 > 플러그인에서 위와 같이 확인이 가능합니다. 플러그인 자체에서 별도의 설정 기능은 제공하지 않고요. 코드리뷰 플러그인 설치방법은 일반적인 레드마인 플러그인 설치와 동일합니다. 현재 공식 웹 사이트는 접속이 되지 않고 있는데 소스는 Bitbucket에서 다운로드가 가능합니다.
다운로드한 소스를 /plugins 디렉터리에 업로드합니다.
rake redmine:plugins:migrate RAILS_ENV=production
또는
rake redmine:plugins:migrate NAME=redmine_code_review RAILS_ENV=production
명령어를 실행해서 설치를 합니다.
- code_reviews
- code_review_assignments
- code_review_project_settings
- code_review_user_settings
코드리뷰 플러그인은 위와 같이 4개의 테이블을 생성해서 사용합니다. 플러그인 설치 시 위 테이블이 생성이 함께 이루어집니다.
레드마인을 재기동하게 되면 코드리뷰 플러그인 설치가 완료됩니다. 위에서 언급했듯이 코드리뷰 플러그인은 관리 > 플러그인에서는 별도의 설정 옵션이 없습니다. 하지만 사용하기 전 체크할게 몇 가지 있는데
코드리뷰를 적용하고 하는 프로젝트의 설정 > 모듈 창에서 새로 생성된 코드리뷰 메뉴를 체크합니다.
그럼 상단의 메뉴에 코드리뷰메뉴가 생성되고 선택을 하게 되면 이렇게 코드 리뷰 창을 확인하실 수 있습니다.
그리고 레드마인에 연결된 저장소의 화면에서 차이점 보기를 선택하시면 연필 아이콘이 생성되어 있고 연필 아이콘을 클릭해서 해당 라인의 내용에 대해 주석을 달 수 있게 됩니다.
리뷰 작성 화면입니다. 작성된 리뷰는 일감에 등록되어 관리가 됩니다.
코드 리뷰(주석)가 작성된 라인에는 위 이미지처럼 체크표시가 있는 아이콘이 생성되는데 해당 아이콘을 클릭 시 주석내용을 확인할 수 있고 코드리뷰에 창에서도 등록된 리뷰 내용을 확인할 수 있습니다.
여기까지 간단하게 코드리뷰 플러그인의 설치 방법과 설정 및 관련 화면에 대해 살펴봤는데요. 이런 기능들을 함께 잘 사용하면 좋은데 적용하기가 쉽지는 않은 것 같습니다. 아~ 그리고 혹시 저처럼 레드마인 3.3 이상 버전을 사용하시는 분들은 코드 리뷰 플러그인 0.7.0 버전 설치 시 약간의 소스 수정 작업이 필요한데요. 3.2 까지는 정상적으로 동작한 걸로 기억되는데 3.3 버전에서는 500 Internal Server Error 가 발생합니다.
/plugins/redmine_code_review/app/controllers
디렉터리에 있는 code_review_controller.rb 파일의
39: @review_count = CodeReview.count(:conditions => ['project_id = ? and issue_id is NOT NULL', @project.id])
40: @all_review_count = CodeReview.count(:conditions => ['project_id = ?', @project.id])
내용을 아래와 같이 변경해 주세요.
39: @review_count = CodeReview.count("project_id = " + @project.id.to_s + " and issue_id is NOT NULL")
40: @all_review_count = CodeReview.count("project_id = " + @project.id.to_s)
변경 후 레드마인을 재시작하시면 500 Internal Server Error 페이지가 아닌 정상적인 페이지를 보실 수 있습니다.
그럼 이렇게 수정 내용까지 레드마인 코드리뷰 플러그인에 대한 포스팅을 마치겠습니다.
여러분들이 공감과 댓글을 남겨주시면 공감은 저에게 많은 힘이 댓글은 저의 더 많은 포스팅 작성에 도움이 됩니다.
고맙습니다. ^^