이 기사에서는 k6를 XRAY/Jira와 통합할 수 있는 간단한 방법을 보여 드리겠습니다.

언젠가 저는 꽤 많은 요청을 처리할 것으로 예상되는 API에 대한 성능 테스트를 작성하는 작업을 맡았습니다. 이러한 이유로 우리는 모든 QA 엔지니어가 더 빨리 픽업하고 더 쉽게 기여할 수 있는 좋은 도구가 필요했습니다.
예전에 로드임팩트를 사용해본 경험이 있어서 K6에 대해서는 꽤 익숙했습니다. 우리가 다른 성능 테스트 도구 대신 k6을 선택한 주된 이유는 다음과 같습니다.

• 자바스크립트 사용: 우리 팀의 QA/개발자들은 대부분 자바스크립트에 익숙해서 새로운 언어를 배울 필요가 없었습니다.

• 오픈 소스: 즉, 도구를 사용하는 데 결제가 필요하지 않으며 커뮤니티가 활성화되어 있습니다.

• CI/CD: k6를 CI/CD 파이프라인과 통합하는 것은 간단했습니다.

k6 선택의 장점을 계속 이어갈 수 있는데, 이에 대해 구체적으로 이야기하기 위해 새 글을 쓰겠습니다.

테스트 프레임워크를 완료한 후 Jira에서 테스트 결과를 얻고 싶었습니다. 우리는 이미 XRAY를 사용하고 있었기 때문에 k6 JSON 보고서를 X-ray 형식으로 변환하는 솔루션이 필요했습니다. 우리 사건에 맞는 해결책을 찾을 수 없었습니다.

K6 핸들요약()

K6에는 모든 측정항목을 얻는 데 사용할 수 있는 필수 기능이 있습니다. 이러한 옵션은 stdout, XML 및 JSON입니다.

이를 위해 우리는 handlerSummary 함수에서 데이터 객체를 가져오는 스크립트를 생성하기만 하면 되었습니다.

다음은 k6의 데이터 개체를 간단한 XRAY 형식 보고서로 변환하는 스크립트입니다.

k6-XRAY-스크립트

k6 및 Xray 통합을 위한 생성기 도우미 스크립트를 설정하는 방법

원하는 위치에 저장소를 복제하세요.
메인 프로젝트 내에 폴더를 생성하는 것이 바람직합니다.

예:
도우미, 소스, 보고

이렇게 하면 문제 없이 가져오기를 잘 관리하는 데 도움이 됩니다.

전제 조건

시작하기 전에 컴퓨터에 다음이 설치되어 있는지 확인하세요.

• Node.js
• npm
• k6

용법

k6 테스트가 그룹으로 구성되어 있고 각 그룹 제목이 Xray의 테스트 사례에 해당하는 경우 생성기 스크립트를 사용하여 Xray와 호환되는 JSON 파일을 생성할 수 있습니다.

예

아래 Xray 문서 이미지는 CALC-01 및 CALC-02 키를 사용한 테스트 사례를 보여줍니다.

k6 테스트 스크립트에서 그룹 제목 이름을 CALC-01 및 CALC-02로 지정할 수 있습니다. 스크립트는 이러한 그룹 이름을 검색하고 Xray의 각 테스트 사례에 테스트 결과를 할당합니다.

group('CALC-01', function() {
  // test code
});
group('CALC-02', function() {
  // test code
});

산출

스크립트는 Xray와 호환되는 JSON 파일을 생성하고 스크립트와 동일한 디렉터리에 저장됩니다.

저장소 복제

git clone https://github.com/skingori/k6-json-xray.git

스크립트를 설정하는 방법

k6에서 제공하는 handlerSummary 함수와 Generator.js 스크립트의 textSummary를 사용하여 JSON 파일을 생성합니다. handlerSummary 함수는 데이터 개체를 가져오고 이를 getSummary에 전달하여 Xray 호환 형식으로 수정합니다.

여기에서 k6 HandleSummary에 대해 자세히 알아보세요.

실행 스크립트를 열고 다음 줄을 추가하세요.

import { getSummary } from "./generator.js";
import { textSummary } from "https://jslib.k6.io/k6-summary/0.0.1/index.js";

내 스크립트와 동일한 폴더에 있는 ./generator.js를 직접 사용하고 있습니다. 도우미를 사용하고 있다고 가정해 보겠습니다.

import { getSummary } from "./helper/generator.js";

코드 끝부분에 handlerSummary 함수를 추가하세요.

export function handleSummary(data) {
    return {
        stdout: textSummary(data, { indent: " ", enableColors: true }),
        "summary.json": JSON.stringify(getSummary(data, "CALC-2062", "CALC"), null, 2)
    };
}

getSummary 함수는 데이터 객체를 X선 예상 형식으로 변환하고 출력을 summary.json 파일에 저장합니다.

textSummary를 사용하는 이유는 무엇입니까?

콘솔에 출력을 인쇄하려면 k6 JS 유틸리티 라이브러리에서 textSummary를 가져와야 합니다.

그러나 표준 출력 보고서가 필요하지 않은 경우 모든 사람에게 적용되는 것은 아니며 텍스트 요약을 가져올 필요가 없습니다.

예

import http from 'k6/http';
import { sleep, group, check } from 'k6';
import { getSummary } from "./generator.js";
import { textSummary } from "https://jslib.k6.io/k6-summary/0.0.1/index.js";

export const options = {
    vus: 10,
    duration: '30s',
};

export default function() {
    group('CALC-01', function() {
        const resp = http.get('http://test.k6.io');
        check(resp, {
            'status is 200': (r) => r.status === 200,
        });
        sleep(1);
    });

    group('CALC-02', function() {
        const resp = http.get('http://test.k6.io');
        check(resp, {
            'status is 200': (r) => r.status === 200,
        });
        sleep(1);
    });
};

export function handleSummary(data) {
    return {
        stdout: textSummary(data, { indent: " ", enableColors: true }),
        "summary.json": JSON.stringify(getSummary(data, "CALC-2062", "CALC"), null, 2)
    };
}

참고: textSummary를 가져오지 않으려면 stdout: textSummary(data, { indent: " ", 활성화Colors: true }), 줄을 제거할 수 있습니다.

handleSummary는 기본적으로 작동하며 일반적으로 테스트 수명 주기가 끝날 때 호출됩니다.

스크립트 실행

스크립트를 실행하려면 다음 명령을 사용하세요.

k6 run script.js -e TEST_PLAN_KEY="CALC-2345" -e TEST_EXEC_KEY="CALC-0009"

TEST_PLAN_KEY 및 TEST_EXEC_KEY는 Xray에서 테스트 계획 및 테스트 실행을 식별하는 데 사용됩니다.

여기에서 테스트 계획 및 테스트 실행 키에 대해 자세히 알아보세요.

산출

위 스크립트는 summary.json 아래에 다음 보고서를 생성합니다.

{
  "info": {
    "summary": "K6 Test execution - Mon Sep 09 2024 21:20:16 GMT 0300 (EAT)",
    "description": "This is k6 test with maximum iteration duration of 4.95s, 198 passed requests and 0 failures on checks",
    "user": "k6-user",
    "startDate": "2024-09-09T18:20:16.000Z",
    "finishDate": "2024-09-09T18:20:16.000Z",
    "testPlanKey": "CALC-2345"
  },
  "testExecutionKey": "CALC-0009",
  "tests": [
    {
      "testKey": "CALC-01",
      "start": "2024-09-09T18:20:16.000Z",
      "finish": "2024-09-09T18:20:16.000Z",
      "comment": "Test execution passed",
      "status": "PASSED"
    },
    {
      "testKey": "CALC-02",
      "start": "2024-09-09T18:20:16.000Z",
      "finish": "2024-09-09T18:20:16.000Z",
      "comment": "Test execution passed",
      "status": "PASSED"
    }
  ]
}

k6 및 X-ray에 대한 자세한 내용을 보려면 해당 문서에 문의하세요.
K6 문서
XRAY 문서

이것도 확인해 보세요 - Sérgio Freire가 작성한 멋진 기사인 Xray 및 Jira를 사용하여 테스트 사례를 만들고 관리하는 방법

언제나 그렇듯이 언제든지 저에게 연락해 주세요!

링크드인
이메일
Github