Add unit tests. Rename KLL_WARN to KLL_WARNING. Add the log level of …

…the logged message to the KeenLogSink protocol.
keenlabs · Feb 20, 2017 · 42a3d26 · masojus · Feb 23, 2017 · 42a3d26
1 parent f71efbd
commit 42a3d26
Show file tree

Hide file tree

Showing 8 changed files with 300 additions and 9 deletions.
diff --git a/KeenClient.xcodeproj/project.pbxproj b/KeenClient.xcodeproj/project.pbxproj
@@ -81,6 +81,7 @@
 		481A9B7E1E5691270094B985 /* KeenLogSink.h in Headers */ = {isa = PBXBuildFile; fileRef = 481A9B711E5687EA0094B985 /* KeenLogSink.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		48583E071E58CDE2002CFD99 /* KeenLogger.h in Headers */ = {isa = PBXBuildFile; fileRef = 48583E051E58CDE2002CFD99 /* KeenLogger.h */; };
 		48583E081E58CDE2002CFD99 /* KeenLogger.m in Sources */ = {isa = PBXBuildFile; fileRef = 48583E061E58CDE2002CFD99 /* KeenLogger.m */; };
+		48583E0F1E5904FD002CFD99 /* KeenLoggerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 48583E0E1E5904FD002CFD99 /* KeenLoggerTests.m */; };
 		A51E31241B03C6EF00008248 /* HTTPCodes.h in Headers */ = {isa = PBXBuildFile; fileRef = A51E31221B03C6EF00008248 /* HTTPCodes.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		A51E31251B03C6EF00008248 /* HTTPCodes.m in Sources */ = {isa = PBXBuildFile; fileRef = A51E31231B03C6EF00008248 /* HTTPCodes.m */; };
 		CA6410D818E37E7C00E53E3C /* KIODBStore.h in Headers */ = {isa = PBXBuildFile; fileRef = CA6410D618E37E7C00E53E3C /* KIODBStore.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -184,6 +185,8 @@
 		481A9B7B1E5690950094B985 /* KeenLogSinkNSLog.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = KeenLogSinkNSLog.m; sourceTree = "<group>"; };
 		48583E051E58CDE2002CFD99 /* KeenLogger.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = KeenLogger.h; sourceTree = "<group>"; };
 		48583E061E58CDE2002CFD99 /* KeenLogger.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = KeenLogger.m; sourceTree = "<group>"; };
+		48583E0D1E5904FD002CFD99 /* KeenLoggerTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = KeenLoggerTests.h; sourceTree = "<group>"; };
+		48583E0E1E5904FD002CFD99 /* KeenLoggerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = KeenLoggerTests.m; sourceTree = "<group>"; };
 		A51E31221B03C6EF00008248 /* HTTPCodes.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = HTTPCodes.h; sourceTree = "<group>"; };
 		A51E31231B03C6EF00008248 /* HTTPCodes.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = HTTPCodes.m; sourceTree = "<group>"; };
 		A58E0C061AF85F3C00DF2B71 /* KeenSwiftClientExample.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = KeenSwiftClientExample.xcodeproj; path = KeenSwiftClientExample/KeenSwiftClientExample.xcodeproj; sourceTree = "<group>"; };
@@ -360,6 +363,8 @@
 				CA6410E118E39F3A00E53E3C /* KIODBStoreTests.m */,
 				3E63D9F51AE7425000E57A17 /* KIOQueryTests.h */,
 				3E63D9F61AE7425000E57A17 /* KIOQueryTests.m */,
+				48583E0D1E5904FD002CFD99 /* KeenLoggerTests.h */,
+				48583E0E1E5904FD002CFD99 /* KeenLoggerTests.m */,
 			);
 			path = KeenClientTests;
 			sourceTree = "<group>";
@@ -712,6 +717,7 @@
 			files = (
 				CA6410E218E39F3A00E53E3C /* KIODBStoreTests.m in Sources */,
 				3E63D9F71AE7425000E57A17 /* KIOQueryTests.m in Sources */,
+				48583E0F1E5904FD002CFD99 /* KeenLoggerTests.m in Sources */,
 				017EE13F14E30C96000F3868 /* KeenClientTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

diff --git a/KeenClient/KeenClient.h b/KeenClient/KeenClient.h
@@ -384,7 +384,8 @@ typedef NSDictionary* (^KeenGlobalPropertiesBlock)(NSString *eventCollection);
 + (void)removeLogSink:(id<KeenLogSink>)sink;
 
 /**
- Set the verbosity of logging that will be sent to the sinks
+ Set the verbosity of logging that will be sent to the sinks.
+ The default log level is KLL_ERROR.
  */
 + (void)setLogLevel:(KeenLogLevel)level;
 
@@ -393,7 +394,7 @@ typedef NSDictionary* (^KeenGlobalPropertiesBlock)(NSString *eventCollection);
 
 // defines the KCLog macro
 #define KCLogError(message, ...)    { [KeenClient logMessageWithLevel:KLL_ERROR andMessage:[NSString stringWithFormat:message, ##__VA_ARGS__]]; }
-#define KCLogWarn(message, ...)     { [KeenClient logMessageWithLevel:KLL_WARN andMessage:[NSString stringWithFormat:message, ##__VA_ARGS__]]; }
+#define KCLogWarn(message, ...)     { [KeenClient logMessageWithLevel:KLL_WARNING andMessage:[NSString stringWithFormat:message, ##__VA_ARGS__]]; }
 #define KCLogInfo(message, ...)     { [KeenClient logMessageWithLevel:KLL_INFO andMessage:[NSString stringWithFormat:message, ##__VA_ARGS__]]; }
 #define KCLogVerbose(message, ...)  { [KeenClient logMessageWithLevel:KLL_VERBOSE andMessage:[NSString stringWithFormat:message, ##__VA_ARGS__]]; }
 

diff --git a/KeenClient/KeenLogSink.h b/KeenClient/KeenLogSink.h
@@ -14,7 +14,7 @@
 // be logged.
 typedef enum {
     KLL_ERROR = 1,
-    KLL_WARN = 2,
+    KLL_WARNING = 2,
     KLL_INFO = 3,
     KLL_VERBOSE = 4
 } KeenLogLevel;
@@ -25,7 +25,7 @@ typedef enum {
 //
 @protocol KeenLogSink
 
-- (void)logMessage:(NSString*)message;
+- (void)logMessageWithLevel:(KeenLogLevel)msgLevel andMessage:(NSString*)message;
 
 // Even after calling KeenClient removeLogSink, a sink will
 // receive messages that had already been queued before the call

diff --git a/KeenClient/KeenLogSinkNSLog.m b/KeenClient/KeenLogSinkNSLog.m
@@ -10,8 +10,23 @@
 
 @implementation KeenLogSinkNSLog
 
-- (void)logMessage:(NSString*)message {
-    NSLog(@"%@", message);
+- (void)logMessageWithLevel:(KeenLogLevel)msgLevel andMessage:(NSString*)message {
+    NSString* logPrefix;
+    switch (msgLevel) {
+        case KLL_ERROR:
+            logPrefix = @"E:";
+            break;
+        case KLL_WARNING:
+            logPrefix = @"W:";
+            break;
+        case KLL_INFO:
+            logPrefix = @"I:";
+            break;
+        case KLL_VERBOSE:
+            logPrefix = @"V:";
+            break;
+    }
+    NSLog(@"%@%@", logPrefix, message);
 }
 
 - (void)onRemoved {

diff --git a/KeenClient/KeenLogger.m b/KeenClient/KeenLogger.m
@@ -126,7 +126,7 @@ - (void)logMessageWithLevel:(KeenLogLevel)msgLevel andMessage:(NSString*)message
         if (logSinksEnabled &&
             msgLevel <= logLevel) {
             for (id<KeenLogSink> sink in logSinks) {
-                [sink logMessage:message];
+                [sink logMessageWithLevel:msgLevel andMessage:message];
             }
         }
     });

diff --git a/KeenClientTests/KeenClientTests.m b/KeenClientTests/KeenClientTests.m
@@ -53,6 +53,7 @@ - (void)setUp {
     [[KeenClient sharedClient] setProjectID:nil];
     [[KeenClient sharedClient] setWriteKey:nil];
     [[KeenClient sharedClient] setReadKey:nil];
+    [KeenClient setLogLevel:KLL_VERBOSE];
     [KeenClient enableLogging];
     [[KeenClient sharedClient] setGlobalPropertiesBlock:nil];
     [[KeenClient sharedClient] setGlobalPropertiesDictionary:nil];

diff --git a/KeenClientTests/KeenLoggerTests.h b/KeenClientTests/KeenLoggerTests.h
@@ -6,8 +6,8 @@
 //  Copyright © 2017 Keen Labs. All rights reserved.
 //
 
-#import <Foundation/Foundation.h>
+#import <XCTest/XCTest.h>
 
-@interface KeenLoggerTests : NSObject
+@interface KeenLoggerTests : XCTestCase
 
 @end