mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00:00
Ansible module to enable the user to provision CPGs on HPE StoreServ 3PAR device (#39656)
* Added storage modules and unit tests Removed unnecessary file Fixing pep8 issues Adding reusable documentation to the data fragment file Fixing issues reported by module validation in documentation Fixed issues: 10549, 10553 Fixed unit tests Added future imports and removed license from init py file Resolved import issue reported by ansible sanity test Fixed unit tests Adding CPG management module Fixing sanity test issues Resolving line ending issues Resolved import issue reported by ansible sanity test Correcting the error message when resource is more than 31 char Update hpe3par_cpg.py Fix for defect 10556: Unable to modify volume. Persona not set Fix for defect 10556: Unable to modify volume. Persona not set Fixing pep8 changes Fixed pep8 issues Added more pep8 related fixes Added more pep8 related fixes Fixed rebase issue in cps test Adding GPL3.0+ License (#7) * Update hpe3par.py * Update hpe3par_cpg.py * Update hpe3par_cpg.py Adding GPLV3+ only license Fix anity test Addressing review comments Fixing undefined variable error Addressed review comments and added more unit tests (#8) Added maintainers Fixed sanity test Update test_hpe3par_cpg.py Renamed the module as per the review comments (#9) * Added maintainers * Renaming the module to remove the vendor name from the module * remove pep8 related issues Modify the requirements to add version of 3par sdk Review address (#10) * Unit is no longer a different paramter in the task * Fixing unit tests * Taking into account the default values Fixing issue with default values fixing unit test Adding more flexibility and checks to the size and it's units Fixed pylint extra line issue Fixing conflicts in BOTMETA.yml Made changes according to the review comments Updating ansible version Refactored the code to move reusable method to module utils Modified the GPLv3+ license text according to the review comments. Modified the module utils license to BSD Corrected the BOTMETA entry. Fixed the pep8 issues Fixing entries in BOTMETA.yml Removed ansible version, renamed the version to address the name review comments Reverting name change for module to revert test failures Set size and raid type and now reuqired together based on the review comment Fixed unit tests Removing default value as raid and set size are now required together Renaming the modules to ss_3par_* Resolving the pep8 issues Added storage modules and unit tests Removed unnecessary file Fixing pep8 issues Adding reusable documentation to the data fragment file Fixing issues reported by module validation in documentation Fixed issues: 10549, 10553 Fixed unit tests Added future imports and removed license from init py file Resolved import issue reported by ansible sanity test Fixed unit tests Adding CPG management module Fixing sanity test issues Resolving line ending issues Resolved import issue reported by ansible sanity test Correcting the error message when resource is more than 31 char Update hpe3par_cpg.py Fix for defect 10556: Unable to modify volume. Persona not set Fix for defect 10556: Unable to modify volume. Persona not set Fixing pep8 changes Fixed pep8 issues Added more pep8 related fixes Added more pep8 related fixes Fixed rebase issue in cps test Adding GPL3.0+ License (#7) * Update hpe3par.py * Update hpe3par_cpg.py * Update hpe3par_cpg.py Adding GPLV3+ only license Fix anity test Addressing review comments Fixing undefined variable error Addressed review comments and added more unit tests (#8) Added maintainers Fixed sanity test Update test_hpe3par_cpg.py Renamed the module as per the review comments (#9) * Added maintainers * Renaming the module to remove the vendor name from the module * remove pep8 related issues Modify the requirements to add version of 3par sdk Review address (#10) * Unit is no longer a different paramter in the task * Fixing unit tests * Taking into account the default values Fixing issue with default values fixing unit test Adding more flexibility and checks to the size and it's units Fixed pylint extra line issue Fixing conflicts in BOTMETA.yml Made changes according to the review comments Updating ansible version Refactored the code to move reusable method to module utils Modified the GPLv3+ license text according to the review comments. Modified the module utils license to BSD Corrected the BOTMETA entry. Fixed the pep8 issues Removed ansible version, renamed the version to address the name review comments Reverting name change for module to revert test failures Set size and raid type and now reuqired together based on the review comment Fixed unit tests Removing default value as raid and set size are now required together Renaming the modules to ss_3par_* Resolving the pep8 issues Update lib/ansible/modules/storage/hpe3par/ss_3par_cpg.py Co-Authored-By: farhan7500 <farhan7500@gmail.com> Update lib/ansible/modules/storage/hpe3par/ss_3par_cpg.py Co-Authored-By: farhan7500 <farhan7500@gmail.com> Fixed rebase issue Fixed rebase issuein BOTMETA.yml * Modified the documentation based on the review comments * Fixed the pep8 sanity issue * Moved the doc fragment file based on latest changes * Reverting inadvertent rebase changes * Fixed inadvertent change during rebase
This commit is contained in:
Farhan Nomani
committed by
John R Barker
John R Barker
parent
076562e5c2
commit
27804b3b8b
0
test/units/modules/storage/hpe3par/__init__.py
Normal file
0
test/units/modules/storage/hpe3par/__init__.py
Normal file
248
test/units/modules/storage/hpe3par/test_ss_3par_cpg.py
Normal file
248
test/units/modules/storage/hpe3par/test_ss_3par_cpg.py
Normal file
@@ -0,0 +1,248 @@
|
||||
# Copyright: (c) 2018, Hewlett Packard Enterprise Development LP
|
||||
# GNU General Public License v3.0+
|
||||
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
import mock
|
||||
import pytest
|
||||
import sys
|
||||
sys.modules['hpe3par_sdk'] = mock.Mock()
|
||||
sys.modules['hpe3par_sdk.client'] = mock.Mock()
|
||||
sys.modules['hpe3parclient'] = mock.Mock()
|
||||
sys.modules['hpe3parclient.exceptions'] = mock.Mock()
|
||||
from ansible.modules.storage.hpe3par import ss_3par_cpg
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.storage.hpe3par import hpe3par
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.AnsibleModule')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.create_cpg')
|
||||
def test_module_args(mock_create_cpg, mock_module, mock_client):
|
||||
"""
|
||||
hpe3par CPG - test module arguments
|
||||
"""
|
||||
|
||||
PARAMS_FOR_PRESENT = {
|
||||
'storage_system_ip': '192.168.0.1',
|
||||
'storage_system_username': 'USER',
|
||||
'storage_system_password': 'PASS',
|
||||
'cpg_name': 'test_cpg',
|
||||
'domain': 'test_domain',
|
||||
'growth_increment': 32768,
|
||||
'growth_increment_unit': 'MiB',
|
||||
'growth_limit': 32768,
|
||||
'growth_limit_unit': 'MiB',
|
||||
'growth_warning': 32768,
|
||||
'growth_warning_unit': 'MiB',
|
||||
'raid_type': 'R6',
|
||||
'set_size': 8,
|
||||
'high_availability': 'MAG',
|
||||
'disk_type': 'FC',
|
||||
'state': 'present',
|
||||
'secure': False
|
||||
}
|
||||
mock_module.params = PARAMS_FOR_PRESENT
|
||||
mock_module.return_value = mock_module
|
||||
mock_client.HPE3ParClient.login.return_value = True
|
||||
mock_create_cpg.return_value = (True, True, "Created CPG successfully.")
|
||||
ss_3par_cpg.main()
|
||||
mock_module.assert_called_with(
|
||||
argument_spec=hpe3par.cpg_argument_spec(),
|
||||
required_together=[['raid_type', 'set_size']])
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.AnsibleModule')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.create_cpg')
|
||||
def test_main_exit_functionality_present_success_without_issue_attr_dict(mock_create_cpg, mock_module, mock_client):
|
||||
"""
|
||||
hpe3par flash cache - success check
|
||||
"""
|
||||
PARAMS_FOR_PRESENT = {
|
||||
'storage_system_ip': '192.168.0.1',
|
||||
'storage_system_name': '3PAR',
|
||||
'storage_system_username': 'USER',
|
||||
'storage_system_password': 'PASS',
|
||||
'cpg_name': 'test_cpg',
|
||||
'domain': 'test_domain',
|
||||
'growth_increment': 32768,
|
||||
'growth_increment_unit': 'MiB',
|
||||
'growth_limit': 32768,
|
||||
'growth_limit_unit': 'MiB',
|
||||
'growth_warning': 32768,
|
||||
'growth_warning_unit': 'MiB',
|
||||
'raid_type': 'R6',
|
||||
'set_size': 8,
|
||||
'high_availability': 'MAG',
|
||||
'disk_type': 'FC',
|
||||
'state': 'present',
|
||||
'secure': False
|
||||
}
|
||||
# This creates a instance of the AnsibleModule mock.
|
||||
mock_module.params = PARAMS_FOR_PRESENT
|
||||
mock_module.return_value = mock_module
|
||||
instance = mock_module.return_value
|
||||
mock_client.HPE3ParClient.login.return_value = True
|
||||
mock_create_cpg.return_value = (
|
||||
True, True, "Created CPG successfully.")
|
||||
ss_3par_cpg.main()
|
||||
# AnsibleModule.exit_json should be called
|
||||
instance.exit_json.assert_called_with(
|
||||
changed=True, msg="Created CPG successfully.")
|
||||
# AnsibleModule.fail_json should not be called
|
||||
assert instance.fail_json.call_count == 0
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.AnsibleModule')
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.delete_cpg')
|
||||
def test_main_exit_functionality_absent_success_without_issue_attr_dict(mock_delete_cpg, mock_module, mock_client):
|
||||
"""
|
||||
hpe3par flash cache - success check
|
||||
"""
|
||||
PARAMS_FOR_DELETE = {
|
||||
'storage_system_ip': '192.168.0.1',
|
||||
'storage_system_name': '3PAR',
|
||||
'storage_system_username': 'USER',
|
||||
'storage_system_password': 'PASS',
|
||||
'cpg_name': 'test_cpg',
|
||||
'domain': None,
|
||||
'growth_increment': None,
|
||||
'growth_increment_unit': None,
|
||||
'growth_limit': None,
|
||||
'growth_limit_unit': None,
|
||||
'growth_warning': None,
|
||||
'growth_warning_unit': None,
|
||||
'raid_type': None,
|
||||
'set_size': None,
|
||||
'high_availability': None,
|
||||
'disk_type': None,
|
||||
'state': 'absent',
|
||||
'secure': False
|
||||
}
|
||||
# This creates a instance of the AnsibleModule mock.
|
||||
mock_module.params = PARAMS_FOR_DELETE
|
||||
mock_module.return_value = mock_module
|
||||
instance = mock_module.return_value
|
||||
mock_delete_cpg.return_value = (
|
||||
True, True, "Deleted CPG test_cpg successfully.")
|
||||
mock_client.HPE3ParClient.login.return_value = True
|
||||
ss_3par_cpg.main()
|
||||
# AnsibleModule.exit_json should be called
|
||||
instance.exit_json.assert_called_with(
|
||||
changed=True, msg="Deleted CPG test_cpg successfully.")
|
||||
# AnsibleModule.fail_json should not be called
|
||||
assert instance.fail_json.call_count == 0
|
||||
|
||||
|
||||
def test_convert_to_binary_multiple():
|
||||
assert hpe3par.convert_to_binary_multiple(None) == -1
|
||||
assert hpe3par.convert_to_binary_multiple('-1.0 MiB') == -1
|
||||
assert hpe3par.convert_to_binary_multiple('-1.0GiB') == -1
|
||||
assert hpe3par.convert_to_binary_multiple('1.0 MiB') == 1
|
||||
assert hpe3par.convert_to_binary_multiple('1.5GiB') == 1.5 * 1024
|
||||
assert hpe3par.convert_to_binary_multiple('1.5 TiB') == 1.5 * 1024 * 1024
|
||||
assert hpe3par.convert_to_binary_multiple(' 1.5 TiB ') == 1.5 * 1024 * 1024
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
def test_validate_set_size(mock_client):
|
||||
mock_client.HPE3ParClient.RAID_MAP = {'R0': {'raid_value': 1, 'set_sizes': [1]},
|
||||
'R1': {'raid_value': 2, 'set_sizes': [2, 3, 4]},
|
||||
'R5': {'raid_value': 3, 'set_sizes': [3, 4, 5, 6, 7, 8, 9]},
|
||||
'R6': {'raid_value': 4, 'set_sizes': [6, 8, 10, 12, 16]}
|
||||
}
|
||||
raid_type = 'R0'
|
||||
set_size = 1
|
||||
assert ss_3par_cpg.validate_set_size(raid_type, set_size)
|
||||
|
||||
set_size = 2
|
||||
assert not ss_3par_cpg.validate_set_size(raid_type, set_size)
|
||||
|
||||
raid_type = None
|
||||
assert not ss_3par_cpg.validate_set_size(raid_type, set_size)
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
def test_cpg_ldlayout_map(mock_client):
|
||||
mock_client.HPE3ParClient.PORT = 1
|
||||
mock_client.HPE3ParClient.RAID_MAP = {'R0': {'raid_value': 1, 'set_sizes': [1]},
|
||||
'R1': {'raid_value': 2, 'set_sizes': [2, 3, 4]},
|
||||
'R5': {'raid_value': 3, 'set_sizes': [3, 4, 5, 6, 7, 8, 9]},
|
||||
'R6': {'raid_value': 4, 'set_sizes': [6, 8, 10, 12, 16]}
|
||||
}
|
||||
ldlayout_dict = {'RAIDType': 'R6', 'HA': 'PORT'}
|
||||
assert ss_3par_cpg.cpg_ldlayout_map(ldlayout_dict) == {
|
||||
'RAIDType': 4, 'HA': 1}
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
def test_create_cpg(mock_client):
|
||||
ss_3par_cpg.validate_set_size = mock.Mock(return_value=True)
|
||||
ss_3par_cpg.cpg_ldlayout_map = mock.Mock(
|
||||
return_value={'RAIDType': 4, 'HA': 1})
|
||||
|
||||
mock_client.HPE3ParClient.login.return_value = True
|
||||
mock_client.HPE3ParClient.cpgExists.return_value = False
|
||||
mock_client.HPE3ParClient.FC = 1
|
||||
mock_client.HPE3ParClient.createCPG.return_value = True
|
||||
|
||||
assert ss_3par_cpg.create_cpg(mock_client.HPE3ParClient,
|
||||
'test_cpg',
|
||||
'test_domain',
|
||||
'32768 MiB',
|
||||
'32768 MiB',
|
||||
'32768 MiB',
|
||||
'R6',
|
||||
8,
|
||||
'MAG',
|
||||
'FC'
|
||||
) == (True, True, "Created CPG %s successfully." % 'test_cpg')
|
||||
|
||||
mock_client.HPE3ParClient.cpgExists.return_value = True
|
||||
assert ss_3par_cpg.create_cpg(mock_client.HPE3ParClient,
|
||||
'test_cpg',
|
||||
'test_domain',
|
||||
'32768.0 MiB',
|
||||
'32768.0 MiB',
|
||||
'32768.0 MiB',
|
||||
'R6',
|
||||
8,
|
||||
'MAG',
|
||||
'FC'
|
||||
) == (True, False, 'CPG already present')
|
||||
|
||||
ss_3par_cpg.validate_set_size = mock.Mock(return_value=False)
|
||||
assert ss_3par_cpg.create_cpg(mock_client.HPE3ParClient,
|
||||
'test_cpg',
|
||||
'test_domain',
|
||||
'32768.0 MiB',
|
||||
'32768 MiB',
|
||||
'32768.0 MiB',
|
||||
'R6',
|
||||
3,
|
||||
'MAG',
|
||||
'FC'
|
||||
) == (False, False, 'Set size 3 not part of RAID set R6')
|
||||
|
||||
|
||||
@mock.patch('ansible.modules.storage.hpe3par.ss_3par_cpg.client')
|
||||
def test_delete_cpg(mock_client):
|
||||
mock_client.HPE3ParClient.login.return_value = True
|
||||
mock_client.HPE3ParClient.cpgExists.return_value = True
|
||||
mock_client.HPE3ParClient.FC = 1
|
||||
mock_client.HPE3ParClient.deleteCPG.return_value = True
|
||||
|
||||
assert ss_3par_cpg.delete_cpg(mock_client.HPE3ParClient,
|
||||
'test_cpg'
|
||||
) == (True, True, "Deleted CPG %s successfully." % 'test_cpg')
|
||||
|
||||
mock_client.HPE3ParClient.cpgExists.return_value = False
|
||||
|
||||
assert ss_3par_cpg.delete_cpg(mock_client.HPE3ParClient,
|
||||
'test_cpg'
|
||||
) == (True, False, "CPG does not exist")
|
||||
assert ss_3par_cpg.delete_cpg(mock_client.HPE3ParClient,
|
||||
None
|
||||
) == (True, False, "CPG does not exist")
|
||||
Reference in New Issue
Block a user