Static Analysis는 프로그램을 실행할 필요 없이 프로그램의 프로덕션 전 코드를 분석하는 소프트웨어 테스트 기법으로, 프로그램이 정적 상태임을 의미합니다. Static Analysis는 Software Development Life Cycle(SDLC) 초기에 유지 관리 문제를 식별하고 코딩 모범 사례를 준수하여 최고 품질의 코드만 프로덕션에 적용될 수 있도록 지원합니다.
Static Analysis를 사용하면 다음과 같은 이점을 얻을 수 있습니다:
Static Analysis를 사용하면 선택한 모든 CI 플랫폼 제공자에서 다양한 언어의 코드 리뷰에 대한 피드백을 통합할 수 있습니다. 다음 통합에 대한 자세한 내용은 설명서를 참조하세요:
Datadog Static Analysis를 사용하려면, 리포지토리의 루트 디렉터리에 static-analysis.datadog.yml 파일을 추가하여 사용할 규칙 세트를 지정하세요.
rulesets:
- <ruleset-name>
- <ruleset-name>
예를 들어, Python 규칙의 경우:
rulesets:
- python-code-style
- python-best-practices
- python-inclusive
Datadog API 및 애플리케이션 키를 설정하고 각 CI 제공자에서 Static Analysis를 실행합니다.
CircleCI로 Static Analysis를 실행하려면 다음 CircleCI Orb 설정 지침을 따르세요.
GitHub로 Static Analysis를 실행하려면, 다음 GitHub Actions 설정 지침을 따르세요.
CircleCI Orbs 또는 GitHub Actions를 사용하지 않는 경우, CI 파이프라인 플랫폼에서 직접 Datadog CLI를 실행할 수 있습니다.
필수 조건:
다음 환경 변수를 설정하세요:
| 이름 | 설명 | 필수 사항 | 기본값 |
|---|---|---|---|
DD_API_KEY | Datadog API 키. 이 키는 Datadog 조직에서 생성하며 비밀로 저장해야 합니다. | Yes | |
DD_APP_KEY | Datadog 애플리케이션 키. 이 키는 Datadog 조직에서 생성하며 비밀로 저장해야 합니다. | Yes | |
DD_SITE | 정보를 전송하는 Datadog 사이트. Datadog 사이트는 | No | datadoghq.com |
다음 입력을 입력합니다:
| 이름 | 설명 | 필수 사항 | 기본값 |
|---|---|---|---|
service | 결과에 태그를 지정할 서비스의 이름입니다. | Yes | |
env | 결과에 태그를 지정할 환경입니다. ci 는 이 입력에 유용한 값입니다. | No | none |
CI 파이프라인에 다음을 추가하세요:
# 종속성을 설치하세요
npm install -g @datadog/datadog-ci
curl -L http://dtdg.co/latest-static-analyzer > /tmp/ddog-static-analyzer
unzip /tmp/ddog-static-analyzer -d /tmp
# Static Analysis를 실행하세요 (사전 설치된 JVM 필요)
/tmp/cli-1.0-SNAPSHOT/bin/cli --directory . -t true -o results.sarif -f sarif
# 결과를 업로드하세요
datadog-ci sarif upload results.sarif --service "$DD_SERVICE" --env "$DD_ENV"
타사 정적 분석 도구의 결과가 상호 운용 가능한 Static Analysis Results Interchange Format (SARIF) 형식인 경우 Datadog으로 결과를 전송할 수 있습니다.
SARIF 보고서를 업로드하려면:
선택 사항: DD_SITE 변수를 지정합니다 (기본값: datadoghq.com).
datadog-ci 유틸리티를 설치합니다:
npm install -g @datadog/datadog-ci
코드에 타사 정적 분석 결과 도구를 실행하고 결과를 SARIF 형식으로 출력합니다.
결과를 Datadog에 업로드합니다:
datadog-ci sarif upload $OUTPUT_LOCATION --service <datadog-service> --env <datadog-env>
datadog-ci CLI를 사용해 CI 파이프라인에서 Datadog Static Analysis를 실행하고, Datadog의 기본 규칙 세트에 따라 코드를 검사합니다.
Datadog Static Analyzer를 실행하도록 CI 파이프라인을 설정한 후에는 Static Analysis Results 페이지에 위반 사항이 나타납니다. 결과를 필터링하려면 목록 왼쪽의 패싯을 사용하거나 검색하세요.
각 위반 사항은 CI 파이프라인이 실행된 리포지토리의 특정 커밋 및 브랜치와 연관되어 있습니다. 행은 커밋별 모든 위반 사항을 나타냅니다.
위반 사항을 클릭하면 위반 범위와 위반이 발생한 위치에 대한 정보가 포함된 사이드 패널이 열립니다.
위반 내용은 탭에 표시됩니다:
Source Code: 위반에 대한 설명 및 위반의 원인이 된 코드 줄입니다. 위반 코드 스니펫을 확인하려면 Datadog GitHub App을 설정하세요.
Fix: 가능한 경우 위반 사항을 해결할 수 있는 하나 이상의 코드 수정 사항을 복사하여 붙여넣을 수 있습니다.
Event: Static Analysis 위반 사항 이벤트와 관련된 JSON 메타데이터입니다.
Additional helpful documentation, links, and articles:
