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

Add tests for WANT_JSON and old style modules #50555

Merged
merged 8 commits into from
Jan 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions test/integration/targets/old_style_modules_posix/aliases
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shippable/posix/group3
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/bin/sh
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.

if [ -f "$1" ]; then
. "$1"
else
echo '{"msg": "No argument file provided", "failed": true}'
exit 1
fi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this module includes an error check for no argument file, I'd include testing that in the integration test. Just execute it as a script instead of a module to verify it fails as expected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in the latest commit


salutation=${salutation:=Hello}
name=${name:=World}

cat << EOF
{"msg": "${salutation}, ${name}!"}
EOF
39 changes: 39 additions & 0 deletions test/integration/targets/old_style_modules_posix/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- name: Hello, World!
helloworld:
register: hello_world

- assert:
that:
- 'hello_world.msg == "Hello, World!"'

- name: Hello, Ansible!
helloworld:
args:
name: Ansible
register: hello_ansible

- assert:
that:
- 'hello_ansible.msg == "Hello, Ansible!"'

- name: Goodbye, Ansible!
helloworld:
args:
salutation: Goodbye
name: Ansible
register: goodbye_ansible

- assert:
that:
- 'goodbye_ansible.msg == "Goodbye, Ansible!"'

- name: Execute module directly
command: '/bin/sh {{ role_path }}/library/helloworld.sh'
register: direct
ignore_errors: true

- assert:
that:
- direct is failed
- |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the multi-line syntax here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had done it originally due to simplifying quoting, but after a change it's no longer needed, I just didn't remove it. It wasn't done for multiline, but rather as a block literal, to avoid the need for outer quotes which would have complicated things.

direct.stdout == '{"msg": "No argument file provided", "failed": true}'
1 change: 1 addition & 0 deletions test/integration/targets/want_json_modules_posix/aliases
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shippable/posix/group3
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/usr/bin/python
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.

# WANT_JSON

import json
import sys

try:
with open(sys.argv[1], 'r') as f:
data = json.load(f)
except (IOError, OSError, IndexError):
print(json.dumps(dict(msg="No argument file provided", failed=True)))
sys.exit(1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this module includes an error check for no argument file, I'd include testing that in the integration test. Just execute it as a script instead of a module to verify it fails as expected.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in the latest commit


salutation = data.get('salutation', 'Hello')
name = data.get('name', 'World')
print(json.dumps(dict(msg='%s, %s!' % (salutation, name))))
39 changes: 39 additions & 0 deletions test/integration/targets/want_json_modules_posix/tasks/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- name: Hello, World!
helloworld:
register: hello_world

- assert:
that:
- 'hello_world.msg == "Hello, World!"'

- name: Hello, Ansible!
helloworld:
args:
name: Ansible
register: hello_ansible

- assert:
that:
- 'hello_ansible.msg == "Hello, Ansible!"'

- name: Goodbye, Ansible!
helloworld:
args:
salutation: Goodbye
name: Ansible
register: goodbye_ansible

- assert:
that:
- 'goodbye_ansible.msg == "Goodbye, Ansible!"'

- name: Execute module directly
command: '{{ ansible_python_interpreter|default(ansible_playbook_python) }} {{ role_path }}/library/helloworld.py'
register: direct
ignore_errors: true

- assert:
that:
- direct is failed
- |
direct.stdout == '{"msg": "No argument file provided", "failed": true}'
1 change: 1 addition & 0 deletions test/sanity/code-smell/shebang.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ def main():
'test/integration/targets/win_module_utils/library/legacy_only_new_way_win_line_ending.ps1',
'test/integration/targets/win_module_utils/library/legacy_only_old_way_win_line_ending.ps1',
'test/utils/shippable/timing.py',
'test/integration/targets/old_style_modules_posix/library/helloworld.sh',
])

# see https://unicode.org/faq/utf_bom.html#bom1
Expand Down