Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6227

lkirkwood · 2023-03-24T04:25:18Z

SUMMARY

I ran into an issue where about 1/3 of the time, when using the XenOrchestra inventory plugin, the process would fail due to the first response from the XO server received being unrelated to the request. This can be easily fixed by checking that the response ID is the same as the request ID, which is what this change does.

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

xen_orchestra inventory

ADDITIONAL INFORMATION

The messages from the server that cause the issue vary, but one that I noticed frequently is shown below:

{
  "jsonrpc": "2.0",
  "method": "all",
  "params": {
    "type": "exit",
    "items": {
      "eb859a79-1725-eecd-67e6-b9bf941205e4": 0
    }
  }
}

Before change:

[ansible@ansible-machine ~]$ ansible-inventory -i /etc/ansible/xen_orchestra.yml --graph
[WARNING]:  * Failed to parse /etc/ansible/xen_orchestra.yml with ansible_collections.community.general.plugins.inventory.xen_orchestra plugin: 'result'
[WARNING]: Unable to parse /etc/ansible/xen_orchestra.yml as an inventory source
[WARNING]: No inventory was parsed, only implicit localhost is available
@all:
  |--@ungrouped:

After change:

[ansible@ansible-machine ~]$ ansible-inventory -i /etc/ansible/xen_orchestra.yml --graph                                                                   @all:
  |--@halted:                                                                                                                                                              
  |  |--027c4638-0ad1-aab3-bc38-0c34a0009058                                                                                                                            
  |  |--02ddbd9b-af42-bab1-6811-e1e22ba719bf                                                                                                                             
  |  |--058c4616-ee04-b310-7aa8-95fb0aedab08
...

ansibullbot · 2023-03-24T04:30:24Z

cc @ddelnano @shinuza
click here for bot help

felixfontein

Thanks for your contribution!

changelogs/fragments/6227-xen-orchestra-check-response-id.yml

plugins/inventory/xen_orchestra.py

lkirkwood · 2023-03-24T12:42:30Z

I have made the changes you suggested. Thanks :)

github-actions · 2023-03-24T12:51:23Z

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

plugins/inventory/xen_orchestra.py

Co-authored-by: Felix Fontein <felix@fontein.de>

patchback · 2023-03-26T07:29:39Z

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/cd706454eca6bcae5e495fa27b041f350ffda21e/pr-6227

Backported as #6244

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

felixfontein · 2023-03-26T07:29:46Z

@lirkwood thanks for your contribution!

…nse ID. (#6227) * Added call method to select proper response from xo server * Added changelog fragment * Removed excess blank lines * Moved period in changelog fragment * Made suggested changes * Remove f-strings for Python 2.7 compatibility Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Linus Kirkwood <lkirkwood@allette.com.au> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit cd70645)

patchback · 2023-03-26T07:29:49Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/cd706454eca6bcae5e495fa27b041f350ffda21e/pr-6227

Backported as #6245

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

…nse ID. (#6227) * Added call method to select proper response from xo server * Added changelog fragment * Removed excess blank lines * Moved period in changelog fragment * Made suggested changes * Remove f-strings for Python 2.7 compatibility Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Linus Kirkwood <lkirkwood@allette.com.au> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit cd70645)

…lugin failing due to not checking response ID. (#6244) Fixed XenOrchestra inventory plugin failing due to not checking response ID. (#6227) * Added call method to select proper response from xo server * Added changelog fragment * Removed excess blank lines * Moved period in changelog fragment * Made suggested changes * Remove f-strings for Python 2.7 compatibility Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Linus Kirkwood <lkirkwood@allette.com.au> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit cd70645) Co-authored-by: lirkwood <linuskirkwood@gmail.com>

…lugin failing due to not checking response ID. (#6245) Fixed XenOrchestra inventory plugin failing due to not checking response ID. (#6227) * Added call method to select proper response from xo server * Added changelog fragment * Removed excess blank lines * Moved period in changelog fragment * Made suggested changes * Remove f-strings for Python 2.7 compatibility Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Linus Kirkwood <lkirkwood@allette.com.au> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit cd70645) Co-authored-by: lirkwood <linuskirkwood@gmail.com>

lkirkwood and others added 2 commits March 24, 2023 14:59

Added call method to select proper response from xo server

b22b434

Added changelog fragment

860d161

lkirkwood marked this pull request as ready for review March 24, 2023 04:30

ansibullbot added WIP Work in progress bug This issue/PR relates to a bug inventory inventory plugin new_contributor Help guide this first time contributor plugins plugin (any type) labels Mar 24, 2023

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed WIP Work in progress labels Mar 24, 2023

Removed excess blank lines

3c3fb99

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Mar 24, 2023

felixfontein reviewed Mar 24, 2023

View reviewed changes

changelogs/fragments/6227-xen-orchestra-check-response-id.yml Outdated Show resolved Hide resolved

plugins/inventory/xen_orchestra.py Outdated Show resolved Hide resolved

plugins/inventory/xen_orchestra.py Outdated Show resolved Hide resolved

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels Mar 24, 2023

lkirkwood added 2 commits March 24, 2023 23:38

Moved period in changelog fragment

7eb979e

Made suggested changes

415c5eb

felixfontein reviewed Mar 25, 2023

View reviewed changes

plugins/inventory/xen_orchestra.py Outdated Show resolved Hide resolved

Remove f-strings for Python 2.7 compatibility

77a9b69

Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein approved these changes Mar 26, 2023

View reviewed changes

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Mar 26, 2023

felixfontein merged commit cd70645 into ansible-collections:main Mar 26, 2023

patchback bot mentioned this pull request Mar 26, 2023

[PR #6227/cd706454 backport][stable-5] Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6244

Merged

patchback bot mentioned this pull request Mar 26, 2023

[PR #6227/cd706454 backport][stable-6] Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6245

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6227

Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6227

lkirkwood commented Mar 24, 2023 •

edited

Loading

ansibullbot commented Mar 24, 2023

This comment was marked as outdated.

felixfontein left a comment

lkirkwood commented Mar 24, 2023

github-actions bot commented Mar 24, 2023 •

edited

Loading

patchback bot commented Mar 26, 2023 •

edited

Loading

felixfontein commented Mar 26, 2023

patchback bot commented Mar 26, 2023 •

edited

Loading

Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6227

Fixed XenOrchestra inventory plugin failing due to not checking response ID. #6227

Conversation

lkirkwood commented Mar 24, 2023 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Mar 24, 2023

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

lkirkwood commented Mar 24, 2023

github-actions bot commented Mar 24, 2023 • edited Loading

Docs Build 📝

patchback bot commented Mar 26, 2023 • edited Loading

Backport to stable-5: 💚 backport PR created

felixfontein commented Mar 26, 2023

patchback bot commented Mar 26, 2023 • edited Loading

Backport to stable-6: 💚 backport PR created

lkirkwood commented Mar 24, 2023 •

edited

Loading

github-actions bot commented Mar 24, 2023 •

edited

Loading

patchback bot commented Mar 26, 2023 •

edited

Loading

patchback bot commented Mar 26, 2023 •

edited

Loading