summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSviatoslav Sydorenko <wk@sydorenko.org.ua>2020-07-02 22:13:33 +0200
committerSviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>2020-07-03 10:44:54 +0200
commit8d97c8c222d134cb1108310c5b22eb65ead2d2d3 (patch)
treec0cccd5148a5b9f0f88f93b6e03ea5fa2c143c65
parent0198ceebe40f9221909988def2c35405e6023924 (diff)
downloadansible-8d97c8c222d134cb1108310c5b22eb65ead2d2d3.tar.gz
Fix the internal Python API usage examples
Previous version initialized the `TaskQueueManager` after calling `Play.load()` while advertising a way to inject a custom library location path. This caused the tasks loader not to find any custom modules because it was triggered before the path was actually added to the module loader. This patch changes the order of the operations to ensure that the customized `context.CLIARGS` actually influences things. Resolves https://github.com/ansible/ansible/issues/69758.
-rw-r--r--docs/docsite/rst/dev_guide/developing_api.rst22
-rwxr-xr-xexamples/scripts/uptime.py26
2 files changed, 30 insertions, 18 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_api.rst b/docs/docsite/rst/dev_guide/developing_api.rst
index f18d6f1d4e..5e08c7cc60 100644
--- a/docs/docsite/rst/dev_guide/developing_api.rst
+++ b/docs/docsite/rst/dev_guide/developing_api.rst
@@ -71,6 +71,18 @@ This example is a simple demonstration that shows how to minimally run a couple
# variable manager takes care of merging all the different sources to give you a unified view of variables available in each context
variable_manager = VariableManager(loader=loader, inventory=inventory)
+ # Instantiate task queue manager, which takes care of forking
+ # and setting up all objects to iterate over host list and tasks.
+ # IMPORTANT: This also adds library dirs paths to the module loader
+ # IMPORTANT: and so it must be initialized before calling `Play.load()`.
+ tqm = TaskQueueManager(
+ inventory=inventory,
+ variable_manager=variable_manager,
+ loader=loader,
+ passwords=passwords,
+ stdout_callback=results_callback, # Use our custom callback instead of the ``default`` callback plugin, which prints to stdout
+ )
+
# create data structure that represents our play, including tasks, this is basically what our YAML loader does internally.
play_source = dict(
name = "Ansible Play",
@@ -86,16 +98,8 @@ This example is a simple demonstration that shows how to minimally run a couple
# this will also automatically create the task objects from the info provided in play_source
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
- # Run it - instantiate task queue manager, which takes care of forking and setting up all objects to iterate over host list and tasks
- tqm = None
+ # Actually run it
try:
- tqm = TaskQueueManager(
- inventory=inventory,
- variable_manager=variable_manager,
- loader=loader,
- passwords=passwords,
- stdout_callback=results_callback, # Use our custom callback instead of the ``default`` callback plugin, which prints to stdout
- )
result = tqm.run(play) # most interesting data for a play is actually sent to the callback's methods
finally:
# we always need to cleanup child procs and the structures we use to communicate with them
diff --git a/examples/scripts/uptime.py b/examples/scripts/uptime.py
index c403dd9101..6542ff55b3 100755
--- a/examples/scripts/uptime.py
+++ b/examples/scripts/uptime.py
@@ -48,10 +48,27 @@ def main():
loader = DataLoader()
passwords = dict()
+ # Instantiate our ResultsCollector for handling results as
+ # they come in. Ansible expects this to be one of its main
+ # display outlets.
+ callback = ResultsCollector()
+
# create inventory and pass to var manager
inventory = InventoryManager(loader=loader, sources=sources)
variable_manager = VariableManager(loader=loader, inventory=inventory)
+ # Instantiate task queue manager, which takes care of forking
+ # and setting up all objects to iterate over host list and tasks.
+ # IMPORTANT: This also adds library dirs paths to the module loader
+ # IMPORTANT: and so it must be initialized before calling `Play.load()`.
+ tqm = TaskQueueManager(
+ inventory=inventory,
+ variable_manager=variable_manager,
+ loader=loader,
+ passwords=passwords,
+ stdout_callback=callback,
+ )
+
# create play with tasks
play_source = dict(
name="Ansible Play",
@@ -62,16 +79,7 @@ def main():
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
# actually run it
- tqm = None
- callback = ResultsCollector()
try:
- tqm = TaskQueueManager(
- inventory=inventory,
- variable_manager=variable_manager,
- loader=loader,
- passwords=passwords,
- stdout_callback=callback,
- )
result = tqm.run(play)
finally:
if tqm is not None: