GAS開発のJestによるモック入り結合テスト仕立て / The way to develop GAS with mocking integration test by Jest

このスライドは
【エンジニア交流会】Google Apps Script 活用ミートアップ #3 (2018-10-17)
https://gaiax.connpass.com/event/101411/
で発表したものです。
Google App Script の開発はお手軽だけど動作確認がポチポチ面倒じゃありませんか？
Jestの強力なモック機能を駆使した結合テストを導入して、かなり楽になった知見を実例を交えてご紹介しようと思いました。

サンプルコードGist
https://gist.github.com/AquiTCD/81294f568b823e5eecca11a182a69e14

---
2019-3-8 追記

現在はWebpackではなくClasp+TypeScriptで書いています。
こちらも参考になれば嬉しいです。

Google App ScriptをTypeScriptとClass構文で書く - 環境導入
https://blog.solunita.net/lean-to-develop-google-app-script-with-typescript-class-setup/

Google App ScriptをTypeScriptとClass構文で書く - 実装
https://blog.solunita.net/lean-to-develop-google-app-script-with-typescript-class-implement/

Transcript

1. ~ ࣮༻ྫΛఴ͑ͯ ~ GAS։ൃͷ JestʹΑΔϞοΫೖΓ ݁߹ςετ࢓ཱͯ 2018-10-17 Google Apps Script ׆༻ϛʔτΞοϓ #3 @AquiTCD
2. GAS ྑ͍Ͱ͢ΑͶʂ ͓खܰͰྑ͍Ͱ͢ΑͶʂ
3. Ͱ΋ ಈ࡞֬ೝπϥ͘ͳ͍ʁ
4. ίʔυΛมߋ GASʹద༻ ϙνϙνΫϦοΫͯ͠ຊ൪Խ ͏·͘ಈ͔͘ͳ…ʁ
5. ໘౗͗͘͢͞Δʂ ϙνϙνΫϦοΫͨ͠Γ… ϒϥ΢βૢ࡞ͨ͠Γ…
6. ͔ͩΒ ࣗಈςετͰ ָ͠·͠ΐ͏Αʂ
7. ࣗݾ঺հ Aqui TSUCHIDA ౔ా ໌৴ @AquiTCD αʔόʔαΠυΤϯδχΞ at झຯ: ϑϩϯτΤϯυ։ൃ #ྉཧ #ےτϨ #ήʔϚʔ #ݩόοΫύοΧʔ https://aquitcd.github.io/Pentazemin/ja/ Pentazemin: Electron੡λεΫ؅ཧΞϓϦ https://aquitcd.github.io/yantan/ja/ YANTAN: Chrome֦ு Rubyist, JSer
8. ΞδΣϯμ - ࠓ೔࿩͢͜ͱ • ςετΛՄೳʹ͢Δ؀ڥ • ࣮ࡍͷέʔεΛྫͱͯ͠঺հ • ݁߹ςετͷͨΊʹ΍Δ͜ͱ ※͜͜Ͱ͸ೖྗ͔Βग़ྗ·Ͱͷςετͱ͠·͢ ࠓ೔࿩͞ͳ͍͜ͱ • ؀ڥߏஙͷࡉ͔͍࿩(clasp, webpackͷಋೖํ๏ͳͲʣ • JestͰͷςετίʔυͷॻ͖ํ αϯϓϧίʔυͷGist: https://gist.github.com/AquiTCD/81294f568b823e5eecca11a182a69e14
9. ؀ڥ ϩʔΧϧ։ൃͰ͖ΔΑ͏ʹ ES6 + Module ςετ؀ڥ Φεεϝ͸3ͭͷηοτ • Clasp https://github.com/google/clasp • Webpack https://webpack.js.org/ • Jest https://jestjs.io/ja/
10. Clasp is Կʁ ϩʔΧϧͰ։ൃͰ͖ΔͱԿ͕͍͍ͷʁ • Git؅ཧͰ͖Δ • Linter, Formatter͕ޮ͘ • ES6ͷه๏Ͱॻ͚Δ • ςετ͕ॻ͚ͯճͤΔ $ clasp push $ clasp deploy ͳͲͰຊ൪ద༻Ͱ͖ͪΌ͏ ϩʔΧϧ؀ڥͰGASΛ։ൃͰ͖ΔCLIπʔϧ = εΫϦϓτΤσΟλ಺Ͱॻ͔ͳ͍͍ͯ͘
11. Webpack ͱ Jest • JSͷ͋Ε΍͜Ε΍ΛΨονϟϯί • ඞਢͰ͸ͳ͍ͷͰผͷπʔϧͰ΋Մ • Jest • facebook੡ͷςετπʔϧ • ΦʔϧΠϯϫϯ • ڧྗͳϞοΫϥΠϒϥϦΛ಺ଂ
12. ྫ IF GitHubʹ ϓϧϦΫΤετ͕Ͱ͖ͨΒ THEN Chatworkʹ ௨஌͍ͤͨ͞
13. GitHub Chatwork GAS Webhook: JSON API: TEXT Sheets 設定を参照 doPost(e)
14. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
15. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
16. Jestʹάϩʔόϧࢦఆ • package.json ͷ Jest config
17. Jestʹάϩʔόϧࢦఆ • package.json ͷ Jest config globals ʹ ࢖༻ͯ͠Δ ૊ΈࠐΈΫϥεΛ એݴ͢Δ
18. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
19. GASͷ૊ΈࠐΈΫϥεΛϞοΫ SpreadSheet ͷ ֤ Sheet ΛϞοΫίʔυͰදݱ͢Δʹ͸
20. GASͷ૊ΈࠐΈΫϥεΛϞοΫ
21. GASͷ૊ΈࠐΈΫϥεΛϞοΫ globals Ͱઃఆͨ͠ SpreadSheetApp ͷ getActiveSpreadSheet ϝιουͰ SpreadSheet ΠϯελϯεΛฦ͢Α͏ʹ Jest.fn() ͰϞοΫ
22. GASͷ૊ΈࠐΈΫϥεΛϞοΫ SpreadSheet Λ new ͨ͠Β Sheet ʹ໊લΛ͚ͭͯ new ͢ΔΑ͏ʹϞοΫ
23. GASͷ૊ΈࠐΈΫϥεΛϞοΫ getSheetByName() ϝιου͸ sheet ΠϯελϯεΛฦ͢ϞοΫ࣮૷
24. GASͷ૊ΈࠐΈΫϥεΛϞοΫ • repos γʔτ
25. GASͷ૊ΈࠐΈΫϥεΛϞοΫ • members γʔτ
26. GASͷ૊ΈࠐΈΫϥεΛϞοΫ
27. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 1ߦ͸1ͭͷ഑ྻ ෳ਺ߦ͸ߦͷ഑ྻͷ഑ྻ
28. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 1ߦ͸1ͭͷ഑ྻ ෳ਺ߦ͸ߦͷ഑ྻͷ഑ྻ
29. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 1ߦ͸1ͭͷ഑ྻ ෳ਺ߦ͸ߦͷ഑ྻͷ഑ྻ
30. GASͷ૊ΈࠐΈΫϥεΛϞοΫ Sheet Ϋϥεʹ ࢖༻ͯ͠ΔϝιουΛ γϛϡϨʔτͨ͠ϞοΫ࣮૷Λ͢Δ
31. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
32. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ • package.json ͷ Jest config globals ʹ ࢖༻ͯ͠Δ ϥΠϒϥϦͷ ΫϥεΛએݴ͢Δ
33. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ
34. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ Underscore ͸ lodash ΛಡΈࠐΉ͜ͱͰ୅ସ Moment ͸ Moment.moment ͱͳΔΑ͏ʹ एׯ࢖͍ํ͕ҟͳΔͷͰɺҾ਺Λ౉͢Α͏ʹ୅ସ
35. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ APIΛ sendMessage Λ୯७ʹreturn͢ΔΑ͏ϞοΫ → ͜ͷ໭Δ `msgObj` ΛΞαʔγϣϯʹ͔͚Δ͜ͱͰ ςετ͕ՄೳʹͳΔ ChatWorkClient ͷ Client ΛϞοΫ࣮૷
36. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
37. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
38. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ • ྫ: test/fixtures/gh_pr.json ҎԼུ
39. GASͷಈ࡞Λςετʹ͢Δ 1. Jestʹάϩʔόϧࢦఆ 2. GASͷ૊ΈࠐΈΫϥεΛϞοΫ 3. GAS༻ϥΠϒϥϦͷ୅ସͱϞοΫ 4. ্هΛςετ༻ͷηοτΞοϓͱͯ͠·ͱΊΔ 5. WebhookΛςετϑΟΫενϟͱͯ͠༻ҙ 6. ςετͷ࠷ॳͰಡΈࠐΉ 7. ςετΛॻ͍ͯճ͢
40. ςετʹ·ͱΊΔ
41. ςετʹ·ͱΊΔ require Ͱςετίʔυͷ࠷ॳͰ ϞοΫ࣮૷͕·ͱ·ͬͨϑΝΠϧΛಡΈࠐΉ
42. ςετʹ·ͱΊΔ Webhook ͷJSONΛ૝ఆͨ͠ϑΟΫενϟΛηοτ
43. ςετʹ·ͱΊΔ doPost(e) ͷ࠷ޙ͸ChatworkͷsendMessage → ϞοΫͯ͠ΔͷͰ௨஌ͷத਎͸ ςετதͰ͸୯७ʹreturn͞ΕΔ͸ͣ → ͭ·ΓฦΓ஋ΛΞαʔγϣϯʹ͔͚Ε͹OK
44. ΋͏ ίʔυมߋ → σϓϩΠ ͏ʔΜ…ಈ͍ͯͳ͍ ·ͨมߋ → σϓϩΠ ͠ͳ͍͍ͯ͘ʂ
45. ςετΛಋೖͯ͠ ຊ౰ʹ͓ؾָͳ GAS։ൃΛ!!