API 테스트를 위한 극작가 대안

API 테스트를 위해 Playwright를 사용해 온 SDET라면 데이터베이스 종속성, 데이터 관리 및 끝없는 정리 필요성을 처리하는 데 따른 좌절감에 너무 익숙할 것입니다. 현실을 직시하자 - Playwright는 UI 테스트에는 훌륭하지만 API 테스트에서는 번거로울 수 있습니다. 그런데 이 문제를 처리하는 더 좋은 방법이 있다면 어떨까요?

이 게시물에서는 오픈 소스 API 테스트 도구이자 API 테스트 및 모의 API에 관한 최고의 극작가 대안인 Keploy로 전환하는 방법을 보여 드리겠습니다. 테스트 프로세스를 간소화하고 데이터베이스 문제를 해결하고 싶다면 계속 기다리십시오. 이번 마이그레이션은 여러분이 기다려 왔던 획기적인 변화가 될 수 있습니다.

API 테스트에 대한 극작가 개요

Playwright 테스트는 엔드투엔드 테스트 요구 사항을 충족하기 위해 특별히 제작되었습니다. 브라우저 상호 작용을 자동화하는 데 널리 사용되며 기능을 API 테스트로 확장했습니다. Playwright의 API 테스트 기능을 사용하면 HTTP 요청, 응답 유효성 검사, 심지어 모의 엔드포인트까지 가능합니다. 하지만 복잡한 환경에서 API 테스트를 위해 Playwright에 의존하면 문제가 빠르게 추가됩니다.

Playwright는 견고한 도구이지만 문제가 발생한 이유는 다음과 같습니다.

• 수동 모의 설정: Playwright를 사용하면 각 API 상호 작용에 대한 모의 응답을 수동으로 정의해야 합니다. 여기에는 page.route()를 사용하여 경로를 설정하거나 반복적이고 오류가 발생하기 쉬운 고정 장치를 사용하여 네트워크 요청을 가로채는 작업이 포함됩니다. 엔드포인트가 많은 대규모 애플리케이션의 경우 이로 인해 관리하고 유지해야 하는 코드의 양이 상당히 많아집니다.

• 범위가 포괄적이지 않을 수 있음: Playwright는 주로 엔드 투 엔드 테스트와 사용자 상호 작용 시뮬레이션에 중점을 두기 때문에 UI 코드만 테스트되고 기본 로직( API 호출, 백엔드 처리)가 완전히 다루어지지 않을 수 있습니다.

• 테스트 설정 오버헤드: 특히 API 호출을 모의할 때 Playwright에서 테스트 환경을 설정하는 데는 시간이 많이 걸립니다. 이 설정에는 경로, 응답 및 데이터 구성이 포함되므로 실제 테스트를 실행하기 전에 추가 시간과 노력이 필요합니다.

• 느린 테스트 실행: Playwright에서 수동으로 API 응답을 시뮬레이션하려면 다양한 엔드포인트와 응답에 대해 많은 수의 모의를 설정해야 하는 경우가 많습니다. 모든 테스트가 여러 개의 모의 상호작용을 거쳐야 하기 때문에 실행 시간이 늘어나고 특히 대규모 테스트 스위트의 경우 상당한 수의 모의를 처리하면 프로세스 속도가 느려질 수 있습니다.

• 백엔드 로직과의 제한된 통합: Playwright는 API 또는 서버 측 테스트가 아닌 브라우저 상호 작용에 중점을 두도록 설계되었습니다. 결과적으로 백엔드 API 또는 서비스에 의존하는 상호작용을 테스트하는 경우 백엔드 코드가 완전히 포함되었는지 여부에 대한 가시성이 자연스럽게 제공되지 않습니다.

• 테스트 격리 문제: Playwright 테스트에는 실제 또는 모의 데이터가 필요한 경우가 많으며, 특히 외부 데이터베이스, 서비스 또는 타사 API에 의존하는 경우 적절한 테스트 격리를 설정하는 것이 까다로울 수 있습니다.

이러한 문제가 발생하면서 저는 API 테스트를 더 간단하고 효율적으로 만들 수 있는 솔루션을 찾기 시작했습니다. Keploy가 등장한 곳이 바로 그곳입니다.

Keploy로 마이그레이션해야 하는 이유

Keploy는 데이터 모의/스텁 생성에도 도움이 되는 훌륭한 API 테스트 도구입니다. 데이터베이스 관리 및 테스트 데이터 생성을 위해 복잡한 설정이 필요한 경우가 많은 Playwright와 달리 Keploy는 이러한 프로세스 중 많은 부분을 자동화합니다. Keploy로 마이그레이션한 이유는 다음과 같습니다.

1. 수동 모의 설정은 이제 그만

   Keploy는 반복적인 API 테스트 코드를 작성하는 수고를 덜어줍니다. 요청, 응답, 모의 데이터를 수동으로 정의하는 대신 Keploy는 실제 API 상호 작용을 캡처하고 나중에 재생할 수 있도록 해줍니다. 이렇게 하면 광범위한 테스트 코드가 필요하지 않으며 테스트 생성에 소요되는 시간이 대폭 줄어듭니다.

2. 데이터베이스 종속성 없음
   
   Keploy는 실제 API 상호 작용을 기록하고 향후 테스트 실행을 위해 이를 재생합니다. 즉, 테스트를 실행하기 위해 더 이상 라이브 데이터베이스가 필요하지 않습니다. 이렇게 하면 실행 중인 데이터베이스를 유지 관리하고 각 테스트 후에 정리하는 오버헤드가 제거됩니다.

3. 더욱 빠르게*빠른 테스트 실행*

   Keploy는 데이터베이스를 설정하거나 해제할 필요가 없기 때문에 테스트 실행 속도가 훨씬 빨라집니다. 테스트가 이미 기록되었으므로 테스트 데이터를 준비하거나 데이터베이스와 상호 작용할 필요가 없습니다.

4. CI/CD와의 손쉬운 통합

   Keploy는 CI/CD 파이프라인과 원활하게 통합되어 더 빠른 피드백을 제공하고 전반적인 생산성을 향상시킵니다. 데이터베이스 상태나 수동 테스트 설정에 대한 걱정 없이 지속적인 통합 프로세스의 일부로 기록된 API 테스트를 쉽게 실행할 수 있습니다.

5. 종합적인 테스트 범위

   Keploy는 실제 API 상호 작용을 기록하므로 보다 정확하고 완전한 테스트 범위를 달성할 수 있습니다. Keploy는 이렇게 기록된 상호 작용을 재생함으로써 수동으로 작성된 테스트로는 완전히 포착할 수 없는 실제 상황의 극단적인 사례를 시뮬레이션할 수 있습니다.

Playwright에서 Keploy로 마이그레이션하는 단계

이 가이드의 데이터베이스로 Postgres를 사용하여 NextJS에서 간단한 사용자 관리 애플리케이션을 실행하겠습니다.

1단계: 현재 API 테스트 설정 평가

마이그레이션을 시작하기 전에 먼저 Playwright에서 작성한 기존 API 테스트를 평가했습니다. 여기에는 다음이 포함됩니다.

• 테스트 중이었던 모든 API 요청과 응답을 검토합니다.

• 각 테스트에 필요한 설정을 문서화합니다(예: 데이터베이스 상태 및 모의 데이터).

• 전체 테스트 제품군을 실행하여 기존 문제를 확인하고 테스트 적용 범위 데이터를 수집합니다.

내 애플리케이션에 대한 극작가 테스트는 app.spec.ts 테스트 폴더 아래에 있습니다.

import { test, expect } from '@playwright/test';

const apiUrl = 'http://localhost:3000/api/users';  // Application is running on port 3000

test.describe('User API Tests', () => {

    // Test GET request (Fetch all users)
    test('GET /api/users should return a list of all users', async ({ request }) => {
        const response = await request.get(apiUrl);
        expect(response.status()).toBe(200);  // Ensure status code is 200
        const body = await response.json();
        expect(body.users).toBeInstanceOf(Array);
    });    
});

현재 테스트 상황을 명확하게 이해하고 나면 이제 조치를 취해야 할 때입니다.

2단계: Keploy 설치 및 환경 설정

다음 단계는 테스트 환경에 Keploy를 설치하는 것이었습니다. Keploy의 설치 프로세스는 간단하고 간단하며 Keploy GitHub 저장소에서 자세한 지침을 확인할 수 있습니다. 설치 후 터미널에서 빠른 확인을 실행하여 설정을 확인할 수 있습니다.

이를 통해 Keploy가 올바르게 설치되어 사용할 준비가 되었음을 확인했습니다.

3단계: Keploy와의 API 상호작용 기록

Keploy는 테스트 실행 중에 발생하는 실제 API 상호 작용을 기록하는 방식으로 작동합니다. 이러한 상호 작용을 포착하려면 평소와 같이 Playwright 테스트를 실행해야 하지만 이번에는 Keploy 녹화 모드를 사용하여 실행해야 합니다. 설정 방법은 다음과 같습니다.

1. Docker Compose 또는 다른 설정을 사용하여 애플리케이션과 데이터베이스를 시작하세요.

2. 기록 모드에서 Keploy를 실행하여 실제 API 상호 작용을 캡처하세요.
   

keploy record -c "npm run dev"

이 명령은 Keploy에게 Playwright 테스트에서 생성된 모든 HTTP 요청과 응답을 캡처하도록 지시했습니다.

극작가 테스트 스위트를 실행해 봅시다 -

Keploy가 극작가로 작성된 기존 테스트 스위트의 일부인 각 테스트 케이스를 기록하는 것을 볼 수 있습니다.

Keploy에서 생성된 각 테스트 사례는 Playwrigth 테스트 사례입니다. –

test('POST /api/users should create a new user', async ({ request }) => {
        const newUser = {
            name: 'John Do',
            email: 'johndoee@xyz.com'
        };

        const response = await request.post(apiUrl, {
            data: newUser
        });

        expect(response.status()).toBe(200);  // Ensure status code is 200
        const body = await response.json();
        expect(body.users[0]).toHaveProperty('id');  // Check if the first user in the array has an ID
        expect(body.users[0].name).toBe(newUser.name);
        expect(body.users[0].email).toBe(newUser.email);
    });


    // Test PUT request (Update an existing user)
    test('PUT /api/users should update an existing user', async ({ request }) => {
        // First, create a new user to update
        const newUser = {
            name: 'Jane Doe',
            email: 'janedoe@example.com'
        };

        let response = await request.post(apiUrl, {
            data: newUser
        });

        // Check if the POST request was successful
        expect(response.status()).toBe(200); // Ensure status code is 200
        const createdUser = await response.json();
        expect(createdUser.users).toHaveLength(1);
        const userId = createdUser.users[0].id;

        // Prepare the updated user data
        const updatedUser = {
            id: userId,
            name: 'John Deo',
            email: 'updated@example.com'
        };

        // Make the PUT request to update the user
        response = await request.put(apiUrl, {
            data: updatedUser
        });

        // Check if the PUT request was successful
        expect(response.status()).toBe(200);
        const body = await response.json();

        // Check if the updated fields match the new values
        expect(body.users[0].name).toBe(updatedUser.name);
        expect(body.users[0].email).toBe(updatedUser.email);
    });    

    // Test DELETE request (Delete a user)
    test('DELETE /api/users should delete a user', async ({ request }) => {
        // First, create a user to delete
        const newUser = {
            name: 'Mark Doe',
            email: 'markdoe@example.com'
        };

        let response = await request.post(apiUrl, {
            data: newUser
        });

        // Check if the response body is empty or invalid
        if (!response.ok()) {
            console.error('Failed to create user', await response.text());
            expect(response.ok()).toBe(true);  // Fail the test if the response is not OK
        }

        const createdUser = await response.json();
        if (!createdUser || !createdUser.users || createdUser.users.length === 0) {
            console.error('Invalid response format:', createdUser);
            throw new Error('Created user response format is invalid');
        }

        const userId = createdUser.users[0].id;  // Accessing the ID of the newly created user

        // Delete the created user
        response = await request.delete(apiUrl, {
            data: { id: userId }  // Sending the ID of the user to be deleted
        });

        // Check if the delete response is valid
        expect(response.status()).toBe(200);  // Ensure status code is 200
        const body = await response.json();
        expect(body.users[0].id).toBe(userId);  // Ensure the correct user is deleted
    });

4단계: 기록된 상호 작용을 테스트로 재생

상호작용이 기록되면 Keploy는 해당 테스트 사례를 자동으로 생성했습니다. 다음은 그러한 keploy 테스트 사례 중 하나입니다. –

이러한 테스트는 라이브 데이터베이스와 같은 외부 종속성이 필요 없이 독립적으로 실행될 수 있습니다. 내가 해야 할 일은 Keploy의 테스트 스위트를 실행하는 것뿐이었습니다:

import { test, expect } from '@playwright/test';

const apiUrl = 'http://localhost:3000/api/users';  // Application is running on port 3000

test.describe('User API Tests', () => {

    // Test GET request (Fetch all users)
    test('GET /api/users should return a list of all users', async ({ request }) => {
        const response = await request.get(apiUrl);
        expect(response.status()).toBe(200);  // Ensure status code is 200
        const body = await response.json();
        expect(body.users).toBeInstanceOf(Array);
    });    
});

이 명령은 기록된 상호 작용의 재생을 트리거하여 실제 데이터베이스 없이 API를 테스트했습니다.

결론

Playwright에서 Keploy로 마이그레이션한 것은 내 API 테스트 프로세스에 획기적인 변화를 가져왔습니다. Keploy가 최신 API 테스트에 훨씬 더 적합한 이유를 간단히 요약하면 다음과 같습니다.

• 더 이상 데이터베이스 문제가 발생하지 않습니다: Keploy를 사용하면 라이브 데이터베이스가 필요하지 않으므로 테스트를 더 빠르고 쉽게 관리할 수 있습니다.

• 제로 코드 테스트: 더 이상 반복적인 테스트 코드가 없습니다. Keploy는 데이터 모의 작업부터 테스트 생성까지 모든 것을 자동화합니다.

• 원활한 CI/CD 통합: Keploy는 기존 CI/CD 파이프라인에 완벽하게 적합하여 피드백 주기를 가속화하고 생산성을 높입니다.

• 현실적인 테스트 범위: Keploy는 실제 API 상호 작용을 캡처하여 포괄적인 테스트 범위와 신뢰할 수 있는 결과를 보장합니다.

Playwright의 API 테스트 복잡성으로 인해 어려움을 겪고 계시다면 Keploy를 사용해 보시기를 적극 권장합니다. API 테스트를 자동화하는 쉽고 강력하며 효율적인 방법이므로 인프라 설정 및 데이터 관리에 씨름하는 대신 고품질 소프트웨어 구축에 집중할 수 있습니다.

위 내용은 API 테스트를 위한 극작가 대안의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!