Run_script echo output to console, and capture errors from script

[alextrical]

Description

run_script steps are now run with output echoed into the terminal, allowing the user to see the status of a script.
Errors raised from the script are now have handling.

Any Raised errors other than 0, will create an error message but continue with the rest of the manifest (non blocking)
However it could be advisable to gracefully terminate the application installation with a GUI message?

Fixes #3275

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.

• Run any application manifest with a "run_script" step. The output will be echoed into the terminal.

[mirkobrombin]

change this to return result.returncode == 0 this will return True if the condition meet and False otherwise. If you look at how the install function executes the installer' steps, it checks if one of them returns False

Bottles/bottles/backend/managers/installer.py

Lines 421 to 424 in 2bd8b60

	if not self.__perform_steps(_config, steps):
	return Result(
	False, data={"message": "Installer is not well configured."}
	)

and then return a proper Result object according to that.

Currently, there is no easy way to show a message to the user graphically. It could be possible by making each step returning a tuple (boolean, message) and have the install function append that message to the Result object, then updating the installer view in the frontend to use that message if available

Bottles/bottles/frontend/windows/installer.py

Lines 165 to 185 in 2bd8b60

	def __install(self, *_args):
	self.set_deletable(False)
	self.stack.set_visible_child_name("page_install")
	@GtkUtils.run_in_main_loop
	def set_status(result, error=False):
	if result.ok:
	return self.__installed()
	_err = result.data.get("message", _("Installer failed with unknown error"))
	self.__error(_err)
	self.set_steps(self.manager.installer_manager.count_steps(self.installer))
	RunAsync(
	task_func=self.manager.installer_manager.install,
	callback=set_status,
	config=self.config,
	installer=self.installer,
	step_fn=self.next_step,
	local_resources=self.__final_resources,
	)

[alextrical]

adding the line return result.returncode == 0 results in a known failure (exit 1) in the script not even putting a warning in the Console, and just continuing with the rest of the manifest steps.

Same goes for adding
return False
or

      return Result( 
         False, data={"message": "Installer is not well configured."} 
     ) 

Bottles just continues on with the rest of the manifest regardless of the failure

It looks like there is something missing to handle the return at this point, as it continues regardless of any state returned

[mirkobrombin]

It's handled here

Bottles/bottles/frontend/windows/installer.py

Line 171 in 2bd8b60

if result.ok:

it will simply never complete without an ok result. Can' t take a look in a short time.

[alextrical]

It seems like I'm missing a couple of tricks today, but as far as i can tell it always completes regardless of the result being set to Null, True or False. I can't get it to fail the install process from a script by setting the "Result"

Edit: Welp it seems i accidentally closed this... For now I should probably take a break from projects for a few days while i get other things sorted out

[mirkobrombin]

Let me know if I should re-open it

[alextrical]

If you could, that would be great.

I think the next step is working out why the Result doesn't look like it's being checked. As either False or no Result being set don't stop the manifest proceeding to the next step

[fab-sonarqube]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

0.0% Coverage
0.0% Duplication

[github-actions]

Pylint result on modfied files:

************* Module bottles.backend.managers.installer
bottles/backend/managers/installer.py:100:20: I1101: Module 'pycurl' has no 'Curl' member, but source is unavailable. Consider adding this module to extension-pkg-allow-list if you want to perform analysis based on run-time introspection of living objects. (c-extension-no-member)
bottles/backend/managers/installer.py:102:38: R1732: Consider using 'with' for resource-allocating operations (consider-using-with)
bottles/backend/managers/installer.py:252:17: W1510: 'subprocess.run' used without explicitly defining the value for 'check'. (subprocess-run-check)
bottles/backend/managers/installer.py:231:4: R1710: Either all return statements in a function should return an expression, or none of them should. (inconsistent-return-statements)
bottles/backend/managers/installer.py:361:4: R0913: Too many arguments (6/5) (too-many-arguments)