Report progress and errors when running scripts

[imobachgs]

Problem

The only way a user can check whether a user script failed is by checking the logs.

Solution

Implement support to report errors (using the questions mechanism) and ask the user whether Agama should retry running the script. The question includes additional information that can be used (in the future) in the UI to present a better question:

[
  {
    "id": 1,
    "text": "Running the script 'test.sh' failed. Do you want to try again?",
    "class": "scripts.retry",
    "field": {
      "type": "none"
    },
    "actions": [
      {
        "id": "Yes",
        "label": "Yes"
      },
      {
        "id": "No",
        "label": "No"
      }
    ],
    "defaultAction": "No",
    "data": {
      "stderr": "some error message\n",
      "name": "test.sh",
      "exit_code": "1"
    }
  }
]

Additionally, Agama now reports the progress of running the scripts.

[jreidinger]

do we have that type of question already documented? If not, please write it down to some follow up, to update documentation when new api will be merged.

[imobachgs]

Good point. No, it is not documented, but I opened agama-project.github.io#134.

Talking about this, I think we should drop the questions.md from this repository.

[jreidinger]

that maybe open question if we should document that it is only for 16.1 and newer, but it is topic for that documentation PR

[jreidinger]

note: this can be problematic if script will print too much in stdout or stderr as it will eat memory.

[imobachgs]

This behaviour comes from AutoYaST.

[jreidinger]

and does autoyast also store whole output in memory or stream it via fs redirections to that file?

[imobachgs]

Oh, now I know what you meant. No, AutoYaST writes it directly to a file. So I have adapted the code to behave in the same way, but I think we need to do additional changes:

• If we decide to write the stdout to a file because it can be a big file, then we should not send its content as part of the question. So I a dropping the stdout key.
• I am not sure about stderr (I would expect it to be smaller, but there are no guarantees about it). By now I am still ending the whole content.

Perhaps we could send just part of the stdout/stderr content to the question.

[jreidinger]

small note about localization. If you change localization during progress..it won't switch localization when we have it working of course :)

[imobachgs]

Yes, we need to go through the whole application when we have l10n/i18n working :-)