[core] feat: add support for overwriting columns in built-in reports

Author: AndreyMarkinPPC

libs/core/garf_core/query_editor.py

@@ -227,13 +227,6 @@ def macros(self) -> QueryParameters:
 
   def generate(self) -> BaseQueryElements:
     self.remove_comments().expand().extract_resource_name()
-    if self.query.resource_name.startswith('builtin'):
-      return BaseQueryElements(
-        title=self.query.resource_name.replace('builtin.', ''),
-        text=self.query.text,
-        resource_name=self.query.resource_name,
-        is_builtin_query=True,
-      )
     (
       self.remove_trailing_comma()
       .extract_fields()
@@ -243,6 +236,9 @@ def generate(self) -> BaseQueryElements:
       .extract_virtual_columns()
       .extract_customizers()
     )
+    if self.query.resource_name.startswith('builtin'):
+      self.query.title = self.query.resource_name.replace('builtin.', '')
+      self.query.is_builtin_query = True
     return self.query
 
   def expand(self) -> Self:
@@ -366,6 +362,8 @@ def _extract_query_lines(self) -> Generator[str, None, None]:
       r'\bSELECT\b|FROM .*', '', self.text, flags=re.IGNORECASE
     ).split(',')
     for row in selected_rows:
+      if row.strip() == '*':
+        return
       if non_empty_row := row.strip():
         yield non_empty_row
 

libs/core/garf_core/report_fetcher.py

@@ -166,7 +166,10 @@ def fetch(
         raise query_editor.GarfBuiltInQueryError(
           f'Cannot find the built-in query "{query.title}"'
         )
-      return builtin_report(self, **kwargs)
+      rep = builtin_report(self, **kwargs)
+      if columns := query.column_names:
+        rep.column_names = columns
+      return rep
 
     if self.enable_cache:
       try:

libs/core/tests/unit/test_query_editor.py

@@ -128,17 +128,28 @@ def test_generate_raises_error_on_missing_column_names(self):
     ):
       test_query_spec.generate()
 
-  def test_generate_returns_builtin_query(self):
-    query = 'SELECT test FROM builtin.test'
+  @pytest.mark.parametrize(
+    ('select', 'expect_fields', 'expect_columns'),
+    [
+      ('*', [], []),
+      ('test', ['test'], ['test']),
+      ('test AS new_test', ['test'], ['new_test']),
+    ],
+  )
+  def test_generate_returns_builtin_query(
+    self, select, expect_fields, expect_columns
+  ):
+    query = f'SELECT {select} FROM builtin.test'
     test_query_spec = query_editor.QuerySpecification(text=query, title='test')
     test_query_spec.generate()
     expected_query_elements = query_editor.BaseQueryElements(
       title='test',
       text=query,
+      fields=expect_fields,
+      column_names=expect_columns,
       resource_name='builtin.test',
       is_builtin_query=True,
     )
-
     assert test_query_spec.query == expected_query_elements
 
   def test_generate_returns_macros(self):

libs/core/tests/unit/test_report_fetcher.py

@@ -105,20 +105,28 @@ def test_fetch_returns_empty_report_for_empty_api_response(self):
 
     assert not test_report
 
+  @pytest.mark.parametrize(
+    ('select', 'expect'),
+    [
+      ('*', 'test'),
+      ('test', 'test'),
+      ('test AS new_test', 'new_test'),
+    ],
+  )
   def test_fetch_builtin_query_returns_correct_builtin_report(
-    self, test_dict_report_fetcher
+    self, test_dict_report_fetcher, select, expect
   ):
     test_report = report.GarfReport(results=[[1]], column_names=['test'])
 
-    def test_builtin_query(report_fetcher):
+    def builtin_query(report_fetcher):
       return test_report
 
-    test_dict_report_fetcher.add_builtin_queries({'test': test_builtin_query})
+    test_dict_report_fetcher.add_builtin_queries({'test': builtin_query})
 
-    query = 'SELECT test FROM builtin.test'
+    query = f'SELECT {select} FROM builtin.test'
     fetched_report = test_dict_report_fetcher.fetch(query)
-
-    assert fetched_report == test_report
+    expected_report = report.GarfReport(results=[[1]], column_names=[expect])
+    assert fetched_report == expected_report
 
   def test_fetch_parses_virtual_columns(self, test_dict_report_fetcher):
     query = """