웹개발 및 최신 테크 소식을 전하는 블로그, 웹이즈프리
웹사이트를 개발 후 다양한 테스트 도구들이 필요합니다. 물론 테스트 도구가 반드시 필요한 것은 아니지만 더 완성도 높은 웹사이트를 만들면서 버그를 줄이고 유지보수가 용이한 웹사이트를 만들어야겠죠. 결국 보다 완벽한 테스트 코드를 작성하고 지속적인 검증과 수정하는 과정이 필요합니다.
e2e 테스트는 최종 단계의 테스트 도구로 이 전 단계의 테스트에서 발견하지 못한 이슈들을 발견하고 검증하는 효과적인 툴입니다. 이 중에서도 많이 사용되는 툴 중 하나인 Puppeteer 사용시 코드 내부에 지연시간을 만드는 방법을 알아보겠습니다.
Cypress 등과 더불어 FrontEnd에서 인기있는 e2e 테스트 도구이면서 웹스크랩퍼, 크롤링 도구로도 사용되는 Puppeteer가 많이 사용되는데요 여기서는 Puppeteer 내부에서 지연시간(delay)을 발생시키는 방법에 대하여 알아보려고 합니다. 그 전에 왜 지연시간이 필요할까요?
1. 사용자 행동 시뮬레이션 : Puppeteer를 사용하여 클릭이나 스크롤 이동 등등 실제 방문자의 행동을 비슷하게 코드로 구현할 수 있습니다. 이 경우 일정시간 만큼의 지연시간을 발생시켜야 하겠죠.
2. 네트워크 호출 대기 : Ajax 등을 사용한 네트워크 호출이 발생하는 경우 이를 기다리기 위한 지연시간 확보가 필요할 수 있습니다.
3. 애니메이션 완료까지 대기 : 해당 페이지에 애니메이션이 있는 경우 이 시간 이상의 지연시간이 필요할 수 있습니다.
4. 헤드리스 사용하지 않는 경우 : headless: false로 실제 크로미움을 띄워 테스트 코드를 눈으로 확인하기 위한 목적
위의 목적 외에도 더 많은 이유가 있을 수 있겠으나 가장 큰 목적은 위의 방법들이라 할 수 있습니다. 필요한 이유를 알아봤으니 바로 Puppeteer를 사용하는 테스트 코드에 지연시간을 설정하는 방법과 몇 가지 예제를 함께 살펴보겠습니다.
가장 먼저 우리가 잘 알고 있고 익숙한 자바스크립트의 함수를 사용하는 방법입니다. 시간 지연을 위해서 setTimeout 함수와 Promise를 함께 사용할 수 있죠. Puppeteer에서 이를 추가해 사용하는 예제를 만들어보겠습니다.
위 delayTime 함수는 일정 시간이 지난 후에 Promise의 resolve()를 실행시켜 다음 동작이 가능하도록 만든 간단한 지연함수입니다. 만약 3초 후 다음 코드를 실행하기 위해서 원래의 코드 안의 필요한 곳에 아래처럼 추가해 사용하면 됩니다.
참고로 await은 async와 반드시 함께 사용되야 한다는 점 잊지 마세요. async/await !!
다음 방법은 Puppeteer의 내장 메서드를 사용하는 방법입니다. 다른 테스트 도구들처럼 Puppeteer 역시 자체 시간지연 메서드를 제공하고 있습니다. 바로 page.waitForTimeout입니다. 자체 메서드를 사용하면 보다 간단한 코드 작성이 가능합니다.
이 방법도 매우 쉽게 지연시간을 만들 수 있습니다. 이처럼 위의 두 가지 방법을 사용하면 간단하게 지연시간을 발생시킬 수 있게 됩니다.
여기까지 Puppeteer 테스트 코드 내부에 지연시간을 발생시키는 방법을 알아보았는데요 아무런 조건 없이 지연시간을 발생시키는 방법이 특징입니다. 만약 특정 조건 아래의 지연시간이 필요하다면? 이 외에 아래와 같은 방법으로 지연시간을 발생시키는 방법도 존재합니다.
일반적으로 지연시간이 필요한 이유는 네트워크나 사용자 인터렉션, 애니메이션 등이 사용될 경우 이를 기다리는 목적이 크겠습니다. 만약 다음 테스트 코드가 특정 버튼 요소를 클릭하기 위해서 지연시간이 필요한 경우라면? Puppeteer의 내장 메서드 중 하나인 page.waitForSelector()를 사용할 수 있습니다. 이 메서드는 해당 선택 요소가 나타나게 될 때까지 지연하게 만드는 메소드입니다.
await page.waitForSelector(selector)
만약 좀 더 빠른 테스트 결과가 필요한 경우라면? 처음 방법처럼 고정된 지연시간을 사용하는 것보다 위의 waitForSelector()처럼 정해진 조건에 따라 지연시간을 발생하는 방법이 훨씬 빠르고 동작하게됩니다.
이제 실제 동작하는 코드를 만들어 보겠습니다. 아래와 같이 지연시간이 필요한 부분에 선택자를 page.waitForSelector()를 추가해 사용하도록 합니다.
위 코드를 추가하면 매우 간단하게 해당 엘리먼트가 노출될 때까지 기다렸다가 다음 코드를 실행하게 됩니다.
@ 만약 특정 조건이 참인 경우까지 지연하는 방법은?
좀 더 범용적으로 사용할 수 있는 방법도 존재하는데요 바로 page.waitForFunction() 메서드입니다. 이 메서드는 매개변수로 함수를 전달하며 이 함수에 사용된 조건이 참을 반환할 때까지 지연되도록 합니다. 아무래도 가장 많은 조건들에 사용될 수 있다는 장점이있습니다.
await page.waitForFunction(Function)
여기서 Function은 반드시 참을 반환해야 다음 코드가 실행될 수 있을 것 입니다. 아래는 간단한 예제입니다.
@ button 선택자 요소가 3개 이상이 될 때까지 지연시간 발생하는 코드
위 코드는 button 엘리먼트가 3개 이상이 될 때까지 지연하게 만드는 매우 쉽고 효과적인 코드입니다. 이 메서드만 알고 잘 사용하면 여러 조건들을 만족하는 지연시간을 쉽게 만들 수 있게합니다.
여기까지 Puppeteer에서 지연시간을 도입하는 다양한 방법을 소개해보았습니다. 테스트 코드를 잘 작성하는 것은 매우 중요한데요 ~ e2e 테스트의 경우 생각보다 지연시간을 함께 사용할 경우가 많으니 알아두시면 좋겠습니다.
e2e 테스트는 최종 단계의 테스트 도구로 이 전 단계의 테스트에서 발견하지 못한 이슈들을 발견하고 검증하는 효과적인 툴입니다. 이 중에서도 많이 사용되는 툴 중 하나인 Puppeteer 사용시 코드 내부에 지연시간을 만드는 방법을 알아보겠습니다.
e2e 테스트 도구인 Puppeteer에서 지연시간 설정하여 사용하는 방법
Cypress 등과 더불어 FrontEnd에서 인기있는 e2e 테스트 도구이면서 웹스크랩퍼, 크롤링 도구로도 사용되는 Puppeteer가 많이 사용되는데요 여기서는 Puppeteer 내부에서 지연시간(delay)을 발생시키는 방법에 대하여 알아보려고 합니다. 그 전에 왜 지연시간이 필요할까요?
e2e 테스트 코드 내부에 지연시간이 필요한 이유는?
1. 사용자 행동 시뮬레이션 : Puppeteer를 사용하여 클릭이나 스크롤 이동 등등 실제 방문자의 행동을 비슷하게 코드로 구현할 수 있습니다. 이 경우 일정시간 만큼의 지연시간을 발생시켜야 하겠죠.
2. 네트워크 호출 대기 : Ajax 등을 사용한 네트워크 호출이 발생하는 경우 이를 기다리기 위한 지연시간 확보가 필요할 수 있습니다.
3. 애니메이션 완료까지 대기 : 해당 페이지에 애니메이션이 있는 경우 이 시간 이상의 지연시간이 필요할 수 있습니다.
4. 헤드리스 사용하지 않는 경우 : headless: false로 실제 크로미움을 띄워 테스트 코드를 눈으로 확인하기 위한 목적
위의 목적 외에도 더 많은 이유가 있을 수 있겠으나 가장 큰 목적은 위의 방법들이라 할 수 있습니다. 필요한 이유를 알아봤으니 바로 Puppeteer를 사용하는 테스트 코드에 지연시간을 설정하는 방법과 몇 가지 예제를 함께 살펴보겠습니다.
1. setTimeout 또는 Promise 사용하기
가장 먼저 우리가 잘 알고 있고 익숙한 자바스크립트의 함수를 사용하는 방법입니다. 시간 지연을 위해서 setTimeout 함수와 Promise를 함께 사용할 수 있죠. Puppeteer에서 이를 추가해 사용하는 예제를 만들어보겠습니다.
function delayTime(ms) {
return new Promise(function(resolve) {
setTimeout(resolve, ms);
});
}
return new Promise(function(resolve) {
setTimeout(resolve, ms);
});
}
위 delayTime 함수는 일정 시간이 지난 후에 Promise의 resolve()를 실행시켜 다음 동작이 가능하도록 만든 간단한 지연함수입니다. 만약 3초 후 다음 코드를 실행하기 위해서 원래의 코드 안의 필요한 곳에 아래처럼 추가해 사용하면 됩니다.
await delayTime(3000);
console.log('다음 동작 실행')
console.log('다음 동작 실행')
참고로 await은 async와 반드시 함께 사용되야 한다는 점 잊지 마세요. async/await !!
2. Puppeteer의 내장 메서드 page.waitForTimeout 사용하기
다음 방법은 Puppeteer의 내장 메서드를 사용하는 방법입니다. 다른 테스트 도구들처럼 Puppeteer 역시 자체 시간지연 메서드를 제공하고 있습니다. 바로 page.waitForTimeout입니다. 자체 메서드를 사용하면 보다 간단한 코드 작성이 가능합니다.
await page.waitForTimeout(3000);
console.log('3초 후 다음 동작 실행')
console.log('3초 후 다음 동작 실행')
이 방법도 매우 쉽게 지연시간을 만들 수 있습니다. 이처럼 위의 두 가지 방법을 사용하면 간단하게 지연시간을 발생시킬 수 있게 됩니다.
여기까지 Puppeteer 테스트 코드 내부에 지연시간을 발생시키는 방법을 알아보았는데요 아무런 조건 없이 지연시간을 발생시키는 방법이 특징입니다. 만약 특정 조건 아래의 지연시간이 필요하다면? 이 외에 아래와 같은 방법으로 지연시간을 발생시키는 방법도 존재합니다.
특정 요소가 나타날 때까지 지연하는 방법
일반적으로 지연시간이 필요한 이유는 네트워크나 사용자 인터렉션, 애니메이션 등이 사용될 경우 이를 기다리는 목적이 크겠습니다. 만약 다음 테스트 코드가 특정 버튼 요소를 클릭하기 위해서 지연시간이 필요한 경우라면? Puppeteer의 내장 메서드 중 하나인 page.waitForSelector()를 사용할 수 있습니다. 이 메서드는 해당 선택 요소가 나타나게 될 때까지 지연하게 만드는 메소드입니다.
await page.waitForSelector(selector)
만약 좀 더 빠른 테스트 결과가 필요한 경우라면? 처음 방법처럼 고정된 지연시간을 사용하는 것보다 위의 waitForSelector()처럼 정해진 조건에 따라 지연시간을 발생하는 방법이 훨씬 빠르고 동작하게됩니다.
이제 실제 동작하는 코드를 만들어 보겠습니다. 아래와 같이 지연시간이 필요한 부분에 선택자를 page.waitForSelector()를 추가해 사용하도록 합니다.
await page.waitForSelector(selector);
위 코드를 추가하면 매우 간단하게 해당 엘리먼트가 노출될 때까지 기다렸다가 다음 코드를 실행하게 됩니다.
@ 만약 특정 조건이 참인 경우까지 지연하는 방법은?
좀 더 범용적으로 사용할 수 있는 방법도 존재하는데요 바로 page.waitForFunction() 메서드입니다. 이 메서드는 매개변수로 함수를 전달하며 이 함수에 사용된 조건이 참을 반환할 때까지 지연되도록 합니다. 아무래도 가장 많은 조건들에 사용될 수 있다는 장점이있습니다.
await page.waitForFunction(Function)
여기서 Function은 반드시 참을 반환해야 다음 코드가 실행될 수 있을 것 입니다. 아래는 간단한 예제입니다.
@ button 선택자 요소가 3개 이상이 될 때까지 지연시간 발생하는 코드
await page.waitForFunction(() => {
return document.querySelectorAll('button').length >= 3;
});
return document.querySelectorAll('button').length >= 3;
});
위 코드는 button 엘리먼트가 3개 이상이 될 때까지 지연하게 만드는 매우 쉽고 효과적인 코드입니다. 이 메서드만 알고 잘 사용하면 여러 조건들을 만족하는 지연시간을 쉽게 만들 수 있게합니다.
마치면서
여기까지 Puppeteer에서 지연시간을 도입하는 다양한 방법을 소개해보았습니다. 테스트 코드를 잘 작성하는 것은 매우 중요한데요 ~ e2e 테스트의 경우 생각보다 지연시간을 함께 사용할 경우가 많으니 알아두시면 좋겠습니다.
아래의 글도 찾고 계시지 않나요?
