Snyk 코드 CLI 결과 보기

Snyk CLI를 사용하여 snyk code test 명령의 결과에 대해 다음 작업을 수행할 수 있습니다:

Snyk code test에 대해 JSON 및 SARIF 형식은 동일합니다. 따라서 예시는 한 형식으로만 표시됩니다.

Snyk-to-html을 사용하여 HTML 형식으로 CLI 결과 표시도 가능합니다.

CLI 결과 분석

CLI에서 snyk code test 명령을 실행한 후 테스트 결과가 표시됩니다:

CLI에서 나온 테스트 결과
CLI에서 나온 테스트 결과

Snyk 웹 UI에서 문제를 무시했다면, 이러한 문제는 여전히 CLI 결과에 나타납니다. 이 페이지의 각 섹션은 표시된 결과의 한 부분을 설명합니다.

에서 감지한 취약점 문제 목록

Snyk Code 테스트에서 발견된 문제 목록은 문제의 심각도 수준에 따라 구성되어 있습니다.

각 문제에 대해 다음 정보가 제공됩니다:

문제에 대한 CLI 테스트 정보
문제에 대한 CLI 테스트 정보
  • 헤더: 문제의 심각도 수준 및 취약점 유형.

  • 경로: 문제가 발견된 파일 이름 및 파일에서 문제가 발견된 라인. 이 위치 세부 정보는 문제의 Sink를 나타내며, 테스트된 저장소에서 취약점이 실행될 수 있는 위치를 의미합니다.

  • 정보: 문제 데이터 흐름에 대한 설명.

Info 섹션에 나타나는 메시지는 웹 UI의 Data flow 섹션에 있는 메시지와 동일합니다:

문제에 대한 CLI 테스트 정보
문제에 대한 CLI 테스트 정보

테스트 결과에 대한 일반 정보

테스트 결과에 대한 일반 정보는 다음과 같은 세부 정보를 포함합니다:

CLI 테스트 결과 일반 정보 세부사항
CLI 테스트 결과 일반 정보 세부사항
  • 테스트 성공: 테스트가 완료되었는지 여부.

  • 조직: 테스트가 실행된 조직의 Snyk ID 또는 내부 이름. 자세한 내용은 CLI 테스트용 Snyk 조직 설정을 참조하십시오.

  • 테스트 유형: 결과를 생성한 테스트 명령의 유형. {Snyk Code}의 경우 항상 정적 코드 분석입니다.

  • 프로젝트 경로: 테스트된 저장소의 경로.

테스트 결과 요약

테스트 결과 요약에는 다음과 같은 세부 정보가 포함됩니다:

문제에 대한 CLI 테스트 결과 요약
문제에 대한 CLI 테스트 결과 요약
  • Snyk Code에서 발견한 취약점 문제 수.

  • 각 심각도 수준별 발견된 문제 수.

snyk code test 명령에는 종료 코드가 있습니다. 이러한 코드의 정의는 이 코드들에 대한 도움말을 참조하십시오. 종료 코드를 보려면 snyk code test -d를 실행하십시오.

모든 CLI 명령에 대한 종료 코드 요약은 CLI 명령 및 옵션 요약을 참조하십시오.

심각도 수준별 결과 필터링

CLI 터미널에 표시되는 테스트 결과를 필터링하여 특정 심각도 수준 이상의 문제만 표시할 수 있습니다.

특정 심각도 수준을 초과하는 문제만 표시하려면 다음을 입력하십시오:

snyk code test <폴더/경로> --severity-threshold=<낮음|중간|높음>

결과에는 지정된 심각도 수준의 문제 및 해당 수준보다 더 높은 심각도 수준의 문제만 포함됩니다.

예를 들어, snyk-goof-master 폴더에서 8개의 문제가 발견되었는데, 그 중 4개는 높은 심각도 수준이었으며 4개는 중간 수준인 경우:

의 높고 중간 심각도 문제에 대한 CLI 테스트 결과
Snyk Code의 높고 중간 심각도 문제에 대한 CLI 테스트 결과

높은 심각도 수준 이상의 문제만 표시하려면 다음을 입력하십시오:

snyk code test /Users/username/Documents/Repositories/snyk-goof-master --severity-threshold=high

결과는 높은 심각도 수준인 4개의 문제가 모두 표시됩니다. 낮은 심각도 수준의 문제는 표시되지 않습니다:

높은 심각도 수준의 Snyk Code CLI 결과

JSON 및 SARIF 파일에서 심각도 수준

snyk code test를 실행하여 발견된 문제의 심각도 수준은 JSON 및 SARIF 파일에서 다르게 표시됩니다. JSON 및 SARIF 결과에서 사용되는 심각도 수준은 다음과 같습니다:

  • 높음 = 에러

  • 중간 = 경고

  • 낮음 = 노트/정보

크리티컬 표시는 Snyk Code에서 사용되지 않습니다.

터미널에 표시된 중간 심각도 예시는 다음과 같습니다:

JSON 또는 SARIF 출력의 중간 심각도
JSON 또는 SARIF 출력의 중간 심각도

다음은 파일에서 높은 및 낮은 심각도 수준 예시를 보여줍니다:

JSON 또는 SARIF 파일의 높은 및 낮은 심각도 수준
JSON 또는 SARIF 파일의 높은 및 낮은 심각도 수준

테스트 결과 출력

Snyk code test 결과를 표준 CLI 형식으로 표시하는 대신 터미널에서 JSON 또는 SARIF 형식으로 출력할 수 있습니다.

또한 테스트 결과를 JSON 또는 SARIF 형식 파일로 내보낼 수도 있습니다. SARIF는 정적 분석 도구의 출력을 위한 오픈 표준입니다. 자세한 정보는 SARIF 사이트를 참조하십시오.

snyk code test를 실행하여 발견된 문제의 심각도 수준 및 JSON 및 SARIF 파일에서보고된 결과가 터미널 결과와 다르게 표시됩니다. 자세한 내용은 JSON 및 SARIF 파일에서의 심각도 수준을 참조하십시오.

테스트 결과를 JSON 형식으로 출력하려면 다음을 입력하십시오:

snyk code test <폴더/경로> --json

테스트 결과를 SARIF 형식으로 출력하려면 다음을 입력하십시오:

snyk code test <폴더/경로> --sarif

테스트 결과는 터미널에서 JSON 또는 SARIF 형식으로 표시됩니다.

JSON 및 SARIF는 snyk code test에 대해 동일하므로 여기에서는 JSON 예시만 표시됩니다. snyk-goof-master 폴더의 테스트 결과를 JSON 형식으로 터미널에 출력하려면 다음 명령을 사용하여 리포지토리의 루트 폴더로 이동하고 다음과 같이 명령을 입력합니다:

snyk code test /Users/username/Documents/Repositories/snyk-goof-master --json

테스트 결과는 터미널에서 JSON 형식으로 표시됩니다:

JSON 형식의 snyk code test 결과
snyk code test 결과를 JSON 형식으로 출력

테스트 결과 내보내기

Snyk code test 결과를 JSON 또는 SARIF 형식 파일로 내보낼 수 있습니다. 결과를 내보낼 때 새 파일의 이름을 제공해야 합니다.

테스트 결과를 JSON 또는 SARIF 파일로 터미널에서 출력하는 것도 가능합니다.

snyk code test를 실행하여 발견된 문제의 심각도 수준 및 JSON 및 SARIF 파일에서보고된 결과가 터미널 결과와 다르게 표시됩니다. 자세한 내용은 JSON 및 SARIF 파일에서의 심각도 수준을 참조하십시오.

두 가지 방법으로 결과를 JSON 또는 SARIF 파일로 내보낼 수 있습니다. 다음 지침은 JSON 파일을 기준으로 설명하지만 SARIF 파일도 내보낼 수 있습니다.

표준 결과가 터미널에 표시되는 새 파일로 결과 내보내기

Snyk code test --json-file-output=<새_파일/경로> 명령은 Snyk CLI v. 1.910.0 이상에서 사용할 수 있습니다. Snyk CLI 버전을 업데이트하려면 Snyk CLI 설치 또는 업데이트를 참조하십시오.

새 JSON 파일로 결과를 내보내려면, 터미널에서 다음 명령을 사용합니다:

snyk code test --json-file-output=<새_json_파일/경로>

새로운 SARIF 파일로 테스트 결과를 내보내려면 다음 명령을 사용합니다:

snyk code test --sarif-file-output=<새_sarif_파일/경로>

결과가 터미널에 표시되고 지정한 경로에 JSON 또는 SARIF 파일이 만들어집니다.

JSON 및 SARIF는 snyk code test에 대해 동일하므로 여기에서는 JSON 예시만 표시됩니다. snyk-goof-master 폴더의 테스트 결과를 json이라는 JSON 파일로 내보내려면 디렉토리를 루트 폴더로 변경하고 다음과 같이 명령하십시오:

snyk code test --json-file-output=json

터미널에서 코드 테스트 결과가 표준 형식으로 표시됩니다:

터미널에서 snyk code test 결과
snyk code test 결과 터미널에 표시

리포지토리 폴더에 JSON 파일이 생성됩니다:

리포지토리의 JSON 파일
리포지토리의 JSON 파일

터미널 결과가 표시되지 않고 새 파일로 결과 내보내기

터미널에 결과를 표시하지 않고 새 JSON 파일로 결과를 내보내려면 다음

Last updated