Add interface / convenience functionality concerning result file handling needed by SAF

[rfahlberg]

📝 Description of the feature

• To ParametricSystem wrapper class, add interface / convenience functionality to
  • Obtain path to result OMDB file (resemble functionality of OWS "/omdb" endpoints)
  • Generate and store a CSV/Json file containing result designs
• To Node wrapper class, add functionality to
  • Obtain information about node result files:
    • Path on filesystem
    • Registered file ID and Comment
    • Status (exists or not)
    • File size
    • Last modified
• To Project wrapper class, add functionality to
  • Obtain information about project result files:
    • Path on filesystem
    • Registered file ID and Comment
    • Status (exists or not)
    • File size
    • Last modified

Effort estimation: 1PW

💡 Steps for implementing the feature

No response

🔗 Useful links and references

According tasks in SAF:

• https://github.com/Solution-Applications/solution-enablement-product-management/issues/484
• https://github.com/Solution-Applications/solution-enablement-product-management/issues/515

[rfahlberg]

@asbfall @iazehaf FYI

[rfahlberg]

@sebastian-wolff FYI

[PanekOndrej]

Hi Ronny, could you please clarify, what exactly you mean by result files? Do you mean registered files that I can obtain by basic_project_info query for the project? For nodes I can then use get_actor_info to obtain uids of registered files associated with individual nodes and filter whole list obtained by basic_project_info.

@rfahlberg

[rfahlberg]

@PanekOndrej Yes, exactly. The "result files" are the centrally registered files, which are set to { "usage": "Output file" }. The global list can be obtained using "basic_project_info". If a registered file is not associated to (use by) a certain node, it should be accessible via pyosl "Project" interface. If a registered file is associated to (use by) a certain node, it should be accessible via pyosl "Node" interface. For nodes you can use get_actor_info to obtain uids of used registered files.

[PanekOndrej]

I implemented requested functionality and linked a branch to this issue.

• Regarding designs, I implemented:

  • Node wrapper class's public method get_states_ids() -> Tuple[str]
  • ParametricSystem wrapper class's methods:
    • private method _get_designs_dicts() -> OrderedDict returning designs of all available states for given parametric system (sorted by state hid key)
    • public method get_omdb_files() -> Tuple[File]
    • public method save_designs_as(hid: str, file_name: str, format: FileOutputFormat = FileOutputFormat.JSON, dir: Union[Path, str] = None) -> File
    • *File object contains file's path and convenience functionality to get info about the file
  • We may create public method get_designs() that would return object DesignCollection (or sth like that), that would contain individual designs (Design class, that is already implemented could be used for this) and methods to work with these design
    resembling OWS functionality (number of succeeded designs, processed designs etc.).

• Regarding result files, both Node (and it's subclasses) and Project wrappers have methods get_registered_files() and get_result_files -> Tuple[RegisteredFile], which is a object with properties returning requested info.

I think this should do it, please let me know if there are any issues with implementation. Otherwise I'd like to create unit tests and then it should be ready for merge into main branch.

@rfahlberg

[rfahlberg]

@PanekOndrej looks very good to me. Please go ahead with unit tests and PR.

[rfahlberg]

@iazehaf Please confirm the additions are sufficient for SAF.