gets rid of loud logging and sets requirement for Twisted to 15.2.1 which is needed for crosstown_traffic testing

Author: anthonyalmarza

hendrix/__init__.py

@@ -1 +1 @@
-__version__ = '1.0.0'
+__version__ = '1.0.1'

hendrix/contrib/async/crosstown_traffic.py

@@ -1,12 +1,9 @@
 from twisted.internet.threads import deferToThread, deferToThreadPool
 from twisted.internet import reactor
+from twisted.logger import Logger
 
 import threading
 
-import logging
-
-logger = logging.getLogger(__name__)
-logger.setLevel(logging.INFO)
 
 def get_response_for_thread(thread=None):
 
@@ -24,6 +21,8 @@ def get_tasks_to_follow_current_response(thread=None):
 
 class ThroughToYou(object):
 
+    log = Logger()
+
     def __init__(self,
                  same_thread=False,
                  no_go_status_codes=['5xx', '4xx'],
@@ -40,7 +39,11 @@ def __call__(self, crosstown_task):
         self.response = get_response_for_thread()
 
         if not self.no_go:
-            logger.info("Adding '%s' to crosstown_traffic for %s" % (crosstown_task.__name__, self.response))
+            self.log.info(
+                "Adding '{task!r}' to crosstown_traffic for "
+                "{log_source.response}",
+                task=crosstown_task
+            )
             self.response.crosstown_tasks.append(self)
 
     def run(self, threadpool):
@@ -71,9 +74,11 @@ def populate_no_go_status_code_list(self):
                 self.no_go_status_code_list.extend(range(begin, end))
 
             else:
-                 self.no_go_status_code_list.append(no_go_code)
+                self.no_go_status_code_list.append(no_go_code)
 
-        logger.debug("no_go_status_codes are %s" % self.no_go_status_code_list)
+        self.log.debug(
+            "no_go_status_codes are {data!r}", data=self.no_go_status_code_list
+        )
 
     def check_status_code_against_no_go_list(self):
         if self.no_go_status_codes:
@@ -83,7 +88,10 @@ def check_status_code_against_no_go_list(self):
             self.populate_no_go_status_code_list()
 
             if self.status_code in self.no_go_status_code_list:
-                logger.info("Flagging no-go becasue status code is %s" % self.status_code)
+                self.log.info(
+                    "Flagging no-go becasue status code is "
+                    "{log_source.status_code}"
+                )
                 self.no_go = True
 
 

hendrix/defaults.py

@@ -1,6 +1,12 @@
+import os
+
+
 CACHE_PORT = 8080
 HTTP_PORT = 8000
 HTTPS_PORT = 4430
 
 
 DEFAULT_MAX_AGE = 3600
+
+DEFAULT_LOG_PATH = os.path.dirname(__file__)
+DEFAULT_LOG_FILE = os.path.join(DEFAULT_LOG_PATH, 'default-hendrix.log')

hendrix/deploy/base.py

@@ -35,17 +35,21 @@ def __init__(self, action='start', options={}, reactor=reactor):
         # because running the management command overrides self.options['wsgi']
         if self.options['wsgi']:
             if hasattr(self.options['wsgi'], '__call__'):
-                # If it has a __call__, we assume that it is the application object itself.
+                # If it has a __call__, we assume that it is the application
+                # object itself.
                 self.application = self.options['wsgi']
                 try:
-                    self.options['wsgi_app_name'] = "%s.%s" % (self.application.__module__, self.application.__name__)
+                    self.options['wsgi'] = "%s.%s" % (
+                        self.application.__module__, self.application.__name__
+                    )
                 except AttributeError:
-                    self.options['wsgi_app_name'] = self.application.__class__.__name__
+                    self.options['wsgi'] = self.application.__class__.__name__
             else:
-                # Otherwise, we'll try to discern an application in the belief that this is a dot path.
+                # Otherwise, we'll try to discern an application in the belief
+                # that this is a dot path.
                 wsgi_dot_path = self.options['wsgi']
-                self.application = HendrixDeploy.importWSGI(wsgi_dot_path)  # will raise AttributeError if we can't import it.
-                self.options['wsgi_app_name'] = wsgi_dot_path
+                # will raise AttributeError if we can't import it.
+                self.application = HendrixDeploy.importWSGI(wsgi_dot_path)
             self.use_settings = False
         else:
             os.environ['DJANGO_SETTINGS_MODULE'] = self.options['settings']

hendrix/logger.py

@@ -0,0 +1,22 @@
+from .defaults import DEFAULT_LOG_FILE
+from twisted.logger import (
+    ILogObserver, jsonFileLogObserver, FilteringLogObserver,
+    LogLevelFilterPredicate, LogLevel, globalLogPublisher
+)
+from zope.interface import provider
+
+import io
+
+
+@provider(ILogObserver)
+def hendrixObserver(path=DEFAULT_LOG_FILE, log_level=LogLevel.warn):
+    json_observer = jsonFileLogObserver(
+        io.open(path, 'a')
+    )
+    return FilteringLogObserver(
+        json_observer,
+        [LogLevelFilterPredicate(log_level), ]
+    )
+
+
+globalLogPublisher.addObserver(hendrixObserver(log_level=LogLevel.debug))

hendrix/options.py

@@ -1,7 +1,6 @@
-import os
-
 from hendrix import defaults
 from optparse import make_option, OptionParser
+import os
 
 
 def cleanOptions(options):
@@ -55,7 +54,7 @@ def cleanOptions(options):
         '--log',
         dest='log',
         type=str,
-        default=os.path.join(os.path.dirname(__file__), 'hendrix.log'),
+        default=os.path.join(defaults.DEFAULT_LOG_PATH, 'hendrix.log'),
         help=(
             'file path to where the log files should live '
             '[default: $PYTHON_PATH/lib/.../hendrix/hendrix.log]'

hendrix/resources.py

@@ -7,40 +7,34 @@
 from twisted.web import resource, static
 from twisted.web.server import NOT_DONE_YET
 from twisted.web.wsgi import WSGIResource, _WSGIResponse
+from twisted.logger import Logger
 
-import logging
 import chalk
-from twisted.internet.threads import deferToThread
 import threading
-import  uuid
-
-logger = logging.getLogger(__name__)
-
-# thread_list = []  # Debug
+import uuid
 
 
 class HendrixWSGIResponse(_WSGIResponse):
 
+    log = Logger()
+
     def __init__(self, *args, **kwargs):
         self.crosstown_tasks = []
         return super(HendrixWSGIResponse, self).__init__(*args, **kwargs)
 
     def run(self, *args, **kwargs):
         self.thread = threading.current_thread()
-        # thread_list.append(self.thread)  # Debug
-        # logger.debug("Assigning %s as the current response for thread %s" % (self, self.thread))
         self.thread.response_object = self
         self.request.setHeader('server', 'hendrix/Twisted')
         ran = super(HendrixWSGIResponse, self).run(*args, **kwargs)
         self.follow_response_tasks()
         return ran
-    
-    def follow_response_tasks(self):
 
+    def follow_response_tasks(self):
         for task in self.crosstown_tasks:
-            logger.info("Processing crosstown task: '%s'" % task)
             task.run(self.threadpool)
 
+
 class LoudWSGIResponse(HendrixWSGIResponse):
 
     def startResponse(self, status, headers, excInfo=None):
@@ -55,19 +49,20 @@ def startResponse(self, status, headers, excInfo=None):
             responseInColor, self.request, status, headers
         )
         return self.write
-    
+
 
 class HendrixWSGIResource(WSGIResource):
-    
+
     ResponseClass = HendrixWSGIResponse
-    
-    def render(self, request):        
+
+    def render(self, request):
         response = self.ResponseClass(
-            self._reactor, self._threadpool, self._application, request)
+            self._reactor, self._threadpool, self._application, request
+        )
         response.start()
         return NOT_DONE_YET
 
-        
+
 class DevWSGIResource(HendrixWSGIResource):
 
     ResponseClass = LoudWSGIResponse
@@ -86,12 +81,16 @@ class HendrixResource(resource.Resource):
     to ensure that django always gets the full path.
     """
 
+    log = Logger()
+
     def __init__(self, reactor, threads, application, loud=False):
         resource.Resource.__init__(self)
         if loud:
             self.wsgi_resource = DevWSGIResource(reactor, threads, application)
         else:
-            self.wsgi_resource = HendrixWSGIResource(reactor, threads, application)
+            self.wsgi_resource = HendrixWSGIResource(
+                reactor, threads, application
+            )
 
     def getChild(self, name, request):
         """
@@ -137,11 +136,12 @@ def putNamedChild(self, res):
 
             name = parts[-1]  # get the path part that we care about
             if children.get(name):
-                logger.warning(
-                    'A resource already exists at this path. Check '
-                    'your resources list to ensure each path is '
-                    'unique. The previous resource will be overridden.'
-                )
+                # self.log.warn(
+                #     'A resource already exists at this path. Check '
+                #     'your resources list to ensure each path is '
+                #     'unique. The previous resource will be overridden.'
+                # )
+                pass
             parent.putChild(name, res)
         except AttributeError:
             # raise an attribute error if the resource `res` doesn't contain
@@ -215,9 +215,6 @@ def DjangoStaticResource(path, rel_url='static'):
     rel_url = rel_url.strip('/')
     StaticFilesResource = MediaResource(path)
     StaticFilesResource.namespace = rel_url
-    chalk.green(
-        "Adding media resource for URL '%s' at path '%s'" % (rel_url, path)
-    )
     return StaticFilesResource
 
 

hendrix/runtests.py

@@ -1,4 +1,5 @@
-import os, sys
+import os
+import sys
 
 # begin chdir armor
 sys.path[:] = map(os.path.abspath, sys.path)
@@ -8,4 +9,4 @@
 sys.argv.append("test")
 
 from twisted.scripts.trial import run
-run()
+run()

hendrix/services.py

@@ -2,13 +2,10 @@
 from .resources import HendrixResource
 from twisted.application import internet, service
 from twisted.internet import reactor
+from twisted.logger import Logger
 from twisted.python.threadpool import ThreadPool
 from twisted.web import server
 
-import logging
-
-logger = logging.getLogger(__name__)
-
 
 class HendrixService(service.MultiService):
     """
@@ -19,6 +16,8 @@ class HendrixService(service.MultiService):
     'services' refers to a list of twisted Services to add to the collection.
     """
 
+    log = Logger()
+
     def __init__(
             self, application, port=80, resources=None, services=None,
             loud=False):
@@ -27,10 +26,10 @@ def __init__(
         # Create, start and add a thread pool service, which is made available
         # to our WSGIResource within HendrixResource
         threads = ThreadPool(name="Hendrix Service")
-        
+
         # Testing threads 1-2-3
         threads.adjustPoolsize(3, 5)
-        
+
         reactor.addSystemEventTrigger('after', 'shutdown', threads.stop)
         ThreadPoolService(threads).setServiceParent(self)