📰 | 코드 품질 관리가 필요한 이유와 방법, 정적&동적 분석, Sonar Cloud

 

Sonar클라우드와 미팅할 때 처음 접해보는 개발 상식들이 있었다. 미팅이 끝나자마자 검색♾️의 연속..꼬리에 꼬리를 물며 코드 품질 관리에 대해서 톺아봤다.

 

 

🤷🏻‍♀️코드 품질 관리가 필요한 이유

 코드를 작성하다 보면 통용되는 컨벤션, 중복되는 코드, 보안 취약점 등을 인지하지 못한채 개발하게 된다. 더욱이 개발자 개개인이 새로운 언어를 배운다 하더라도 본인에게 익숙한 언어스타일로 개발을 하게 되는데, 사내에서 공식적으로 사용하는 언어의 방식과 본인의 스타일이 다르면 그 간극은 커진다. 마치 Java를 C언어 처럼 사용한다거나 Go언어를 JS처럼 사용할 수도 있게 된다는 문제점이 있기 때문에 품질 관리가 필요하다.

 또한 코드 품질관리를 하면 작업 효율이 높아지는데, 아래의 이유들로 인해 소프트웨어 개발에서 필수적인 요소라고 볼 수 있다.

• 버그 감소 : 높은 품질의 코드는 버그를 줄이고, 시스템이 예측대로 동작하도록 한다.
• 유지 보수성 향상 : 읽기 쉽고 일관성 있는 코드는 유지 보수를 더 쉽게 만든다. 새로운 개발자가 프로젝트에 참여할 때에도 적응이 빠르다.
• 생산성 향상 : 잘 구조화된 코드와 자동화된 테스트는 개발자들이 새로운 기능을 빠르게 추가하고 변경 사항들을 쉽게 반영할 수 있게 한다.
• 코드 재사용성 증가 : 높은 품질의 모듈화된 코드는 다양한 프로젝트에서 재사용하기 용이하다.
• 보안 강화 : 코드 품질 관리 도구와 프로세스는 보안 취약점을 조기에 발견하고 수정할 수 있게 도와준다.
• (궁극적으로)비용 절감 : 버그나 문제를 사전에 발견하고 수정함으로써, 이후 단계에서 발생할 수 있는 높은 비용을 절감할 수 있다.

 

💁🏻‍♀️코드 품질 관리 방법

• 코드 리뷰(Code Review) : 팀원들이 서로의 코드를 검토하여 버그, 스타일 문제, 논리적 오류 등을 발견한다.
• 단위 테스트(Unit Testing) : 개별 함수나 모듈이 예상대로 동작하는지 확인하는 테스트를 작성한다. 시스템의 일부분이 제대로 통합되고 있는지 검증한다.
• CI/CD 파이프라인(CI/CD Pipeline) : Jenkins, Travis CI, GitHub Actions 등의 도구를 사용하여 지속적 통합(Continuous Integration)과 지속적 배포(Continuous Deployment)를 통해 코드 변경 사항이 자동으로 테스트되고 배포되도록 한다.
•  코딩 표준 및 스타일 가이드(Code Standards and Style Guides) : 팀 안에서 스탠다드를 정의하고, 준수한다.
• 리팩토링(Refactoring) : 코드의 기능을 변경하지 않으면서 구조를 개선하여 유지 보수성을 높인다.
• 문서화(Documentation) : README파일 등을 작성하여 코드의 목적과 사용법을 명확히 하여 코드 자체에 주석을 추가하고, 함수나 모듈의 사용법을 문서화 한다.

 

💁🏻‍♀️코드 품질 관리 방법-정적 분석 도구

정적 분석 도구(Static Analysis Tools) :  코드의 품질을 자동으로 분석한다. 소스 코드나 컴파일된 코드를 실행하지 않고 분석하는 방법이다.

• 분석 시점 : 코드를 작성한 후, 실행하기 전에 수행된다.
• 초점 : 코드 스타일, 문법 오류, 잠재적인 버그, 보안 취약점, 코드 복잡도, 중복 코드, 형식 오류 등을 식별한다.
• 분석 도구 : SonarQube, ESLint, Pylint
• 장점 :
  • 코드가 실제로 실행되기 전에 문제를 발경할 수 있다.
  • 코드의 구조적 문제를 조기에 발견하여 수정할 수 있다.
  • 자동화된 도구를 통해 빠르고 광범위한 분석이 가능하다.
• 단점 : (→ 실제로 코드를 실행하며 분석하는 동적분석Dynamic Analysis으로 보완해야한다.)
  • 실행 시점에서 발생하는 런타임 오류를 잡아내지 못한다.
  • 실제 동작과 관련된 문제를 식별하지 못할 수 있다.

*참고! 정적 분석은 코드를 실행하지 않고 소스 코드 자체를 분석하여 문제를 찾고, 동적 분석은 실행 중인 프로그램을 분석하여 런타임 오류, 메모리 문제, 성능 문제 등을 발견한다. 이 두가지 방법은 분석 시점이 달라 상호보완적이다. 정적 분석을 통해 코드 작성 단계에서 오류를 줄이고, 동적 분석을 통해 실제 실행할 때 발생할 수 있는 문제를 해결하면 전체적인 코드 품질을 향상시킬 수 있다.

 

 

💁🏻‍♀️코드 품질 관리 방법-정적 분석 도구-Sonar Cloud

출처 : sonarcloud.com

SonarCloud is a cloud-based code analysis service designed to detect code quality issues in 25 different programming languages, continuously ensuring the maintainability, reliability and security of your code.

SonarCloud는 말 그대로 정적 코드 분석이다. 각각의 개발 언어에서 지정된 코드 품질에 대한 코드를 가지고 분석하여 유지보수성, 안정성 및 보안 등을 지속적으로 관리해주는 업무툴이다.

 

Sonar는 기본적으로 Automatic Analysis방식을 디폴트 옵션으로 제공하고 있다.

SonarCloud의 자동 분석 기능은 코드 품질과 보안을 지속적으로 모니터링하고 개선할 수 있도록 도와준다. CI/CD 파이프라인과 통합되어 코드가 변경될 때마다 자동으로 분석을 수행하며, 품질 게이트를 통해 코드가 배포되기 전에 문제를 식별하고 해결할 수 있고, 직관적인 대시보드와 이슈 트래킹 기능을 통해 코드 품질을 체계적으로 관리할 수 있다고 한다.

 

 

 

 

🙋🏻‍♀️정리

 Sonar는 예상치 못한 에러나 버그가 발생할 수 있는 위험도를 낮춰주고 신뢰성을 높여주며, 관리자는 대쉬보드에서 정량적인 코드 지표를 볼 수 있어 합리적인 코드 퀄리티가 가능한 툴이다. 위에서 말했듯 정적 분석이 에러나 버그 처리에 절대적이지는 않다. (동적분석을 함께 해주며 상호보완을 해야한다.) 하지만 정확한 파악을 하며 기능을 사용하면 상당히 유용한 툴인 것 같다.