Cypress는 자바스크립트 애플리케이션을 위해 특별히 개발된 유명한 테스트 플랫폼입니다. 주로 사용자 인터페이스(UI) 구성 요소와 브라우저 내 상호 작용을 평가하는 데 중점을 두고 있지만, API 검사에도 탁월한 능력을 발휘합니다. 이 프레임워크를 활용하면 HTTP 요청을 통해 RESTful API에 대한 테스트를 수행하고 해당 응답을 확인할 수 있습니다.
Cypress를 활용하면 웹 애플리케이션의 라이프사이클 전체를 처음부터 끝까지 포괄하는 테스트 스위트를 생성할 수 있습니다.
Cypress를 사용한 API 테스트 시작하기
Cypress를 활용하면 애플리케이션의 API(애플리케이션 프로그래밍 인터페이스)가 의도한 사양을 준수하는지 여부를 검증할 수 있습니다. 일반적으로 여기에는 API의 종료 지점, 입력 데이터, 하이퍼텍스트 전송 프로토콜(HTTP) 반응에 대한 면밀한 조사가 포함됩니다. 또한 API와 외부 서비스 간의 일관성을 검증하고 오류 관리 시스템의 효과도 검증할 수 있습니다.
애플리케이션 프로그래밍 인터페이스(API) 테스트를 통해 애플리케이션의 기능, 신뢰성 및 적합성을 보장합니다. 이 프로세스를 통해 라이브 환경에서 문제가 발생하기 전에 문제를 식별하고 수정할 수 있으므로 잠재적인 합병증을 최소화할 수 있습니다.
Cypress 는 널리 사용되는 일부 JavaScript 프레임워크에서 사용되는 훌륭한 UI 테스트 도구입니다. HTTP 요청을 생성하고 테스트하는 기능 덕분에 API 테스트에도 똑같이 효과적입니다.
Node.js는 HTTP 요청을 만드는 엔진 역할을 하며, 단일 스레드에서 실행되는 JavaScript 코드를 사용하여 데이터 스트림을 가볍고 효율적으로 처리하는 이벤트 중심 비차단 I/O 모델을 통해 정교한 방식으로 응답을 처리합니다.
이 프로젝트의 소스 코드는 관련된 모든 파일과 문서의 디지털 아카이브 역할을 하는 GitHub 리포지토리를 통해 액세스할 수 있습니다.
Express.js REST API 생성
프로세스를 시작하려면 Express를 사용하여 웹 서버를 설정하고 프로젝트 범위 내에 이 패키지를 통합해야 합니다.
npm install cors
Cypress의 기능을 프로젝트에 통합하려면 Cypress 패키지를 설치해야 합니다. 이 작업은 명령줄 인터페이스를 사용하거나 Visual Studio Code와 같은 통합 개발 환경(IDE)을 통해 수행할 수 있습니다. 설치가 완료되면 웹 애플리케이션 테스트를 위해 Cypress에서 제공하는 모든 기능에 액세스할 수 있습니다.
npm install cypress --save-dev
`package.json` 파일에 테스트 스크립트를 통합하려면 다음 단계를 따르십시오: 1. 텍스트 편집기 또는 IDE에서 프로젝트의 루트 디렉토리를 엽니다. 2. 해당 디렉토리 내에서 `package.json` 파일을 찾아 엽니다. 파일이 없는 경우 `npm init -y`를 실행하여 파일을 생성합니다. 3. 3. ‘스크립트’ 섹션 아래에 “test”라는 이름과 빈 문자열을 값으로 하는 새 키-값 쌍을 추가합니다. 이것은 사용자 정의 스크립트의 자리 표시자 역할을 합니다. 예를 들어 “`bash { “name”: “my-project”, “version”: “0.0.1”, “설명”: “”, “main”: “index.js”, “스크립트”: { “test”:
"test": "npx cypress open"
API 컨트롤러 정의
실제 시나리오를 설명하기 위해 시뮬레이션 API 호출을 통해 데이터베이스 또는 외부 API와 상호 작용하여 데이터를 읽고 쓸 수 있도록 할 것입니다. 그러나 이 특정 사례에서는 실제 API 상호 작용을 활용하지 않고 배열을 조작하여 사용자 정보를 생성하고 검색할 것입니다.
프로젝트의 기본 디렉터리에 “controllers/userControllers.js”라는 제목의 새 파일을 생성하세요. 이 파일 안에 후속 코드 블록을 포함하세요.
사용자 등록 경로를 관리하는 기능을 구현하기 위해 먼저 `userController` 내에 `registerUser` 메서드를 도입해야 합니다. 이 메서드는 들어오는 요청을 처리하고 새로운 사용자 객체의 생성을 처리하는 역할을 담당합니다. 요청 본문에서 사용자 정보를 추출하고 적절한 메서드와 함께 활용하여 새로운 사용자 인스턴스를 생성합니다. 이 작업이 성공적으로 완료되면 컨트롤러는 사용자가 성공적으로 등록되었음을 나타내는 확인 메시지와 함께 201 상태 코드가 포함된 HTTP 응답을 반환합니다.
const users = [];
exports.registerUser = async (req, res) => {
const { username, password } = req.body;
try {
const newUser = { username, password };
users.push(newUser);
res.status(201).send({ message: 'User registered successfully' });
} catch (error) {
console.error(error);
res.status(500).send({ message: 'An error occurred!!' });
}
};
이 대화 앞부분에서 정의한 `getUsers()` 함수를 사용하여 `users` 배열에서 사용자 데이터를 검색하기 위한 추가 경로를 포함하도록 `app.js` 파일을 수정합니다. 새 경로는 사용자 데이터를 JSON 응답으로 반환해야 합니다. 이를 수행하는 방법은 다음과 같습니다: 자바스크립트 const express = require(‘express’); const bodyParser = require(‘body-parser’); const getUsers = require(‘./routes/userRoutes’).getUsers; // ‘userRoutes’ 모듈에서 getUsers() 함수 가져오기 const app = express(); // bodyParser 미들웨어를 사용하여 JSON 요청 본문 파싱하기 app.use(bodyParser.json()); // 모든 사용자를 불러오는 경로를 정의합니다. app.get(‘/api/users’, (req, res) =>
exports.getUsers = async (req, res) => {
try {
res.json(users);
} catch (error) {
console.error(error);
res.status(500).send({ message: 'An error occurred!!' });
}
};
또한 단일 파일 내에 다음 코드를 통합하여 모의 로그인을 수행할 수도 있습니다: ”’자바스크립트 const { users } = require(‘./users’); // 별도의 파일에서 사용자 배열을 가져옵니다. 함수 인증(사용자 이름, 비밀번호) { const foundUser = users.find((user) => user.username === username && user.password === password); return foundUser; }
exports.loginUser = async (req, res) => {
const { username, password } = req.body;
try {
const user = users.find((u) =>
u.username === username && u.password === password);
if (user) {
res.status(200).send({ message: 'Login successful' });
} else {
res.status(401).send({ message: 'Invalid credentials' });
}
} catch (error) {
console.error(error);
res.status(500).send({ message: 'An error occurred!!' });
}
};
API 경로 정의
Express RESTful API의 경로를 설정하기 위해 기본 디렉터리 내에 userRoutes.js 파일을 생성하고 그 안에 후속 코드를 포함시켜야 합니다:
const express = require('express');
const router = express.Router();
const userControllers = require('../controllers/userControllers');
const baseURL = '/v1/api/';
router.post(baseURL + 'register', userControllers.registerUser);
router.get(baseURL + 'users', userControllers.getUsers);
router.post(baseURL + 'login', userControllers.loginUser);
module.exports = router;
Server.js 파일 업데이트
다음과 같은 조정을 포함하여 API에 대해 지정된 구성을 준수하도록 ‘server.js’ 파일의 내용을 세분화하여 수정합니다:
const express = require('express');
const cors = require('cors');
const app = express();
const port = 5000;
app.use(express.json());
app.use(express.urlencoded({ extended: true }));
app.use(cors());
const userRoutes = require('./routes/userRoutes');
app.use('/', userRoutes);
app.listen(port, () => {
console.log(`Server is listening at http://localhost:${port}`);
});
module.exports = app;
테스트 환경 설정
데모 API를 활용하여 이제 테스트 환경을 구축할 준비가 되었습니다. 터미널에서 다음 명령을 실행하여 고급 서버를 시작하세요:
node server.js
그런 다음 독립적인 인터페이스에서 터미널 명령을 사용하여 테스트 스크립트를 실행합니다:
npm run test
이 명령을 실행하면 Cypress 데스크톱 애플리케이션이 시작되어 적절한 테스트 플랫폼을 제공합니다. 프로그램을 열면 “E2E 테스트” 탭으로 이동합니다. 엔드투엔드 테스트의 목적은 서버, 경로 및 해당 컨트롤러 절차에 대한 Cypress 액세스 권한을 부여하여 Express API의 포괄적인 기능을 평가하는 것입니다.
Cypress 구성 파일을 포함하려면 “계속”을 클릭하여 계속 진행하세요.
초기화 프로세스가 성공적으로 완료되면 작업 내에서 외부 Cypress 디렉터리가 인식되어야 합니다. 동시에 Cypress는 시험에 대한 구성을 구성하는 cypress.config.js 문서를 소개합니다.
다음과 같은 방식으로 서버의 기본 주소를 통합하여 이 문서를 자유롭게 수정할 수 있습니다:
const { defineConfig } = require("cypress");
module.exports = defineConfig({
chromeWebSecurity: false,
e2e: {
baseUrl: 'http://localhost:5000',
setupNodeEvents(on, config) {
},
},
});
테스트 케이스 작성
Cypress를 사용하여 테스트 케이스 작성을 시작하려면 먼저 테스트를 실행하기 위해 Cypress 테스트 환경이 제공하는 선택 사항 중에서 웹 브라우저를 선택합니다.
테스트 케이스에 필요한 모든 정보를 입력했으면 메뉴에서 “새 사양 생성” 옵션을 선택합니다. 그런 다음 테스트 파일에 적절한 제목을 지정한 후 ‘스펙 생성’ 버튼을 클릭하여 생성합니다.
Cypress/Fixtures/example.json 파일을 열고 이어지는 사용자 자격 증명을 통합하여 수정하세요. 픽스처는 테스트 인스턴스 내에서 사용할 수 있는 고정 테스트 데이터 세트를 나타냅니다.
{
"username": "testuser",
"password": "password123"
}
Cypress에서 제공하는 기능을 활용하여 cy.request 메서드를 사용하면 웹 서버로 향하는 HTTP 요청을 실행하여 다양한 유형의 엔드포인트 관리를 테스트할 수 있으며, 해당 범위 내에서 GET, POST, PUT, DELETE를 포괄할 수 있습니다.
앞서 설정한 세 가지 API 엔드포인트의 기능을 검증하기 위해 등록 엔드포인트와 관련된 테스트 시나리오를 설명하는 것부터 시작하겠습니다. 이 테스트 시나리오의 목적은 새 사용자 계정을 생성하고 해당 어설션을 확인하여 해당 엔드포인트가 의도한 대로 작동하는지 확인하는 것입니다.
보다 정교한 방식으로 파일을 수정하는 데 도움을 드릴 수 있도록 “cypress/e2e/user.routes.spec.cy.js” 파일의 원본 콘텐츠를 제공해 주시기 바랍니다.
describe('User Routes', () => {
it('registers a new user', () => {
cy.fixture('example').then((testUser) => {
cy.request({
method: 'POST',
url: `${baseUrl}/v1/api/register`,
body: testUser,
}).then((response) => {
expect(response.status).to.eq(201);
expect(response.body.message).to.eq('User registered successfully');
});
});
});
이 검사를 실행하는 동안 Cypress는 픽스처 파일에 포함된 정보를 활용하여 표시된 엔드포인트로 향하는 일련의 POST 요청을 생성합니다. 모든 검증이 사실이면 테스트 인스턴스가 성공한 것으로 간주됩니다. 반대로 전제 조건 중 하나라도 충족되지 않으면 평가는 실패한 것으로 간주됩니다.
Cypress 테스트에 사용되는 구문과 Mocha 테스트의 구문 간의 유사성은 고려해야 할 주목할 만한 측면입니다. Cypress는 Mocha 테스트에서 이 구문을 통합하여 자체 프레임워크의 필수적인 부분으로 만들었습니다.
현재 구현된 테스트는 수신된 응답의 내용에 대한 일련의 어설션을 활용하여 지정된 엔드포인트에 대한 요청의 응답에 관련 사용자 정보가 포함되어 있는지 확인합니다. 이는 아래와 같이 ‘describe’ 블록 내에 특정 어설션 문을 포함시킴으로써 이루어집니다:
it('gets users data and the username matches test data', () => {
cy.fixture('example').then((expectedUserData) => {
cy.request({
method: 'GET',
url: `${baseUrl}/v1/api/users`,
}).then((response) => {
expect(response.status).to.eq(200);
const username = response.body[0].username;
expect(username).to.eq(expectedUserData.username);
});
});
});
결론적으로 등록 및 로그인 엔드포인트 모두에 대한 포괄적인 테스트 사례 세트를 개발하는 것이 필수적입니다. 이러한 테스트는 유효 및 유효하지 않은 입력, 인증 실패, 비밀번호 재설정, 이메일 확인, 사용자 역할 관리, 토큰 해지, 만료 및 세션 처리와 같은 다양한 시나리오를 다루어야 합니다. 원활한 커뮤니케이션과 기능을 보장하기 위해 SMS 서비스 제공업체와 같은 타사 API와의 통합도 테스트해야 합니다. 또한 과부하 상태에서의 시스템 성능과 SQL 인젝션 또는 크로스 사이트 스크립팅(XSS)과 같은 일반적인 웹 공격에 대한 복원력에 대한 철저한 평가도 수행해야 합니다. 마지막으로, 암호화 알고리즘, 보안 스토리지 메커니즘, 액세스 제어 정책을 포함한 강력한 테스트 사례 세트를 통해 보안 조치를 검증해야 합니다.
it('logs in a user', () => {
cy.fixture('example').then((loginData) => {
cy.request({
method: 'POST',
url: `${baseUrl}/v1/api/login`,
body: loginData,
}).then((response) => {
expect(response.status).to.eq(200);
});
});
});
});
Cypress를 사용하여 테스트를 실행하려면 Cypress가 감독하는 웹 브라우저 환경으로 돌아가서 실행하려는 특정 테스트 스크립트 파일을 선택합니다.
Cypress 테스트 러너를 사용하여 일련의 테스트를 실행하고 각 개별 테스트 케이스의 결과를 자세히 설명하는 보고서와 합격 또는 불합격 여부를 표시하는 보고서를 얻습니다.
API의 성능과 안정성을 종합적으로 평가하기 위해서는 단순히 기능적인 측면을 검사하는 것 이상으로 확장된 테스트를 수행하는 것이 중요합니다. 보다 광범위한 테스트 접근 방식을 채택함으로써 시스템 전체의 전반적인 성능과 안정성을 평가할 수 있습니다.
API 테스트에 대한 철저한 접근 방식에는 성능, 내구성, 원활한 작동에 대한 평가와 함께 추가 시스템이 포함되어야 합니다. 테스트 계획에 다양한 평가 기법을 통합하면 광범위한 테스트 범위를 확보할 수 있으므로 API가 실제 사용을 위해 배포되기 전에 유능할 뿐만 아니라 신뢰할 수 있음을 보장할 수 있습니다.
Cypress를 사용하여 전체 웹 경험 테스트
Cypress를 탁월한 리소스로 활용하여 프론트엔드 및 백엔드 구성 요소의 평가를 쉽게 포괄함으로써 웹 애플리케이션에 대한 포괄적인 테스트를 효율적으로 수행합니다.
테스트 환경 생성 프로세스를 간소화하는 직관적인 인터페이스를 자랑하는 소프트웨어입니다. 몇 번의 클릭만으로 프로그램의 다양한 측면을 평가하기 위한 포괄적인 설정을 구축하여 최적의 기능을 보장할 수 있습니다.