docurun

다큐런

DocuRun은 문서를 통합 테스트로 실행하는 도구입니다.

왜 ?

귀하의 통합 테스트 와 문서 모두 실망스러울 것입니다.

• 통합 테스트는 아마도 작성하기 어렵고, 읽기 어렵고, 디버깅하기 어려울 것입니다. 문제가 발생하면 코드를 자세히 살펴보고 브라우저에서 수동으로 수행한 작업과 다른 점을 추측해야 합니다.
• 개발자가 코드를 변경할 때마다 업데이트하는 것을 원하지 않기 때문에 최종 사용자 설명서가 최신이 아닐 수 있습니다. 버튼의 문구를 변경할 때 문서의 스크린샷을 업데이트해야 한다는 사실을 기억해야 합니다. 그렇지 않을 수도 있습니다.

사용자 인터페이스의 문서화된 동작을 깨뜨리는 변경을 수행하는 경우 사용자가 불만을 제기할 때만 알 수 있습니다.

다큐런(DocuRun)이란 무엇인가요?

DocuRun은 극작가 코드 블록을 포함한 마크다운 파일을 가져와 통합 테스트로 실행하는 도구입니다. 테스트 중에 찍은 스크린샷이 포함된 아름다운 문서 웹 사이트를 생성합니다.

도큐런 이용방법

1. 애플리케이션 사용 방법을 설명하는 코드 블록을 포함하여 마크다운 파일로 문서를 작성하세요. 다음과 같은 docurun/index.md 파일을 만듭니다.
2. 마크다운 파일에서 DocuRun을 실행하세요.

   npx docurun

3. Docurun은 어떤 마크다운 파일이 성공적으로 실행되었고 어떤 파일이 실패했는지 보여주는 멋진 보고서를 표준 출력에 표시합니다. 모든 테스트가 통과하면 종료 코드가 0이 되고, 일부 테스트가 실패하면 1이 되므로 CI/CD 파이프라인에 쉽게 통합할 수 있습니다. 또한 문서와 스크린샷이 포함된 정적 웹사이트가 포함된 docurun/website/ 디렉터리도 생성됩니다. 일부 테스트가 실패한 경우 문서에는 실패 당시 페이지의 스크린샷과 오류 메시지가 포함됩니다.

도커

기계에 node.js를 설치할 필요 없이 docker 컨테이너에서 DocuRun을 실행할 수도 있습니다.

docker run -v $( pwd ) /docurun:/docurun -it lovasoa/docurun

Docker Hub의 lovaoa/docurun을 참조하세요.

스크린샷

SQL페이지

이는 SQLPage 웹 사이트 구축 도구의 실행 가능한 문서를 보여줍니다.

Github 스타

오류

오류 실행은 터미널에서 다음과 같습니다.

 $ npx docurun

> [email protected] start
> node cli.js

Processing all files in ./docurun/:
 - download_sqlpage.md
 - star_a_repository.md.
Saving results to ./docurun/website/.

✅ download_sqlpage
Error while executing code:
await page.getByText('inexistent element').click()

locator.click: Timeout 30000ms exceeded.
Call log:
  - waiting for getByText('inexistent element')

 star_a_repository

그리고 렌더링되었습니다: