Accept a dictionary for playbook #855

samdoran · 2021-09-28T21:24:24Z

Fixes #852
Fixes #642

The validation function isplaybook() expects a playbook to be a list of dictionaries, not a bare dictionary or a string. Update the docs to reflect this requirement and cast a bare dictionary to a list before passing to isplaybook().

Add tests

samdoran · 2021-09-28T21:30:57Z

It may also be a good idea to add some error handling here for invalid values to playbook in order to fail early rather than later in unexpected ways.

samdoran · 2021-10-07T15:23:35Z

recheck

samdoran · 2021-10-11T18:58:46Z

recheck

ansible_runner/interface.py

ansible_runner/utils/__init__.py

A string isn't valid.

Use Python 3.8 for linters Remove Python 3.8 specific code changes CI is stuck on Python 3.6 for tests currently, so these changes won't pass.

shanemcd

Nice work

Remove the use of reset_mock() and create separate tests.

Add tests for role vars and skipping fact gathering

A dictionary is more accuratey a MutableMapping.

ansible-zuul

LGTM!

patchback · 2021-10-13T17:58:59Z

Backport to release_2.0: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 3d6886d on top of patchback/backports/release_2.0/3d6886d1a26358ead139fef736d1c8ca07f7ab71/pr-855

Backporting merged PR #855 into devel

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/ansible/ansible-runner.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/release_2.0/3d6886d1a26358ead139fef736d1c8ca07f7ab71/pr-855 upstream/release_2.0

Now, cherry-pick PR Accept a dictionary for playbook #855 contents into that branch:
```
$ git cherry-pick -x 3d6886d1a26358ead139fef736d1c8ca07f7ab71
```
If it'll yell at you with something like fatal: Commit 3d6886d1a26358ead139fef736d1c8ca07f7ab71 is a merge but no -m option was given., add -m 1 as follows intead:
```
$ git cherry-pick -m1 -x 3d6886d1a26358ead139fef736d1c8ca07f7ab71
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Accept a dictionary for playbook #855 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/release_2.0/3d6886d1a26358ead139fef736d1c8ca07f7ab71/pr-855

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

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

Accept a dictionary for playbook Fixes ansible#852 Fixes ansible#642 The validation function isplaybook() expects a playbook to be a list of dictionaries, not a bare dictionary or a string. Update the docs to reflect this requirement and cast a bare dictionary to a list before passing to isplaybook(). Add tests Reviewed-by: David Shrewsbury <None> Reviewed-by: Sam Doran <sdoran@redhat.com> Reviewed-by: Shane McDonald <me@shanemcd.com> Reviewed-by: None <None> (cherry picked from commit 3d6886d)

The validation function isplaybook() expects a playbook to be a list of dictionaries, not a bare dictionary or a string. Update the docs to reflect this requirement and cast a bare dictionary to a list before passing to isplaybook(). (cherry picked from commit 3d6886d)

[release_2.0] Accept a dictionary for playbook (#855) Backport of #855 for Ansible Runner 2.0. Reviewed-by: David Shrewsbury <None> Reviewed-by: None <None>

samdoran force-pushed the issue/852-playbook-as-dict branch 3 times, most recently from 75e16a8 to 190e50c Compare October 6, 2021 20:28

samdoran requested a review from a team October 11, 2021 18:58

samdoran marked this pull request as ready for review October 11, 2021 18:59

Shrews reviewed Oct 11, 2021

View reviewed changes

ansible_runner/interface.py Outdated Show resolved Hide resolved

ansible_runner/utils/__init__.py Show resolved Hide resolved

samdoran force-pushed the issue/852-playbook-as-dict branch 3 times, most recently from 6aa48d2 to 2796c6f Compare October 12, 2021 15:58

Shrews approved these changes Oct 13, 2021

View reviewed changes

samdoran added 4 commits October 13, 2021 10:02

Correct docstring

d1d4162

A string isn't valid.

Ensure play is a list of dictionaries

08a1ae8

Use Python 3.8 for linters Remove Python 3.8 specific code changes CI is stuck on Python 3.6 for tests currently, so these changes won't pass.

Update tests to match new behavior

1426af3

Update installation docs to refelct minimum Python requirements

38acfba

shanemcd approved these changes Oct 13, 2021

View reviewed changes

samdoran added 4 commits October 13, 2021 10:06

Break up test_utils.py and refactor tests

b7297e2

Remove the use of reset_mock() and create separate tests.

Increase coverage of dump_artificacts

aad55e8

Add tests for role vars and skipping fact gathering

Add integration tests

4beaa83

Use MutableMapping instead of Mapping

0fecae8

A dictionary is more accuratey a MutableMapping.

samdoran force-pushed the issue/852-playbook-as-dict branch from 2796c6f to 0fecae8 Compare October 13, 2021 14:07

Shrews added the gate label Oct 13, 2021

ansible-zuul bot approved these changes Oct 13, 2021

View reviewed changes

ansible-zuul bot merged commit 3d6886d into ansible:devel Oct 13, 2021

samdoran added the backport-2.0 label Oct 13, 2021

samdoran deleted the issue/852-playbook-as-dict branch October 13, 2021 17:59

samdoran mentioned this pull request Oct 13, 2021

[release_2.0] Accept a dictionary for playbook (#855) #868

Merged

Shrews mentioned this pull request May 26, 2022

Documentation bug: Need to update min supported Python for 2.x.y versions #1083

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Accept a dictionary for playbook #855

Accept a dictionary for playbook #855

samdoran commented Sep 28, 2021 •

edited

samdoran commented Sep 28, 2021

samdoran commented Oct 7, 2021

samdoran commented Oct 11, 2021

shanemcd left a comment

ansible-zuul bot left a comment

patchback bot commented Oct 13, 2021 •

edited

Accept a dictionary for playbook #855

Accept a dictionary for playbook #855

Conversation

samdoran commented Sep 28, 2021 • edited

samdoran commented Sep 28, 2021

samdoran commented Oct 7, 2021

samdoran commented Oct 11, 2021

shanemcd left a comment

Choose a reason for hiding this comment

ansible-zuul bot left a comment

Choose a reason for hiding this comment

patchback bot commented Oct 13, 2021 • edited

Backport to release_2.0: 💔 cherry-picking failed — conflicts found

Backporting merged PR #855 into devel

samdoran commented Sep 28, 2021 •

edited

patchback bot commented Oct 13, 2021 •

edited