GMS UnitTest Tutorial(2)

2021-03-03 Write UnitTest code

---

Summary

지난시간에 REST_API 명세를 살펴봄에 이어서 이번에는 직접 실질적인 Unit Test code를 작성해보는 시간을 가졌다.

GMS

먼저 시작 전에 MOCK_ETCD=1 prove -lvm -Ilibgms -I../GSM/lib 으로 test code 한번 돌려보고 시작하자.

All tests successful 로 잘 돌아간다는 멘트가 나왔다면, 시작할 수 있다.

오늘은 GMS 하위의 .gitlab-ci.yml 파일을 들여다 보는 것으로 시작한다.

image: "centos:7" #어떤 docker 이미지를 사용할건지. (unit test 는 도커를 사용하기때문)

variables: # 환경변수
    GIRASOLE_ROOT: "/tmp/girasole"

before_script:
    - |
        echo "
        [anystor-e]
        name=AnyStor Enterprise Repository for production
        baseurl=http://abs.gluesys.com/repo/anystor/3.0/os/x86_64
        enabled=1
        gpgcheck=0

        [anystor-e-testing]
        name=AnyStor Enterprise Repository for development
        baseurl=http://abs.gluesys.com/repo/testing/3.0/os/x86_64
        enabled=1
        gpgcheck=0

        [anystor-e-debuginfo]
        name=AnyStor Enterprise Repository for DebugInfo
        baseurl=http://abs.gluesys.com/repo/anystor/3.0/debuginfo
        enabled=0
        gpgcheck=0

        [anystor-e-testing-debuginfo]
        name=AnyStor Enterprise Repository for DebugInfo
        baseurl=http://abs.gluesys.com/repo/testing/3.0/debuginfo
        enabled=0
        gpgcheck=0" > /etc/yum.repos.d/anystor-e.repo
    - yum clean all
    - >
        yum install -y
        git etcd jq rpm-build expect cifs-utils nfs-utils bonnie++ ntpdate
        perl-enum perl-Env perl-Test-Harness perl-Devel-Leak-Object
        perl-Devel-NYTProf perl-Devel-Cover perl-Test-Class-Moose
        perl-Test-MockModule perl-Mock-Sub perl-Array-Diff perl-XML-Smart
        perl-DateTime perl-DateTime-Format-Strptime
        perl-Module-Load perl-Module-Loaded
        perl-Mouse perl-MouseX-Foreign perl-MouseX-NativeTraits
        perl-Etcd perl-Coro perl-Coro-Multicore
        perl-Data-Compare perl-Data-Validator perl-Data-Validate-IP
        perl-Data-Dump perl-IPC-Cmd perl-File-chmod-Recursive
        perl-File-Copy-Recursive perl-Filesys-Statvfs perl-Socket6
        perl-Net-IP perl-Hash-Merge perl-Net-OpenSSH
        perl-AnyEvent perl-AnyEvent-HTTP
        perl-Mojolicious perl-Mojolicious-Plugin-OpenAPI
        perl-Sys-Syslog perl-MojoX-Log-Log4perl perl-Switch
        perl-Sys-Hostname-FQDN perl-IO-Interface perl-Digest-SHA
        perl-IO-Compress perl-libintl
        perl-Number-Bytes-Human perl-Filesys-Df perl-File-Slurp
        perl-Net-Netmask perl-Proc-Exists perl-String-Util perl-TimeDate
        perl-Mojo-JWT perl-CryptX perl-Crypt-AES-CTR perl-Crypt-OpenSSL-RSA
        samba-client cifs-utils perl-Tree-Simple
    - git clone http://jenkins:JzGRBbyEXa7tN-1zam6N@gitlab.gluesys.com/gitlab/potatogim/GSM.git ${GIRASOLE_ROOT} 
    #  클론을 받아오는데 계정에 대한 토큰을 미리 받아올 수 있음.( 클론 받아올 계정명:access token~~) 패스워드가 아니여도 이런식으로 clone 받을 수 있다.

# 여기서부터 실제 test.
unittest: # gitlab ci 에 들어가보면 나오는 unittest . (각  step 을 나타냄)
  script:
    - pwd
    - env
    - cover -delete
    - >
      MOCK_ETCD=1 TEST_VERBOSE=1 HARNESS_PERL_SWITCHES=-MDevel::Cover
      prove -lvm -Ilibgms -I${GIRASOLE_ROOT}/lib t/unit.t :: --statistics
    - cover -ignore_re '^t/prove' # ignore regular expression (예외 추가)
  artifacts: #artifacts (test 결과물 중 보관대상) 을 어떻게 보관할건지. 
    when: always #항상 만들것이다.
    paths:
      - cover_db # 
      - unit.log # unit test 돌렸을 때 log 남는것
    expire_in: 1 week   #일주일간 킵. 이후 만기.

이러한 형태로 존재하는 .gitlab-ci 야맬 파일을 유심히 볼 필요가 있다.
주석으로 작성해 놓은 설명을 읽어보고 진행하자.

먼저 어떤 part의 unit-test code를 작성할 건지 한번 coverage 정보를 살펴보자.

gitlab - CI/CD 에 올라온 Pipelines 를 보면, 맨 우측에 다운로드 버튼이 있고 artifact를 다운할 수 있게 되어있다.

zip 파일을 다운받아서 압축 해제 후, 안의 coverage.html 파일을 열어보면 다음과 같은 화면이 띄워진다.

여기서 많은 것들 중, libgms-Account-Local pm 을 살펴보자.
오늘은 이 Account::Local 에서도 check 메서드에 대한 test code를 작성해 볼 것이다.

먼저 다음과 같이 표시되는 table에서 각 column 이 의미하는 바가 뭐지 살펴보자.

• stmt : statement. 단일 code, 단일 구문에 대한 cover.
• bran : branch. 분기문에 대한 cover.
• cond : condition. 조건 자체에 대한 cover.
• sub   : subroutine. 호출이 안되는 함수가 있느지 확인.

이 중에서 밑으로 쭉 내리다가 만나는 빨간색 part (아직 test code 작성되지 않은 부분) check 메서드의 cond 부분에 under line이 그어져 있는 부분을 클릭해 보자.

이런 식으로 화면이 띄워진다. libgms 하위의 Account::Local 의 66 line으로 가보자.

이렇게 분기문이 존재한다. 이 부분을 검증해주는 code가 존재하지 않는다는 뜻이다.

그럼 이 부분에 대해 test code를 작성해 보자.

GMS/t/lib/Test/ 하위에 Account directory 를 생성하고, 그 안에 Local.pm 파일을 생성하자.

기본적으로 test를 하기 위한 template은 다른 아무 test 파일을 참조하여 가져온다.

Account::Local 의 check 메서드를 검증하는 test code이다. 따라서 subroutine 명으로 test_check 를 작성한다.

이제 test_check 메소드만 작성하면 된다.

자. 어떻게 생각이 흘러가야 할까? 먼저 Account::Local의 check method를 살펴보자.

Account::Local 의 check에서는 분기문으로 passwd_file, group_file, shawdow_file 이 각각 읽히는지를 확인하고 있다.
이 파일들이 무엇인지부터 확인해야 겠다.

Account::Local에서는

Account::Local::Config
Account::Local::User
Account::Local::Group 
Account::Local::Subgroup

들을 상속받고 있다.

상위 경로로 올라가서 Account/Local 하위로 들어가보자.
User.pm 과 Group.pm 등 확인해보고 싶은 파일들이 존재한다.
각각에서 살펴보니 역시 passwd_file, group_file, shawdow_file 속성들이 무엇인지 정의하고 있다.

이제 이 파일들이 무엇인지도 확인하였으니, test code를 작성해 보자.

sub test_check : Tests(no_plan)
{
    my $self = shift;


    mkdir('/tmp/etc'); # /etc/passwd 같은 파일을 변경하게 되면 안되므로, /tmp 디렉토리 하위에 etc dir를 생성하고 작업한다.
    my $fh;

    # Mock_up

    my $obj = Account::Local->new( # Class Object를 생성할 때, 각 속성들을 parameter로 전달하여 설정한다.
        passwd_file => '/tmp/etc/passwd',
        shadow_file => '/tmp/etc/shadow',
        group_file => '/tmp/etc/group',
    );

    $obj->check(); # Account::Local::check() 호출.

    cmp_ok($obj->check(), '==', 0, 'check()_success');  # cmp_ok(실행값, 비교 연산자, 기댓값, test description)
    
    foreach my $file ('/tmp/etc/passwd', '/tmp/etc/shadow', '/tmp/etc/group')
    # for문 순회로 각 파일들을 하나씩 unlink(파일 삭제) 해봄.
    # 이로써 파일을 하나씩 못 읽는 
    {
        unlink($file);
        cmp_ok($obj->check(), '==', -1, 'check()_failure');
        open($fh, '>', $file);
        close($fh);
    }
}

이와 같이 작성한다.

Class 객체 생성 시 parameter로 속성값들을 전달하여 초기화 시키는 것 처럼,
기존의 file을 건드리지 않고, Test file을 별도로 만드는 것을 Mock_up 이라 한다.

Mock_up 의 방식에는 Class method 를 overriding 하는 방식 등 여러가지가 존재하나,
상황에 맞춰 적합한 방식을 택하는 것이 중요하다.
(Test code 작성할 때 마다 팀장님꼐 어떠한 방식으로 Mock_up 할 지 조언을 구하자.)

(중요!! 원래는 항상 실패지점부터 시작해야 한다. 지금 작성된 code는 여러 실패를 거치며 모든 경우를 포함한 결과이다.)

이렇게 test code를 작성했으면,
(코드는 몇 줄 안되나 여기까지 생각해내는 것이 쉽지만은 않다.)

다음과 같은 분기문 조건들을 모두 확인한 것이다.
이제 test를 돌리고 이 표가 모두 초록색으로 채워지는지 확인해보자.

unit test 실행하는 명령어는 익숙하다시피
MOCK_ETCD=1 prove -lvm -Ilibgms -I../GSM/lib으로 실행하면 된다.
여기에 :: --classes Test::Account::Local 을 추가하여 해당 test module만 테스트를 진행할 수 있다는 것도 지난시간에 살펴보았다.

Unit Test 를 돌려본다.

성공을 확인한다.

Coverage

Test 결과가 success 인지 failure 인지 와는 별개로, 우리는 해당 condition을 모든 조건에서 확인하는 test code를 작성하였다.

이것을 반영하여 coverage 결과를 살펴보자. 어떻게 해야할까?

앞서 언급했던 .gitlab-ci.yml 파일을 살펴본다.
(.gitlab-ci.yml 파일은 실제로 GitLab - CI 에서 동작하는 것들을 단편적으로 수행시킬 수 있도록 해준다.)

unittest 하위에 실행 명령어로 MOCK_ETCD=1 TEST_VERBOSE=1 HARNESS_PERL_SWITCHES=-MDevel::Cover prove -lvm -Ilibgms -I${GIRASOLE_ROOT}/lib t/unit.t :: --statistics 가 보인다.

참고하여 다음을 입력한다.

MOCK_ETCD=1 TEST_VERBOSE=1 HARNESS_PERL_SWITCHES=-MDevel::Cover prove -lvm -Ilibgms -I../GSM/lib :: --classes Test::Account::Local

(실행되기 위해선 cpanm MDevel::Cover를 설치해야 함.)

이후 test 결과가 나오면 (성공, 실패 여부는 관계없음.)
cover 명령어를 입력한다.

이와 같이 맨 밑에 HTML이 다음 경로에 저장되었다는 출력 메세지가 나온다.
경로에 들어가서 coverage.html 파일을 확인해보자.

Account::Local의 check method - coverage 표가 이렇게 채워졌음을 확인할 수 있다.

또한, 이번 경우엔, 분기문에 대한 test code를 작성하므로써 이렇게 다른 column
(statement, branch, subroutine)들도 test 했다는 결과를 얻게 되었다.

이렇게 coverage 까지 확인한 후, 마지막으로
GitLab remote repository에 commit 과 Merge request 를 올리면 된다.

Commit & Merge Request

앞으로 작성할 unit test code들은
fork를 떠 온 나의 개인 project에서 branch 하나를 생성, 그 branch에서 test code 작성 후, remote (ac2) master에 merge request 를 올리는 방식으로 작업하게 될 것이다.

Local에서 git commit -s -m "Commit message" 를 이용하여 커밋
(좀 더 상세히 작성할 필요가 있을 시에는 commit -s 만 입력하여 vi 창으로 넘어가 메세지를 detail하게 적도록 하자)
후, git push origin unit-test 로 나의 remote branch 에 push 한다.

이후 GitLab 에 접속하여 Merge Request - New merge request 를 클릭하여
Source branch와 Target branch를 적절히 선택해 준 후, Merge Request를 요청하면 된다.