fix: Exit gracefully on artwork and sourcecode src file access errors

[kesara]

Fixes #1125

[rjsparks]

This changes the overall behavior to "exit on first error" rather than "list all errors". Is that necessary?
I think #1125 was complaining more about the lack of a human-readable interpretation of what had gone wrong than it was the stack trace hiding the error.

[kesara]

This changes the overall behavior to "exit on first error" rather than "list all errors". Is that necessary? I think #1125 was complaining more about the lack of a human-readable interpretation of what had gone wrong than it was the stack trace hiding the error.

This changes the overall behavior to "exit on first error" rather than "list all errors". Is that necessary? I think #1125 was complaining more about the lack of a human-readable interpretation of what had gone wrong than it was the stack trace hiding the error.

xml2rfc doesn't have a builtin functionality to list errors and not generate an output. (EDIT: This statement is incorrect.)
If we are to list these errors, xml2rfc will output something with empty art work/sourcecode.

EDIT: Exception being the parser, where it list errors and on-certain errors xml2rfc exits. But this happens after the parsing in prep stage.

[cabo]

xml2rfc doesn't have a builtin functionality to list errors and not generate an output.
If we are to list these errors, xml2rfc will output something with empty art work/sourcecode.

Which may be exactly what you want during editing the document.

(FYI, kramdown-rfc does not use src=.)

[kesara]

The existing behaviour is artwork src= exits with an error without generating output:

/root/xml2rfc/draft-doe-src-00.xml(26): Error: Expected an <artwork> src= file at '/root/xml2rfc/foobar.txt', but no such file exists
Not creating output file due to errors (see above)
Unable to complete processing draft-doe-src-00.xml

The sourcecode src= crashes:

/root/xml2rfc/draft-doe-src-00.xml(26): Error: Expected an <sourcecode> src= file at '/root/xml2rfc/foobar.txt', but no such file exists
Traceback (most recent call last):
  File "/usr/local/bin/xml2rfc", line 8, in <module>
    sys.exit(main())
  File "/usr/local/lib/python3.10/dist-packages/xml2rfc/run.py", line 720, in main
    xmlrfc.tree = prep.prep()
  File "/usr/local/lib/python3.10/dist-packages/xml2rfc/writers/preptool.py", line 215, in prep
    tree = self.dispatch(self.selectors)
  File "/usr/local/lib/python3.10/dist-packages/xml2rfc/writers/base.py", line 1933, in dispatch
    func(e, e.getparent())
  File "/usr/local/lib/python3.10/dist-packages/xml2rfc/writers/preptool.py", line 1944, in element_sourcecode
    self.normalize_whitespace(e)
  File "/usr/local/lib/python3.10/dist-packages/xml2rfc/writers/preptool.py", line 196, in normalize_whitespace
    lines = e.text.split('\n')
AttributeError: 'NoneType' object has no attribute 'split'

[kesara]

With c4a4a0e, sourcecode src= exits gracefully similar to artwork src=.

[kesara]

Proposed change lists all the errors before exiting:

/root/xml2rfc/draft-doe-src-00.xml(27): Error: Expected an <artwork> src= file at '/root/xml2rfc/foobar.txt', but no such file exists
/root/xml2rfc/draft-doe-src-00.xml(26): Error: Expected an <sourcecode> src= file at '/root/xml2rfc/foobar.txt', but no such file exists
Not creating output file due to errors (see above)
Unable to complete processing draft-doe-src-00.xml

[rjsparks]

This is incremental improvement, so we should take it.
But we should have a separate issue that tracks letting the run go further, collecting errors along the way, so that users don't have to run the program repeatedly to find all the errors.

[kesara]

This is incremental improvement, so we should take it. But we should have a separate issue that tracks letting the run go further, collecting errors along the way, so that users don't have to run the program repeatedly to find all the errors.

xml2rfc is already doing that in preptool stage, my initial statement was incorrect. I've updated comment.¹

Proposed change will follow the same pattern. See output in #1203 (comment)

Footnotes

1. https://github.com/ietf-tools/xml2rfc/pull/1203#issuecomment-2596855989 ↩