From 1a0be0e05f8d299820b60cd888d74ed5ed73e265 Mon Sep 17 00:00:00 2001 From: Akash Gangil Date: Sat, 2 Aug 2014 02:53:14 -0700 Subject: [PATCH] Move from Python logging to Openstack logging Replacing usage of python standard logging module with Openstack common logging module. Apart from the said replacements, this patch also removes basicConfig() setup from a couple of modules since its not needed. Also removes unused LOG & imports. Change-Id: I6a391951e00fb63905b2027270af9f401841d5b9 Closes-Bug: #1350937 --- .../db/migration/alembic_migrations/heal_script.py | 2 ++ .../plugins/cisco/common/cisco_credentials_v2.py | 4 ---- neutron/plugins/cisco/models/virt_phy_sw_v2.py | 2 +- neutron/plugins/cisco/network_plugin.py | 2 +- .../cisco/nexus/cisco_nexus_network_driver_v2.py | 2 +- .../plugins/cisco/nexus/cisco_nexus_plugin_v2.py | 2 +- neutron/plugins/cisco/nexus/cisco_nexus_snippets.py | 5 ----- .../ml2/drivers/cisco/nexus/nexus_snippets.py | 5 ----- neutron/plugins/vmware/plugins/base.py | 13 ++++++------- neutron/tests/base.py | 11 +++++------ neutron/tests/unit/cisco/test_network_plugin.py | 9 +++++---- neutron/tests/unit/db/firewall/test_db_firewall.py | 2 -- .../unit/db/loadbalancer/test_db_loadbalancer.py | 3 --- neutron/tests/unit/db/metering/test_db_metering.py | 3 --- neutron/tests/unit/ml2/test_helpers.py | 4 ++-- neutron/tests/unit/test_servicetype.py | 3 --- .../vmware/apiclient/test_api_eventlet_request.py | 10 +++++----- 17 files changed, 29 insertions(+), 53 deletions(-) diff --git a/neutron/db/migration/alembic_migrations/heal_script.py b/neutron/db/migration/alembic_migrations/heal_script.py index 0c49df3b7..276008171 100644 --- a/neutron/db/migration/alembic_migrations/heal_script.py +++ b/neutron/db/migration/alembic_migrations/heal_script.py @@ -34,6 +34,8 @@ METHODS = {} def heal(): + # This is needed else the heal script will start spewing + # a lot of pointless warning messages from alembic. LOG.setLevel(logging.INFO) if context.is_offline_mode(): return diff --git a/neutron/plugins/cisco/common/cisco_credentials_v2.py b/neutron/plugins/cisco/common/cisco_credentials_v2.py index c7af2bca8..115cab488 100644 --- a/neutron/plugins/cisco/common/cisco_credentials_v2.py +++ b/neutron/plugins/cisco/common/cisco_credentials_v2.py @@ -14,16 +14,12 @@ # # @author: Sumit Naiksatam, Cisco Systems, Inc. -import logging as LOG from neutron.plugins.cisco.common import cisco_constants as const from neutron.plugins.cisco.common import cisco_exceptions as cexc from neutron.plugins.cisco.common import config from neutron.plugins.cisco.db import network_db_v2 as cdb -LOG.basicConfig(level=LOG.WARN) -LOG.getLogger(const.LOGGER_COMPONENT_NAME) - class Store(object): """Credential Store.""" diff --git a/neutron/plugins/cisco/models/virt_phy_sw_v2.py b/neutron/plugins/cisco/models/virt_phy_sw_v2.py index 4702e0a75..619c00626 100644 --- a/neutron/plugins/cisco/models/virt_phy_sw_v2.py +++ b/neutron/plugins/cisco/models/virt_phy_sw_v2.py @@ -18,7 +18,6 @@ # import inspect -import logging import sys from neutron.api.v2 import attributes @@ -27,6 +26,7 @@ from neutron.extensions import portbindings from neutron.extensions import providernet as provider from neutron import neutron_plugin_base_v2 from neutron.openstack.common import importutils +from neutron.openstack.common import log as logging from neutron.plugins.cisco.common import cisco_constants as const from neutron.plugins.cisco.common import cisco_credentials_v2 as cred from neutron.plugins.cisco.common import cisco_exceptions as cexc diff --git a/neutron/plugins/cisco/network_plugin.py b/neutron/plugins/cisco/network_plugin.py index 4c6134073..b3f679e9d 100644 --- a/neutron/plugins/cisco/network_plugin.py +++ b/neutron/plugins/cisco/network_plugin.py @@ -14,7 +14,6 @@ # # @author: Sumit Naiksatam, Cisco Systems, Inc. -import logging import webob.exc as wexc @@ -22,6 +21,7 @@ from neutron.api import extensions as neutron_extensions from neutron.api.v2 import base from neutron.db import db_base_plugin_v2 from neutron.openstack.common import importutils +from neutron.openstack.common import log as logging from neutron.plugins.cisco.common import cisco_exceptions as cexc from neutron.plugins.cisco.common import config from neutron.plugins.cisco.db import network_db_v2 as cdb diff --git a/neutron/plugins/cisco/nexus/cisco_nexus_network_driver_v2.py b/neutron/plugins/cisco/nexus/cisco_nexus_network_driver_v2.py index f55a80014..9ee95bf36 100644 --- a/neutron/plugins/cisco/nexus/cisco_nexus_network_driver_v2.py +++ b/neutron/plugins/cisco/nexus/cisco_nexus_network_driver_v2.py @@ -19,11 +19,11 @@ Implements a Nexus-OS NETCONF over SSHv2 API Client """ -import logging from ncclient import manager from neutron.openstack.common import excutils +from neutron.openstack.common import log as logging from neutron.plugins.cisco.common import cisco_constants as const from neutron.plugins.cisco.common import cisco_credentials_v2 as cred from neutron.plugins.cisco.common import cisco_exceptions as cexc diff --git a/neutron/plugins/cisco/nexus/cisco_nexus_plugin_v2.py b/neutron/plugins/cisco/nexus/cisco_nexus_plugin_v2.py index 012c85604..a0fc4d4bb 100644 --- a/neutron/plugins/cisco/nexus/cisco_nexus_plugin_v2.py +++ b/neutron/plugins/cisco/nexus/cisco_nexus_plugin_v2.py @@ -22,10 +22,10 @@ PlugIn for Nexus OS driver """ -import logging from neutron.openstack.common import excutils from neutron.openstack.common import importutils +from neutron.openstack.common import log as logging from neutron.plugins.cisco.common import cisco_constants as const from neutron.plugins.cisco.common import cisco_exceptions as cisco_exc from neutron.plugins.cisco.common import config as conf diff --git a/neutron/plugins/cisco/nexus/cisco_nexus_snippets.py b/neutron/plugins/cisco/nexus/cisco_nexus_snippets.py index 81a93f537..e8c8e2633 100644 --- a/neutron/plugins/cisco/nexus/cisco_nexus_snippets.py +++ b/neutron/plugins/cisco/nexus/cisco_nexus_snippets.py @@ -19,11 +19,6 @@ Nexus-OS XML-based configuration snippets """ -import logging - - -LOG = logging.getLogger(__name__) - # The following are standard strings, messages used to communicate with Nexus, EXEC_CONF_SNIPPET = """ diff --git a/neutron/plugins/ml2/drivers/cisco/nexus/nexus_snippets.py b/neutron/plugins/ml2/drivers/cisco/nexus/nexus_snippets.py index fb38e4199..99f38251b 100644 --- a/neutron/plugins/ml2/drivers/cisco/nexus/nexus_snippets.py +++ b/neutron/plugins/ml2/drivers/cisco/nexus/nexus_snippets.py @@ -18,11 +18,6 @@ Cisco Nexus-OS XML-based configuration snippets. """ -import logging - - -LOG = logging.getLogger(__name__) - # The following are standard strings, messages used to communicate with Nexus. EXEC_CONF_SNIPPET = """ diff --git a/neutron/plugins/vmware/plugins/base.py b/neutron/plugins/vmware/plugins/base.py index e59c527ee..f015e28a5 100644 --- a/neutron/plugins/vmware/plugins/base.py +++ b/neutron/plugins/vmware/plugins/base.py @@ -13,7 +13,6 @@ # License for the specific language governing permissions and limitations # under the License. -import logging import uuid from oslo.config import cfg @@ -51,7 +50,9 @@ from neutron.extensions import portsecurity as psec from neutron.extensions import providernet as pnet from neutron.extensions import securitygroup as ext_sg from neutron.openstack.common import excutils +from neutron.openstack.common.gettextutils import _LE from neutron.openstack.common import lockutils +from neutron.openstack.common import log as logging from neutron.plugins.common import constants as plugin_const from neutron.plugins import vmware from neutron.plugins.vmware.api_client import exception as api_exc @@ -2080,12 +2081,10 @@ class NsxPluginV2(addr_pair_db.AllowedAddressPairsMixin, def _get_nsx_device_id(self, context, device_id): return self._get_gateway_device(context, device_id)['nsx_id'] - def _rollback_gw_device(self, context, device_id, - gw_data=None, new_status=None, - is_create=False, log_level=logging.ERROR): - LOG.log(log_level, - _("Rolling back database changes for gateway device %s " - "because of an error in the NSX backend"), device_id) + def _rollback_gw_device(self, context, device_id, gw_data=None, + new_status=None, is_create=False): + LOG.error(_LE("Rolling back database changes for gateway device %s " + "because of an error in the NSX backend"), device_id) with context.session.begin(subtransactions=True): query = self._model_query( context, networkgw_db.NetworkGatewayDevice).filter( diff --git a/neutron/tests/base.py b/neutron/tests/base.py index b0bccef37..99a91affa 100644 --- a/neutron/tests/base.py +++ b/neutron/tests/base.py @@ -17,7 +17,7 @@ import contextlib import gc -import logging +import logging as std_logging import os import os.path import sys @@ -110,7 +110,6 @@ class BaseTestCase(testtools.TestCase): def setUp(self): super(BaseTestCase, self).setUp() - # Ensure plugin cleanup is triggered last so that # test-specific cleanup has a chance to release references. self.addCleanup(self.cleanup_core_plugin) @@ -120,12 +119,12 @@ class BaseTestCase(testtools.TestCase): self.addOnException(post_mortem_debug.exception_handler) if os.environ.get('OS_DEBUG') in TRUE_STRING: - _level = logging.DEBUG + _level = std_logging.DEBUG else: - _level = logging.INFO + _level = std_logging.INFO capture_logs = os.environ.get('OS_LOG_CAPTURE') in TRUE_STRING if not capture_logs: - logging.basicConfig(format=LOG_FORMAT, level=_level) + std_logging.basicConfig(format=LOG_FORMAT, level=_level) self.log_fixture = self.useFixture( fixtures.FakeLogger( format=LOG_FORMAT, @@ -138,7 +137,7 @@ class BaseTestCase(testtools.TestCase): fixtures.FakeLogger( name='neutron.api.extensions', format=LOG_FORMAT, - level=logging.ERROR, + level=std_logging.ERROR, nuke_handlers=capture_logs, )) diff --git a/neutron/tests/unit/cisco/test_network_plugin.py b/neutron/tests/unit/cisco/test_network_plugin.py index 4e7be3e87..bde9cb551 100644 --- a/neutron/tests/unit/cisco/test_network_plugin.py +++ b/neutron/tests/unit/cisco/test_network_plugin.py @@ -16,7 +16,7 @@ import contextlib import copy import inspect -import logging +import logging as std_logging import mock import six @@ -33,6 +33,7 @@ from neutron.extensions import portbindings from neutron.extensions import providernet as provider from neutron import manager from neutron.openstack.common import gettextutils +from neutron.openstack.common import log as logging from neutron.plugins.cisco.common import cisco_constants as const from neutron.plugins.cisco.common import cisco_exceptions as c_exc from neutron.plugins.cisco.common import config as cisco_config @@ -923,7 +924,7 @@ class TestCiscoNetworksV2(CiscoNetworkPluginV2TestCase, *args, **kwargs) patched_plugin.side_effect = side_effect res = self._create_network_bulk(self.fmt, 2, 'test', True) - LOG.debug("response is %s" % res) + LOG.debug('response is %s', res) # We expect an internal server error as we injected a fault self._validate_behavior_on_bulk_failure( res, @@ -1052,10 +1053,10 @@ class TestCiscoRouterInterfacesV2(CiscoNetworkPluginV2TestCase): def _count_exception_logs(*args, **kwargs): self.log_exc_count += 1 - mock.patch.object(logging.LoggerAdapter, 'exception', + mock.patch.object(std_logging.LoggerAdapter, 'exception', autospec=True, side_effect=_count_exception_logs, - wraps=logging.LoggerAdapter.exception).start() + wraps=std_logging.LoggerAdapter.exception).start() super(TestCiscoRouterInterfacesV2, self).setUp() ext_mgr = extensions.PluginAwareExtensionManager.get_instance() self.ext_api = test_extensions.setup_extensions_middleware(ext_mgr) diff --git a/neutron/tests/unit/db/firewall/test_db_firewall.py b/neutron/tests/unit/db/firewall/test_db_firewall.py index 0abd35464..b1234d481 100644 --- a/neutron/tests/unit/db/firewall/test_db_firewall.py +++ b/neutron/tests/unit/db/firewall/test_db_firewall.py @@ -16,7 +16,6 @@ # @author: Sumit Naiksatam, sumitnaiksatam@gmail.com, Big Switch Networks, Inc. import contextlib -import logging import mock import webob.exc @@ -35,7 +34,6 @@ from neutron.services.firewall import fwaas_plugin from neutron.tests.unit import test_db_plugin -LOG = logging.getLogger(__name__) DB_FW_PLUGIN_KLASS = ( "neutron.db.firewall.firewall_db.Firewall_db_mixin" ) diff --git a/neutron/tests/unit/db/loadbalancer/test_db_loadbalancer.py b/neutron/tests/unit/db/loadbalancer/test_db_loadbalancer.py index fec26b77b..b47d61167 100644 --- a/neutron/tests/unit/db/loadbalancer/test_db_loadbalancer.py +++ b/neutron/tests/unit/db/loadbalancer/test_db_loadbalancer.py @@ -14,7 +14,6 @@ # limitations under the License. import contextlib -import logging import mock from oslo.config import cfg @@ -40,8 +39,6 @@ from neutron.services import provider_configuration as pconf from neutron.tests.unit import test_db_plugin -LOG = logging.getLogger(__name__) - DB_CORE_PLUGIN_KLASS = 'neutron.db.db_base_plugin_v2.NeutronDbPluginV2' DB_LB_PLUGIN_KLASS = ( "neutron.services.loadbalancer." diff --git a/neutron/tests/unit/db/metering/test_db_metering.py b/neutron/tests/unit/db/metering/test_db_metering.py index 06ec8b146..4c05632b7 100644 --- a/neutron/tests/unit/db/metering/test_db_metering.py +++ b/neutron/tests/unit/db/metering/test_db_metering.py @@ -15,7 +15,6 @@ # under the License. import contextlib -import logging import webob.exc @@ -28,8 +27,6 @@ from neutron.plugins.common import constants from neutron.services.metering import metering_plugin from neutron.tests.unit import test_db_plugin -LOG = logging.getLogger(__name__) - DB_METERING_PLUGIN_KLASS = ( "neutron.services.metering." "metering_plugin.MeteringPlugin" diff --git a/neutron/tests/unit/ml2/test_helpers.py b/neutron/tests/unit/ml2/test_helpers.py index b1543261a..7c74a5387 100644 --- a/neutron/tests/unit/ml2/test_helpers.py +++ b/neutron/tests/unit/ml2/test_helpers.py @@ -14,7 +14,7 @@ # under the License. import fixtures -import logging +import logging as std_logging import mock from sqlalchemy.orm import query @@ -48,7 +48,7 @@ class HelpersTest(base.BaseTestCase): fixtures.FakeLogger( name=helpers.__name__, format=base.LOG_FORMAT, - level=logging.DEBUG + level=std_logging.DEBUG )) def check_raw_segment(self, expected, observed): diff --git a/neutron/tests/unit/test_servicetype.py b/neutron/tests/unit/test_servicetype.py index 633e4bb4c..6db85b79f 100644 --- a/neutron/tests/unit/test_servicetype.py +++ b/neutron/tests/unit/test_servicetype.py @@ -16,8 +16,6 @@ # @author: Salvatore Orlando, VMware # -import logging - import mock from oslo.config import cfg import webob.exc as webexc @@ -39,7 +37,6 @@ from neutron.tests.unit import test_extensions from neutron.tests.unit import testlib_api -LOG = logging.getLogger(__name__) DEFAULT_SERVICE_DEFS = [{'service_class': constants.DUMMY, 'plugin': dp.DUMMY_PLUGIN_NAME}] diff --git a/neutron/tests/unit/vmware/apiclient/test_api_eventlet_request.py b/neutron/tests/unit/vmware/apiclient/test_api_eventlet_request.py index c77b85568..536b7ea5a 100644 --- a/neutron/tests/unit/vmware/apiclient/test_api_eventlet_request.py +++ b/neutron/tests/unit/vmware/apiclient/test_api_eventlet_request.py @@ -13,7 +13,6 @@ # under the License. import httplib -import logging import new import random @@ -21,13 +20,14 @@ import eventlet from eventlet.green import urllib2 import mock +from neutron.openstack.common.gettextutils import _LI +from neutron.openstack.common import log as logging from neutron.plugins.vmware.api_client import eventlet_client as client from neutron.plugins.vmware.api_client import eventlet_request as request from neutron.tests import base from neutron.tests.unit import vmware -logging.basicConfig(level=logging.DEBUG) LOG = logging.getLogger("test_api_request_eventlet") @@ -60,7 +60,7 @@ class ApiRequestEventletTest(base.BaseTestCase): def test_apirequest_spawn(self): def x(id): eventlet.greenthread.sleep(random.random()) - LOG.info('spawned: %d' % id) + LOG.info(_LI('spawned: %d'), id) for i in range(10): request.EventletApiRequest._spawn(x, i) @@ -72,8 +72,8 @@ class ApiRequestEventletTest(base.BaseTestCase): a._handle_request = mock.Mock() a.start() eventlet.greenthread.sleep(0.1) - logging.info('_handle_request called: %s' % - a._handle_request.called) + LOG.info(_LI('_handle_request called: %s'), + a._handle_request.called) request.EventletApiRequest.joinall() def test_join_with_handle_request(self): -- 2.45.2