test_minidump_full.py 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. import zipfile
  2. from io import BytesIO
  3. from unittest.mock import patch
  4. import pytest
  5. from django.core.files.uploadedfile import SimpleUploadedFile
  6. from django.urls import reverse
  7. from sentry import eventstore
  8. from sentry.lang.native.utils import STORE_CRASH_REPORTS_ALL
  9. from sentry.models.eventattachment import EventAttachment
  10. from sentry.testutils.cases import TransactionTestCase
  11. from sentry.testutils.factories import get_fixture_path
  12. from sentry.testutils.helpers.task_runner import BurstTaskRunner
  13. from sentry.testutils.relay import RelayStoreHelper
  14. from sentry.testutils.skips import requires_kafka, requires_symbolicator
  15. from sentry.utils.safe import get_path
  16. from tests.symbolicator import insta_snapshot_native_stacktrace_data, redact_location
  17. # IMPORTANT:
  18. #
  19. # This test suite requires Symbolicator in order to run correctly.
  20. # Set `symbolicator.enabled: true` in your `~/.sentry/config.yml` and run `sentry devservices up`
  21. #
  22. # If you are using a local instance of Symbolicator, you need to
  23. # either change `system.url-prefix` option override inside `initialize` fixture to `system.internal-url-prefix`,
  24. # or add `127.0.0.1 host.docker.internal` entry to your `/etc/hosts`
  25. pytestmark = [requires_symbolicator, requires_kafka]
  26. @pytest.mark.snuba
  27. class SymbolicatorMinidumpIntegrationTest(RelayStoreHelper, TransactionTestCase):
  28. @pytest.fixture(autouse=True)
  29. def initialize(self, live_server, reset_snuba):
  30. self.project.update_option("sentry:builtin_symbol_sources", [])
  31. with patch("sentry.auth.system.is_internal_ip", return_value=True), self.options(
  32. {"system.url-prefix": live_server.url}
  33. ):
  34. # Run test case
  35. yield
  36. def upload_symbols(self):
  37. url = reverse(
  38. "sentry-api-0-dsym-files",
  39. kwargs={
  40. "organization_slug": self.project.organization.slug,
  41. "project_slug": self.project.slug,
  42. },
  43. )
  44. self.login_as(user=self.user)
  45. out = BytesIO()
  46. f = zipfile.ZipFile(out, "w")
  47. f.write(get_fixture_path("native", "windows.sym"), "crash.sym")
  48. f.close()
  49. response = self.client.post(
  50. url,
  51. {
  52. "file": SimpleUploadedFile(
  53. "symbols.zip", out.getvalue(), content_type="application/zip"
  54. )
  55. },
  56. format="multipart",
  57. )
  58. assert response.status_code == 201, response.content
  59. assert len(response.json()) == 1
  60. _FEATURES = {
  61. "organizations:event-attachments": True,
  62. "organizations:symbol-sources": False,
  63. "organizations:custom-symbol-sources": False,
  64. }
  65. def test_full_minidump(self):
  66. self.project.update_option("sentry:store_crash_reports", STORE_CRASH_REPORTS_ALL)
  67. self.upload_symbols()
  68. with self.feature(self._FEATURES):
  69. with open(get_fixture_path("native", "windows.dmp"), "rb") as f:
  70. event = self.post_and_retrieve_minidump(
  71. {
  72. "upload_file_minidump": f,
  73. "some_file": ("hello.txt", BytesIO(b"Hello World!")),
  74. },
  75. {
  76. "sentry[logger]": "test-logger",
  77. "sentry[level]": "error",
  78. },
  79. )
  80. candidates = event.data["debug_meta"]["images"][0]["candidates"]
  81. redact_location(candidates)
  82. event.data["debug_meta"]["images"][0]["candidates"] = candidates
  83. insta_snapshot_native_stacktrace_data(self, event.data)
  84. assert event.data.get("logger") == "test-logger"
  85. assert event.data.get("level") == "error"
  86. # assert event.data.get("extra") == {"foo": "bar"}
  87. attachments = sorted(
  88. EventAttachment.objects.filter(event_id=event.event_id), key=lambda x: x.name
  89. )
  90. hello, minidump = attachments
  91. assert hello.name == "hello.txt"
  92. assert hello.sha1 == "2ef7bde608ce5404e97d5f042f95f89f1c232871"
  93. assert minidump.name == "windows.dmp"
  94. assert minidump.sha1 == "74bb01c850e8d65d3ffbc5bad5cabc4668fce247"
  95. def test_full_minidump_json_extra(self):
  96. self.project.update_option("sentry:store_crash_reports", STORE_CRASH_REPORTS_ALL)
  97. self.upload_symbols()
  98. with self.feature("organizations:event-attachments"):
  99. with open(get_fixture_path("native", "windows.dmp"), "rb") as f:
  100. event = self.post_and_retrieve_minidump(
  101. {"upload_file_minidump": f},
  102. {"sentry": '{"logger":"test-logger"}', "foo": "bar"},
  103. )
  104. assert event.data.get("logger") == "test-logger"
  105. assert event.data.get("extra") == {"foo": "bar"}
  106. # Other assertions are performed by `test_full_minidump`
  107. def test_full_minidump_invalid_extra(self):
  108. self.project.update_option("sentry:store_crash_reports", STORE_CRASH_REPORTS_ALL)
  109. self.upload_symbols()
  110. with self.feature("organizations:event-attachments"):
  111. with open(get_fixture_path("native", "windows.dmp"), "rb") as f:
  112. event = self.post_and_retrieve_minidump(
  113. {"upload_file_minidump": f},
  114. {"sentry": "{{{{", "foo": "bar"}, # invalid sentry JSON
  115. )
  116. assert not event.data.get("logger")
  117. assert event.data.get("extra") == {"foo": "bar"}
  118. # Other assertions are performed by `test_full_minidump`
  119. def test_missing_dsym(self):
  120. with self.feature(self._FEATURES):
  121. with open(get_fixture_path("native", "windows.dmp"), "rb") as f:
  122. event = self.post_and_retrieve_minidump(
  123. {"upload_file_minidump": f}, {"sentry[logger]": "test-logger"}
  124. )
  125. insta_snapshot_native_stacktrace_data(self, event.data)
  126. assert not EventAttachment.objects.filter(event_id=event.event_id)
  127. def test_reprocessing(self):
  128. # NOTE:
  129. # When running this test against a local symbolicator instance,
  130. # make sure that instance has its caches disabled. This test assumes
  131. # that a symbol upload has immediate effect, whereas in reality the
  132. # negative cache needs to expire first.
  133. self.project.update_option("sentry:store_crash_reports", STORE_CRASH_REPORTS_ALL)
  134. features = dict(self._FEATURES)
  135. features["organizations:reprocessing-v2"] = True
  136. with self.feature(features):
  137. with open(get_fixture_path("native", "windows.dmp"), "rb") as f:
  138. event = self.post_and_retrieve_minidump(
  139. {"upload_file_minidump": f}, {"sentry[logger]": "test-logger"}
  140. )
  141. insta_snapshot_native_stacktrace_data(self, event.data, subname="initial")
  142. self.upload_symbols()
  143. from sentry.tasks.reprocessing2 import reprocess_group
  144. with BurstTaskRunner() as burst:
  145. reprocess_group.delay(project_id=self.project.id, group_id=event.group_id)
  146. burst(max_jobs=100)
  147. new_event = eventstore.backend.get_event_by_id(self.project.id, event.event_id)
  148. assert new_event is not None
  149. assert new_event.event_id == event.event_id
  150. candidates = new_event.data["debug_meta"]["images"][0]["candidates"]
  151. redact_location(candidates)
  152. new_event.data["debug_meta"]["images"][0]["candidates"] = candidates
  153. insta_snapshot_native_stacktrace_data(self, new_event.data, subname="reprocessed")
  154. for event_id in (event.event_id, new_event.event_id):
  155. (minidump,) = sorted(
  156. EventAttachment.objects.filter(event_id=new_event.event_id), key=lambda x: x.name
  157. )
  158. assert minidump.name == "windows.dmp"
  159. assert minidump.sha1 == "74bb01c850e8d65d3ffbc5bad5cabc4668fce247"
  160. def test_minidump_threadnames(self):
  161. self.project.update_option("sentry:store_crash_reports", STORE_CRASH_REPORTS_ALL)
  162. with self.feature(self._FEATURES):
  163. with open(get_fixture_path("native", "threadnames.dmp"), "rb") as f:
  164. event = self.post_and_retrieve_minidump({"upload_file_minidump": f}, {})
  165. thread_name = get_path(event.data, "threads", "values", 1, "name")
  166. assert thread_name == "sentry-http"