<div id="readability-page-1" class="page"><div>JetBrains에서 SonarQube와 같은 정적 분석 도구를 출시했다.
<ul data-ke-list-type="disc">
<li><a href="https://www.jetbrains.com/ko-kr/qodana/">Qodana</a></li>
</ul>
JetBrains 에서 출시하는 제품들은 일단 관심을 가지게 된다. IntelliJ, WebStorm, DataGrip 등을 몇년간 계속해서 사용하면서 충분히 만족감을 느꼈고 (불편함이 없진 않았지만), 최근에 출시한 <a href="https://www.jetbrains.com/ko-kr/writerside/">Writerside</a>도 VSCode를 대체한 마크다운 에디터로 잘 사용하고 있다. 그만큼 DX를 가장 신경쓰는 제품을 만드는 회사라는 확신이 있기 때문에 이번 Qodana 역시 기존의 Sonar 제품들을 잘 대체할 수 있을까 하는 기대감에 사용해보게 되었다.
그리고 기존에 잘 사용하던 SonarQube의 대체제를 고민하던 시점이기도 했다. Qodana는 SonarQube에 비해 어떤 장점이 있을까? 눈여겨 본 가장 큰 이유가 가격 경쟁력이였다.
<img src="https://blog.kakaocdn.net/dn/4h703/btsAL57iBCN/aVUk1O0R0NqIwe2Y37qtC1/img.png" alt="price1">
2개의 도구는 서로 다른 조직에 적합하다.
<ul data-ke-list-type="disc">
<li>SonarQube
<ul data-ke-list-type="disc">
<li>전체 라인수 비례 가격</li>
<li>개발자가 많지만 프로젝트는 분산되지 않은 경우</li>
<li>단일 프로젝트에 여러명의 개발자가 활동하는 경우</li>
<li>반대로, 프로젝트가 여러개면 이에 따른 비즈니스 외 코드들도 그만큼 늘어서 라인수가 기하급수적으로 늘어난다.</li>
</ul>
</li>
<li>Qodana
<ul data-ke-list-type="disc">
<li>활성화된 사용자수 비례 가격</li>
<li>개발자에 비해 프로젝트 수가 많은 경우</li>
<li>개발자가 많은 것에 비해 프로젝트 수가 적으면 한명 한명 채용될때마다 부담스럽다.
<ul data-ke-list-type="disc">
<li>SonarQube와는 완전히 반대상황이다.</li>
</ul>
</li>
</ul>
</li>
</ul>
현재 우리 조직은 거대한 레거시 하나를 작은 레거시 프로젝트 여러개로 나눠서 개발인원 / 팀 규모에 비해 라인수가 상당히 높다.
실제 우리팀의 현 상황은 다음과 같다.
<ul data-ke-list-type="disc">
<li>26명의 개발자</li>
<li>94만 라인수</li>
</ul>
<img src="https://blog.kakaocdn.net/dn/rzoNY/btsAMW9SuNQ/xIOek4bqwWmhKyiECQ4YI1/img.png" alt="price2">
이때 2개 서비스의 가격을 비교해보면
<img src="https://blog.kakaocdn.net/dn/teijB/btsALZlEZST/8jkixkotBmKyVY0ncAb23k/img.png" alt="price3">
(연간 $4,000 / 517만원)
만약 여기서 조금만 프로젝트 규모가 커지면 다음 플랜의 가격은 100% 상승한다. (1m 다음 플랜이 바로 2m이다.)
<img src="https://blog.kakaocdn.net/dn/A2EJf/btsAM2vmRCL/o9tC2ywZvQmsn9UzL9lF1K/img.png" alt="price4">
(연간 $8,000 / 1,000만원)
반면 Qodana로 비교하면
<img src="https://blog.kakaocdn.net/dn/Wx3Ff/btsANu6mVKZ/EkTuP9V4qp35ClMryWjw2k/img.png" alt="price5">
(연간 $60 * 26 = $1,560 / 200만원)
개발 팀원이 40명으로 늘어난다 하더라도 $2,400 (310만원) 이다.
현재 기준으로는 1/3 가격으로 정적 분석 도구를 사용할 수 있다. Qodana로 연간 $8,000 정도가 되려면 개발팀원이 130명이상 되어야만 하는데, 여기까지 가려면 아직 한참 시간이 남았다.
소수의 인원으로 다양한 프로젝트를 해야하는 (웹/앱/서버) 스타트업 특성상 Qodana의 가격 정책은 굉장히 합리적이다.
그래서 일단 개인 계정으로 무료로 한번 사용해보자.
<h2 data-ke-size="size26">1. Qodana Cloud 생성 및 프로젝트 연결</h2>
<a href="https://www.jetbrains.com/ko-kr/">JetBrains 계정</a>이 있다고 가정하고, <a href="https://qodana.cloud/">Qodana Cloud</a> 에 접속하여 로그인한다.
<img src="https://blog.kakaocdn.net/dn/bFLv3h/btsAOKVuZ1t/CcvMogI02aEDK6hLGQbjh0/img.png" alt="login1">
접속을 하면, Team을 만들어야 한다. (Team 안에 여러 Repo를 연동시킬 수 있다. 성격에 맞게 Repo를 관리하기 위해서)
<img src="https://blog.kakaocdn.net/dn/qLUfB/btsAMrCh0vR/XUNZyL7SkXRUgk7SkzxYY1/img.png" alt="new1">
team를 만들었다면, 다음과 같이 프로젝트를 연결할 수 있다.
<img src="https://blog.kakaocdn.net/dn/bhzTux/btsAPKAlJo2/OmqN7BuYpe0kEHhzBrerYK/img.png" alt="new2">
해당 team을 클릭해 들어가면 <code>Create project</code> 버튼이 있는데, 이를 클릭하여 해당 team에서 관리하고자 하는 Github Repo를 연결한다.
<img src="https://blog.kakaocdn.net/dn/xHJEH/btsAL5lVtAM/8OkjLKURmdKUKE7LXiCWJ0/img.png" alt="new3">
Project 생성시에 <code>SSH URL</code> 을 요구한다.
<img src="https://blog.kakaocdn.net/dn/bJc1Qk/btsAMpRZcQO/2QSmYdQA2KYBHj2k8o7ufK/img.png" alt="new5">
이는 Github Repository의 <code>Code &gt; SSH</code> 에서 확인할 수 있다. 해당 정보를 등록 한 뒤,
<img src="https://blog.kakaocdn.net/dn/lsQsa/btsAO7JrGtK/ZNIPTXpWDrRVvLWrJT8dgK/img.png" alt="new4">
바로 아래에 있는 <code>Public key</code> 는 Github의 해당 Repo에 <code>Deploy Key</code>로 등록해야한다.
<img src="https://blog.kakaocdn.net/dn/cKqwba/btsAOM6Dv3e/2SQ7PF9bLgwQUMHdjLT2qK/img.png" alt="new5">
이제 Github Repository에 들어가서 <code>Settings &gt; Deploy keys</code> 에서 <code>Add deploy key</code> 를 클릭한다.
<img src="https://blog.kakaocdn.net/dn/vdFRG/btsAOMlpuFq/kKyOnaQWVkRWrlqUFagtOK/img.png" alt="new6">
<code>Title</code> 은 아무거나 입력해도 되고, <code>Key</code> 에는 위에서 복사한 <code>Public key</code> 를 붙여넣는다. <code>Allow write access</code> 를 체크하면 해당 키로 푸시도 가능하다. 단, 여기서는 저장소 코드만 스캔 하는 것을 목표로 하기 때문에 굳이 해당 옵션을 체크하지 않는다.
<img src="https://blog.kakaocdn.net/dn/cqR5pz/btsAPwvuufj/avRscRAkikYB00KeYnpCGK/img.png" alt="new7">
이제 다시 Qodana Cloud로 돌아와서 보면 <code>Project</code> 가 생성된 것을 확인할 수 있다.
<img src="https://blog.kakaocdn.net/dn/b1aAad/btsAQcXGN9j/VI7hTYoIOkOpzRS0Qgm3VK/img.png" alt="new8">
이후부터는 어느 도구로 Qodana를 연동할 것인지 가이드가 나온다. 여기서 하단의 Key는 Github Action에서 사용해야할 Key이다.
<img src="https://blog.kakaocdn.net/dn/HUjrv/btsAMW28BX7/BYHM4kWLmu6RqSGgAsGmT1/img.png" alt="new9">
그래서 Github Repository의 <code>Settings &gt; Security -&gt; Secrets and variables -&gt; Actions</code> 에서 등록해야한다. <code>Name</code> 은 <code>QODANA_TOKEN</code> 으로, <code>Value</code> 는 위에서 복사한 <code>Key</code> 를 붙여넣는다.
<img src="https://blog.kakaocdn.net/dn/lqCgE/btsAOVbi8Og/cnRc0dbG3PdqYpHGHv3gi1/img.png" alt="new10">
이제 모든 환경 설정은 끝이났다. Github Action 의 연동으로 PR / Push가 발생할때마다 코드 분석이 되도록 진행한다.
<h2 data-ke-size="size26">2. Github Action 연동</h2>
Github Action 연동은 위에서 사용한 키들이 다 Github Repository에 생성되어있어야만 가능하다.
Github Actions 에서 다시 한번 <code>Secrets and variables</code> 에서 <code>Repository secrets</code> 에 <code>QODANA_TOKEN</code> 이 있는지 확인해보고, 있으면 바로 아래를 진행한다.
프로젝트 기준으로 <code>./github/workflows/qodana.yml</code> 파일을 생성한다. (파일명은 아무거나 상관없다.)
그리고 아래 내용을 붙여넣는다.
<pre data-ke-language="typescript"><code>name: qodana

on:
 push:
 branches:
 - master
 pull_request:
 branches:
 - "**"

jobs:
 qodana:
 runs-on: ubuntu-latest
 permissions:
 contents: write
 pull-requests: write
 checks: write
 steps:
 - uses: actions/checkout@v3
 with:
 ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit
 fetch-depth: 0
 - name: Use Node.js 18.x
 uses: actions/setup-node@v2
 with:
 node-version: 18.x
 cache: 'yarn'

 - name: Install dependencies
 run: yarn install

 - name: 'Qodana Scan'
 uses: JetBrains/qodana-action@v2023.2
 with:
 pr-mode: false
 args: --apply-fixes
 push-fixes: pull-request
 env:
 QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}</code></pre>
<ul data-ke-list-type="disc">
<li>master push, 모든 pull Request에 대해 실행</li>
<li>TS &amp; ESLint를 사용하고 있어서 Node.js 18.x / yarn을 사용</li>
</ul>
<blockquote data-ke-style="style2">
이외 다양한 기능과 옵션을 사용하고 싶다면 <a href="https://www.jetbrains.com/help/qodana/github.html#Usage">공식 문서</a> 내용을 참고해본다.
</blockquote>
이제 Github Action을 통해 코드 분석이 진행된다. (최초 실행시에는 10분 정도 소요된다.)
분석이 완료되면, Github Repository의 <code>Actions &gt; qodana</code> 에서 결과를 확인할 수 있다.
<img src="https://blog.kakaocdn.net/dn/cCmZUu/btsANJPSnpk/PafXw1mobyeFI2L9gbVYC1/img.png" alt="gh1">
Qodana Scan 의 로그를 보면 Scan이 실행된 로그를 확인할 수 있다.
<img src="https://blog.kakaocdn.net/dn/mZNOn/btsAO7ipsfn/0zEkzSxMTiTyCqtB2a9kOk/img.png" alt="gh2">
Qodana Cloud로 다시 이동해보면 Scan 결과를 확인할 수 있다.
<img src="https://blog.kakaocdn.net/dn/bW9rCa/btsAL6kUVNH/fn4ottZE0sBFUGllmQ7rf0/img.png" alt="result1">
특정 코드의 문제점 역시 함께 상세하게 분석해준다.
<img src="https://blog.kakaocdn.net/dn/cqTE0i/btsAOSMpovw/GkNXFFEpoPJU83I2RIGZFK/img.png" alt="result2">
대시보드의 전체적인 사용법은 <a href="https://www.jetbrains.com/help/qodana/ui-overview.html#ui-overview-actual-problems">공식 문서</a>를 참고하면 된다.
<h2 data-ke-size="size26">3. IDE (IntelliJ, WebStorm 등) 연동</h2>
Qodana Cloud의 분석 결과를 실시간으로 IDE에서도 확인할 수 있다. Sonar에 비해 Cloud에서 분석한 결과를 IDE로 내려주는 방식이라, 로컬에서 실시간 분석을 위해 자원을 소모하지 않는다는 장점이 있다.
같은 JetBrains 제품 계열이라 연동 자체는 굉장히 간단하다.
IDE에서 <code>Tools -&gt; Qodana</code> 를 선택한다. (만약 없다면 <code>Plugins</code> 에서 <code>Qodana</code> 를 설치한다.)
<img src="https://blog.kakaocdn.net/dn/nSYrL/btsANtfjBXD/uoZ6yMT17Oq5nIttYmbqzk/img.png" alt="ide1">
Log In 버튼 클릭후 로그인을 하면, 연동된 프로젝트가 나타난다. (우린 방금 연동한 프로젝트가 노출될 것이다.)
<img src="https://blog.kakaocdn.net/dn/HxdwJ/btsAMrWAfm2/238NtRdtVUxTIJvouH4Af1/img.png" alt="ide2">
해당 프로젝트를 선택하고 <code>Apply</code> 를 클릭하면
<img src="https://blog.kakaocdn.net/dn/bnpuv4/btsAPwPMheU/aF15WL3IAY6traWQ3qAaMK/img.png" alt="ide3">
분석 결과를 실시간으로 확인할 수 있다. (분석 결과는 Cloud와 동일하다.)
<img src="https://blog.kakaocdn.net/dn/kIpMh/btsAM05nU6r/087tIJuuOC3KKg5OB2kR41/img.png" alt="ide4">
연동이 완료되면 아래와 같이 Qodana와 동일한 분석 결과를 IDE에서 실시간으로 받아볼 수 있다.
<img src="https://blog.kakaocdn.net/dn/NqHyB/btsAPJ2wdkW/1iTl9I5yfHOkrgFPg2d4mK/img.png" alt="ide5">
<h2 data-ke-size="size26">후기</h2>
무료플랜으로는 막상 사용하기가 애매하다.
<img src="https://blog.kakaocdn.net/dn/cVsaVL/btsAOJWwuyK/TvtKGAKAK5zdgNOebdFkEk/img.png" alt="price2">
언어쪽은 TS로 된 프로젝트도 측정해주는것 같다. (위 글에서 테스트한 프로젝트가 TS로 된 프로젝트)
다만, 테스트 커버리지 측정이 안된다는 것이 무료 버전의 큰 단점이다. 공개된 프로젝트에서는 대부분의 기능을 사용할 수 있는 SonarCloud에 비해 Qodana에서는 그런 기능이 유료플랜에만 지원하는것 같다.
이런 정적 분석 도구들은 최대한 많은 분석 자료들이 쌓이면 좋을텐데, 공개 프로젝트들에 한해서는 최대한 많은 기능을 오픈해주는게 어떨까 하는 아쉬움도 든다.
<blockquote data-ke-style="style2">
이후에 <a href="https://www.jetbrains.com/ko-kr/community/opensource/#support">JetBrains 오픈소스 라이센스</a>를 얻어서 풀 기능으로 제대로 비교를 해봐야할것 같다.
</blockquote></div></div>

기억보단 기록을

이동욱 (향로)

JetBrains에서 SonarQube와 같은 정적 분석 도구를 출시했다.
Qodana
JetBrains 에서 출시하는 제품들은 일단 관심을 가지게 된다.
IntelliJ, WebStorm, DataGrip 등을 몇년간 계속해서 사용하면서 충분히 만족감을 느꼈고 (불편함이 없진 않았지만), 최근에 출시한 Writerside도 VSCode를 대체한 마크다운 에디터로 잘 사용하고 있다.
그만큼 DX를 가장 신경쓰는 제품을 만드는 회사라는 확신이 있기 때문에 이번 Qodana 역시 기존의 Sonar 제품들을 잘 대체할 수 있을까 하는 기대감에 사용해보게 되었다.
그리고 기존에 잘 사용하던 SonarQube의 대체제를 고민하던 시점이기도 했다.
Qodana는 SonarQube에 비해 어떤 장점이 있을까?
눈여겨 본 가장 큰 이유가 가격 경쟁력이였다.
2개의 도구는 서로 다른 조직에 적합하다.
SonarQube
전체 라인수 비례 가격
개발자가 많지만 프로젝트는 분산되지 않은 경우
단일 프로젝트에 여러명의 개발자가 활동하는 경우
반대로, 프로젝트가 여러개면 이에 따른 비즈니스 외 코드들도 그만큼 늘어서 라인수가 기하급수적으로 늘어난다.
Qodana
활성화된 사용자수 비례 가격
개발자에 비해 프로젝트 수가 많은 경우
개발자가 많은 것에 비해 프로젝트 수가 적으면 한명 한명 채용될때마다 부담스럽다.
SonarQube와는 완전히 반대상황이다.
현재 우리 조직은 거대한 레거시 하나를 작은 레거시 프로젝트 여러개로 나눠서 개발인원 / 팀 규모에 비해 라인수가 상당히 높다.
실제 우리팀의 현 상황은 다음과 같다.
26명의 개발자
94만 라인수
이때 2개 서비스의 가격을 비교해보면
(연간 $4,000 / 517만원)
만약 여기서 조금만 프로젝트 규모가 커지면 다음 플랜의 가격은 100% 상승한다.
(1m 다음 플랜이 바로 2m이다.)
(연간 $8,000 / 1,000만원)
반면 Qodana로 비교하면
(연간 $60 * 26 = $1,560 / 200만원)
개발 팀원이 40명으로 늘어난다 하더라도 $2,400 (310만원) 이다.
현재 기준으로는 1/3 가격으로 정적 분석 도구를 사용할 수 있다.
Qodana로 연간 $8,000 정도가 되려면 개발팀원이 130명이상 되어야만 하는데, 여기까지 가려면 아직 한참 시간이 남았다.
소수의 인원으로 다양한 프로젝트를 해야하는 (웹/앱/서버) 스타트업 특성상 Qodana의 가격 정책은 굉장히 합리적이다.
그래서 일단 개인 계정으로 무료로 한번 사용해보자.
1. Qodana Cloud 생성 및 프로젝트 연결
JetBrains 계정이 있다고 가정하고,
Qodana Cloud 에 접속하여 로그인한다.
접속을 하면, Team을 만들어야 한다.
(Team 안에 여러 Repo를 연동시킬 수 있다.
성격에 맞게 Repo를 관리하기 위해서)
team를 만들었다면, 다음과 같이 프로젝트를 연결할 수 있다.
해당 team을 클릭해 들어가면 Create project 버튼이 있는데, 이를 클릭하여 해당 team에서 관리하고자 하는 Github Repo를 연결한다.
Project 생성시에 SSH URL 을 요구한다.
이는 Github Repository의 Code > SSH 에서 확인할 수 있다.
해당 정보를 등록 한 뒤,
바로 아래에 있는 Public key 는 Github의 해당 Repo에 Deploy Key로 등록해야한다.
이제 Github Repository에 들어가서 Settings > Deploy keys 에서 Add deploy key 를 클릭한다.
Title 은 아무거나 입력해도 되고, Key 에는 위에서 복사한 Public key 를 붙여넣는다.
Allow write access 를 체크하면 해당 키로 푸시도 가능하다.
단, 여기서는 저장소 코드만 스캔 하는 것을 목표로 하기 때문에 굳이 해당 옵션을 체크하지 않는다.
이제 다시 Qodana Cloud로 돌아와서 보면 Project 가 생성된 것을 확인할 수 있다.
이후부터는 어느 도구로 Qodana를 연동할 것인지 가이드가 나온다.
여기서 하단의 Key는 Github Action에서 사용해야할 Key이다.
그래서 Github Repository의 Settings > Security -> Secrets and variables -> Actions 에서 등록해야한다.
Name 은 QODANA_TOKEN 으로, Value 는 위에서 복사한 Key 를 붙여넣는다.
이제 모든 환경 설정은 끝이났다.
Github Action 의 연동으로 PR / Push가 발생할때마다 코드 분석이 되도록 진행한다.
2. Github Action 연동
Github Action 연동은 위에서 사용한 키들이 다 Github Repository에 생성되어있어야만 가능하다.
Github Actions 에서 다시 한번 Secrets and variables 에서 Repository secrets 에 QODANA_TOKEN 이 있는지 확인해보고, 있으면 바로 아래를 진행한다.
프로젝트 기준으로 ./github/workflows/qodana.yml 파일을 생성한다.
(파일명은 아무거나 상관없다.)
그리고 아래 내용을 붙여넣는다.
name: qodana
on:
  push:
    branches:
      - master
  pull_request:
    branches:
      - "**"
jobs:
  qodana:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
      checks: write
    steps:
      - uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.sha }}  # to check out the actual pull request commit, not the merge commit
          fetch-depth: 0
      - name: Use Node.js 18.x
        uses: actions/setup-node@v2
        with:
          node-version: 18.x
          cache: 'yarn'
      - name: Install dependencies
        run: yarn install
      - name: 'Qodana Scan'
        uses: JetBrains/qodana-action@v2023.2
        with:
          pr-mode: false
          args: --apply-fixes
          push-fixes: pull-request
        env:
          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
master push, 모든 pull Request에 대해 실행
TS & ESLint를 사용하고 있어서 Node.js 18.x / yarn을 사용
이외 다양한 기능과 옵션을 사용하고 싶다면 공식 문서 내용을 참고해본다.
이제 Github Action을 통해 코드 분석이 진행된다.
(최초 실행시에는 10분 정도 소요된다.)
분석이 완료되면, Github Repository의 Actions > qodana 에서 결과를 확인할 수 있다.
Qodana Scan 의 로그를 보면 Scan이 실행된 로그를 확인할 수 있다.
Qodana Cloud로 다시 이동해보면 Scan 결과를 확인할 수 있다.
특정 코드의 문제점 역시 함께 상세하게 분석해준다.
대시보드의 전체적인 사용법은 공식 문서를 참고하면 된다.
3. IDE (IntelliJ, WebStorm 등) 연동
Qodana Cloud의 분석 결과를 실시간으로 IDE에서도 확인할 수 있다.
Sonar에 비해 Cloud에서 분석한 결과를 IDE로 내려주는 방식이라, 로컬에서 실시간 분석을 위해 자원을 소모하지 않는다는 장점이 있다.
같은 JetBrains 제품 계열이라 연동 자체는 굉장히 간단하다.
IDE에서 Tools -> Qodana 를 선택한다.
(만약 없다면 Plugins 에서 Qodana 를 설치한다.)
Log In 버튼 클릭후 로그인을 하면, 연동된 프로젝트가 나타난다.
(우린 방금 연동한 프로젝트가 노출될 것이다.)
해당 프로젝트를 선택하고 Apply 를 클릭하면
분석 결과를 실시간으로 확인할 수 있다.
(분석 결과는 Cloud와 동일하다.)
연동이 완료되면 아래와 같이 Qodana와 동일한 분석 결과를 IDE에서 실시간으로 받아볼 수 있다.
후기
무료플랜으로는 막상 사용하기가 애매하다.
언어쪽은 TS로 된 프로젝트도 측정해주는것 같다.
(위 글에서 테스트한 프로젝트가 TS로 된 프로젝트)
다만, 테스트 커버리지 측정이 안된다는 것이 무료 버전의 큰 단점이다.
공개된 프로젝트에서는 대부분의 기능을 사용할 수 있는 SonarCloud에 비해 Qodana에서는 그런 기능이 유료플랜에만 지원하는것 같다.
이런 정적 분석 도구들은 최대한 많은 분석 자료들이 쌓이면 좋을텐데, 공개 프로젝트들에 한해서는 최대한 많은 기능을 오픈해주는게 어떨까 하는 아쉬움도 든다.
이후에 JetBrains 오픈소스 라이센스를 얻어서 풀 기능으로 제대로 비교를 해봐야할것 같다.

Qodana 무료로 시작해보기 (2023.11)

댓글