From 79efeba4c30323a7fceb4dd87b2966d9f037d84b Mon Sep 17 00:00:00 2001
From: Clint Byrum <clint@fewbar.com>
Date: Tue, 8 Jul 2014 14:13:37 -0700
Subject: [PATCH] Do not log unconfigured collector as warning

The configuration will dictate whether or not something is configured.
If it is not, this is a normal state and should not be logged as a
warning.

Change-Id: I479f0aed5837871009bc69fa028f5eb64a060c53
Closes-Bug: #1321551
---
 os_collect_config/collect.py            |  3 +++
 os_collect_config/exc.py                |  8 ++++++--
 os_collect_config/tests/test_collect.py | 15 ++++++++++++++-
 3 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/os_collect_config/collect.py b/os_collect_config/collect.py
index d820f37..9ce22ef 100644
--- a/os_collect_config/collect.py
+++ b/os_collect_config/collect.py
@@ -134,6 +134,9 @@ def collect_all(collectors, store=False, collector_kwargs_map=None):
         except exc.SourceNotAvailable:
             logger.warn('Source [%s] Unavailable.' % collector)
             continue
+        except exc.SourceNotConfigured:
+            logger.debug('Source [%s] Not configured.' % collector)
+            continue
 
         if store:
             for output_key, output_content in content:
diff --git a/os_collect_config/exc.py b/os_collect_config/exc.py
index 88a6485..e64fd6f 100644
--- a/os_collect_config/exc.py
+++ b/os_collect_config/exc.py
@@ -18,6 +18,10 @@ class SourceNotAvailable(RuntimeError):
     """The requested data source is unavailable."""
 
 
+class SourceNotConfigured(RuntimeError):
+    """The requested data source is not configured."""
+
+
 class Ec2MetadataNotAvailable(SourceNotAvailable):
     """The EC2 metadata service is not available."""
 
@@ -30,11 +34,11 @@ class HeatMetadataNotAvailable(SourceNotAvailable):
     """The heat metadata service is not available."""
 
 
-class CfnMetadataNotConfigured(SourceNotAvailable):
+class CfnMetadataNotConfigured(SourceNotConfigured):
     """The cfn metadata service is not fully configured."""
 
 
-class HeatMetadataNotConfigured(SourceNotAvailable):
+class HeatMetadataNotConfigured(SourceNotConfigured):
     """The heat metadata service is not fully configured."""
 
 
diff --git a/os_collect_config/tests/test_collect.py b/os_collect_config/tests/test_collect.py
index 7b8919b..1b76af9 100644
--- a/os_collect_config/tests/test_collect.py
+++ b/os_collect_config/tests/test_collect.py
@@ -300,7 +300,7 @@ class TestCollect(testtools.TestCase):
 class TestCollectAll(testtools.TestCase):
     def setUp(self):
         super(TestCollectAll, self).setUp()
-        self.useFixture(fixtures.FakeLogger())
+        self.log = self.useFixture(fixtures.FakeLogger())
         collect.setup_conf()
         self.cache_dir = self.useFixture(fixtures.TempDir())
         self.backup_cache_dir = self.useFixture(fixtures.TempDir())
@@ -440,6 +440,19 @@ class TestCollectAll(testtools.TestCase):
         self.assertThat(content, matchers.IsInstance(dict))
         self.assertNotIn('ec2', content)
 
+    def test_collect_all_cfn_unconfigured(self):
+        collector_kwargs_map = {
+            'cfn': {'requests_impl': test_cfn.FakeRequests(self)}
+        }
+        cfg.CONF.cfn.metadata_url = None
+        (changed_keys, content) = self._call_collect_all(
+            store=False, collector_kwargs_map=collector_kwargs_map,
+            collectors=['heat_local', 'cfn'])
+        self.assertIn('No metadata_url configured', self.log.output)
+        self.assertNotIn('cfn', content)
+        self.assertIn('heat_local', content)
+        self.assertEqual(test_heat_local.META_DATA, content['heat_local'])
+
 
 class TestConf(testtools.TestCase):