[firestore] fix: mark 3 tests as flaky (GoogleCloudPlatform#3295)

Takashi Matsuo · crwilcox · web-flow · commit 4b43e62dcfcd · 2020-04-08T10:20:04.000-07:00
fixes GoogleCloudPlatform#3131 These tests are testing sample code that has `sleep(1)` in it. The test is naturally flaky, but when I run the test 100 times, they all pass, so they are somewhat stable. I believe it will mitigate the flakiness a lot just by retrying 3 times. If it doesn't work, we'll probably need to make a fundamental fix to remove `sleep(1)` calls. Co-authored-by: Christopher Wilcox <crwilcox@google.com>
diff --git a/firestore/cloud-client/requirements-test.txt b/firestore/cloud-client/requirements-test.txt
@@ -1 +1,2 @@
 pytest==5.3.2
+flaky==3.6.1
diff --git a/firestore/cloud-client/snippets_test.py b/firestore/cloud-client/snippets_test.py
@@ -267,19 +267,22 @@ def test_cursor_multiple_conditions():
     snippets.cursor_multiple_conditions()
 
 
+@pytest.mark.flaky(max_runs=3)
 def test_listen_document(capsys):
     snippets.listen_document()
     out, _ = capsys.readouterr()
     assert 'Received document snapshot: SF' in out
 
 
+@pytest.mark.flaky(max_runs=3)
 def test_listen_multiple(capsys):
     snippets.listen_multiple()
     out, _ = capsys.readouterr()
     assert 'Current cities in California:' in out
     assert 'SF' in out
 
 
+@pytest.mark.flaky(max_runs=3)
 def test_listen_for_changes(capsys):
     snippets.listen_for_changes()
     out, _ = capsys.readouterr()
