✅ Added debug test cases

src/esxport.py

@@ -12,7 +12,7 @@
 
 from src.constant import FLUSH_BUFFER, TIMES_TO_TRY
 from src.exceptions import FieldNotFoundError, IndexNotFoundError
-from src.strings import index_not_found
+from src.strings import index_not_found, output_fields, sorting_by, using_indexes, using_query
 from src.utils import retry
 from src.writer import Writer
 
@@ -92,10 +92,11 @@ def _prepare_search_query(self: Self) -> None:
             self.search_args["_source_includes"] = ",".join(self.opts.fields)
 
         if self.opts.debug:
-            logger.debug(f'Using these indices: {", ".join(self.opts.index_prefixes)}.')
-            logger.debug(f"Query {self.opts.query}")
-            logger.debug(f'Output field(s): {", ".join(self.opts.fields)}.')
-            logger.debug(f"Sorting by: {self.opts.sort}.")
+            logger.debug(using_indexes.format(indexes={", ".join(self.opts.index_prefixes)}))
+            query = json.dumps(self.opts.query)
+            logger.debug(using_query.format(query={query}))
+            logger.debug(output_fields.format(fields={", ".join(self.opts.fields)}))
+            logger.debug(sorting_by.format(sort=self.opts.sort))
 
     @retry(ConnectionError, tries=TIMES_TO_TRY)
     def next_scroll(self: Self, scroll_id: str) -> Any:

src/strings.py

@@ -1,2 +1,6 @@
 """Common used strings."""
 index_not_found = "Any of index(es) {} does not exist in {}."
+using_indexes = "Using indices: {indexes}."
+using_query = "Using query: {query}."
+output_fields = "Output fields : {fields}."
+sorting_by = "Sorting by: {sort}."

test/esxport/_prepare_search_query_test.py

@@ -10,7 +10,7 @@
 
 from src.esxport import EsXport
 from src.exceptions import IndexNotFoundError
-from src.strings import index_not_found
+from src.strings import index_not_found, output_fields, sorting_by, using_indexes
 
 if TYPE_CHECKING:
     from typing_extensions import Self
@@ -155,3 +155,23 @@ def test_sort(
         es_export = EsXport(cli_options, mock_es_client)
         es_export._prepare_search_query()
         assert es_export.search_args["sort"] == random_sort
+
+    def test_debug_option(
+        self: Self,
+        _: Any,
+        mock_es_client: ElasticsearchClient,
+        cli_options: CliOptions,
+        caplog: pytest.LogCaptureFixture,
+    ) -> None:
+        """Arr, matey!.
+
+        Let's test if our search query be successful, with valid input parameters!.
+        """
+        cli_options.debug = True
+
+        es_export = EsXport(cli_options, mock_es_client)
+        es_export._prepare_search_query()
+        assert caplog.records[0].msg == using_indexes.format(indexes={", ".join(cli_options.index_prefixes)})
+        assert caplog.records[1].msg.startswith("Using query")
+        assert caplog.records[2].msg == output_fields.format(fields={", ".join(cli_options.fields)})
+        assert caplog.records[3].msg == sorting_by.format(sort=cli_options.sort)