Changeset 2399

Timestamp:

07/15/09 23:18:57 (4 years ago)

Author:

lmajano

Message:

logbox category inheritance

Location:

coldbox/trunk

Files:

• system/logging/LogBox.cfc (modified) (4 diffs)
• testharness/handlers/ehGeneral.cfc (modified) (2 diffs)
• testharness/model/TimeSlotService.cfc (added)
• testing/cases/logging/LogBoxTest.cfc (modified) (2 diffs)

coldbox/trunk/system/logging/LogBox.cfc

@@ -34 +34 @@
                 instance.categoryAppenders = "";        
                 // Version
-                instance.version = "1.0 Beta";   
+                instance.version = "1.0 Beta 2";         
                 // Configuration object
                 instance.config = "";   
@@ -123 +123 @@
                         arguments.category = trim(arguments.category);
                         
-                        //Is logger created already?
+                        //Is logger by category name created already?
                         if( structKeyExists(instance.loggerRegistry,arguments.category) ){
                                 return instance.loggerRegistry[arguments.category];
                         }
-                        
-                        //Do we have a cat definition?
+                        //Do we have a category definition, so we can build it?
                         if( getConfig().categoryExists(arguments.category) ){
                                 categoryConfig = getConfig().getCategory(arguments.category);
+                                // Setup creation arguments
                                 args.category = categoryConfig.name;
                                 args.levelMin = categoryConfig.levelMin;
@@ -137 +137 @@
                         }
                         else{
-                                // Do
+                                // Setup new category name
                                 args.category = arguments.category;
+                                // Do Category Inheritance? or else just return the root logger.
+                                root = locateCategoryParentLogger(arguments.category);
+                                // Setup the category levels according to parent found.
                                 args.levelMin = root.getLevelMin();
                                 args.levelMax = root.getLevelMax();
@@ -174 +177 @@
 
 <!------------------------------------------- PRIVATE ------------------------------------------>
+        
+        <!--- locateCategoryParentLogger --->
+        <cffunction name="locateCategoryParentLogger" output="false" access="private" returntype="any" hint="Get a parent logger according to category convention inheritance.  If not found, it returns the root logger.">
+                <cfargument name="category" type="string" required="true" hint="The category name to investigate for parents."/>
+                <cfscript>
+                        // Get parent category name shortened by one.
+                        var parentCategory = listDeleteAt(arguments.category, listLen(arguments.category,"."), ".");
+                        
+                        // Check if parent Category is empty
+                        if( len(parentCategory) EQ 0 ){
+                                // Just return the root logger, nothing found.
+                                return getRootLogger();
+                        }                       
+                        // Does it exist already in the instantiated loggers?
+                        if( structKeyExists(instance.loggerRegistry,parentCategory) ){
+                                return instance.loggerRegistry[parentCategory];
+                        }
+                        // Do we need to create it, lazy loading?
+                        if( getConfig().categoryExists(arguments.category) ){
+                                return getLogger(arguments.category);   
+                        }
+                        // Else, it was not located, recurse
+                        return locateCategoryParentLogger(parentCategory);                      
+                </cfscript>
+        </cffunction>
         
         <!--- registerAppender --->

coldbox/trunk/testharness/handlers/ehGeneral.cfc

@@ -40 +40 @@
         <cfproperty name="loaderService"                                type="coldbox:loaderService"            scope="instance">
         <cfproperty name="cacheManager"                                 type="coldbox:cacheManager"             scope="instance">
+        <cfproperty name="TimeSlotService"                              type="model"            scope="variables">
         
         <!--- properties --->
@@ -45 +46 @@
                 this.allowedMethods = {doFormBean="POST,GET"};
         </cfscript>
+        
+        <!--- onDIComplete --->
+        <cffunction name="onDIComplete" output="false" access="public" returntype="any" hint="">
+                <cfdump var="#variables.TimeSlotService#"><cfabort>
+        </cffunction>
 
         <cffunction name="init" access="public" returntype="any" output="false">

coldbox/trunk/testing/cases/logging/LogBoxTest.cfc

@@ -10 +10 @@
                 //root
                 config.root(appenders="luis,luis2");
-                
+                //Sample categories
+                config.debug("coldbox.system.interceptors");
+                config.off("coldbox.system");
+                //init logBox
                 logBox.init(config);
         }
@@ -17 +20 @@
                 logger = logBox.getLogger('MyCat');
                 logger.debug("My Test");
+                
+                //2: category inheritance
+                logger = logBox.getLogger("coldbox.system.interceptors.SES");
+                assertEquals( logger.getLevelMin(), logger.logLevels.DEBUG);
+                assertEquals( logger.getRootLogger().getCategory(), "coldbox.system.interceptors");
+                
+                //3: category inheritance
+                logger = logBox.getLogger("coldbox.system.plugins");
+                assertEquals( logger.getLevelMin(), logger.logLevels.OFF);
+                assertEquals( logger.getRootLogger().getCategory(), "coldbox.system");
         }
         
+        function testgetRootLogger(){
+                logger = logBox.getRootLogger();
+                logger.info("Test");
+        }
+        
+        function testGetCurrentLoggers(){
+                debug( logBox.getCurrentLoggers() );
+        }
+        function testGetCurrentAppenders(){
+                debug( logBox.getCurrentAppenders() );
+        }
+        
+        function testLocateCategoryParentLogger(){
+                makePublic(logbox,"locateCategoryParentLogger");
+                // 1: root logger
+                assertEquals( logBox.getRootLogger(), logBox.locateCategoryParentLogger("invalid") );
+                
+                // 2: Expecting a logger with debug levels only
+                logger = logBox.locateCategoryParentLogger("coldbox.system.interceptors.SES");
+                assertEquals( logger.getLevelMin(), logger.logLevels.DEBUG);
+                
+                // 3: Expecting an OFF logger
+                logger = logBox.locateCategoryParentLogger("coldbox.system.plugins");
+                assertEquals( logger.getLevelMin(), logger.logLevels.OFF);
+        }
 </cfscript>
 </cfcomponent>