2017-07-10

sinonでmockしてみた

やってみた

内容は以下のような感じで、Node.js ネイティブ環境では動かないオブジェクトに対して、それでも期待通りに呼び出されたかどうかを確認するためのテスト。

describe('SpreadsheetApp return ActiveSheet', ()=> {
  it('called getActiveSheet() once', ()=> {
    // まず Node.js 環境で動かないメソッド呼び出しを stub out
    // SpreadsheetApp -> Spreadsheet -> Sheet の構造があって、
    // getActiveSheet() は中間のオブジェクトの持つメソッドで、どうやっても動かせない
    // これを spreadsheet.book().sheet() の構造にマップしようとしている
    // getActiveSheet() メソッドを持つダミーのオブジェクトを返すメソッドを stub out
    sinon.stub(spreadsheet, 'book').returns({getActiveSheet: function() { return {} }})

    // stub out したメソッドを mock にして期待する動作を設定
    let book = sinon.mock(spreadsheet.book())
    book.expects('getActiveSheet').once()

    // メソッドを実行したのち、結果の verify
    spreadsheet.sheet()
    book.verify()
  })
})

※ もちろんこれをコピペしても動きません

ポイント

  • 恐らくイマドキ JavaScript のテストのかなりの割合は Node.js 上で実行されている
  • Node.js 環境には存在しないオブジェクト、メソッドに対して期待する振る舞いを記述するために、まず stub out する(でないと実際に呼び出されてしまったらエラーになる)
  • そのうえで stub out したメソッドが期待通り呼び出されたかどうかを mock で verify する

で、たぶん合ってると思います。間違えてたら教えてくだしあ。

参考

Sinon.JS - Standalone test spies, stubs and mocks for JavaScript. Works with any unit testing framework.

この中の mock の記述、分かったような分からないような感じなんですよね。というか RSpec の時もそうだったんだけど、mock の説明の記述って汎用的に書かれているとほんとによく分からないので、個人的には RR の記述が分かりやすくてよかったのでオススメです。

RR - a test double framework for Ruby

RR は RR の記述そのものがすごくシンプルで分かりやすく、意味の方に集中しやすくてよいです。(が、RSpec 3+ とは完全には統合できないので注意が必要)

About

例によって個人のなんちゃらです

Recent Posts

Categories

Tool 日々 Web Biz Net Apple MS ことば News Unix howto Food PHP Movie Edu Community Book Security Text TV Perl Ruby Music Pdoc 生き方 RDoc ViewCVS CVS Rsync Disk Mail FreeBSD Cygwin PDF Photo Zebedee Debian OSX Comic Cron Sysadmin Font Analog iCal Sunbird DNS Linux Wiki Emacs Thunderbird Sitecopy Terminal Drawing tDiary AppleScript Life Money Omni PukiWiki Xen XREA Zsh Screen CASL Firefox Fink zsh haXe Ecmascript PATH_INFO SQLite PEAR Lighttpd FastCGI Subversion au prototype.js jsUnit Apache Trac Template Java Rhino Mochikit Feed Bloglines CSS del.icio.us SBS qwikWeb gettext Ajax JSDoc Rails HTML CHM EPWING NDTP EB IE CLI ck ThinkPad Toy WSH RFC readline rlwrap ImageMagick epeg Frenzy sysprep Ubuntu MeCab DTP ERD DBMS eclipse Eclipse Awk RD Diigo XAMPP RubyGems PHPDoc iCab DOM YAML Camino Geekmonkey w3m Scheme Gauche Lisp JSAN Google VMware DSL SLAX Safari Markdown Textile IRC Jabber Fastladder MacPorts LLSpirit CPAN Mozilla Twitter OpenFL Rswatch ITS NTP GUI Pragger Yapra XML Mobile Git Study JSON VirtualBox Samba Pear Growl Mercurial Rack Capistrano Rake Win RSS Mechanize Sitemaps Android JavaScript Python RTM OOo iPod Yahoo Unicode Github iTunes God SBM friendfeed Friendfeed HokuUn Sinatra TDD Test Project Evernote iPad Geohash Location Map Search Simplenote Image WebKit RSpec Phone CSV WiMAX USB Chrome RubyKaigi RubyKaigi2011 Space CoffeeScript Nokogiri Hpricot Rubygems jQuery Node GTD CI UX Design VCS Kanazawa.rb Kindle Amazon Agile Vagrant Chef Windows Composer Dotenv PaaS Itamae SaaS Docker Swagger Grape WebAPI Microservices OmniAuth HTTP 分析基盤 CDN Terraform IaaS HCL Webpack Vue.js BigQuery Middleman CMS AWS PNG Laravel Selenium OAuth OpenAPI GitHub UML GCP TypeScript SQL Hanami Document SVG AsciiDoc Pandoc DocBook Develop Jekyll macOS Node.js Vite Heroku Transformer AI Data Cloud Wasm