Slides for Hokkaido.pm #11. Talking about software testing and documentation.

1. Hokkaido.pm 🍣x11
ブログ炎上
@moznion
from Hachioji.pm

2. @moznion
大学院生 (退学失敗)
ソフトウェアエンジニア
(アルバイト)

3. 今年の流行語

5. ではなくて

6. DevOps

7. Dev🔫Ops
or
Ops🔫Dev

8. Dev🔫Ops
or
Ops🔫Dev

9. Dev🔫Ops
or
Ops🔫Dev
Dev💕Ops
Dev🍣Ops
Dev🍺Ops

10. DevとOpsが協調

11. めでたい！

12. 他に協調出来そうな
概念は無いだろうか

13. 例えば
TestとDocumentの関係

14. Testとは？

15. ソフトウェアの正しい動作を
記述・表現・保証するもの

16. Documentとは？

17. 正しいソフトウェアの
動作を定義・表現するもの

18. つまりTestもDocumentも
ソフトウェアの正しい動作に
着目している

19. DocumentとTestは
距離が近い

20. 協調可能ではないか？

21. 協調することによる
メリット

22. Documentの
不整合を防げる
破滅しない

23. Documentの
陳腐化からの卒業

24. DocumentとTestを
それぞれ書くよりも
コストを減らせる(かも)

25. アプローチ

26. 1

27. Documentから
Testを生成する

28. 2

29. Testから
Documentを生成する

30. 第Ⅰ部

31. Documentから
Testを生成する

32. Documentがそのまま
Testと化すので
陳腐化を防げる

33. Documentを書く作業と
Testを書く作業が
分離しない

34. しかし

35. 難しい

36. 実現しようとすると
Documentが
冗長になる傾向

37. e.g. javadoc

38. Documentを書く
コストが格段に
跳ね上がる

39. そのコストはDocumentとTest
それぞれ分離して書いた時の
コストと比較してどちらが高い？

40. また, Documentから
生成するテストケースは
適切だろうか？

41. etc etc…

42. 多分, Documentから
Testを生成するのは
あまり良い方法ではない

43. では生成するのを
やめてはどうか

44. DocumentとTestを
同居させるという手法

45. e.g.
DocTest (Python)
Test::Inline (Perl)
power-doctest (JS)

46. 今回書いたやつ

47. Test::Synopsis::Expectation
https://metacpan.org/release/Test-Synopsis-Expectation
https://github.com/moznion/Test-Synopsis-Expectation

48. CPANモジュールの
Documentの中でも
非常に重要なSYNOPSIS

49. そのSYNOPSISを
Testする

50. SS

51. SYNOPSISの中に
テストケースを
同居させる

52. 可読性もそこそこ高いので
人間が読んでも理解できる

53. もちろんDocumentも
陳腐化しない

54. Documentを書くと
Testも増えるという思想

55. 割と良いのではないか

56. Documentから
Testを生成する
DocumentとTestを
同居させる

57. 第Ⅰ部完

58. 第Ⅱ部

59. Testから
Documentを生成する

60. r7kamura氏のautodoc

61. 衝撃！！！

62. autodoc?

63. JSON APIのTestを書くと
APIのDocumentが
生成されるやつ

66. Testで動作が正しいことが
保証されているものが
そのままDocumentになる

67. 正しいドキュメントが
必然的に得られる

68. APIとか代謝が早くて
Documentが追いつかない
ケースが多い

69. ただ, 健全な開発ならば
APIに対するTestは
存在しているはず

70. そのTestからDocumentを
生成することで
Docが遅れなくなる

71. で, 書いた

72. Test::JsonAPI::Autodoc
https://metacpan.org/release/Test-JsonAPI-Autodoc
https://github.com/moznion/Test-JsonAPI-Autodoc

73. 細かな差異はあれど,
ほぼautodocのport

76. また, 似たコンセプトのものに
Shodoというのがあり…

78. 後ほど説明が
あると思います

79. 第Ⅱ部完

80. まとめ

81. TestとDocumentは
近い存在
協調できると思う

82. 協調すると,
ドキュメントの破滅
などから救われる

83. TestとDocumentを
同居させる方法と
TestからDocumentを
生成する方法は
割と良いのではないか

84. 双方の使い分けは
ドメインに応じて

85. という感じ

86. 2013 DevOps
⇩
2014 DocTest

87. Doc🍣Test

88. Any Q?