Cypress 를 이용한 웹 화면 테스트

개요

웹 개발을 진행할 때 기능이 완료되면 기본적으로 개발자가 테스트를 진행하게 됩니다. 테스트를 꼭 해야하는데 지루하고 반복적인 하기 싫은 과정입니다. 특히 입력화면을 테스트 할 때 필요한 값을 입력하고 선택하고 버튼을 클릭해서 실제 사용자가 사용하는 것 처럼 여러번 반복해야 합니다. 이런 귀찮은 작업을 자동화할 수 있는 Cypress 가 있습니다.

Cypress

Cypress 는 브라우저에서 동작하는 것을 테스트 할 수 있는 프로그램(프레임워크)입니다. Selenium 과 비슷한 역할을 한다고 이해하시면 됩니다. Selenium 이 더 오래되었지만 개인적으로는 Cypress 가 Javascript 를 사용해서 스크립트를 작성할 수 있어 더 접근성이 좋다고 생각됩니다.

화면내에 있는 항목을 위치로 판단하는 것이 아니라 이름이나 아이디로 직접 참조하는 방식입니다. 참조 후 글자를 입력하거나 선택, 클릭 등 여러가지 동작을 적용할 수 있습니다.

게시판 글쓰기 테스트

간단한 게시판 글쓰기 화면이 있다고 가정하고 간단하게 테스트 스크립트를 작성해 보겠습니다.

설치는 이곳을 참조하셔서 진행하시면 됩니다. 개발 환경에 따라 선호하는 방식으로 설치하시면 됩니다. 필자는 윈도우용 바이너리 파일을 받아서 압축을 풀어 실행한 후 스크립트를 오픈해서 테스트를 진행하는 방식으로 하겠습니다.

Cypress 프로그램을 실행하면 다음과 같은 화면이 나타납니다.

Cypress 실행화면
Cypress 실행화면

스크립트가 있는 폴더를 드래그 하거나 선택합니다. 필자가 만든 D:\temp\cypress_board_test 폴더를 드래그 하면 다음과 같은 화면이 나타납니다.

폴더를 드래그 한 후 화면
폴더를 드래그 한 후 화면

기본적으로 예제를 포함해 줍니다. 그리고 기준이 되는 폴더 하위에 cypress 폴더가 생성됩니다. 그 하위에 integration 폴더가 생성되고 여기에 스크립트 파일을 하나 생성합니다. 그러면 다음과 같은 화면이 됩니다.

프로젝트 폴더 오픈 후 integration 폴더에 boardwrite.js 파일 생성
프로젝트 폴더 오픈 후 integration 폴더에 boardwrite.js 파일 생성

테스트 대상이 되는 화면의 소스는 다음과 같습니다. 간단한 게시판으로 생각하시면 되고 개발하고 계신 화면에 적용하셔도 됩니다.

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
        <div>
            제목 : <input type="text" name="subject" id="subject" />
        </div>
        <div>
            글쓴이 : <input type="text" name="writer" id="writer" />
        </div>
        <div>
            종류 : <input type="radio" name="type" id="text" />text <input type="radio" name="type" id="html" />html
        </div>
        <div>
            <textarea rows="20"cols="80" placeholder="내용" name="content" id="content"></textarea>
        </div>
        <div>
            <button type="button" onclick="save();" id="saveButton">등록</button>
        </div>
    </form>
</body>
</html>
<script>
    function save() {
        alert('Save click');
    }
</script>

boardwrite.js 파일의 내용은 다음과 같습니다. 손에 익은 텍스트 에디터를 이용해서 수정하시면 됩니다.

describe('Write board script', () => {
  it('Write board', () => {
      cy.visit('https://localhost:44364/frm_write.aspx')
      cy.get('input[name="subject"]').type('제목입니다.')
      cy.get('input[name="writer"]').type('글쓴이')
      cy.get('#html').check()

      cy.get('textarea[name="content"]').type("<p>내용입니다.<br/>test</p>")
      cy.get('#saveButton').click()
  })
})

3행은 특정한 사이트를 방문하도록 하는 명령입니다. 개발하고 계신 주소를 입력하시면 됩니다. 4행은 이름이 subject 인 항목에 글자를 입력하라는 명령입니다. 5행도 같은 명령입니다. 6행은 html 이라는 아이디를 가진 항목을 선택하라는 명령입니다. 글을 쓰는 폼에 있는 html 항목을 선택하게 됩니다.

8행은 textarea 에 내용을 입력하는 명령입니다. 9행은 아이디가 saveButton 인 항목을 클릭하라는 명령입니다.

boardwrite.js 파일을 클릭하면 브라우저가 실행되면서 스크립트가 실행됩니다.

boardwrite.js 파일 실행결과
boardwrite.js 파일 실행결과

실행한 명령어의 내역이 좌측에 나타나고 우측에 지정한 주소의 화면이 나타납니다. 만일 화면내에 지정한 이름이나 아이디를 가진 항목이 없으면 다음과 같이 오류가 발생합니다. 스크립트 파일을 수정하고 저장하면 자동으로 테스트가 다시 시작됩니다.

이름이 subject1 으로 입력되어 오류가 발생한 상황
이름이 subject1 으로 입력되어 오류가 발생한 상황

어느 부분에서 오류가 발생했는지 상세하게 알려줍니다. 설명을 잘 보고 이에 따라 수정하시고 저장하시면 다시 테스트가 수행됩니다.

아주 기초적인 내용만 다루었지만 예제 파일과 문서에 있는 내용을 참조하시면 더 복잡한 테스트에도 적용하실 수 있을 겁니다. 단순 반복되는 테스트는 Cypress 에게 맡기고 창의적인 작업에 더 시간을 쓰실 수 있으면 좋겠습니다.

Android 앱 개발 전 확인사항

개요

얼마전 개발 중인 android 앱을 올리고 검토가 완료되기를 기다렸습니다. 알림 메일이 도착했는데 앱이 거부되었다는 내용이었습니다. 이전에 앱들은 거부된 적이 한번도 없었는데 어떻게 된 것인지 확인해 보았습니다. 앱의 주요기능을 구현하기 위해 민감한 정보로 분류된 권한을 manifest에 추가했고 그에 따른 필수 기능이 구현되지 않아 발생한 문제였습니다.

앱 등록 거부알림
앱 등록 거부알림

참고 정보

알림 메일 내에는 어떤 정보를 참조하라고 안내되어 있습니다. 대략 무엇이 문제인지 짐작은 할 수 있습니다. 그러나 정확하게 어떤 부분이 문제라고 꼭 집어 알려주지 않습니다. 메일내에 참고 링크가 있는데 다음과 같습니다.

개발자 정책 센터

권한

SMS 또는 통화 기록 권한 그룹 사용

필자의 경우 SMS와 통화 기록 권한 관련한 권한이 문제였습니다. 앱을 의도한 대로 구동하려면 기본 SMS 핸들러 기능을 모두 구현해야 했습니다. 그리고 앱 정보 등록 시 앱 콘텐츠 > 민감한 앱 권한 화면에서 권한에 따른 앱 기능을 선택해야 합니다. 구글에서 이 정보와 앱이 구현된 것이 일치하지 않는다고 판단되면 거부됩니다.

SMS 및 통화 기록 권한 핵심 기능 선택
SMS 및 통화 기록 권한 핵심 기능 선택

요청한 권한에 따라 이것을 달라질 수 있습니다. 필자의 경우 개발을 거의 마친 상태에서 이런 사실을 알게 되었습니다. 앱 사용자 입장에서는 나의 정보가 최소 범위로 제공되고 사용되어야 하는 것이 맞습니다. 개발하는 입장에서는 구글에서 검토와 승인이 잘 되도록 하는 것이 상황에 따라서는 매우 어려울 것 같다는 생각이 들었습니다. 위 이미지에 있는 핵심 기능 이라고 나열되어 있는 항목 중 딱 이것이라고 생각되는 것이 없었습니다. 그래서 비슷한 것으로 선택을 했는데 결국 거부되었습니다. 이러저리 바꾸어 보고 앱의 설명도 첨부해 보았지만 소용없었습니다.

앱 개발 전 사전 검토

기획 단계에서 필요한 권한을 예상해 보고 나열해 봅니다. 혹시 그것이 민감한 정보에 관계된 것인지 확인합니다. 권한 요청 없이 구현할 수 있다면 최대한 그렇게 합니다(ex:SMS 전송 권한 대신 intent 사용). 구글의 승인을 받아야 하는 권한을 최소화 합니다. 아예 없게 만드는 것이 가장 이상적입니다. 이것을 개발이 진행된 상태에서 알게된다면 이전 작업내용을 전혀 다른 형태로 다시 만들어야 할 수도 있습니다. 대체되는 방법으로 구현했으나 초기 기획 의도와는 맞지 않게 될 수도 있습니다. 앱이 거부되었는데 그것을 해결하는데 매우 많은 시간과 노력이 든다면 바람직하지 않을 것입니다. 처음부터 문제가 될 부분을 인식하고 최대한 피해가는 것이 합리적입니다.

독자분들은 제가 했던 실수를 반복하지 않기를 바랍니다.