Discuss ADR: Safe File and Plist Handling Functions

[JamesHabben]

Implement Safe File and Plist Handling Functions

Context

Currently, artifact modules handle file opening and plist parsing directly, without consistent error handling. This can lead to module failures that stop the execution of the entire artifact when encountering issues.

Proposal

Implement two new utility functions in ilapfuncs.py:

1. get_file_content(file_path, binary_mode=False, encoding=None)
2. get_plist_content(file_path)

These functions will encapsulate file opening and plist parsing operations with proper error handling.

Benefits

• Improved error handling and logging across all artifact modules
• Simplified code in individual artifact modules
• Consistent behavior when encountering file access or parsing issues
• Easier maintenance and updates to error handling logic

Implementation Details

See attached ADR for full implementation details of both functions.

Discussion Points

• Are there any other parameters needed for these functions?
• Should we consider any additional error cases?
• How should we approach updating existing modules to use these new functions?

Please review and provide feedback on this proposal.

https://github.com/abrignoni/iLEAPP/blob/lava-output/admin/docs/features/file_content_access_architecture.md

[JamesHabben]

after chat discussion, sounds like we want to include a safe open function to open ccl data

[Johann-PLW]

New functions have been added to get SQLite records, plist file or embedded plist contents.

• get_sqlite_db_records(path, query)
• get_plist_content(data)
• get_plist_file_content(file_path)

The goal is to reduce and simplify code, improve error handling and logging across all artifact modules.

Documentation will be added to ADR: Implement Safe File and Plist Handling Functions file and linked to Updating Modules for Automatic Output Generation.

[abrignoni]

This is great! Looking forward to some sample code. 👏👏👏

…

On Mon, Dec 2, 2024 at 6:21 AM Johann POLEWCZYK ***@***.***> wrote: New functions have been added to get SQLite records, plist file or embedded plist contents. - get_sqlite_db_records(path, query) - get_plist_content(data) - get_plist_file_content(file_path) The goal is to reduce and simplify code, improve error handling and logging across all artifact modules. Documentation will be added to ADR: Implement Safe File and Plist Handling Functions <https://github.com/abrignoni/iLEAPP/blob/lava-output/admin/docs/features/file_content_access_architecture.md> file and linked to Updating Modules for Automatic Output Generation <https://github.com/abrignoni/iLEAPP/blob/lava-output/admin/docs/module_updates.md> . — Reply to this email directly, view it on GitHub <#892 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG3DPC4KVKMRESWWYIZIXND2DQ7E3AVCNFSM6AAAAABQLHFUKGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMJRGI3DIOBVG4> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[Johann-PLW]

@abrignoni.
I have updated the documentation Updating Modules for Automatic Output Generation with some code examples. Let me know if it is enough.
And if you think these changes really improve module writing, I'll update existing scripts to have even more examples.