例としてDAOを使用したEthereumスマートコントラクトのテスト

Ethereumプラットフォームでスマートコントラクトを作成する場合、開発者はメソッドがコントラクトの状態をどのように変更するか、どのイベントを発行するか、いつ、誰に資金を転送する必要があるか、いつ例外をスローするかを定義する特定の作業ロジックを作成します。 スマートコントラクト用のデバッグツールはまだあまり開発されていないため、テストはしばしば必要な開発ツールになります。 各変更後に契約を実行することは、非常に長いプロセスになる可能性があります。 また、エラーが発生した場合、ネットワークにデプロイされた契約のコードを変更することはすでに不可能です。契約を破棄して新しい契約を作成することしかできないため、テスト、特に支払い方法をできるだけ徹底的に実行する必要があります。 この記事では、 Solidityのスマートコントラクトを作成およびデバッグするときに開発者が直面するいくつかのテスト手法を紹介します。

分散型自律組織（DAO）

2016年の夏、THE DAOとの物語はセンセーショナルであり、攻撃者はそこから多額の資金を盗みました 。 DAOは組織として位置付けられるスマートな契約であり、そのすべてのプロセスはブロックチェーン環境で動作するコードによって記述されますが、法人ではなく、すべての投資家によって集合的に管理されます。 3月に、DAO開発者はテストの重要性を強調し、 PythonとJavascriptを混合したフレームワークを使用したテストでスマートコントラクトをカバーしましたが、残念ながらテストは後の脆弱性を閉じませんでした。



たとえば、 DAOスマートコントラクトコードは大きすぎるため、テストオブジェクトとして、 http： //ethereum.orgのブロックチェーンに民主主義を構築する方法の記事で説明されているDAOの原則を実装する議会スマートコントラクトを取り上げます。 将来的には、スマートコントラクトの開発の基本原則に精通していることが前提となります。

スマートコントラクトのテスト方法

一般的な原則は、他のコードのテストに似ています-一連の参照メソッド呼び出しが事前定義された環境で作成され、結果ステートメントが書き込まれます。 テストには、BDD-Behavior Driven Development Practicesを使用すると便利です。テストと一緒に、ドキュメントと使用例を作成できます。

テストツール

多くのイーサリアムスマートコントラクトテストフレームワークとライブラリが開発されました。

トリュフ

Truffle v.2では、MochaフレームワークとChaiライブラリを使用して、JavaScriptでテストが開発されています。 バージョン3では、 Solidityのテストを作成する機能が追加されています 。

まだら

DAppleでは、特別に開発された基本的なスマートコントラクトの方法を使用して、Solidityにテストが実装されます。

Embarkjs

EmbarkJSでは、アプローチはTruffleに似ており、テストはJavascriptで記述され、Mochaフレームワークが使用されます。



Solidityのテストの開発はこの言語の機能によって非常に制限されているため、Javascriptを使用します。すべての例ではTruffle Frameworkを使用します。 また、 truffle-contractやtruffle-artifactorなどのTruffle Frameworkコンポーネントを使用して、スマートコントラクトと対話するためのカスタムソリューションを作成できます。

テストクライアント

ブロックチェーンシステム、特にイーサリアムは非常に高速に動作しないため、テストには「テスト」ブロックチェーンクライアントを使用します。たとえば、 イーサリアムクライアントのJSON RPC APIをほぼ完全にエミュレートするTestRPCです。 TestRPCは、標準のメソッドに加えて、テスト時にevm_increaseTime 、 evm_mineなどの使用に便利ないくつかの追加メソッドも実装します。



別の方法として、標準クライアントの1つを使用する方法があります。たとえば、パリティはdevモードで動作し 、トランザクションは即座に確認されます。 さらなる例では、TestRPCが使用されます。

環境設定

テストクライアント

npmを介したインストール：

npm install -g ethereumjs-testrpc
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

TestRPCは別のターミナルで実行する必要があります。 テストを開始するたびに、テストクライアントは10個の新しいアカウントを生成します。各アカウントには既に資金が配置されています。

トリュフフレームワーク

npmを介したインストール：

 npm install -g truffle
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

プロジェクト構造を作成するには、truffle initコマンドを実行する必要があります

 $ mkdir solidity-test-example $ cd solidity-test-example/ $ truffle init
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コントラクトはコントラクト/ディレクトリに配置する必要があります。コントラクトをコンパイルするとき、Truffle Frameworkは各コントラクトが個別のファイルに配置されることを期待し、コントラクトの名前はファイルの名前と等しくなります。 テストはtest /ディレクトリに配置されます。 truffle initコマンドが実行されると 、Metacoin et al。テストコントラクトも作成されます。



さらなる例では、プロジェクトhttps://github.com/vitiko/solidity-test-exampleが使用されます。これには、 議会のスマート契約コードとそのテストが含まれています。 テストはTruffle v.2環境で実行されます。最近リリースされたv.3バージョンでは、Truffleによって生成されたコードの接続と、状態変更メソッドを呼び出した後に返されるトランザクションデータ形式にわずかな違いがあります。

Truffleフレームワークに基づいたテスト開発

テスト組織

テストではJavaScriptオブジェクトを使用します。これは、コントラクトの操作、オブジェクトの操作とEthereumクライアントメソッドのJSON RPC呼び出し間のマッピングの抽象化です。 これらのオブジェクトは、ソースコード* .solファイルのコンパイル時に自動的に作成されます。 すべてのメソッドの呼び出しは非同期であり、Promiseを返します。これにより、トランザクション確認の追跡を心配する必要がなくなり、すべてがTruffleコンポーネントの「内部」で実装されます。



Truffle Frameworkサイトの例では、.then（）チェーンを使用した記述スタイルを使用しています。 大規模なシナリオを説明する場合、テストコードは非常に膨大です。 async / awaitを使用したテストコードははるかに簡潔で読みやすいため、このスタイルのテストを使用します。 また、開発者のサイトの例では、スマートコントラクトのインスタンスが使用されており、そのデプロイは移行で規定されています 。 移行とテストインスタンスの作成を混在させないために、テストで明示的に作成する方が便利です。このため、各テスト関数を呼び出す前に、コントラクトの新しいインスタンスを作成するコードを使用できます。 以下の例は、 Congressオブジェクトのインスタンスが作成されるbeforeEach関数を示しています。

 const congressInitialParams = { minimumQuorumForProposals: 3, minutesForDebate: 5, marginOfVotesForMajority: 1, congressLeader: accounts[0] }; let congress; beforeEach(async function() { congress = await Congress.new(...Object.values(congressInitialParams)); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

スマートコントラクトのステータスをテストする

まず、スマートコントラクトの状態を変更するaddMemberメソッドをテストしてみましょう。このメソッドは、 メンバー構造の配列にDAOメンバーに関する情報を書き込む必要があります。





テストでは、テストアカウントで配列を使用して、参加者を契約に追加します。 次に、members関数（ members構造体の配列のゲッター）が入力されたデータを返すことを確認します。 addMemberメソッドを呼び出すたびに、トランザクションが作成され、ブロックチェーンの状態が変化することに注意してください。 情報は分散レジストリに記録されます。

 it("should allow owner to add members", async function() { //  3  for (let i = 1; i <= 3; i++) { let addResult = await congress.addMember(accounts[i], 'Name for account ' + i); //    members      2. // .. members[0] - empty, members[1] - ,   (. ) let memberInfoFromContract = await congress.members(i + 1); //  members(pos)       Member //  [0] -   , [1] -    assert.equal(memberInfoFromContract[0], accounts[i]); assert.equal(memberInfoFromContract[1], 'Name for account ' + i); } });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

イベントテスト

イーサリアムのイベントには、かなり普遍的なアプリケーションがあり、使用できます。

• 以下を含む、契約の状態を変更するメソッドから値を返す ユーザーインターフェースへ
• スマートコントラクトのステータスの履歴を作成するには
• 情報の安価なストレージとして（イベントログにデータを配置するコストは、契約の状態よりもはるかに安価です）

次の例では、 議会の契約に提案を追加するnewProposalメソッドを呼び出すときに、 Proposal Addedイベントのレコードが作成されることを確認します





これを行うには、テストで最初にDAOメンバーを作成し、彼に代わって提案を作成します。 次に、 ProposalAddedイベントのサブスクライバーを作成し、 newProposalメソッドの呼び出し後にイベントが発生し、その属性が送信されたデータに対応することを確認します。

 it("should fire event 'ProposalAdded' when member add proposal", async function() { let proposedAddedEventListener = congress.ProposalAdded(); const proposalParams = { beneficiary : accounts[9], etherAmount: 100, JobDescription : 'Some job description', transactionBytecode : web3.sha3('some content') }; await congress.addMember(accounts[5], 'Name for account 5'); await congress.newProposal(...Object.values (proposalParams), { from: accounts[5] }); let proposalAddedLog = await new Promise( (resolve, reject) => proposedAddedEventListener.get( (error, log) => error ? reject(error) : resolve(log) )); assert.equal(proposalAddedLog.length, 1, 'should be 1 event'); let eventArgs = proposalAddedLog[0].args; assert.equal(eventArgs.proposalID , 0); assert.equal(eventArgs.recipient , proposalParams.beneficiary); assert.equal(eventArgs.amount , proposalParams.etherAmount); assert.equal(eventArgs.description , proposalParams.JobDescription); }); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

エラーテストとメッセージ送信者の検証

コントラクトメソッドの操作を中断する標準的なメソッドは、 throwステートメントを使用して作成できる例外です。 メソッドへのアクセスを制限する必要がある場合など、例外が必要になる場合があります。 これを行うために、メソッドを呼び出したアカウントのアドレスをチェックする修飾子が実装され、条件を満たさない場合、例外がスローされます。 たとえば、コントラクトの所有者がaddMemberメソッドを呼び出した場合に例外がスローされることを確認するテストを作成しましょう。 以下のコードでは、 議会の契約がアカウント[0]に代わって作成され、次にaddMemberメソッドが別のアカウントに代わって呼び出されます。

 it("should disallow no owner to add members", async function() { let addError; try { //  ,  accounts[0] != accounts[9] await congress.addMember(accounts[1], 'Name for account 1', { from: accounts[9] }); } catch (error) { addError = error; } assert.notEqual(addError, undefined, 'Error must be thrown'); //      ,       //  "invalid JUMP" assert.isAbove(addError.message.search('invalid JUMP'), -1, 'invalid JUMP error must be returned'); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

スマートコントラクトの現在の時刻を使用して、スマートコントラクトのバランスの変化をテストする

おそらく、DAOの原則を実装する議会のスマートコントラクトの最も重要な機能は、 executeProposal機能です。この機能は、提案が必要な投票数を受け取ったことを確認し、提案の議論がスマートコントラクトの作成時に設定された最低必要時間以上続いた後、受益者に送金します議論中の提案。





経過時間をシミュレートするために、 testrpcに 実装されているevm_increaseTimeメソッドを使用します。これを使用して、クライアントブロックチェーンの内部時間を変更できます。

 it("should pay for executed proposal", async function() { const proposalParams = { beneficiary: accounts[9], etherAmount: 1, JobDescription: 'Some job description', transactionBytecode: web3.sha3('some content') }; //    accounts[9]   executeProposal let curAccount9Balance = web3.eth.getBalance(accounts[9]).toNumber(); //  ,         //     accounts[9] await congress.newProposal(...Object.values(proposalParams), { from: accounts[0] //accounts[0]  , ..      }); //  DAO,      //     3    //   3  DAO     0    for (let i of[3, 4, 5]) { await congress.addMember(accounts[i], 'Name for account ' + i); await congress.vote(0, true, 'Some justification text from account ' + i, { from: accounts[i] }); } //    let curProposalState = await congress.proposals(0); //   ,       //  .  //... //    testrpc  10 ,    //       minutesForDebate (5) await new Promise((resolve, reject) => web3.currentProvider.sendAsync({ jsonrpc: "2.0", method: "evm_increaseTime", params: [10 * 600], id: new Date().getTime() }, (error, result) => error ? reject(error) : resolve(result.result)) ); //    -  3  “”, //      await congress.executeProposal(0, proposalParams.transactionBytecode); // ,     accounts[9] //   ,     let newAccount9Balance = web3.eth.getBalance(accounts[9]).toNumber(); assert.equal(web3.fromWei(newAccount9Balance - curAccount9Balance, 'ether'), proposalParams.etherAmount, 'balance of acccounts[9] must increase to proposalParams.etherAmount'); let newProposalState = await congress.proposals(0); assert.isOk(newProposalState[PROPOSAL_PASSED_FIELD]); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ヘルパー関数

テストの記述プロセスでは、例外のチェック、イベントログの受信、テストクライアントの時刻の変更など、テスト中に頻繁に使用される操作に便利な機能が役立ちました。 関数はパッケージhttps://www.npmjs.com/package/solidity-test-utilでホストされ、コードはgithubでホストされます。 以下は、 testUtil.assertThrow関数を使用して例外をチェックする例です。

 it("should disallow no owner to add members", async function() { await testUtil.assertThrow(() => congress.addMember(accounts[1], 'Name for account 1', { from: accounts[9] })); });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

solidity-test-util関数を使用した他の例については、 こちらをご覧ください 。

おわりに

テストの開発の結果、スマートコントラクトの作業の正確性の自動検証と、一般に、他のプログラムコードのテストについて言えるすべての仕様と使用例の両方が得られます。