Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make divest functions error aware #206

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

make divest functions error aware #206

wants to merge 3 commits into from

Conversation

steadfasterX
Copy link
Contributor

@steadfasterX steadfasterX commented Apr 14, 2023 •
edited
Loading

this commit adds (the currently non-existing) error handling when using divest's functions and scripts.
all the magic here gets activated when source ../../Scripts/init.sh gets executed which is already a mandatory step before starting any of the divest functions.

when something fails during patching, resetting or building each error will be catched + printed including an error code now. last but not least the executed file and the line number causing that failure will be shown, too.

as all divest functions get source'd and so not a single build script gets executed all ERR's needs to be trapped to catch issues. I am not aware of another way to handle that properly as sourcing means we cannot track a script or smth while this approach here just works.

Example for an error thrown in a function call:

ERROR: $DOS_WORKSPACE_ROOT/Scripts/Common/Functions.sh -> verifyAllPlatformTags() ended with status >1< at line >49<

Final SUCCESS result message after using patchWorkspace:

[FINAL RESULT] No error detected (please check the above output nevertheless!)

Final ERROR result message after using patchWorkspace:

[FINAL RESULT] Serious error(s) found!!!
Summary error code was: 126. Check & fix all error lines above

Some notes:

  • when an error occurs the process continues until the end (like it is now) i.e. an error will not stop the current and following tasks
  • when multiple errors occur the exit codes will be summed
  • buildDevice: a (summed) end result gets printed (SUCCESS or ERROR) at the very end
  • the trap used to catch any error will also be active for any command executed on the cli. that means: type "false" -> ENTER and you will get an error, too same for any script exectued after source init.sh
  • when all goes well the trap will be resetted at the end but there are cases where this might not happen -> that is why resetEnv can be executed to reset the trap, i.e. all becomes as it was before sourcing init.sh
  • resetEnv gets called automatically:
    • after a successful patchWorkspace run
    • whenever CTRL+C is used (during a running task or just on the cli)
    • a process get killed (SIGHUP, TERM)
  • the whole implementation might not catch all errors though - it highly depends on how the function or the script/program called actually handles errors or better said: if they return a proper exit code on failures. For example some tools (like some git cmds) might print an error but don't return a non-zero exit code. This cannot be tracked other then with your eyes or these must be replaced by other methods returning a non-zero exit code on failures.

@SkewedZeppelin
Copy link
Member

I'll need to play around with this, but looks good!

@SkewedZeppelin SkewedZeppelin added the enhancement New feature or request label Apr 18, 2023
@steadfasterX
Copy link
Contributor Author

steadfasterX commented Jun 1, 2023 •
edited
Loading

I'll need to play around with this, but looks good!

do you had some time playing with it ;) @SkewedZeppelin ?

@steadfasterX steadfasterX mentioned this pull request Jul 10, 2023
Closed
steadfasterX added a commit to AXP-OS/build that referenced this pull request Jul 13, 2023
@steadfasterX
fix an issue when no delta requested
9450cf4 
this one will break the build when using Divested-Mobile#206 :

> rename: /ssd/tmp/dos/hotdog/LineageOS-20.0/release_keys//incrementals/xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*: not accessible: No such file or directory

the next one is a cosmetic thing only. while the current implementation does not break the build I prefer skipping it if not needed at all instead of just the `|| true`  workaround.
"fixes" the message in build output when no delta is requested:

> cp: cannot stat 'xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*': No such file or directory

Signed-off-by: steadfasterX <[email protected]>
@steadfasterX steadfasterX mentioned this pull request Jul 13, 2023
Merged
steadfasterX added a commit to AXP-OS/build that referenced this pull request Jul 13, 2023
@steadfasterX
fix an issue when no delta requested
1cf7f6d 
this one will break the build when using Divested-Mobile#206 :

> rename: /ssd/tmp/dos/hotdog/LineageOS-20.0/release_keys//incrementals/xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*: not accessible: No such file or directory

the next one is a cosmetic thing only. while the current implementation does not break the build I prefer skipping it if not needed at all instead of just the `|| true`  workaround.
"fixes" the message in build output when no delta is requested:

> cp: cannot stat 'xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*': No such file or directory

Signed-off-by: steadfasterX <[email protected]>
SkewedZeppelin pushed a commit that referenced this pull request Jul 13, 2023
@steadfasterX @SkewedZeppelin
fix an issue when no delta requested
492ba67 
this one will break the build when using #206 :

> rename: /ssd/tmp/dos/hotdog/LineageOS-20.0/release_keys//incrementals/xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*: not accessible: No such file or directory

the next one is a cosmetic thing only. while the current implementation does not break the build I prefer skipping it if not needed at all instead of just the `|| true`  workaround.
"fixes" the message in build output when no delta is requested:

> cp: cannot stat 'xxxx-20.0-20230713-dos-hotdog-incremental_*.zip*': No such file or directory

Signed-off-by: steadfasterX <[email protected]>
@steadfasterX steadfasterX marked this pull request as draft April 12, 2024 11:14
steadfasterX and others added 3 commits April 22, 2024 10:24
@steadfasterX
make divest functions error aware
7724c3e 
this commit adds (the currently non-existing) error handling when
using divest's functions and scripts.
all the magic here gets activated when `source ../../Scripts/init.sh`
gets executed which is already a mandatory step before starting any
of the divest functions.

when something fails during patching, resetting or building
each error will be catched + printed including an error code now.
last but not least the executed file and the line number causing that
failure will be shown, too.

as all divest functions get source'd and so not a single build
script gets executed all ERR's needs to be trapped to catch issues.
I am not aware of another way to handle that properly as sourcing
means we cannot track a script or smth while this approach here
just works.

Example for an error thrown in a function call:

> ERROR: $DOS_WORKSPACE_ROOT/Scripts/Common/Functions.sh -> verifyAllPlatformTags() ended with status >1< at line >49<

Final SUCCESS result message after using `patchWorkspace`:

> [FINAL RESULT] No error detected (please check the above output nevertheless!)

Final ERROR result message after using `patchWorkspace`:

> [FINAL RESULT] Serious error(s) found!!!
> Summary error code was: 126. Check & fix all error lines above

Some notes:

- when an error occurs the process continues until the end (like it is now)
  i.e. an error will not stop the current and following tasks
- when multiple errors occur the exit codes will be summed
- buildDevice: a (summed) end result gets printed (SUCCESS or ERROR) at the very end
- the trap used to catch any error will also be active for any command executed
  on the cli. that means: type "false" -> ENTER and you will get an error, too
  same for any script exectued after source init.sh
- when all goes well the trap will be resetted at the end but there are cases
  where this might not happen -> that is why `resetEnv` can be executed to
  reset the trap, i.e. all becomes as it was before sourcing init.sh
- `resetEnv` gets called automatically:
  - after a successful `patchWorkspace` run
  - whenever CTRL+C is used (during a running task or just on the cli)
  - a process get killed (SIGHUP, TERM)
- the whole implementation might not catch all errors though - it highly depends
  on how the function or the script/program called actually handles errors or better
  said: if they return a proper exit code on failures.
  For example some tools (like some git cmds) might print an error but don't return
  a non-zero exit code. This cannot be tracked other then with your eyes or these
  must be replaced by other methods returning a non-zero exit code on failures.

Signed-off-by: steadfasterX <[email protected]>
@steadfasterX
common: do not abort when recovery-in-boot
fcec1c8 
when using strict (i.e set -e added by this PR) a build will fail on release when there is no recovery.img. this makes that non-fatal allowing to proceed

Signed-off-by: steadfasterX <[email protected]>
@steadfasterX
fix-up & enhance advanced error handling
30859d2 
new (internal used) functions:
- _exit
- _exit_report
- _exit_sigint

these are used to fix several (wrong) error handlings.

new environment variable:
- UNATTENDED_PATCHING

by default we assume unattended patching, i.e. if an error occurs during
the patch, reset or any other process we will report the error and
auto close the shell. this is needed as we source functions and code and
so cannot simply terminate a master process. instead the whole shell will
be terminated so if an error occurs nothing else will be executed (and you
should notice easily that something is wrong).

without that a (serious) error can still continue the rest of a function
and you likely not even noticing the error itself.

you can use:

export UNATTENDED_PATCHING=0

before or after sourcing init.sh and it will *NOT* auto-close the shell.
that way you can check the output and fix any issues.

Signed-off-by: steadfasterX <[email protected]>
@steadfasterX steadfasterX marked this pull request as ready for review April 22, 2024 08:25
@steadfasterX
Copy link
Contributor Author

re-based on latest master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@josegees291614 josegees291614 Awaiting requested review from josegees291614

Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@steadfasterX @SkewedZeppelin @josegees291614