mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added test to kinesis_stream module.
* Update kinesis_stream based on tests. * Added tests for kinesis_stream.
This commit is contained in:
Allen Sanabria
Matt Clay
parent
24fb52c83b
commit
133b5ccdde
2 changed files with 497 additions and 29 deletions
|
|
@ -201,7 +201,7 @@ def make_tags_in_proper_format(tags):
|
|||
tags (list): The tags you want applied.
|
||||
|
||||
Basic Usage:
|
||||
>>> tags = [{u'Key': 'env', u'Value': 'development'}]
|
||||
>>> tags = [{'Key': 'env', 'Value': 'development'}]
|
||||
>>> make_tags_in_proper_format(tags)
|
||||
{
|
||||
"env": "development",
|
||||
|
|
@ -327,7 +327,7 @@ def find_stream(client, stream_name, limit=1, check_mode=False):
|
|||
'RetentionPeriodHours': 24,
|
||||
'StreamName': stream_name,
|
||||
'StreamARN': 'arn:aws:kinesis:east-side:123456789:stream/{0}'.format(stream_name),
|
||||
'StreamStatus': u'ACTIVE'
|
||||
'StreamStatus': 'ACTIVE'
|
||||
}
|
||||
success = True
|
||||
except botocore.exceptions.ClientError, e:
|
||||
|
|
@ -363,31 +363,24 @@ def wait_for_status(client, stream_name, status, wait_timeout=300,
|
|||
stream = dict()
|
||||
err_msg = ""
|
||||
|
||||
if not check_mode:
|
||||
while wait_timeout > time.time():
|
||||
try:
|
||||
find_success, find_msg, stream = (
|
||||
find_stream(client, stream_name)
|
||||
)
|
||||
if status != 'DELETING':
|
||||
if find_success and stream:
|
||||
if stream.get('StreamStatus') == status:
|
||||
status_achieved = True
|
||||
break
|
||||
elif status == 'DELETING':
|
||||
if not find_success:
|
||||
while wait_timeout > time.time():
|
||||
try:
|
||||
find_success, find_msg, stream = (
|
||||
find_stream(client, stream_name, check_mode=check_mode)
|
||||
)
|
||||
if status != 'DELETING':
|
||||
if find_success and stream:
|
||||
if stream.get('StreamStatus') == status:
|
||||
status_achieved = True
|
||||
break
|
||||
else:
|
||||
time.sleep(polling_increment_secs)
|
||||
except botocore.exceptions.ClientError as e:
|
||||
err_msg = str(e)
|
||||
|
||||
else:
|
||||
status_achieved = True
|
||||
find_success, find_msg, stream = (
|
||||
find_stream(client, stream_name, check_mode=check_mode)
|
||||
)
|
||||
elif status == 'DELETING':
|
||||
if not find_success:
|
||||
status_achieved = True
|
||||
break
|
||||
else:
|
||||
time.sleep(polling_increment_secs)
|
||||
except botocore.exceptions.ClientError as e:
|
||||
err_msg = str(e)
|
||||
|
||||
if not status_achieved:
|
||||
err_msg = "Wait time out reached, while waiting for results"
|
||||
|
|
@ -694,7 +687,7 @@ def update(client, current_stream, stream_name, retention_period=None,
|
|||
retention_period, action='create' )
|
||||
|
||||
Returns:
|
||||
Tuple (bool, bool, str, dict)
|
||||
Tuple (bool, bool, str)
|
||||
"""
|
||||
success = False
|
||||
changed = False
|
||||
|
|
@ -783,9 +776,9 @@ def update(client, current_stream, stream_name, retention_period=None,
|
|||
)
|
||||
)
|
||||
if success and changed:
|
||||
err_msg = 'Kinesis Stream {0} updated successfully'.format(stream_name)
|
||||
err_msg = 'Kinesis Stream {0} updated successfully.'.format(stream_name)
|
||||
elif success and not changed:
|
||||
err_msg = 'Kinesis Stream {0} did not changed'.format(stream_name)
|
||||
err_msg = 'Kinesis Stream {0} did not changed.'.format(stream_name)
|
||||
|
||||
return success, changed, err_msg
|
||||
|
||||
|
|
@ -1003,7 +996,11 @@ def main():
|
|||
wait_timeout = module.params.get('wait_timeout')
|
||||
|
||||
if state == 'present' and not shards:
|
||||
module.fail_json(msg='shards is required when state == present.')
|
||||
module.fail_json(msg='Shards is required when state == present.')
|
||||
|
||||
if retention_period:
|
||||
if retention_period < 24:
|
||||
module.fail_json(msg='Retention period can not be less than 24 hours.')
|
||||
|
||||
if not HAS_BOTO3:
|
||||
module.fail_json(msg='boto3 is required.')
|
||||
|
|
|
|||
471
lib/ansible/modules/extras/cloud/amazon/test_kinesis_stream.py
Normal file
471
lib/ansible/modules/extras/cloud/amazon/test_kinesis_stream.py
Normal file
|
|
@ -0,0 +1,471 @@
|
|||
#!/usr/bin/python
|
||||
|
||||
import unittest
|
||||
|
||||
from collections import namedtuple
|
||||
from ansible.parsing.dataloader import DataLoader
|
||||
from ansible.vars import VariableManager
|
||||
from ansible.inventory import Inventory
|
||||
from ansible.playbook.play import Play
|
||||
from ansible.executor.task_queue_manager import TaskQueueManager
|
||||
|
||||
import kinesis_stream
|
||||
import boto3
|
||||
|
||||
Options = (
|
||||
namedtuple(
|
||||
'Options', [
|
||||
'connection', 'module_path', 'forks', 'become', 'become_method',
|
||||
'become_user', 'remote_user', 'private_key_file', 'ssh_common_args',
|
||||
'sftp_extra_args', 'scp_extra_args', 'ssh_extra_args', 'verbosity',
|
||||
'check'
|
||||
]
|
||||
)
|
||||
)
|
||||
# initialize needed objects
|
||||
variable_manager = VariableManager()
|
||||
loader = DataLoader()
|
||||
options = (
|
||||
Options(
|
||||
connection='local',
|
||||
module_path='./',
|
||||
forks=1, become=None, become_method=None, become_user=None, check=True,
|
||||
remote_user=None, private_key_file=None, ssh_common_args=None,
|
||||
sftp_extra_args=None, scp_extra_args=None, ssh_extra_args=None,
|
||||
verbosity=10
|
||||
)
|
||||
)
|
||||
passwords = dict(vault_pass='')
|
||||
|
||||
# create inventory and pass to var manager
|
||||
inventory = Inventory(loader=loader, variable_manager=variable_manager, host_list='localhost')
|
||||
variable_manager.set_inventory(inventory)
|
||||
|
||||
def run(play):
|
||||
tqm = None
|
||||
results = None
|
||||
try:
|
||||
tqm = TaskQueueManager(
|
||||
inventory=inventory,
|
||||
variable_manager=variable_manager,
|
||||
loader=loader,
|
||||
options=options,
|
||||
passwords=passwords,
|
||||
stdout_callback='default',
|
||||
)
|
||||
results = tqm.run(play)
|
||||
finally:
|
||||
if tqm is not None:
|
||||
tqm.cleanup()
|
||||
return tqm, results
|
||||
|
||||
class AnsibleKinesisStreamTasks(unittest.TestCase):
|
||||
|
||||
def test_a_create_stream_1(self):
|
||||
play_source = dict(
|
||||
name = "Create Kinesis Stream with 10 Shards",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
shards=10,
|
||||
wait='yes'
|
||||
),
|
||||
register='stream'
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.ok['localhost'] == 1)
|
||||
|
||||
def test_a_create_stream_2(self):
|
||||
play_source = dict(
|
||||
name = "Create Kinesis Stream with 10 Shards and create a tag called environment",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
shards=10,
|
||||
tags=dict(
|
||||
env='development'
|
||||
),
|
||||
wait='yes'
|
||||
),
|
||||
register='stream'
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.ok['localhost'] == 1)
|
||||
|
||||
def test_a_create_stream_3(self):
|
||||
play_source = dict(
|
||||
name = "Create Kinesis Stream with 10 Shards and create a tag called environment and Change the default retention period from 24 to 48",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
retention_period=48,
|
||||
shards=10,
|
||||
tags=dict(
|
||||
env='development'
|
||||
),
|
||||
wait='yes'
|
||||
),
|
||||
register='stream'
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.ok['localhost'] == 1)
|
||||
|
||||
def test_b_create_stream_1(self):
|
||||
play_source = dict(
|
||||
name = "Create Kinesis Stream with out specifying the number of shards",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
wait='yes'
|
||||
),
|
||||
register='stream'
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.failures['localhost'] == 1)
|
||||
|
||||
def test_b_create_stream_2(self):
|
||||
play_source = dict(
|
||||
name = "Create Kinesis Stream with specifying the retention period less than 24 hours",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
retention_period=23,
|
||||
shards=10,
|
||||
wait='yes'
|
||||
),
|
||||
register='stream'
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.failures['localhost'] == 1)
|
||||
|
||||
def test_c_delete_stream_(self):
|
||||
play_source = dict(
|
||||
name = "Delete Kinesis Stream test-stream",
|
||||
hosts = 'localhost',
|
||||
gather_facts = 'no',
|
||||
tasks = [
|
||||
dict(
|
||||
action=dict(
|
||||
module='kinesis_stream',
|
||||
name='stream-test',
|
||||
state='absent',
|
||||
wait='yes'
|
||||
)
|
||||
)
|
||||
]
|
||||
)
|
||||
play = Play().load(play_source, variable_manager=variable_manager, loader=loader)
|
||||
tqm, results = run(play)
|
||||
self.failUnless(tqm._stats.ok['localhost'] == 1)
|
||||
|
||||
|
||||
class AnsibleKinesisStreamFunctions(unittest.TestCase):
|
||||
|
||||
def test_convert_to_lower(self):
|
||||
example = {
|
||||
'HasMoreShards': True,
|
||||
'RetentionPeriodHours': 24,
|
||||
'StreamName': 'test',
|
||||
'StreamARN': 'arn:aws:kinesis:east-side:123456789:stream/test',
|
||||
'StreamStatus': 'ACTIVE'
|
||||
}
|
||||
converted_example = kinesis_stream.convert_to_lower(example)
|
||||
keys = converted_example.keys()
|
||||
keys.sort()
|
||||
for i in range(len(keys)):
|
||||
if i == 0:
|
||||
self.assertEqual(keys[i], 'has_more_shards')
|
||||
if i == 1:
|
||||
self.assertEqual(keys[i], 'retention_period_hours')
|
||||
if i == 2:
|
||||
self.assertEqual(keys[i], 'stream_arn')
|
||||
if i == 3:
|
||||
self.assertEqual(keys[i], 'stream_name')
|
||||
if i == 4:
|
||||
self.assertEqual(keys[i], 'stream_status')
|
||||
|
||||
def test_make_tags_in_aws_format(self):
|
||||
example = {
|
||||
'env': 'development'
|
||||
}
|
||||
should_return = [
|
||||
{
|
||||
'Key': 'env',
|
||||
'Value': 'development'
|
||||
}
|
||||
]
|
||||
aws_tags = kinesis_stream.make_tags_in_aws_format(example)
|
||||
self.assertEqual(aws_tags, should_return)
|
||||
|
||||
def test_make_tags_in_proper_format(self):
|
||||
example = [
|
||||
{
|
||||
'Key': 'env',
|
||||
'Value': 'development'
|
||||
},
|
||||
{
|
||||
'Key': 'service',
|
||||
'Value': 'web'
|
||||
}
|
||||
]
|
||||
should_return = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
proper_tags = kinesis_stream.make_tags_in_proper_format(example)
|
||||
self.assertEqual(proper_tags, should_return)
|
||||
|
||||
def test_recreate_tags_from_list(self):
|
||||
example = [('environment', 'development'), ('service', 'web')]
|
||||
should_return = [
|
||||
{
|
||||
'Key': 'environment',
|
||||
'Value': 'development'
|
||||
},
|
||||
{
|
||||
'Key': 'service',
|
||||
'Value': 'web'
|
||||
}
|
||||
]
|
||||
aws_tags = kinesis_stream.recreate_tags_from_list(example)
|
||||
self.assertEqual(aws_tags, should_return)
|
||||
|
||||
def test_get_tags(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg, tags = kinesis_stream.get_tags(client, 'test', True)
|
||||
self.assertTrue(success)
|
||||
should_return = [
|
||||
{
|
||||
'Key': 'DryRunMode',
|
||||
'Value': 'true'
|
||||
}
|
||||
]
|
||||
self.assertEqual(tags, should_return)
|
||||
|
||||
def test_find_stream(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg, stream = (
|
||||
kinesis_stream.find_stream(client, 'test', check_mode=True)
|
||||
)
|
||||
should_return = {
|
||||
'HasMoreShards': True,
|
||||
'RetentionPeriodHours': 24,
|
||||
'StreamName': 'test',
|
||||
'StreamARN': 'arn:aws:kinesis:east-side:123456789:stream/test',
|
||||
'StreamStatus': 'ACTIVE'
|
||||
}
|
||||
self.assertTrue(success)
|
||||
self.assertEqual(stream, should_return)
|
||||
|
||||
def test_wait_for_status(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg, stream = (
|
||||
kinesis_stream.wait_for_status(
|
||||
client, 'test', 'ACTIVE', check_mode=True
|
||||
)
|
||||
)
|
||||
should_return = {
|
||||
'HasMoreShards': True,
|
||||
'RetentionPeriodHours': 24,
|
||||
'StreamName': 'test',
|
||||
'StreamARN': 'arn:aws:kinesis:east-side:123456789:stream/test',
|
||||
'StreamStatus': 'ACTIVE'
|
||||
}
|
||||
self.assertTrue(success)
|
||||
self.assertEqual(stream, should_return)
|
||||
|
||||
def test_tags_action_create(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, err_msg = (
|
||||
kinesis_stream.tags_action(
|
||||
client, 'test', tags, 'create', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_tags_action_delete(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, err_msg = (
|
||||
kinesis_stream.tags_action(
|
||||
client, 'test', tags, 'delete', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_tags_action_invalid(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, err_msg = (
|
||||
kinesis_stream.tags_action(
|
||||
client, 'test', tags, 'append', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertFalse(success)
|
||||
|
||||
def test_update_tags(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, err_msg = (
|
||||
kinesis_stream.update_tags(
|
||||
client, 'test', tags, check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_stream_action_create(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.stream_action(
|
||||
client, 'test', 10, 'create', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_stream_action_delete(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.stream_action(
|
||||
client, 'test', 10, 'delete', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_stream_action_invalid(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.stream_action(
|
||||
client, 'test', 10, 'append', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertFalse(success)
|
||||
|
||||
def test_retention_action_increase(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.retention_action(
|
||||
client, 'test', 48, 'increase', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_retention_action_decrease(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.retention_action(
|
||||
client, 'test', 24, 'decrease', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
|
||||
def test_retention_action_invalid(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
success, err_msg = (
|
||||
kinesis_stream.retention_action(
|
||||
client, 'test', 24, 'create', check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertFalse(success)
|
||||
|
||||
def test_update(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
current_stream = {
|
||||
'HasMoreShards': True,
|
||||
'RetentionPeriodHours': 24,
|
||||
'StreamName': 'test',
|
||||
'StreamARN': 'arn:aws:kinesis:east-side:123456789:stream/test',
|
||||
'StreamStatus': 'ACTIVE'
|
||||
}
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, changed, err_msg = (
|
||||
kinesis_stream.update(
|
||||
client, current_stream, 'test', retention_period=48,
|
||||
tags=tags, check_mode=True
|
||||
)
|
||||
)
|
||||
self.assertTrue(success)
|
||||
self.assertTrue(changed)
|
||||
self.assertEqual(err_msg, 'Kinesis Stream test updated successfully.')
|
||||
|
||||
def test_create_stream(self):
|
||||
client = boto3.client('kinesis', region_name='us-west-2')
|
||||
tags = {
|
||||
'env': 'development',
|
||||
'service': 'web'
|
||||
}
|
||||
success, changed, err_msg, results = (
|
||||
kinesis_stream.create_stream(
|
||||
client, 'test', number_of_shards=10, retention_period=48,
|
||||
tags=tags, check_mode=True
|
||||
)
|
||||
)
|
||||
should_return = {
|
||||
'has_more_shards': True,
|
||||
'retention_period_hours': 24,
|
||||
'stream_name': 'test',
|
||||
'stream_arn': 'arn:aws:kinesis:east-side:123456789:stream/test',
|
||||
'stream_status': 'ACTIVE',
|
||||
'tags': tags,
|
||||
}
|
||||
self.assertTrue(success)
|
||||
self.assertTrue(changed)
|
||||
self.assertEqual(results, should_return)
|
||||
self.assertEqual(err_msg, 'Kinesis Stream test updated successfully.')
|
||||
|
||||
|
||||
def main():
|
||||
unittest.main()
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue