Document about the ways to write unit tests for Bolt apps

オープン
#380 コメント 21 件 リアクション 31 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
python
領域
documentation, testing-qa

調査の方向性

https://slack.dev/bolt-python/ の Bolt for Python ドキュメントから始め、main.py と api.py に示されているハンドラー構造を確認します。これには app.command、app.event、app.db、ack、respond が含まれます。これらのハンドラーの単体テストについて、ハンドラーの引数と app の依存関係に対するテストダブルを含む、妥当なアプローチを、期待される動作が明確になる例とともに文書化します。

索引モデルが issue の本文から書いたものです。

説明

area:async area:sync docs enhancement

I am looking to write unit tests for my Bolt API, which consists of an app with several handlers for events / messages. The handlers are both decorated using the app.event decorator, and make use of the app object to access things like the db connection that has been put on it. For example:

# in main.py
app = App(
    token=APP_TOKEN,
    signing_secret=SIGNING_SECRET,
    process_before_response=True,
    token_verification_enabled=token_verification_enabled,
)
app.db = db

# in api.py:
from .main import app

@app.command("/slashcommand")
def slash_command(ack, respond):
    ack()
    results = app.db.do_query()
    respond(...)

The thing is, I cannot find any framework pointers, or documentation, on how I would write reasonable unit tests for this. Presumably ones where the kwargs like ack and respond are replaced by test doubles. How do I do this?

The page URLs

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

主要言語
Python
スター
1.3k
フォーク
288
平均マージ
1日 8時間
マージ済み PR（30日）
10

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

slackapi/bolt-python のほかの issue

slackapi/bolt-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。