Merge "Skipping central agent pollster when keystone not available"

ceilometer/agent.py

@@ -84,8 +84,8 @@ class PollingTask(object):
                 source_resources = list(self.resources[key].resources)
                 try:
                     samples = list(pollster.obj.get_samples(
-                        self.manager,
+                        manager=self.manager,
-                        cache,
+                        cache=cache,
                         resources=source_resources or agent_resources,
                     ))
                     publisher(samples)

ceilometer/central/manager.py

@@ -19,7 +19,6 @@ from keystoneclient.v2_0 import client as ksclient
 from oslo.config import cfg
 
 from ceilometer import agent
-from ceilometer.openstack.common.gettextutils import _
 from ceilometer.openstack.common import log
 
 cfg.CONF.import_group('service_credentials', 'ceilometer.service')
@@ -44,7 +43,6 @@ class AgentManager(agent.AgentManager):
                 region_name=cfg.CONF.service_credentials.os_region_name,
                 insecure=cfg.CONF.service_credentials.insecure)
         except Exception as e:
-            LOG.error(_('Skip interval_task because Keystone error: %s'), e)
+            self.keystone = e
-            return
 
         super(AgentManager, self).interval_task(task)

ceilometer/central/plugin.py

@@ -17,8 +17,27 @@
 """Base class for plugins used by the central agent.
 """
 
+from ceilometer.openstack.common.gettextutils import _
+from ceilometer.openstack.common import log
 from ceilometer import plugin
 
+LOG = log.getLogger(__name__)
+
 
 class CentralPollster(plugin.PollsterBase):
     """Base class for plugins that support the polling API."""
+
+
+def check_keystone(f):
+    """Decorator function to check if manager has valid keystone client."""
+    def func(self, *args, **kwargs):
+        manager = kwargs.get('manager')
+        if not manager and len(args) > 0:
+            manager = args[0]
+        keystone = getattr(manager, 'keystone', None)
+        if not keystone or isinstance(keystone, Exception):
+            LOG.error(_('Skip due to keystone error %s'),
+                      str(keystone) if keystone else '')
+            return iter([])
+        return f(self, *args, **kwargs)
+    return func

ceilometer/energy/kwapi.py

@@ -81,7 +81,7 @@ class _Base(plugin.CentralPollster):
 
 class EnergyPollster(_Base):
     """Measures energy consumption."""
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         """Returns all samples."""
         for probe in self._iter_probes(manager.keystone, cache):
@@ -101,7 +101,7 @@ class EnergyPollster(_Base):
 
 class PowerPollster(_Base):
     """Measures power consumption."""
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         """Returns all samples."""
         for probe in self._iter_probes(manager.keystone, cache):

ceilometer/image/glance.py

@@ -23,12 +23,12 @@ import itertools
 import glanceclient
 from oslo.config import cfg
 
+from ceilometer.central import plugin
 from ceilometer.openstack.common import timeutils
-from ceilometer import plugin
 from ceilometer import sample
 
 
-class _Base(plugin.PollsterBase):
+class _Base(plugin.CentralPollster):
 
     @staticmethod
     def get_glance_client(ksclient):
@@ -102,7 +102,7 @@ class _Base(plugin.PollsterBase):
 
 
 class ImagePollster(_Base):
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for image in self._iter_images(manager.keystone, cache):
             yield sample.Sample(
@@ -119,7 +119,7 @@ class ImagePollster(_Base):
 
 
 class ImageSizePollster(_Base):
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for image in self._iter_images(manager.keystone, cache):
             yield sample.Sample(

ceilometer/objectstore/swift.py

@@ -24,10 +24,10 @@ from keystoneclient import exceptions
 from oslo.config import cfg
 from swiftclient import client as swift
 
+from ceilometer.central import plugin
 from ceilometer.openstack.common.gettextutils import _
 from ceilometer.openstack.common import log
 from ceilometer.openstack.common import timeutils
-from ceilometer import plugin
 from ceilometer import sample
 
 
@@ -43,7 +43,7 @@ OPTS = [
 cfg.CONF.register_opts(OPTS)
 
 
-class _Base(plugin.PollsterBase):
+class _Base(plugin.CentralPollster):
 
     CACHE_KEY_TENANT = 'tenants'
     METHOD = 'head'
@@ -86,7 +86,7 @@ class _Base(plugin.PollsterBase):
 class ObjectsPollster(_Base):
     """Iterate over all accounts, using keystone.
     """
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for tenant, account in self._iter_accounts(manager.keystone, cache):
             yield sample.Sample(
@@ -105,7 +105,7 @@ class ObjectsPollster(_Base):
 class ObjectsSizePollster(_Base):
     """Iterate over all accounts, using keystone.
     """
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for tenant, account in self._iter_accounts(manager.keystone, cache):
             yield sample.Sample(
@@ -124,7 +124,7 @@ class ObjectsSizePollster(_Base):
 class ObjectsContainersPollster(_Base):
     """Iterate over all accounts, using keystone.
     """
-
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for tenant, account in self._iter_accounts(manager.keystone, cache):
             yield sample.Sample(
@@ -146,6 +146,7 @@ class ContainersObjectsPollster(_Base):
 
     METHOD = 'get'
 
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for project, account in self._iter_accounts(manager.keystone, cache):
             containers_info = account[1]
@@ -169,6 +170,7 @@ class ContainersSizePollster(_Base):
 
     METHOD = 'get'
 
+    @plugin.check_keystone
     def get_samples(self, manager, cache, resources=None):
         for project, account in self._iter_accounts(manager.keystone, cache):
             containers_info = account[1]

ceilometer/tests/agentbase.py

@@ -169,30 +169,27 @@ class BaseAgentManagerTestCase(base.BaseTestCase):
             self.pipeline_cfg,
             self.transformer_manager)
 
-    def create_pollster_manager(self):
+    def get_extention_list(self):
-        return extension.ExtensionManager.make_test_instance(
+        return [extension.Extension('test',
-            [
-                extension.Extension(
-                    'test',
                                     None,
                                     None,
                                     self.Pollster(), ),
-                extension.Extension(
+                extension.Extension('testanother',
-                    'testanother',
                                     None,
                                     None,
                                     self.PollsterAnother(), ),
-                extension.Extension(
+                extension.Extension('testexception',
-                    'testexception',
                                     None,
                                     None,
                                     self.PollsterException(), ),
-                extension.Extension(
+                extension.Extension('testexceptionanother',
-                    'testexceptionanother',
                                     None,
                                     None,
-                    self.PollsterExceptionAnother(), ),
+                                    self.PollsterExceptionAnother(), )]
-            ],
+
+    def create_pollster_manager(self):
+        return extension.ExtensionManager.make_test_instance(
+            self.get_extention_list(),
         )
 
     def create_discovery_manager(self):

ceilometer/tests/central/test_manager.py

@@ -18,10 +18,13 @@
 """
 
 import mock
+from stevedore import extension
 
 from ceilometer.central import manager
+from ceilometer.central import plugin
 from ceilometer.openstack.common.fixture import mockpatch
 from ceilometer.openstack.common import test
+from ceilometer import pipeline
 from ceilometer.tests import agentbase
 
 
@@ -33,7 +36,31 @@ class TestManager(test.BaseTestCase):
         self.assertIsNotNone(list(mgr.pollster_manager))
 
 
+class TestPollsterKeystone(agentbase.TestPollster):
+    @plugin.check_keystone
+    def get_samples(self, manager, cache, resources=None):
+        func = super(TestPollsterKeystone, self).get_samples
+        return func(manager=manager,
+                    cache=cache,
+                    resources=resources)
+
+
 class TestRunTasks(agentbase.BaseAgentManagerTestCase):
+
+    class PollsterKeystone(TestPollsterKeystone):
+        samples = []
+        resources = []
+        test_data = agentbase.TestSample(
+            name='testkeystone',
+            type=agentbase.default_test_data.type,
+            unit=agentbase.default_test_data.unit,
+            volume=agentbase.default_test_data.volume,
+            user_id=agentbase.default_test_data.user_id,
+            project_id=agentbase.default_test_data.project_id,
+            resource_id=agentbase.default_test_data.resource_id,
+            timestamp=agentbase.default_test_data.timestamp,
+            resource_metadata=agentbase.default_test_data.resource_metadata)
+
     @staticmethod
     def create_manager():
         return manager.AgentManager()
@@ -43,18 +70,45 @@ class TestRunTasks(agentbase.BaseAgentManagerTestCase):
         super(TestRunTasks, self).setUp()
         self.useFixture(mockpatch.Patch(
             'keystoneclient.v2_0.client.Client',
-            return_value=None))
+            return_value=mock.Mock()))
+
+    def tearDown(self):
+        self.PollsterKeystone.samples = []
+        self.PollsterKeystone.resources = []
+        super(TestRunTasks, self).tearDown()
+
+    def get_extention_list(self):
+        exts = super(TestRunTasks, self).get_extention_list()
+        exts.append(extension.Extension('testkeystone',
+                                        None,
+                                        None,
+                                        self.PollsterKeystone(),))
+        return exts
 
     def test_get_sample_resources(self):
         polling_tasks = self.mgr.setup_polling_tasks()
         self.mgr.interval_task(polling_tasks.values()[0])
         self.assertTrue(self.Pollster.resources)
 
-    def test_skip_task_when_keystone_fail(self):
+    def test_when_keystone_fail(self):
-        """Test for https://bugs.launchpad.net/ceilometer/+bug/1287613."""
+        """Test for bug 1316532.
+        """
         self.useFixture(mockpatch.Patch(
             'keystoneclient.v2_0.client.Client',
             side_effect=Exception))
+        self.pipeline_cfg = [
+            {
+                'name': "test_keystone",
+                'interval': 10,
+                'counters': ['testkeystone'],
+                'resources': ['test://'] if self.source_resources else [],
+                'transformers': [],
+                'publishers': ["test"],
+            },
+        ]
+        self.mgr.pipeline_manager = pipeline.PipelineManager(
+            self.pipeline_cfg,
+            self.transformer_manager)
         polling_tasks = self.mgr.setup_polling_tasks()
         self.mgr.interval_task(polling_tasks.values()[0])
-        self.assertFalse(self.Pollster.samples)
+        self.assertFalse(self.PollsterKeystone.samples)

ceilometer/tests/energy/test_kwapi.py

@@ -51,7 +51,7 @@ class TestManager(manager.AgentManager):
 
     def __init__(self):
         super(TestManager, self).__init__()
-        self.keystone = None
+        self.keystone = mock.Mock()
 
 
 class TestKwapi(test.BaseTestCase):

ceilometer/tests/image/test_glance.py

@@ -112,7 +112,7 @@ class TestManager(manager.AgentManager):
 
     def __init__(self):
         super(TestManager, self).__init__()
-        self.keystone = None
+        self.keystone = mock.Mock()
 
 
 class TestImagePollster(test.BaseTestCase):