test(derived_code_mappings): Prevent not updating the list of extensions #86196
Conversation
This change mocks the code at a lower level making sure that when we write tests it will fail until the list of supported extensions is updated.
github-actions
bot
added
the
Scope: Backend
| @@ -124,10 +124,12 @@ def _populate_trees(self, repositories: Sequence[dict[str, str]]) -> dict[str, R | |||
| remaining_requests = MINIMUM_REQUESTS_REMAINING | |||
| try: | |||
| remaining_requests = self.get_client().get_remaining_api_requests() | |||
| except ApiError: | |||
| except Exception: | |||
There was a problem hiding this comment.
This is an orthogonal change.
| use_cache = True | ||
| # Report so we can investigate | ||
| logger.warning("Loading trees from cache. Execution will continue. Check logs.") | ||
| logger.warning( | ||
| "Loading trees from cache. Execution will continue. Check logs.", exc_info=True |
There was a problem hiding this comment.
In this case, I want the exception to be included.
Info about exc_info usage:
| def _process_and_assert_code_mapping( | ||
| self, files: Sequence[str], stack_root: str, source_root: str | ||
| ) -> None: | ||
| with ( | ||
| patch(GET_TREES_FOR_ORG, return_value=self._get_trees_for_org(files)), |
There was a problem hiding this comment.
Instead of patching at a higher level, we patch three functions deeper into the code base.
sentry/src/sentry/integrations/source_code_management/repo_trees.py
Lines 80 to 88 in c0f7432
| def _process_and_assert_code_mapping( | ||
| self, files: Sequence[str], stack_root: str, source_root: str | ||
| ) -> None: | ||
| with ( | ||
| patch(GET_TREES_FOR_ORG, return_value=self._get_trees_for_org(files)), | ||
| patch(f"{CLIENT}.get_tree", return_value=self._repo_tree_files(files)), | ||
| patch(f"{CLIENT}.get_remaining_api_requests", return_value=500), |
There was a problem hiding this comment.
_populate_trees will call this:
| def _process_and_assert_code_mapping( | ||
| self, files: Sequence[str], stack_root: str, source_root: str | ||
| ) -> None: | ||
| with ( | ||
| patch(GET_TREES_FOR_ORG, return_value=self._get_trees_for_org(files)), | ||
| patch(f"{CLIENT}.get_tree", return_value=self._repo_tree_files(files)), |
There was a problem hiding this comment.
After we call get_tree [1] we will call filter_source_code_files which reduces the number of files to store in the cache based on the extension.
sentry/src/sentry/integrations/source_code_management/repo_trees.py
Lines 198 to 203 in c0f7432
There was a problem hiding this comment.
At the end of the file, you will see the test that verifies the correctness of the fix.
|
|
||
| with patch(f"{CODE_ROOT}.task.supported_platform", return_value=True): | ||
| # No extensions are supported, thus, we can't generate a code mapping | ||
| self._process_and_assert_no_code_mapping([file_in_repo]) |
There was a problem hiding this comment.
The code mapping does not get generated since the tbd file extension has not yet been added to the list of supported extensions.
| self._process_and_assert_no_code_mapping([file_in_repo]) | ||
|
|
||
| with patch(f"{REPO_TREES_CODE}.SUPPORTED_EXTENSIONS", ["tbd"]): | ||
| self._process_and_assert_code_mapping([file_in_repo], "foo/", "src/foo/") |
armenzg
deleted the
tests/supported_extensions/derived_code_mappings/armenzg
branch
…ons (#86196) This change mocks the code at a lower level ensuring that tests will fail until the list of supported extensions is updated.
armenzg
added this to the Automate Code Mappings & In-App Stack Trace Rules for Java projects milestone
This change mocks the code at a lower level ensuring that tests will fail until the list of supported extensions is updated.