[SmartContract] Truffle 에서 Solidity Test Code 작성하기

 

이번에는 truffle 프로젝트에서 solidity 코드에 대한 test code 작성하는 방법을 알아보겠습니다.

단위 테스트는 javascript 또는 solidity 로 테스트 스크립트를 작성하면 됩니다.

 

자바스크립트의 경우, 자바스크립트 테스트 프레임워크인 mocha 를 기반으로 합니다.

트러플로 테스트를 작성하면, contract 를 컴파일하고 수동으로 배포할 필요 없이 migration 으로 배포된 컨트랙트를 참조할 수 있고, 이더리움 주소를 하드코딩하지 않고 암시적으로 계정을 참조할 수 있습니다.

solidity 로 테스트 스크립트를 작성하는 것은 보다 심화적인 내용이라, 이 포스팅에서는 자바스크립트로 작성하는 것을 해보도록 하겠습니다.

 

1) solidity 코드 작성하기

테스트를 위해 HelloWorld Contract 를 다음과 같이 작성해주었습니다. (/contracts/HelloWorld.sol)

pragma solidity >=0.7.0 <0.9.0;

contract HelloWorld {
    string public greet = "Hello World!";
    function echo(string memory _input) external pure returns (string memory){
        return _input;
    }
}

greet 메시지가 있고, echo 함수가 있는 간단한 contract 입니다.

 

migration 도 작성해줍니다. (/migrations/2_HelloWorld_migration.js)

const HelloWorld = artifacts.require("HelloWorld");

module.exports = function (deployer) {
    deployer.deploy(HelloWorld);
};

 

 

2) test script 작성

테스트 코드는 truffle 프로젝트의 test 폴더에 위치해야 합니다.

 

대부분 비동기로 동작하므로, 결과를 assert 하는 부분도 비동기적으로 작성해야 합니다 (Promise, async/await).

왜 비동기냐 하면은, 블록체인 네트워크에 배포되고 block 이 생성되는 데에는 지연 시간이 발생하기 때문입니다.

따라서 로컬 테스트넷을 이용했을 때 지연시간 없이 동작시키면 비동기로 인한 오류가 발생하지 않을 수 있이므로, 실제 환경에서의 동작도 고려한다면 지연시간을 설정하여 (ganache 에서 설정 가능) 테스트해보기를 권장합니다.

 

먼저 greet 메시지에 대한 테스트로 테스트 코드의 구조를 살펴보도록 하겠습니다. (/test/HelloWorldTest.js)

var hello = artifacts.require("HelloWorld")

contract("HelloWorld", function () {
    it ("is_greet_works_well", async function () {
        const instance = await hello.deployed();
        const response = await instance.greet();
        assert.equal(response, "Hello World", "greeting message is wrong");
    })
})

• var hello = artifacts.require("HelloWorld"): HelloWorld contract 를 가져옵니다.
• contract(): 컨트랙트를 배포하고 테스트를 진하는, '단위 테스트 묶음' 입니다. 이 내부에서는 결과가 공유되므로 필요하다면 순서나 연관 관계를 고려해야 합니다. contract() 호출은 모든 컨트랙트가 이더리움 클라이언트에 다시 배포하는 것으로, 깨끗한 상태에서 테스트를 진행할 수 있도록 합니다. 또한, 기본적으로 account[0] 로 contract 를 배포하게 됩니다.
• it(): 하나의 테스트 코드를 시작합니다.
• it ("is_greet_works_well", async function () {}: 테스트 코드 메시지를 적어주고, 해당하는 함수를 작성해줍니다. promise 문법을 사용해도 되지만, 여기서는 async/await 문법을 사용하기 위해 async function 으로 작성해주었습니다. 또한, 현재 HelloWorld 컨트랙트는 아무런 생성 parameter 가 없으므로 인자를 작성하지 않았습니다.
  (주의: async/await 를 사용하려면 Node.js 버전 8.0 이상에서 실행해야 합니다)
• const instance = await hello.deployed(): HelloWorld 컨트랙트가 배포된 instance 를 가져옵니다.
• const response = await instance.greet(): greet 를 실행하고 반환값을 가져옵니다. AAA 레이아웃 (Arrange, Act, Assert) 의 Act 에 해당하는 부분입니다.
• assert.equal(response, "Hello World!", "greeting message is wrong"): 순서대로 비교할 2가지 값, 실패 시 출력할 메시지를 적어줍니다. 여기서는 반환된 response 와 컨트랙트의 greet 에 넣어둔 "Hello World!", 그리고 실패 시 출력할 "greeting message is wrong" 를 넣어주었습니다. AAA 레이아웃 (Arrange, Act, Assert) 의 Assert 에 해당하는 부분입니다.

 

echo() 에 대한 테스트는 이후 살펴보겠습니다.

 

 

3) test

이제 작성한 테스트 코드를 테스트해보도록 하겠습니다.

contract() 에서도 알 수 있듯이, 트러플은 클린룸 테스트를 지원합니다.

즉, 테스트 코드 실행 전에 타켓 네트워크에 마이그레이션을 실행하여 컨트랙트를 처음부터 다시 배포합니다.

따라서 개발 중에는 테스트 네트워크를 설정하여 단위 테스트를 실행하는 것이 좋고, 최종으로는 퍼블릭 네트워크에서 테스트를 실행하는 것이 좋습니다.

 

여기서는 이전 포스팅에서 설정한 development 네트워크에서 실행하도록 하겠습니다.

development 는 기본 네트워크로 인식하므로 따로 명시하지 않아도 되지만, 다음과 같이 명시하여 사용할 수 있습니다.

$ truffle test
$ truffle test --network development // network 명시
$ truffle test ./test/HelloWorldTest.js // 파일 명시

특정 파일만 실행하고 싶다면 경로를 명시하여 실행시킬 수 있습니다.

 

테스트를 실행시키면 먼저 solidity 코드를 컴파일하고 테스팅을 진행합니다.

다음은 위에 작성한 테스트 코드의 실행 결과입니다.

 

Hello World!

contract 이름과 테스트 내용이 보이고, 통과된 것을 알 수 있습니다.

이번에는 테스트 코드를 assert.equal(response, "Hello World", "greeting message is wrong") 로 바꿔서 테스트 오류에 어떤 일이 발생하는지 보도록 하겠습니다.

 

Hello World

 

이렇게 test 가 fail 되었음을 보여주고, assert.equal 에서 오류 메시지로 작성한 내용 ("greeting message is wrong") 이 보이며 예상한 내용 (2번째 인자, Hello World) 와 실제 내용 (Hello World!) 을 보여줍니다.

 

 

+) 추가로 테스트 코드 작성 및 실행

이번에는 HelloWorld 컨트랙트에 있던 echo() 함수를 테스트해보도록 하겠습니다.

테스트 코드는 다음과 같이 Promise 를 사용한 것과 async/await 를 사용한 것을 둘 다 작성해보았습니다.

async/await 로 작성하면 코드의 가독성이 높아지는 것을 볼 수 있습니다.

var hello = artifacts.require("HelloWorld")

contract("HelloWorld", function () {
    it ("is_echo_works_well_async", async function () {
        const instance = await hello.deployed();
        const message = "testing";
        const response = await instance.echo(message);
        assert.equal(response, message);
    })
    it ("is_echo_works_well_promise", function () {
        return hello.deployed().then(function(instance) {
            const message = "testing";
            instance.echo(message).then(function (response) {
                assert.equal(response, message);
            })
        })
    })
})

이제 HelloWorldTest.js 에는 위의 greet 테스트를 합쳐 3가지 테스트 케이스가 있습니다. (물론 2개는 작성 방식만 다른 것이지만...)

 

이를 실행해보면 다음과 같은 결과를 얻을 수 있습니다.

 

 

 

 

이것으로 트러플에서 솔리디티 테스트 코드를 작성하는 방법을 살펴보았습니다.