Merge lp:~veebers/juju-ci-tools/modelmig_public_clouds_logs into lp:juju-ci-tools

[Christopher Lee]

Add timeout wait-check for logs migration to give them time to migrate in the public could.

Add timeout wait-check for logs migration to give them time to migrate in the public could.

[Curtis Hovey (sinzui)]

Thank you.

review: Approve (code)

=== modified file 'assess_model_migration.py'
--- assess_model_migration.py	2017-02-15 20:12:30 +0000
+++ assess_model_migration.py	2017-02-15 20:12:31 +0000
@@ -394,18 +394,41 @@
         raise JujuAssertionError('Appliction units reside on the same machine')
 
 
-def ensure_model_logs_are_migrated(source_client, dest_client):
+def ensure_model_logs_are_migrated(source_client, dest_client, timeout=60):
+    """Ensure logs are migrated when a model is migrated between controllers.
+
+    :param source_client: ModelClient representing source controller to create
+      model on and migrate that model from.
+    :param dest_client: ModelClient for destination controller to migrate to.
+    :param timeout: int seconds to wait for logs to appear in migrated model.
+    """
     new_model_client = deploy_dummy_source_to_new_model(
         source_client, 'log-migration')
     before_migration_logs = new_model_client.get_juju_output(
         'debug-log', '--no-tail', '-l', 'DEBUG')
     log.info('Attempting migration process')
     migrated_model = migrate_model_to_controller(new_model_client, dest_client)
-    after_migration_logs = migrated_model.get_juju_output(
-        'debug-log', '--no-tail', '--replay', '-l', 'DEBUG')
-    if before_migration_logs not in after_migration_logs:
-        raise JujuAssertionError('Logs failed to be migrated.')
-    log.info('SUCCESS: logs migrated.')
+
+    assert_logs_appear_in_client_model(
+        migrated_model, before_migration_logs, timeout)
+
+
+def assert_logs_appear_in_client_model(client, expected_logs, timeout):
+    """Assert that `expected_logs` appear in client logs within timeout.
+
+    :param client: ModelClient object to query logs of.
+    :param expected_logs: string containing log contents to check for.
+    :param timeout: int seconds to wait for before raising JujuAssertionError.
+    """
+    for _ in until_timeout(timeout):
+        current_logs = client.get_juju_output(
+            'debug-log', '--no-tail', '--replay', '-l', 'DEBUG')
+        if expected_logs in current_logs:
+            log.info('SUCCESS: logs migrated.')
+            return
+        sleep(1)
+    raise JujuAssertionError(
+        'Logs failed to be migrated after {}'.format(timeout))
 
 
 def ensure_migration_rolls_back_on_failure(source_client, dest_client):

=== modified file 'tests/test_assess_model_migration.py'
--- tests/test_assess_model_migration.py	2017-02-15 20:12:30 +0000
+++ tests/test_assess_model_migration.py	2017-02-15 20:12:31 +0000
@@ -437,8 +437,6 @@
 
 
 class TestWaitForModel(TestCase):
-    # Check that it returns an error if the model never comes up.
-    # Pass in a timeout for the model check
     def test_raises_exception_when_timeout_occurs(self):
         mock_client = _get_time_noop_mock_client()
         with patch.object(until_timeout, 'next', side_effect=StopIteration()):
@@ -876,3 +874,32 @@
         m_am.assert_called_once_with(mig_client, app, resource_string)
 
         self.assertEqual(m_rollback.call_count, 0)
+
+
+class TestAssertLogsAppearInClientModel(TestCase):
+
+    def test_raises_exception_when_timeout_occurs(self):
+        mock_client = Mock()
+        with patch.object(until_timeout, 'next', side_effect=StopIteration()):
+            with self.assertRaises(JujuAssertionError):
+                amm.assert_logs_appear_in_client_model(
+                    mock_client, 'test logs', timeout=60)
+
+    def test_returns_early_when_logs_found(self):
+        mock_client = Mock()
+        mock_client.get_juju_output.return_value = 'test logs'
+        with patch.object(amm, 'sleep', autospec=True) as m_sleep:
+            amm.assert_logs_appear_in_client_model(
+                mock_client, 'test logs', timeout=60)
+        self.assertEqual(m_sleep.call_count, 0)
+
+    def test_tries_multiple_times_to_get_log_output(self):
+        mock_client = Mock()
+        mock_client.get_juju_output.side_effect = ['', 'test logs']
+        with patch.object(
+                until_timeout, 'next',
+                side_effect=[None, None, StopIteration()]):
+            with patch.object(amm, 'sleep', autospec=True) as m_sleep:
+                amm.assert_logs_appear_in_client_model(
+                    mock_client, 'test logs', timeout=60)
+                self.assertEqual(m_sleep.call_count, 1)