Log error when podman client cannot be initialized

[valaparthvi]

Signed-off-by: Parthvi Vala pvala@redhat.com

What type of PR is this:
/kind bug

What does this PR do / why we need it:

Which issue(s) this PR fixes:

Fixes #6501

PR acceptance criteria:

• Unit test

• Integration test

• Documentation

How to test changes / Special notes to the reviewer:

1. export PODMAN_CMD=echo
2. odo dev --platform podman -v 2

[netlify]

✅ Deploy Preview for odo-docusaurus-preview canceled.

Name	Link
🔨 Latest commit	3b22e20
🔍 Latest deploy log	https://app.netlify.com/sites/odo-docusaurus-preview/deploys/63dc9e7908287d00088dfe24

[odo-robot]

OpenShift Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

NoCluster Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

Validate Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

Windows Tests (OCP) on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

Kubernetes Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

Unit Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

OpenShift Unauthenticated Tests on commit c68826c finished successfully.
View logs: TXT HTML

[odo-robot]

Kubernetes Docs Tests on commit bd3d61f finished successfully.
View logs: TXT HTML

[rm3l]

Another point: I find the error message (executable "echo" not found) to be misleading for the end-user and might not be accurate. The echo executable does exist in my PATH, but the output of the command is not the one expected by our Podman Client.

$ ODO_EXPERIMENTAL_MODE=t PODMAN_CMD=echo odo describe component --platform podman -v 3     
I0131 17:30:43.309683 3703568 version.go:28] executing [echo version --format json]
 ✗  unable to access podman. Do you have podman client installed? Cause: executable "echo" not found

For example, if I try to reproduce the steps provided in #6501 using a real Podman binary in my PATH:

$ which podman-v3     
/home/asoro/.local/bin/podman-v3

$ ODO_EXPERIMENTAL_MODE=t PODMAN_CMD=podman-v3 odo describe component --platform podman -v 3
I0131 17:31:21.622000 3705354 version.go:28] executing [podman-v3 version --format json]
 ✗  unable to access podman. Do you have podman client installed? Cause: executable "podman-v3" not found

But if I run the same Podman command to retrieve the version:

$ podman-v3 version --format json
Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM
Error: unable to connect to Podman socket: Get "http://d/v3.4.4/libpod/_ping": dial unix ///run/user/1000/podman/podman.sock: connect: no such file or directory

I think odo should display the full command output if there is an error with the command executed. What do you think?

[rm3l]

I think you raised good points, but I think they might be out of scope for this PR. The errors "executable %q not found" is raised when you initiliaze a new Podman Client. This PR is more about logging error when there is one. I'd be happy to work on it in a separate PR.

Okay, we can do that in a separate PR. But in this case, I'd leave the original issue (#6501) open, as it was more about odo reporting a wrong (and unhelpful) error.
We can say that this PR relates to #6501, but, to me, it does not close it yet.

[valaparthvi]

/override Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests
/override Kubernetes-Integration-Tests/Kubernetes-Integration-Tests
Unrelated errors.

[openshift-ci]

@valaparthvi: Overrode contexts on behalf of valaparthvi: Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests, Kubernetes-Integration-Tests/Kubernetes-Integration-Tests

In response to this:

/override Kubernetes-Integration-Tests/Kubernetes-Docs-Integration-Tests
/override Kubernetes-Integration-Tests/Kubernetes-Integration-Tests
Unrelated errors.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[valaparthvi]

I think you raised good points, but I think they might be out of scope for this PR. The errors "executable %q not found" is raised when you initiliaze a new Podman Client. This PR is more about logging error when there is one. I'd be happy to work on it in a separate PR.

Okay, we can do that in a separate PR. But in this case, I'd leave the original issue (#6501) open, as it was more about odo reporting a wrong (and unhelpful) error. We can say that this PR relates to #6501, but, to me, it does not close it yet.

I've updated the NewPodmanCli to return the actual error. But, this will still not work for odo describe component where it logs warning because it simply checks if the podmanClient is initialized.

[rm3l]

Added a few comments.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

No Coverage information
0.3% Duplication

[rm3l]

Thanks Parthvi!