Add vyos_banner implementation module (#25862)

* Add vyos_banner implementation module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* vyos_banne integration test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* vyos_banner unit test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* minor fix on banner text

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
This commit is contained in:
Trishna Guha 2017-06-20 08:53:03 +05:30 committed by GitHub
commit 947e9aba45
9 changed files with 388 additions and 0 deletions

View file

@ -0,0 +1,3 @@
---
testcase: "*"
test_items: []

View file

@ -0,0 +1,15 @@
---
- name: collect all cli test cases
find:
paths: "{{ role_path }}/tests/cli"
patterns: "{{ testcase }}.yaml"
register: test_cases
- name: set test_items
set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
- name: run test case
include: "{{ test_case_to_run }}"
with_items: "{{ test_items }}"
loop_control:
loop_var: test_case_to_run

View file

@ -0,0 +1,2 @@
---
- { include: cli.yaml, tags: ['cli'] }

View file

@ -0,0 +1,41 @@
---
- name: Setup
vyos_banner:
banner: pre-login
text: |
Junk pre-login banner
over multiple lines
state: present
provider: "{{ cli }}"
- name: remove pre-login
vyos_banner:
banner: pre-login
state: absent
provider: "{{ cli }}"
register: result
- debug:
msg: "{{ result }}"
- assert:
that:
- "result.changed == true"
- "'delete system login banner pre-login' in result.commands"
- name: remove pre-login (idempotent)
vyos_banner:
banner: pre-login
state: absent
provider: "{{ cli }}"
register: result
- assert:
that:
- "result.changed == false"
- "result.commands | length == 0"
# FIXME add in tests for everything defined in docs
# FIXME Test state:absent + test:
# FIXME Without powers ensure "privileged mode required"

View file

@ -0,0 +1,47 @@
---
- name: setup - remove post-login
vyos_banner:
banner: post-login
state: absent
provider: "{{ cli }}"
- name: Set post-login
vyos_banner:
banner: post-login
text: |
this is my post-login banner
that has a multiline
string
state: present
provider: "{{ cli }}"
register: result
- debug:
msg: "{{ result }}"
- assert:
that:
- "result.changed == true"
- "'this is my post-login banner' in result.commands"
- "'that has a multiline' in result.commands"
- name: Set post-login again (idempotent)
vyos_banner:
banner: post-login
text: |
this is my post-login banner
that has a multiline
string
state: present
provider: "{{ cli }}"
register: result
- assert:
that:
- "result.changed == false"
- "result.commands | length == 0"
# FIXME add in tests for everything defined in docs
# FIXME Test state:absent + test:
# FIXME Without powers ensure "privileged mode required"

View file

@ -0,0 +1,47 @@
---
- name: setup - remove pre-login
vyos_banner:
banner: pre-login
state: absent
provider: "{{ cli }}"
- name: Set pre-login
vyos_banner:
banner: pre-login
text: |
this is my pre-login banner
that has a multiline
string
state: present
provider: "{{ cli }}"
register: result
- debug:
msg: "{{ result }}"
- assert:
that:
- "result.changed == true"
- "'this is my pre-login banner' in result.commands"
- "'that has a multiline' in result.commands"
- name: Set pre-login again (idempotent)
vyos_banner:
banner: pre-login
text: |
this is my pre-login banner
that has a multiline
string
state: present
provider: "{{ cli }}"
register: result
- assert:
that:
- "result.changed == false"
- "result.commands | length == 0"
# FIXME add in tests for everything defined in docs
# FIXME Test state:absent + test:
# FIXME Without powers ensure "privileged mode required"

View file

@ -11,3 +11,4 @@
- { role: vyos_command, when: "limit_to in ['*', 'vyos_command']" }
- { role: vyos_config, when: "limit_to in ['*', 'vyos_config']" }
- { role: vyos_user, when: "limit_to in ['*', vyos_user']" }
- { role: vyos_banner, when: "limit_to in ['*', vyos_banner']" }

View file

@ -0,0 +1,53 @@
# 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/>.
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import json
from ansible.compat.tests.mock import patch
from ansible.modules.network.vyos import vyos_banner
from .vyos_module import TestVyosModule, load_fixture, set_module_args
class TestVyosBannerModule(TestVyosModule):
module = vyos_banner
def setUp(self):
self.mock_get_config = patch('ansible.modules.network.vyos.vyos_banner.get_config')
self.get_config = self.mock_get_config.start()
self.mock_load_config = patch('ansible.modules.network.vyos.vyos_banner.load_config')
self.load_config = self.mock_load_config.start()
def tearDown(self):
self.mock_get_config.stop()
self.mock_load_config.stop()
def load_fixtures(self, commands=None):
self.load_config.return_value = dict(diff=None, session='session')
def test_vyos_banner_create(self):
set_module_args(dict(banner='pre-login', text='test\nbanner\nstring'))
commands = ['set system login banner pre-login "test\nbanner\nstring"']
self.execute_module(changed=True, commands=commands)
def test_vyos_banner_remove(self):
set_module_args(dict(banner='pre-login', state='absent'))
commands = ['delete system login banner pre-login']
self.execute_module(changed=True, commands=commands)