Repository Public
1// ORIX Docs2// File: Packages/ORIXDocsKit/Tests/DocAutomationTests/WorkflowStepTests.swift3// Description: Every workflow step on real documents: the resulting model or the file written is what is asserted.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import PDFKit9import Testing10import DocModel11import DocContainer12import DocTemplates13@testable import DocAutomation1415@Suite struct WorkflowStepTests {16 /// Runs `steps` on a document in memory and returns the result (the run must succeed).17 private func run(_ steps: [WorkflowStep], on doc: DocumentModel, name: String = "sample", in folder: TempFolder, sourceLocation: SourceLocation = #_sourceLocation) async throws -> WorkflowResult {18 let runner = WorkflowRunner(outputDirectory: folder.url)19 let result = await runner.run(Workflow(name: "Test", steps: steps), input: .document(doc, name: name))20 #expect(result.record.status == .succeeded, "\(result.record.error?.description ?? "")", sourceLocation: sourceLocation)21 return result22 }2324 @Test func importFromInputAndFromPath() async throws {25 let folder = TempFolder()26 let md = folder.file("notes.md")27 try Data(Sample.markdown.utf8).write(to: md)28 let runner = WorkflowRunner(outputDirectory: folder.subfolder("out"))2930 let fromInput = await runner.run(Workflow(name: "A", steps: [.importDocument(path: nil)]), input: .file(md))31 #expect(fromInput.record.status == .succeeded)32 let doc = try #require(fromInput.document)33 #expect(doc.body.contains { $0.paragraph?.plainText == "Field Notes" })34 #expect(doc.body.contains { $0.table != nil })3536 // A path in the step wins over the input.37 let fromPath = await runner.run(Workflow(name: "B", steps: [.importDocument(path: md.path)]), input: .document(DocumentModel(), name: "ignored"))38 #expect(fromPath.document?.body.contains { $0.paragraph?.plainText == "Method" } == true)3940 let missing = await runner.run(Workflow(name: "C", steps: [.importDocument(path: nil)]), input: .file(folder.file("absent.docx")))41 #expect(missing.record.status == .failed)42 #expect(missing.record.error?.kind == .importFailed)43 #expect(missing.record.error?.stepIndex == 0)44 #expect(missing.record.error?.file.hasSuffix("absent.docx") == true)45 }4647 @Test func stepsNeedADocument() async {48 let folder = TempFolder()49 let result = await WorkflowRunner(outputDirectory: folder.url).run(Workflow(name: "No import", steps: [.acceptAllChanges]), input: .file(folder.file("x.md")))50 #expect(result.record.error?.kind == .missingInput)51 }5253 @Test func applyTheme() async throws {54 let folder = TempFolder()55 let doc = Sample.report()56 #expect(doc.styles.themeName == Theme.orix.name)57 let out = try #require(try await run([.applyTheme(name: "Classic")], on: doc, in: folder).document)58 #expect(out.styles.themeName == "Classic")59 #expect(out.styles.defaultChar.fontFamily == Theme.classic.bodyFont)60 #expect(out.styles.charProps(paraStyle: StyleID.heading(1), charStyle: nil, direct: .none).fontFamily == Theme.classic.headingFont)61 #expect(out.body == doc.body)62 }6364 @Test func applyTemplateStylesKeepsStyleIDsAndCustomStyles() async throws {65 let folder = TempFolder()66 var doc = Sample.report()67 doc.styles.upsert(Style(id: "Pullout", name: "Pull-out", basedOn: StyleID.normal, char: CharProps(italic: true)))68 doc.body.append(.paragraph(Paragraph("A custom paragraph.", style: "Pullout")))69 let template = try #require(TemplateLibrary.template(id: "thesis"))70 let expected = template.make(TemplateContext(author: doc.meta.author, language: "en", paper: doc.pageSetup.paper)).styles7172 let out = try #require(try await run([.applyTemplateStyles(templateID: "thesis")], on: doc, in: folder).document)73 #expect(out.styles.themeName == expected.themeName)74 #expect(out.styles.style(StyleID.heading(1)) == expected.style(StyleID.heading(1)))75 #expect(out.styles.style(StyleID.normal) == expected.style(StyleID.normal))76 // Paragraphs still point at the same style ids, and the custom style survived.77 #expect(out.body.map { $0.paragraph?.style } == doc.body.map { $0.paragraph?.style })78 #expect(out.styles.style("Pullout")?.char.italic == true)79 }8081 @Test func setPageSetupOnEverySection() async throws {82 let folder = TempFolder()83 var doc = Sample.report()84 doc.body.insert(.sectionBreak(SectionBreak(setup: PageSetup(paper: .letter, margins: Insets(all: 36)))), at: 4)85 let options = PageSetupOptions(paper: "a4", orientation: "landscape", margins: 54, marginLeft: 90)86 let out = try #require(try await run([.setPageSetup(options)], on: doc, in: folder).document)87 #expect(out.sectionSetups.count == 2)88 for setup in out.sectionSetups {89 #expect(setup.paper == .a4)90 #expect(setup.landscape)91 #expect(setup.margins == Insets(top: 54, left: 90, bottom: 54, right: 54))92 #expect(setup.pageWidth > setup.pageHeight)93 }94 }9596 private func trackedDocument() -> DocumentModel {97 var doc = DocumentModel(body: [Sample.para("Hello world")])98 doc.settings.trackChanges = true99 var editor = DocumentEditor(doc: doc, selection: Selection(caret: Position(block: 0, offset: 5)), author: "Reviewer")100 editor.insertText(" big")101 return editor.doc102 }103104 @Test func acceptAndRejectAllChanges() async throws {105 let folder = TempFolder()106 let doc = trackedDocument()107 #expect(doc.hasTrackedChanges)108109 let accepted = try await run([.acceptAllChanges], on: doc, in: folder)110 #expect(accepted.document?.hasTrackedChanges == false)111 #expect(accepted.document?.body.first?.paragraph?.plainText == "Hello big world")112 #expect(accepted.record.steps[0].detail.contains("1 change accepted"))113114 let rejected = try await run([.rejectAllChanges], on: doc, in: folder)115 #expect(rejected.document?.hasTrackedChanges == false)116 #expect(rejected.document?.body.first?.paragraph?.plainText == "Hello world")117118 let nothing = try await run([.acceptAllChanges], on: Sample.report(), in: folder)119 #expect(nothing.record.steps[0].outcome == .skipped)120 }121122 @Test func removeComments() async throws {123 let folder = TempFolder()124 var editor = DocumentEditor(doc: Sample.report(), selection: Selection(anchor: Position(block: 2, offset: 4), head: Position(block: 2, offset: 15)), author: "Reviewer")125 #expect(editor.addComment("Check this figure.") != nil)126 #expect(editor.doc.comments.count == 1)127 let out = try #require(try await run([.removeComments], on: editor.doc, in: folder).document)128 #expect(out.comments.isEmpty)129 var anchors = 0130 out.forEachParagraphEverywhere { p, _, _ in anchors += p.runs.filter { !$0.comments.isEmpty }.count }131 #expect(anchors == 0)132 #expect(out.body[2].paragraph?.plainText == Sample.report().body[2].paragraph?.plainText)133 }134135 @Test func tableOfContentsInsertedRefreshedOrSkipped() async throws {136 let folder = TempFolder()137 let inserted = try #require(try await run([.tableOfContents(title: nil, maxLevel: 2)], on: Sample.report(), in: folder).document)138 // After the title, before the first heading.139 guard case .toc(let toc) = inserted.body[1] else { Issue.record("no contents block after the title"); return }140 #expect(toc.kind == .contents && toc.maxLevel == 2 && toc.title == "Contents")141 #expect(inserted.body[0].paragraph?.style == StyleID.title)142 #expect(inserted.body.count == Sample.report().body.count + 1)143144 // Running it again refreshes the existing block instead of adding a second one.145 let again = try await run([.tableOfContents(title: "Summary", maxLevel: 3)], on: inserted, in: folder)146 let blocks = again.document?.body.compactMap { b -> TOCBlock? in if case .toc(let t) = b { return t } else { return nil } } ?? []147 #expect(blocks.count == 1)148 #expect(blocks.first?.maxLevel == 3 && blocks.first?.title == "Summary")149150 let flat = try await run([.tableOfContents(title: nil, maxLevel: 3)], on: DocumentModel(body: [Sample.para("No headings here.")]), in: folder)151 #expect(flat.record.steps[0].outcome == .skipped)152 #expect(flat.document?.body.count == 1)153154 var french = Sample.report()155 french.meta.language = "fr-CA"156 let fr = try await run([.tableOfContents(title: nil, maxLevel: 3)], on: french, in: folder)157 #expect(fr.document?.body.contains { if case .toc(let t) = $0 { return t.title == "Table des matières" } else { return false } } == true)158 }159160 private func citingDocument() -> DocumentModel {161 var doc = Sample.report()162 var p = Paragraph("As shown before ")163 p.runs.append(Run(inline: .citation(Citation("knuth1984"))))164 p.runs.append(Run("."))165 doc.body.append(.paragraph(p))166 doc.bibliography = [BibEntry(key: "knuth1984", type: "book", authors: [PersonName(family: "Knuth", given: "Donald E.")], year: 1984,167 fields: ["title": "The TeXbook", "publisher": "Addison-Wesley"])]168 return doc169 }170171 @Test func bibliographyOnlyWhenCitedAndAbsent() async throws {172 let folder = TempFolder()173 let cited = try await run([.insertBibliography(title: nil)], on: citingDocument(), in: folder)174 guard case .bibliography(let block)? = cited.document?.body.last else { Issue.record("no bibliography at the end"); return }175 #expect(block.title == "References")176177 let twice = try await run([.insertBibliography(title: nil)], on: try #require(cited.document), in: folder)178 #expect(twice.record.steps[0].outcome == .skipped)179 #expect(twice.document?.body.filter { if case .bibliography = $0 { return true } else { return false } }.count == 1)180181 let plain = Sample.report()182 let none = try await run([.insertBibliography(title: nil)], on: plain, in: folder)183 #expect(none.record.steps[0].outcome == .skipped)184 #expect(none.document?.body == plain.body)185 }186187 @Test func citationStyleChangesThePublishedText() async throws {188 let folder = TempFolder()189 let result = try await run([.setCitationStyle(id: "ieee"), .insertBibliography(title: nil), .export(format: .txt, fileName: nil, pdf: nil)], on: citingDocument(), in: folder)190 #expect(result.document?.settings.citationStyle == "ieee")191 let text = try String(contentsOf: folder.file("sample.txt"), encoding: .utf8)192 #expect(text.contains("[1]"))193 #expect(!text.contains("(Knuth, 1984)"))194 }195196 @Test func recalculateTableFormulas() async throws {197 let folder = TempFolder()198 var table = Table(strings: [["Item", "Amount"], ["A", "10"], ["B", "32"], ["Total", "0"]], width: 400)199 table.rows[3].cells[1].formula = "=SUM(ABOVE)"200 let doc = DocumentModel(body: [.table(table)])201 let result = try await run([.recalculateTables], on: doc, in: folder)202 #expect(result.document?.body.first?.table?.rows[3].cells[1].plainText == "42")203 #expect(result.record.steps[0].detail.contains("1 formula"))204 let none = try await run([.recalculateTables], on: Sample.report(), in: folder)205 #expect(none.record.steps[0].outcome == .skipped)206 }207208 @Test func setMetadata() async throws {209 let folder = TempFolder()210 let options = MetadataOptions(title: "Annual Review", subject: "Finance", keywords: ["budget", "audit"], language: "fr")211 let out = try #require(try await run([.setMetadata(options)], on: Sample.report(), in: folder).document)212 #expect(out.meta.title == "Annual Review")213 #expect(out.meta.author == "Ada Lovelace") // absent values are left alone214 #expect(out.meta.subject == "Finance" && out.meta.keywords == ["budget", "audit"] && out.meta.language == "fr")215 }216217 private func brokenDocument() -> DocumentModel {218 var doc = Sample.report()219 var p = Paragraph("See ")220 p.runs.append(Run(inline: .crossRef(CrossRef(target: "no-such-target"))))221 doc.body.append(.paragraph(p))222 return doc223 }224225 @Test func auditCollectsFindingsAndCanFailTheWorkflow() async throws {226 let folder = TempFolder()227 let lenient = try await run([.audit(profile: .standard, failOnErrors: false), .export(format: .txt, fileName: nil, pdf: nil)], on: brokenDocument(), in: folder)228 #expect(lenient.findings.contains { $0.check == .brokenCrossReference && $0.severity == .error })229 #expect((lenient.record.audit?.errors ?? 0) >= 1)230 #expect(FileManager.default.fileExists(atPath: folder.file("sample.txt").path))231232 let strictFolder = TempFolder()233 let strict = await WorkflowRunner(outputDirectory: strictFolder.url).run(234 Workflow(name: "Strict", steps: [.audit(profile: .standard, failOnErrors: true), .export(format: .txt, fileName: nil, pdf: nil)]),235 input: .document(brokenDocument(), name: "sample"))236 #expect(strict.record.status == .failed)237 #expect(strict.record.error?.kind == .auditFailed)238 #expect(strict.record.error?.stepIndex == 0)239 #expect(strict.record.steps[1].outcome == .notRun)240 #expect(!FileManager.default.fileExists(atPath: strictFolder.file("sample.txt").path))241242 // A clean document passes the strict audit.243 let clean = await WorkflowRunner(outputDirectory: strictFolder.url).run(244 Workflow(name: "Strict", steps: [.audit(profile: .minimal, failOnErrors: true)]), input: .document(Sample.report(), name: "clean"))245 #expect(clean.record.status == .succeeded)246 }247248 @Test func exportPDFHasTheExpectedPagesAndText() async throws {249 let folder = TempFolder()250 var doc = Sample.report()251 doc.body.insert(.pageBreak(BreakBlock()), at: 3)252 doc.body.insert(.pageBreak(BreakBlock()), at: 6)253 let result = try await run([.export(format: .pdf, fileName: nil, pdf: PDFExportOptions(outline: true, tagged: true))], on: doc, name: "report", in: folder)254 let url = folder.file("report.pdf")255 #expect(result.record.outputs == [url.resolvingSymlinksInPath().path])256 let pdf = try #require(PDFDocument(url: url))257 #expect(pdf.pageCount == 3)258 let text = pdf.string ?? ""259 #expect(text.contains("Zebra Findings"))260 #expect(text.contains("Quarterly Report"))261 #expect(result.record.warnings.isEmpty, "\(result.record.warnings)")262 // The outline is not asserted here: on macOS 27.0 PDFKit loses it when PDFPublisher re-serialises the file263 // (a defect of the publisher, reported to its owner; see docs/development/automation.md, "Known limits").264265 // A page range publishes only those pages.266 _ = try await run([.export(format: .pdf, fileName: "first-two.pdf", pdf: PDFExportOptions(firstPage: 1, lastPage: 2))], on: doc, in: folder)267 #expect(PDFDocument(url: folder.file("first-two.pdf"))?.pageCount == 2)268 }269270 @Test func exportDOCXReimports() async throws {271 let folder = TempFolder()272 _ = try await run([.export(format: .docx, fileName: "{name}-copy.docx", pdf: nil)], on: Sample.report(), name: "report", in: folder)273 let back = try DocumentConverter.importDocument(at: folder.file("report-copy.docx")).document274 let headings = back.body.compactMap { $0.paragraph }.filter { $0.style == StyleID.heading(1) }.map(\.plainText)275 #expect(headings == ["Introduction", "Zebra Findings", "Conclusion"])276 #expect(back.body.first?.paragraph?.style == StyleID.title)277 }278279 @Test func everyExportFormatWritesAFileThatReadsBack() async throws {280 let folder = TempFolder()281 let steps = DocumentConverter.exportFormats.map { WorkflowStep.export(format: $0, fileName: nil, pdf: nil) }282 let result = try await run(steps, on: Sample.report(), name: "all", in: folder)283 #expect(result.record.outputs.count == DocumentConverter.exportFormats.count)284 for format in DocumentConverter.exportFormats {285 let back = try DocumentConverter.importDocument(at: folder.file("all." + format.fileExtension)).document286 var text = ""287 back.forEachBodyParagraph { p, _ in text += p.plainText + "\n" }288 #expect(text.contains("Zebra Findings"), "\(format)")289 }290 }291292 @Test func auditReportWrittenNextToTheOutput() async throws {293 let folder = TempFolder()294 let steps: [WorkflowStep] = [.audit(profile: .standard, failOnErrors: false), .export(format: .pdf, fileName: nil, pdf: nil),295 .writeAuditReport(format: "md", fileName: nil), .writeAuditReport(format: "json", fileName: nil)]296 let result = try await run(steps, on: brokenDocument(), name: "paper", in: folder)297 #expect(result.record.outputs.map { ($0 as NSString).lastPathComponent } == ["paper.pdf", "paper-audit.md", "paper-audit.json"])298 let md = try String(contentsOf: folder.file("paper-audit.md"), encoding: .utf8)299 #expect(md.contains("no-such-target"))300 let json = try #require(try JSONSerialization.jsonObject(with: Data(contentsOf: folder.file("paper-audit.json"))) as? [String: Any])301 let summary = try #require(json["summary"] as? [String: Any])302 #expect((summary["errors"] as? Int ?? 0) >= 1)303 #expect((json["findings"] as? [[String: Any]])?.contains { $0["check"] as? String == "brokenCrossReference" } == true)304305 // Without an audit step there is nothing to report: the step is skipped, not failed.306 let skipped = try await run([.writeAuditReport(format: "md", fileName: "none.md")], on: Sample.report(), in: folder)307 #expect(skipped.record.steps[0].outcome == .skipped)308 #expect(!FileManager.default.fileExists(atPath: folder.file("none.md").path))309 }310311 @Test func existingOutputIsNeverOverwrittenByDefault() async throws {312 let folder = TempFolder()313 let target = folder.file("sample.txt")314 try Data("keep me".utf8).write(to: target)315 let workflow = Workflow(name: "Export", steps: [.export(format: .txt, fileName: nil, pdf: nil)])316317 let refused = await WorkflowRunner(outputDirectory: folder.url).run(workflow, input: .document(Sample.report(), name: "sample"))318 #expect(refused.record.error?.kind == .outputExists)319 #expect(try String(contentsOf: target, encoding: .utf8) == "keep me")320321 let renamed = await WorkflowRunner(outputDirectory: folder.url, existingFiles: .rename).run(workflow, input: .document(Sample.report(), name: "sample"))322 #expect(renamed.record.outputs.first?.hasSuffix("sample 2.txt") == true)323 #expect(try String(contentsOf: target, encoding: .utf8) == "keep me")324325 let forced = await WorkflowRunner(outputDirectory: folder.url, existingFiles: .overwrite).run(workflow, input: .document(Sample.report(), name: "sample"))326 #expect(forced.record.status == .succeeded)327 #expect(try String(contentsOf: target, encoding: .utf8).contains("Zebra Findings"))328 }329330 @Test func exportNeverReplacesItsOwnInput() async throws {331 let folder = TempFolder()332 let source = try Sample.write(Sample.report(), to: folder.file("report.docx"))333 let before = try Data(contentsOf: source)334 let workflow = Workflow(name: "In place", steps: [.importDocument(path: nil), .applyTheme(name: "Modern"), .export(format: .docx, fileName: nil, pdf: nil)])335 let result = await WorkflowRunner(outputDirectory: folder.url, existingFiles: .overwrite).run(workflow, input: .file(source))336 #expect(result.record.error?.kind == .outputExists)337 #expect(try Data(contentsOf: source) == before)338 }339}340