Mocking in Rust Applications

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

© 2024 Finatext Holdings Ltd. テスト対象のロジックは外部依存について差し替え可能であることが望ましいです(後述) Rustでは交換可能性はGenericsまたはTrait Objectsを使って実現できます ● Generics (+ Trait Bounds): コンパイル時に具体的な型が分かるケースで利用します。コンパイラがそれぞれの具体的な型用のコードを生成する。静的ディスパッチ ● Trait Objects: コンパイル時に具体的な型が分からないケースで利用します。実行時のメソッド呼び出し時に仮想関数テーブルを参照して実際の呼び出し関数(メソッド)を決定します。動的ディスパッチ交換可能性を導入する 5

Slide 7

Slide 7 text

© 2024 Finatext Holdings Ltd. 非同期ジョブのロジックという例: 「GitHub Checks APIを使ってCheckRunを作成して、Git cloneでリポジトリをクローンして、指定された外部コマンドを実行する」テスト時にモックしたい部分 ● GitHub APIを呼ぶ: GithubClient trait ● Git clone: Checkout trait →このケースでは例えば、Handlerという構造体を定義してそれぞれの外部依存を持たせる交換可能性の例 6

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

Slide 18

Slide 18 text

© 2024 Finatext Holdings Ltd. axum crateのStateのような仕組みを使う http crateのRequest構造体にはexstensionの仕組みがあるので、このexstensionに状態を毎回セットする tower::Serviceを作ると同じようなことが実現できる(はず) ある程度の規模以上だと依存管理が煩雑になりそうなのでDependency Injdectionライブラリが有効そうだが少ない。DIパターンもデファクトがあるわけではなさそうなので今後の発展に期待(っぽい) Webアプリケーションでの交換可能性の実現 17

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

© 2024 Finatext Holdings Ltd. ● #[automock] ○ 先の例のような典型的なケースではこのattribute macroで自動生成する ● mock! ○ #[automock]マクロではダメなケースでこのproc macroで半手動(?)で生成する名前に "Mock" preﬁxが付いた構造体が定義されるので、::newか::defaultで構造体を初期化するモック構造体の専用のメソッドを使ってモック対象のtraitのメソッド呼び出しのexpectationを設定する Expectation設定用のメソッド名は "expect_" という規約デストラクタで設定されたexpectationを検証する mockall crate 20

Slide 22

Slide 22 text

Slide 23

Slide 23 text

Slide 24

Slide 24 text

Slide 25

Slide 25 text

© 2024 Finatext Holdings Ltd. ● 構造体の実装のモックはできるが名前空間上でハック(?)が必要でやや微妙 ○ 後述 ● Associated functions(static methods?)のモックはexpectationの設定がグローバルになるので、テストの並列実行で同期ロジックが必要 ○ なるべく避けたい ● モジュール上の関数もモック可能だが名前空間上のハックが必要、かつexpectationの設定がグローバルになる ○ なるべく避けたい ● モック対象のtraitのメソッドが参照を返す場合は制限あり ● モック対象のtraitのメソッドの返り値がimpl Traitの場合は、mockall内部でBoxに変換するので制限あり ● モック対象のtraitのメソッドの返り値がimpl Futureの場合は、返り値をpinningする必要あり ○ 実際はasyncキーワードとasync-trait crateを使うことが多い(?) ○ 後述ドキュメントとexamplesがかなり丁寧でその他のケースも網羅してるので困った時はどうぞ mockallの注意点 24