Log error dependency resolver exceptions strings

[webknjaz]

SUMMARY

$sbj.

ISSUE TYPE

• Maintenance Pull Request

ADDITIONAL INFORMATION

N/A

[jborean93]

@webknjaz are you still interested in this PR?

[webknjaz]

@jborean93 @s-hertel can I get approvals plz?

[jborean93]

@webknjaz do you have an example of the type of error messages this would produce. Is it worth using display.error(...) here instead of display.display(...)?

Also are you able to add a changelog fragment for this new change?

[webknjaz]

@jborean93 So @bcoca asked me to switch away from error @ 86cb2f5 (#81607). This is because raising Ansible Error later on will already produce error output.

[webknjaz]

do you have an example of the type of error messages this would produce

I'll need to see how to trigger it. It was long ago when I looked into this. I just remember that when I was hitting these code branches, it didn't seem like there was enough information in the output to understand what was going on.

[mattclay]

Using display.error is probably the right choice here, especially with the improved error handling in DT.

[webknjaz]

Using display.error is probably the right choice here, especially with the improved error handling in DT.

@mattclay okay, I can revert that commit.

---

@jborean93 I was able to trigger one of the code paths and checked the output. I realized it's rather raw:

$ ansible-galaxy collection install 'vmware.vmware:<1.5' 'vmware.vmware:>1.5' -p .                                                                                                             
[WARNING]: You are running the development version of Ansible. You should only run Ansible from "devel" if you are modifying the Ansible engine, or trying out features under development. This is a
rapidly changing source of code and can become unstable at any point.
Starting galaxy collection install process
[WARNING]: The specified collections path '/home/wk/src/github/ansible/ansible' is not part of the configured Ansible collections paths
'/home/wk/.ansible/collections:/usr/share/ansible/collections'. The installed collection will not be picked up in an Ansible run, unless within a playbook-adjacent collections directory.
Process install dependency map
Collection dependency resolution impossible: [RequirementInformation(requirement=<vmware.vmware:<1.5 of type 'galaxy' from Galaxy>, parent=None), RequirementInformation(requirement=<vmware.vmware:>1.5 of type 'galaxy' from Galaxy>, parent=None)]
ERROR! Failed to resolve the requested dependencies map. Could not satisfy the following requirements:
* vmware.vmware:<1.5 (direct request)
* vmware.vmware:>1.5 (direct request)
Hint: Pre-releases hosted on Galaxy or Automation Hub are not installed by default unless a specific version is requested. To enable pre-releases globally, use --pre.

As for the InconsistentCandidate case, I'm not sure how to trigger it without monkey-patching the provider. Looking into resolvelib suggests that it's happening when find_matches() returns incompatible candidates.

I discovered that some resolvelib exceptions define __str__() that render repr()s of things. So I guess it does make sense to log them in debug mode. Or perhaps use display.vvvvv(). Plus, it seems like the existing user-facing output is good enough.

This PR is so old that I didn't even remember what I was after. But going through it once again, I think it was difficult to understand what exceptions in the error handling paths happen. And logging those details is still useful but I'd do that with increased verbosity only.

I also realized that there's a number of other exceptions in resolevlib that we don't explicitly handle but probably should. So I think I'll look into making more changes to this PR.

[jborean93]

Makes sense, I would be weary of adding more output to the command as well. The sheer number of verbosity levels probably hasn't been the best things and adding more noise may not be that great. Certainly more debug information for when things go wrong would be nice but we don't want to overload the user with too much information.

[webknjaz]

@jborean93 I'll go for vvvvv() then.

[webknjaz]

@jborean93 so I experimented with surfacing better information regarding errors here and there. Plz take a look.

[webknjaz]

@jborean93 @s-hertel could you find a minute to share more thoughts on this?

[webknjaz]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).