b510abce17
* Added aws_retry decorator function with unit tests * Restructured the code to be used with a base class. This base class CloudRetry can be reused by any other cloud provider. This decorator should be used in situations, where you need to implement a backoff algorithm and want to retry based on the status code from the exception. * updated documentation * fixed tabs * added botocore and boto3 to requirements.txt * removed cloud.py from py24 tests, as it depends on boto3 * fix relative imports * updated test to be 2.6 compat * updated method name from retry to backoff * readded lxd * Updated default backoff from 2 seconds to 1.1s. This will be about a total of 48 seconds in 10 tries. This is configurable.
87 lines
2.7 KiB
Python
87 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
# (c) 2015, Allen Sanabria <asanabria@linuxdynasty.org>
|
|
#
|
|
# 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/>.
|
|
|
|
import unittest
|
|
import botocore
|
|
import boto3
|
|
|
|
from ansible.module_utils.ec2 import AWSRetry
|
|
|
|
class RetryTestCase(unittest.TestCase):
|
|
|
|
def test_no_failures(self):
|
|
self.counter = 0
|
|
|
|
@AWSRetry.backoff(tries=2, delay=0.1)
|
|
def no_failures():
|
|
self.counter += 1
|
|
|
|
r = no_failures()
|
|
self.assertEqual(self.counter, 1)
|
|
|
|
def test_retry_once(self):
|
|
self.counter = 0
|
|
err_msg = {'Error': {'Code': 'InstanceId.NotFound'}}
|
|
|
|
@AWSRetry.backoff(tries=2, delay=0.1)
|
|
def retry_once():
|
|
self.counter += 1
|
|
if self.counter < 2:
|
|
raise botocore.exceptions.ClientError(err_msg, 'Could not find you')
|
|
else:
|
|
return 'success'
|
|
|
|
r = retry_once()
|
|
self.assertEqual(r, 'success')
|
|
self.assertEqual(self.counter, 2)
|
|
|
|
def test_reached_limit(self):
|
|
self.counter = 0
|
|
err_msg = {'Error': {'Code': 'RequestLimitExceeded'}}
|
|
|
|
@AWSRetry.backoff(tries=4, delay=0.1)
|
|
def fail():
|
|
self.counter += 1
|
|
raise botocore.exceptions.ClientError(err_msg, 'toooo fast!!')
|
|
|
|
#with self.assertRaises(botocore.exceptions.ClientError):
|
|
try:
|
|
fail()
|
|
except Exception as e:
|
|
self.assertEqual(e.response['Error']['Code'], 'RequestLimitExceeded')
|
|
self.assertEqual(self.counter, 4)
|
|
|
|
def test_unexpected_exception_does_not_retry(self):
|
|
self.counter = 0
|
|
err_msg = {'Error': {'Code': 'AuthFailure'}}
|
|
|
|
@AWSRetry.backoff(tries=4, delay=0.1)
|
|
def raise_unexpected_error():
|
|
self.counter += 1
|
|
raise botocore.exceptions.ClientError(err_msg, 'unexpected error')
|
|
|
|
#with self.assertRaises(botocore.exceptions.ClientError):
|
|
try:
|
|
raise_unexpected_error()
|
|
except Exception as e:
|
|
self.assertEqual(e.response['Error']['Code'], 'AuthFailure')
|
|
|
|
self.assertEqual(self.counter, 1)
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|