c0174.yml

doc_meta: |
  folder: flow-controll
  title: conditionally error handling
  head: |
    Showcases that you can use internal var up_runtime_shell_exec_result to conditionally do your own customised cleanup or business

  sections:
    - title: Demo
      log: yes

    - title: What if I want to handle a specific error
      content: |
        Note that in the finally steps, it uses up_runtime_shell_exec_result to obtain the shell exec exit code, error message and regular output.

        In case you need to deal with a specific error, eg, by exit code, or error message, you can use if condition to implement that

  related:
    refs:
      - title: shell func
        link: ../../quick-start/c0002/
      - title: error handling
        link: ../../test-debug/error_handling/
      - title: finally and rescue
        link: ../../flow-controll/c0172/

notes:
  - all finally block/task to access the failed exec contextual info and conditionally handle the error

tasks:

  -
    name: task
    task:

      -
        func: shell
        do:
          - echo "opening file"
          - echo "hello"|grep "world"
        flags:
          - ignoreError
        finally:
          -
            func: shell
            desc: |
              ensure the opened file is closed
            do:
              - echo "close the file ....."
              - |
                echo """
                exec command: {{.up_runtime_shell_exec_result.Cmd}}
                error code: {{.up_runtime_shell_exec_result.Code}}
                error message: {{.up_runtime_shell_exec_result.ErrMsg}}
                error output: {{.up_runtime_shell_exec_result.Output}}
                """

          -
            func: cmd
            desc: |
              see if the exec context result: up_runtime_shell_exec_result is still availabe
              conditional do something about the error etc
            do:
              - name: print
                cmd: |
                  error message: {{.up_runtime_shell_exec_result.ErrMsg}}
            if: '{{ne .up_runtime_shell_exec_result.Code 0}}'

      -
        func: shell
        desc: |
          this step will not be reached if the ignoreError flag is not set
          try it yourself to remove the ignoreError flag and see difference
        do:
          - echo "extra step ..."