mbox series

[0/3] gitlab-pipeline-status script: provide more information on errors

Message ID 20210222193240.921250-1-crosa@redhat.com (mailing list archive)
Headers show
Series gitlab-pipeline-status script: provide more information on errors | expand

Message

Cleber Rosa Feb. 22, 2021, 7:32 p.m. UTC
When things go wrong with the GitLab API requests, it's useful to give
users more information about the possible causes.

Cleber Rosa (3):
  scripts/ci/gitlab-pipeline-status: split utlity function for HTTP GET
  scripts/ci/gitlab-pipeline-status: give more information on failures
  scripts/ci/gitlab-pipeline-status: give more info when pipeline not
    found

 scripts/ci/gitlab-pipeline-status | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

Comments

Wainer dos Santos Moschetta Feb. 23, 2021, 2:52 p.m. UTC | #1
Hi Cleber,

In case you need to send a v2, mind to add the following patch together?

commit 3c4ed8a78e096e4d7df0398c29887a9d468ae120 (HEAD -> gitlab_runners)
Author: Wainer dos Santos Moschetta <wainersm@redhat.com>
Date:   Tue Feb 23 11:26:08 2021 -0300

     scripts/ci/gitlab-pipeline-status: Handle ValueError exceptions nicely

     With this change, when getting the local branch, it will handle nicely
     any threw ValueError exception instead of print the stack trace.

     Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>

diff --git a/scripts/ci/gitlab-pipeline-status 
b/scripts/ci/gitlab-pipeline-status
index 924db327ff..6177df973a 100755
--- a/scripts/ci/gitlab-pipeline-status
+++ b/scripts/ci/gitlab-pipeline-status
@@ -160,7 +160,11 @@ def main():
      args = parser.parse_args()

      if not args.commit:
-        args.commit = get_local_branch_commit(args.branch)
+        try:
+            args.commit = get_local_branch_commit(args.branch)
+        except ValueError as error:
+            print("ERROR: %s" % error)
+            sys.exit(1)

      success = False
      try:

On 2/22/21 4:32 PM, Cleber Rosa wrote:
> When things go wrong with the GitLab API requests, it's useful to give
> users more information about the possible causes.
>
> Cleber Rosa (3):
>    scripts/ci/gitlab-pipeline-status: split utlity function for HTTP GET
>    scripts/ci/gitlab-pipeline-status: give more information on failures
>    scripts/ci/gitlab-pipeline-status: give more info when pipeline not
>      found
>
>   scripts/ci/gitlab-pipeline-status | 25 ++++++++++++++++++-------
>   1 file changed, 18 insertions(+), 7 deletions(-)
>
Erik Skultety Feb. 23, 2021, 3:19 p.m. UTC | #2
On Tue, Feb 23, 2021 at 11:52:17AM -0300, Wainer dos Santos Moschetta wrote:
> Hi Cleber,
> 
> In case you need to send a v2, mind to add the following patch together?
> 
> commit 3c4ed8a78e096e4d7df0398c29887a9d468ae120 (HEAD -> gitlab_runners)
> Author: Wainer dos Santos Moschetta <wainersm@redhat.com>
> Date:   Tue Feb 23 11:26:08 2021 -0300
> 
>     scripts/ci/gitlab-pipeline-status: Handle ValueError exceptions nicely
> 
>     With this change, when getting the local branch, it will handle nicely
>     any threw ValueError exception instead of print the stack trace.
> 
>     Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
> 
> diff --git a/scripts/ci/gitlab-pipeline-status
> b/scripts/ci/gitlab-pipeline-status
> index 924db327ff..6177df973a 100755
> --- a/scripts/ci/gitlab-pipeline-status
> +++ b/scripts/ci/gitlab-pipeline-status
> @@ -160,7 +160,11 @@ def main():
>      args = parser.parse_args()
> 
>      if not args.commit:
> -        args.commit = get_local_branch_commit(args.branch)
> +        try:
> +            args.commit = get_local_branch_commit(args.branch)
> +        except ValueError as error:
> +            print("ERROR: %s" % error)
> +            sys.exit(1)

1 is the default error code, so you should pass the error message to sys.exit
directly without the print. If you don't want that, at least redirect the
print to sys.stderr.

Erik
Wainer dos Santos Moschetta Feb. 23, 2021, 3:53 p.m. UTC | #3
Hi,

On 2/23/21 12:19 PM, Erik Skultety wrote:
> On Tue, Feb 23, 2021 at 11:52:17AM -0300, Wainer dos Santos Moschetta wrote:
>> Hi Cleber,
>>
>> In case you need to send a v2, mind to add the following patch together?
>>
>> commit 3c4ed8a78e096e4d7df0398c29887a9d468ae120 (HEAD -> gitlab_runners)
>> Author: Wainer dos Santos Moschetta <wainersm@redhat.com>
>> Date:   Tue Feb 23 11:26:08 2021 -0300
>>
>>      scripts/ci/gitlab-pipeline-status: Handle ValueError exceptions nicely
>>
>>      With this change, when getting the local branch, it will handle nicely
>>      any threw ValueError exception instead of print the stack trace.
>>
>>      Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
>>
>> diff --git a/scripts/ci/gitlab-pipeline-status
>> b/scripts/ci/gitlab-pipeline-status
>> index 924db327ff..6177df973a 100755
>> --- a/scripts/ci/gitlab-pipeline-status
>> +++ b/scripts/ci/gitlab-pipeline-status
>> @@ -160,7 +160,11 @@ def main():
>>       args = parser.parse_args()
>>
>>       if not args.commit:
>> -        args.commit = get_local_branch_commit(args.branch)
>> +        try:
>> +            args.commit = get_local_branch_commit(args.branch)
>> +        except ValueError as error:
>> +            print("ERROR: %s" % error)
>> +            sys.exit(1)
> 1 is the default error code, so you should pass the error message to sys.exit
> directly without the print. If you don't want that, at least redirect the
> print to sys.stderr.

There are occurrences of the same pattern on the script, so I better 
send a separate series to change them all. Thanks for pointing it out Erik!

- Wainer

>
> Erik
Thomas Huth March 3, 2021, 5:54 p.m. UTC | #4
On 22/02/2021 20.32, Cleber Rosa wrote:
> When things go wrong with the GitLab API requests, it's useful to give
> users more information about the possible causes.
> 
> Cleber Rosa (3):
>    scripts/ci/gitlab-pipeline-status: split utlity function for HTTP GET
>    scripts/ci/gitlab-pipeline-status: give more information on failures
>    scripts/ci/gitlab-pipeline-status: give more info when pipeline not
>      found
> 
>   scripts/ci/gitlab-pipeline-status | 25 ++++++++++++++++++-------
>   1 file changed, 18 insertions(+), 7 deletions(-)
> 

Thanks, I've queued the three patches now to my testing-next branch:

https://gitlab.com/thuth/qemu/-/commits/testing-next/

  Thomas