#!/usr/bin/env python3 """ Tests for structured-document extraction in the read_file tool. Covers .ipynb / .docx / .xlsx extraction (ported from Kilo-Org/kilocode #10733, #10737, #10740) and the read_file_tool integration: pagination, line-numbering, graceful fallback on malformed input, and hidden-sheet omission. Run with: python -m pytest tests/tools/test_read_extract.py -v """ import json import os import tempfile import unittest import zipfile from unittest import mock from tools.read_extract import ( ExtractionError, extract_document_text, is_extractable_document, ) from tools.file_tools import read_file_tool # --------------------------------------------------------------------------- # Fixture builders — construct minimal valid OOXML / notebook files. # --------------------------------------------------------------------------- def _write_notebook(path, cells, nbformat=4): nb = {"cells": cells, "metadata": {}, "nbformat": nbformat, "nbformat_minor": 5} with open(path, "w", encoding="utf-8") as fh: json.dump(nb, fh) def _write_docx(path, document_xml): with zipfile.ZipFile(path, "w") as z: z.writestr("[Content_Types].xml", "") z.writestr("word/document.xml", document_xml) def _write_xlsx(path, *, workbook, rels, shared, sheets): """sheets: dict of part-name -> xml string.""" with zipfile.ZipFile(path, "w") as z: z.writestr("xl/workbook.xml", workbook) z.writestr("xl/_rels/workbook.xml.rels", rels) if shared is not None: z.writestr("xl/sharedStrings.xml", shared) for part, xml in sheets.items(): z.writestr(part, xml) _NS_W = "http://schemas.openxmlformats.org/wordprocessingml/2006/main" _NS_S = "http://schemas.openxmlformats.org/spreadsheetml/2006/main" # --------------------------------------------------------------------------- # is_extractable_document # --------------------------------------------------------------------------- class TestIsExtractable(unittest.TestCase): def test_recognized_extensions(self): self.assertTrue(is_extractable_document("a.ipynb")) self.assertTrue(is_extractable_document("/x/B.DOCX")) self.assertTrue(is_extractable_document("report.xlsx")) def test_unrecognized_extensions(self): self.assertFalse(is_extractable_document("a.py")) self.assertFalse(is_extractable_document("a.txt")) self.assertFalse(is_extractable_document("a.mp4")) def test_anydoc_extensions_track_availability(self): """PDF (and the other anydoc formats) are extractable exactly when the optional `anydoc` converter is importable.""" from tools import read_extract available = read_extract._anydoc() is not None self.assertEqual(is_extractable_document("a.pdf"), available) self.assertEqual(is_extractable_document("a.odt"), available) self.assertEqual(is_extractable_document("a.epub"), available) # --------------------------------------------------------------------------- # Optional anydoc-backed formats (PDF, legacy Office, ODF, RTF, EPUB) # --------------------------------------------------------------------------- class TestAnydocExtraction(unittest.TestCase): """Real-binding tests — skipped when firecrawl-anydoc is not installed.""" @classmethod def setUpClass(cls): from tools import read_extract cls.mod = read_extract._anydoc() if cls.mod is None: raise unittest.SkipTest("firecrawl-anydoc not installed") def setUp(self): self.tmp = tempfile.mkdtemp(prefix="rex_anydoc_") def tearDown(self): import shutil shutil.rmtree(self.tmp, ignore_errors=True) def test_rtf_extracts_markdown(self): p = os.path.join(self.tmp, "doc.rtf") with open(p, "w", encoding="ascii") as fh: fh.write(r"{\rtf1\ansi {\b Bold title}\par plain body\par}") text = extract_document_text(p) self.assertIn("Bold title", text) self.assertIn("plain body", text) self.assertTrue(text.endswith("\n")) def test_malformed_file_raises_extraction_error(self): p = os.path.join(self.tmp, "junk.pdf") with open(p, "wb") as fh: fh.write(b"\x00\x01 not a pdf at all") with self.assertRaises(ExtractionError): extract_document_text(p) def test_stdlib_docx_path_still_authoritative(self): """A .docx keeps using the stdlib extractor even with anydoc installed — behavior must be identical either way.""" p = os.path.join(self.tmp, "d.docx") _write_docx( p, f'' "hello" "", ) text = extract_document_text(p) self.assertEqual(text, "hello\n") class TestAnydocSizeCap(unittest.TestCase): """Oversized inputs must be rejected before anydoc converts them. Uses a fake binding so it runs regardless of local install state.""" def setUp(self): from tools import read_extract self.rex = read_extract self._saved_module = read_extract._anydoc_module self._saved_cap = read_extract.MAX_ANYDOC_BYTES self.tmp = tempfile.mkdtemp(prefix="rex_cap_") self.calls = [] class _FakeAnydoc: def to_markdown(_self, path): self.calls.append(path) return "converted\n" read_extract._anydoc_module = _FakeAnydoc() def tearDown(self): import shutil self.rex._anydoc_module = self._saved_module self.rex.MAX_ANYDOC_BYTES = self._saved_cap shutil.rmtree(self.tmp, ignore_errors=True) def _write(self, name, size): p = os.path.join(self.tmp, name) with open(p, "wb") as fh: fh.write(b"x" * size) return p def test_oversized_file_rejected_before_conversion(self): from tools.read_extract import _extract_anydoc self.rex.MAX_ANYDOC_BYTES = 10 p = self._write("big.pdf", 11) with self.assertRaises(ExtractionError) as ctx: _extract_anydoc(p) self.assertIn("too large", str(ctx.exception)) self.assertEqual(self.calls, []) def test_file_at_limit_converts(self): from tools.read_extract import _extract_anydoc self.rex.MAX_ANYDOC_BYTES = 10 p = self._write("ok.pdf", 10) self.assertEqual(_extract_anydoc(p), "converted\n") self.assertEqual(self.calls, [p]) def test_missing_file_raises_extraction_error(self): from tools.read_extract import _extract_anydoc with self.assertRaises(ExtractionError): _extract_anydoc(os.path.join(self.tmp, "gone.pdf")) self.assertEqual(self.calls, []) class TestAnydocAbsent(unittest.TestCase): """The absent-dep contract, verified regardless of local install state by forcing the cached module handle to None.""" def setUp(self): from tools import read_extract self._saved = read_extract._anydoc_module read_extract._anydoc_module = None def tearDown(self): from tools import read_extract read_extract._anydoc_module = self._saved def test_pdf_not_extractable_without_anydoc(self): self.assertFalse(is_extractable_document("a.pdf")) self.assertFalse(is_extractable_document("a.rtf")) def test_extract_raises_unsupported_without_anydoc(self): from tools.read_extract import _extract_anydoc with self.assertRaises(ExtractionError): _extract_anydoc("/tmp/whatever.pdf") def test_stdlib_formats_unaffected(self): self.assertTrue(is_extractable_document("a.ipynb")) self.assertTrue(is_extractable_document("a.docx")) self.assertTrue(is_extractable_document("a.xlsx")) class TestAnydocInitLifecycle(unittest.TestCase): """First-load lifecycle: one failed load must not disable extraction for the rest of the process, and concurrent first use must not race.""" def setUp(self): from tools import read_extract self.rex = read_extract self._saved_module = read_extract._anydoc_module self._saved_failed_at = read_extract._anydoc_failed_at self._saved_retry = read_extract.ANYDOC_RETRY_SECONDS read_extract._anydoc_module = read_extract._ANYDOC_UNSET read_extract._anydoc_failed_at = None def tearDown(self): self.rex._anydoc_module = self._saved_module self.rex._anydoc_failed_at = self._saved_failed_at self.rex.ANYDOC_RETRY_SECONDS = self._saved_retry def test_successful_load_is_cached(self): fake = object() calls = [] def fake_import(name): calls.append(name) return fake with mock.patch("importlib.import_module", side_effect=fake_import): self.assertIs(self.rex._anydoc(), fake) self.assertIs(self.rex._anydoc(), fake) self.assertEqual(calls, ["anydoc"]) def test_failed_load_is_retried_after_cooldown(self): fake = object() calls = [] def fake_import(name): calls.append(name) if len(calls) == 1: raise ImportError("boom") return fake self.rex.ANYDOC_RETRY_SECONDS = 0.0 with mock.patch("importlib.import_module", side_effect=fake_import): self.assertIsNone(self.rex._anydoc()) self.assertIs(self.rex._anydoc(), fake) self.assertEqual(calls, ["anydoc", "anydoc"]) def test_failed_load_not_retried_within_cooldown(self): calls = [] def fake_import(name): calls.append(name) raise ImportError("boom") self.rex.ANYDOC_RETRY_SECONDS = 3600.0 with mock.patch("importlib.import_module", side_effect=fake_import): self.assertIsNone(self.rex._anydoc()) self.assertIsNone(self.rex._anydoc()) # One import attempt total, and the handle stays UNSET so a retry # remains possible once the cooldown expires. self.assertEqual(calls, ["anydoc"]) self.assertIs(self.rex._anydoc_module, self.rex._ANYDOC_UNSET) def test_concurrent_first_load_imports_once(self): import threading fake = object() calls = [] barrier = threading.Barrier(4) def fake_import(name): calls.append(name) return fake def worker(out): barrier.wait(5) out.append(self.rex._anydoc()) with mock.patch("importlib.import_module", side_effect=fake_import): results = [] threads = [threading.Thread(target=worker, args=(results,)) for _ in range(3)] for t in threads: t.start() barrier.wait(5) for t in threads: t.join(5) self.assertEqual(calls, ["anydoc"]) self.assertEqual(results, [fake, fake, fake]) # --------------------------------------------------------------------------- # Notebooks (.ipynb) — #10733 # --------------------------------------------------------------------------- class TestNotebookExtraction(unittest.TestCase): def setUp(self): self.tmp = tempfile.mkdtemp(prefix="rex_nb_") def tearDown(self): import shutil shutil.rmtree(self.tmp, ignore_errors=True) def test_markdown_and_code_in_order(self): p = os.path.join(self.tmp, "nb.ipynb") _write_notebook(p, [ {"cell_type": "markdown", "source": ["# Title\n", "para"]}, {"cell_type": "code", "source": "x = 1\nprint(x)", "outputs": [{"output_type": "stream", "text": ["1\n"]}], "execution_count": 1}, ]) text = extract_document_text(p) self.assertIn("# Title", text) self.assertIn("print(x)", text) # Output payloads must NOT leak into the extracted text. self.assertNotIn("output_type", text) self.assertNotIn("execution_count", text) # Order preserved: markdown before code. self.assertLess(text.index("Title"), text.index("print(x)")) def test_empty_cells_raises(self): p = os.path.join(self.tmp, "empty.ipynb") _write_notebook(p, []) with self.assertRaises(ExtractionError): extract_document_text(p) # --------------------------------------------------------------------------- # Word documents (.docx) — #10737 # --------------------------------------------------------------------------- class TestDocxExtraction(unittest.TestCase): def setUp(self): self.tmp = tempfile.mkdtemp(prefix="rex_docx_") def tearDown(self): import shutil shutil.rmtree(self.tmp, ignore_errors=True) def _doc(self, body): return (f'' f'{body}') def test_paragraphs_and_runs(self): p = os.path.join(self.tmp, "d.docx") _write_docx(p, self._doc( 'Hello World' 'Second')) text = extract_document_text(p) self.assertIn("Hello World", text) self.assertIn("Second", text) def test_missing_document_xml_raises(self): p = os.path.join(self.tmp, "nodoc.docx") with zipfile.ZipFile(p, "w") as z: z.writestr("other.xml", "") with self.assertRaises(ExtractionError): extract_document_text(p) # --------------------------------------------------------------------------- # Excel workbooks (.xlsx) — #10740 # --------------------------------------------------------------------------- class TestXlsxExtraction(unittest.TestCase): def setUp(self): self.tmp = tempfile.mkdtemp(prefix="rex_xlsx_") def tearDown(self): import shutil shutil.rmtree(self.tmp, ignore_errors=True) def _build(self, path, *, include_hidden=True): r = "http://schemas.openxmlformats.org/officeDocument/2006/relationships" hidden_sheet = (f'') if include_hidden else "" workbook = ( f'' f'{hidden_sheet}' f'') rels = ( '' '' '' '') shared = (f'NameScore' f'Alice') sheet1 = ( f'' '01' '295' '') sheet2 = (f'' 'SECRETDATA' '') _write_xlsx(path, workbook=workbook, rels=rels, shared=shared, sheets={"xl/worksheets/sheet1.xml": sheet1, "xl/worksheets/sheet2.xml": sheet2}) def test_visible_sheet_content(self): p = os.path.join(self.tmp, "wb.xlsx") self._build(p) text = extract_document_text(p) self.assertIn("Data", text) # sheet label self.assertIn("Name\tScore", text) # shared-string header row self.assertIn("Alice\t95", text) # string + numeric cells def test_not_a_zip_raises(self): p = os.path.join(self.tmp, "bad.xlsx") with open(p, "wb") as fh: fh.write(b"nope") with self.assertRaises(ExtractionError): extract_document_text(p) # --------------------------------------------------------------------------- # read_file_tool integration # --------------------------------------------------------------------------- class TestReadFileToolIntegration(unittest.TestCase): def setUp(self): self.tmp = tempfile.mkdtemp(prefix="rex_int_") def tearDown(self): import shutil shutil.rmtree(self.tmp, ignore_errors=True) def test_notebook_read_is_line_numbered(self): p = os.path.join(self.tmp, "nb.ipynb") _write_notebook(p, [ {"cell_type": "markdown", "source": "# H"}, {"cell_type": "code", "source": "print(1)"}, ]) res = json.loads(read_file_tool(p)) self.assertTrue(res.get("extracted_document")) self.assertIn("1|", res["content"]) # line-number gutter self.assertIn("print(1)", res["content"]) def test_corrupt_docx_falls_through_to_binary_guard(self): p = os.path.join(self.tmp, "bad.docx") with open(p, "wb") as fh: fh.write(b"not a zip") res = json.loads(read_file_tool(p)) # Should NOT crash; falls through to the binary-extension guard. self.assertIn("error", res) self.assertIn("binary", res["error"].lower()) def test_docx_read_extracts(self): p = os.path.join(self.tmp, "d.docx") _write_docx(p, (f'' 'Report body' '')) res = json.loads(read_file_tool(p)) self.assertTrue(res.get("extracted_document")) self.assertIn("Report body", res["content"]) if __name__ == "__main__": unittest.main()