webhook tests: Rename main helper to check_webhook.

Almost all webhook tests use this helper, except a few
webhooks that write to private streams.

Being concise is important here, and the name
`self.send_and_test_stream_message` always confused
me, since it sounds you're sending a stream message,
and it leaves out the webhook piece.

We should consider renaming `send_and_test_private_message`
to something like `check_webhook_private`, but I couldn't
decide on a great name, and it's very rarely used.  So
for now I just made sure the docstrings of the two
sibling functions reference each other.
This commit is contained in:
Steve Howell
2020-08-23 13:49:24 +00:00
committed by Tim Abbott
parent 00001a396b
commit 388053db6b
71 changed files with 1726 additions and 1467 deletions

View File

@@ -16,16 +16,24 @@ class HelloWorldHookTests(WebhookTestCase):
expected_message = "Hello! I am happy to be here! :smile:\nThe Wikipedia featured article for today is **[Marilyn Monroe](https://en.wikipedia.org/wiki/Marilyn_Monroe)**"
# use fixture named helloworld_hello
self.send_and_test_stream_message('hello', expected_topic, expected_message,
content_type="application/x-www-form-urlencoded")
self.check_webhook(
"hello",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_goodbye_message(self) -> None:
expected_topic = "Hello World"
expected_message = "Hello! I am happy to be here! :smile:\nThe Wikipedia featured article for today is **[Goodbye](https://en.wikipedia.org/wiki/Goodbye)**"
# use fixture named helloworld_goodbye
self.send_and_test_stream_message('goodbye', expected_topic, expected_message,
content_type="application/x-www-form-urlencoded")
self.check_webhook(
"goodbye",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_pm_to_bot_owner(self) -> None:
# Note that this is really just a test for check_send_webhook_message
@@ -52,8 +60,12 @@ class HelloWorldHookTests(WebhookTestCase):
self.url = self.build_webhook_url(topic=expected_topic)
expected_message = "Hello! I am happy to be here! :smile:\nThe Wikipedia featured article for today is **[Goodbye](https://en.wikipedia.org/wiki/Goodbye)**"
self.send_and_test_stream_message('goodbye', expected_topic, expected_message,
content_type="application/x-www-form-urlencoded")
self.check_webhook(
"goodbye",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def get_body(self, fixture_name: str) -> str:
return self.webhook_fixture_data("helloworld", fixture_name, file_type="json")