QA (public) » openQA Project (public)

Motivation¶

Calling openqa-cli api can fail due to various ways of missing/invalid api&key combinations all leading to a not much helpful "no api key" message. We should provide better helps to the user what could be wrong, e.g. what keys openqa-cli is looking for and which have been found, what files were found, etc.

Acceptance criteria¶

• AC1: openqa-cli api has significantly better error handling for missing/wrong API key+secret combinations, not just "no api key"
• AC2: mentions in docs/Client.asciidoc are up-to-date

Acceptance tests¶

• AT1-1: Given no file ~/.config/openqa/client.conf When openqa-cli api -X post comments is called Then a clear error message is given which files have been found And pointing to missing ~/.config/openqa/client.conf
• AT1-2: Given an unreadable file ~/.config/openqa/client.conf When openqa-cli api -X post comments is called Then a clear error message is given about the unreadable file
• AT1-3: TBD typo in section header, e.g. "locihost" instead of "localhost"
• AT1-4: TBD wrong keys, e.g. "apikey" instead of "key"

Suggestions¶

• The error "no api key" is returned by the server so one needs to either prevent calls or handle the error after receiving. We just try to call the server when we have not found api key&secret as the client can't know if API key and secret are needed but as the client gets the error response we could parse the JSON error context and give some hints