Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Highlight hpilo kernel module requirement #164

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tacerus
Copy link

@tacerus tacerus commented Aug 9, 2024

The ilorest_chif.so library seems to handle a lack of the "hpilo" kernel module the same way as a lack of iLO devices, returning "No hpilo devices found" with status 19.
This being converted to a "chif" error causes a misleading "Chif driver not found" message if the application is executed on a Linux system having the Chif driver installed, but not having the "hpilo" module loaded.
At the point the message is printed, the library was already loaded, indicating it must be correctly present, otherwise it would not have been able to return an error code.
Improve user guidance by instead setting an error message similar to the one returned by the library itself, but also pointing out the need for the hpilo kernel module if not executed on Windows. Additionally, highlight this requirement in the README.

-----Synopsis of Commits Above-----

Please fill out the following when submitting the PR

Status

  • READY
  • IN-DEVELOPMENT
  • ON-HOLD

Additional High Level Description

A few sentences describing the overall goals of the pull request's commits.

  • Include the issue number here if it fixes one. Example #1
  • Include the QUIX number here if it fixes one.

Dependent PRs

List any PRs that must be merged together. (Tool dependent PRs SHOULD NOT occur.)

  • If additional library PRs are to be referenced simply note the PR#

Before Status can be set to READY I have completed the following:

  • Check if documentation updates
  • Check if example code updates
  • Pylint static analysis tests are passing above 9.0/10.0
  • Unit tests added for any new functions/features and passed.
  • Targeted/Custom Testing performed. Indicate the results in the description above or as additional comments.

The ilorest_chif.so library seems to handle a lack of the "hpilo"
kernel module the same way as a lack of iLO devices, returning
"No hpilo devices found" with status 19.
This being converted to a "chif" error causes a misleading
"Chif driver not found" message if the application is executed
on a Linux system having the Chif driver installed, but not having
the "hpilo" module loaded.
At the point the message is printed, the library was already loaded,
indicating it must be correctly present, otherwise it would not have
been able to return an error code.
Improve user guidance by instead setting an error message similar to
the one returned by the library itself, but also pointing out the
need for the hpilo kernel module if not executed on Windows.
Additionally, highlight this requirement in the README.

Signed-off-by: Georg Pfuetzenreuter <[email protected]>
@tacerus
Copy link
Author

tacerus commented Aug 9, 2024

The "Pylint static analysis tests are passing above 9.0/10.0" checklist entry is odd, because already the version in the master branch seems to not pass this requirement. Should a specific version of Pylint be used?

@tacerus
Copy link
Author

tacerus commented Aug 9, 2024

Tested:

# rmmod hpilo
# ilorest
iLORest : RESTful Interface Tool version 5.1.0.0
Copyright (c) 2014-2024 Hewlett Packard Enterprise Development LP
--------------------------------------------------------------------------------------------------------------------------------------------------------------
ERROR   : No devices were found. Ensure the hpilo kernel module is loaded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants