GULLogger Testing

* Moved over old tests to correct ASLLogger location.
* Added new GULLogger tests
* Changed version `char *` to `NSString *`
* Tidied up some documentation

Author: bstpierr

GoogleUtilities/Example/Tests/Logger/GULASLLoggerTest.m

@@ -12,22 +12,127 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#import <OCMock/OCMock.h>
 #import <XCTest/XCTest.h>
 
+#import <GoogleUtilities/GULASLLogger.h>
 #import <GoogleUtilities/GULLogger.h>
 
 #import <asl.h>
 
+static NSString *const kService = @"my service";
+static NSString *const kCode = @"I-COR000001";
+
+// Redefine class property as readwrite for testing.
+@interface GULLogger (ForTesting)
+@property(nonatomic, class, readwrite) id<GULLoggerSystem> logger;
+@end
+
+// Surface aslclient and dispatchQueues for tests.
+@interface GULASLLogger (ForTesting)
+@property(nonatomic) aslclient aslClient;
+@property(nonatomic) dispatch_queue_t dispatchQueue;
+@end
+
+#pragma mark -
+
 @interface GULASLLoggerTest : XCTestCase
+@property(nonatomic) GULASLLogger *logger;
 @end
 
 @implementation GULASLLoggerTest
 
+#pragma mark Helper Methods
+
+- (BOOL)messageWasLogged:(NSString *)message {
+  // Format the message as it's expected.
+  message = [NSString stringWithFormat:@"%@[%@] %@", kService, kCode, message];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+  aslmsg query = asl_new(ASL_TYPE_QUERY);
+  asl_set_query(query, ASL_KEY_FACILITY, "com.google.utilities.logger", ASL_QUERY_OP_EQUAL);
+  aslresponse response = asl_search(self.logger.aslClient, query);
+  asl_release(query);
+  aslmsg msg;
+  const char *responseMsg;
+  BOOL messageFound = NO;
+  while ((msg = asl_next(response)) != NULL) {
+    responseMsg = asl_get(msg, ASL_KEY_MSG);
+    if ([message isEqualToString:[NSString stringWithUTF8String:responseMsg]]) {
+      messageFound = YES;
+      break;
+    }
+  }
+  asl_release(msg);
+  asl_release(response);
+#pragma clang pop
+  return messageFound;
+}
+
+#pragma mark Testing
+
 - (void)setUp {
-  // Clear out any logger state as though the app just launched.
+  self.logger = [[GULASLLogger alloc] init];
+  GULLogger.logger = self.logger;
 }
 
-// TODO(bstpierre): Write Tests
+- (void)tearDown {
+  self.logger = nil;
+  GULLogger.logger = nil;
+}
+
+- (void)testMessageCodeFormat {
+  // Valid case.
+  XCTAssertNoThrow(GULLogError(kService, NO, @"I-APP000001", @"Message."));
+
+  // An extra dash or missing dash should fail.
+  XCTAssertThrows(GULLogError(kService, NO, @"I-APP-000001", @"Message."));
+  XCTAssertThrows(GULLogError(kService, NO, @"IAPP000001", @"Message."));
+
+  // Wrong number of digits should fail.
+  XCTAssertThrows(GULLogError(kService, NO, @"I-APP00001", @"Message."));
+  XCTAssertThrows(GULLogError(kService, NO, @"I-APP0000001", @"Message."));
+
+  // Lowercase should fail.
+  XCTAssertThrows(GULLogError(kService, NO, @"I-app000001", @"Message."));
+
+  // nil or empty message code should fail.
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wnonnull"
+  XCTAssertThrows(GULLogError(kService, NO, nil, @"Message."));
+#pragma clang diagnostic pop
+
+  XCTAssertThrows(GULLogError(kService, NO, @"", @"Message."));
+
+  // Android message code should fail.
+  XCTAssertThrows(GULLogError(kService, NO, @"A-APP000001", @"Message."));
+}
+
+- (void)testLoggerInterface {
+  XCTAssertNoThrow(GULLogError(kService, NO, kCode, @"Message."));
+  XCTAssertNoThrow(GULLogError(kService, NO, kCode, @"Configure %@.", @"blah"));
+
+  XCTAssertNoThrow(GULLogWarning(kService, NO, kCode, @"Message."));
+  XCTAssertNoThrow(GULLogWarning(kService, NO, kCode, @"Configure %@.", @"blah"));
+
+  XCTAssertNoThrow(GULLogNotice(kService, NO, kCode, @"Message."));
+  XCTAssertNoThrow(GULLogNotice(kService, NO, kCode, @"Configure %@.", @"blah"));
+
+  XCTAssertNoThrow(GULLogInfo(kService, NO, kCode, @"Message."));
+  XCTAssertNoThrow(GULLogInfo(kService, NO, kCode, @"Configure %@.", @"blah"));
+
+  XCTAssertNoThrow(GULLogDebug(kService, NO, kCode, @"Message."));
+  XCTAssertNoThrow(GULLogDebug(kService, NO, kCode, @"Configure %@.", @"blah"));
+}
+
+// The GULLoggerLevel enum must match the ASL_LEVEL_* constants, but we manually redefine
+// them in GULLoggerLevel.h since we cannot include <asl.h> (see b/34976089 for more details).
+// This test ensures the constants match.
+- (void)testGULLoggerLevelValues {
+  XCTAssertEqual(GULLoggerLevelError, ASL_LEVEL_ERR);
+  XCTAssertEqual(GULLoggerLevelWarning, ASL_LEVEL_WARNING);
+  XCTAssertEqual(GULLoggerLevelNotice, ASL_LEVEL_NOTICE);
+  XCTAssertEqual(GULLoggerLevelInfo, ASL_LEVEL_INFO);
+  XCTAssertEqual(GULLoggerLevelDebug, ASL_LEVEL_DEBUG);
+}
 
 @end

GoogleUtilities/Example/Tests/Logger/GULLoggerTest.m

@@ -12,193 +12,89 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#ifdef DEBUG
-// The tests depend upon library methods only built with #ifdef DEBUG
-
 #import <OCMock/OCMock.h>
 #import <XCTest/XCTest.h>
 
 #import <GoogleUtilities/GULLogger.h>
 
-@interface GULLoggerTest : XCTestCase
-@end
-
-@implementation GULLoggerTest
-
-- (void)setUp {
-  // Clear out any logger state as though the app just launched.
-}
-
-// TODO(bstpierre): Write Tests
-
+static GULLoggerLevel kLogLevel = GULLoggerLevelError;
+static NSString *const kService = @"Test Service";
+static NSString *const kCode = @"I-COR000001";
+static NSString *const kLogMessage = @"Log Message";
+static NSString *const kVersionString = @"2";
+static char *const kVersionChar = "2";
+static const BOOL kForced = NO;
+
+// Redefine class property as readwrite for testing.
+@interface GULLogger (ForTesting)
+@property(nonatomic, class, readwrite) id<GULLoggerSystem> logger;
 @end
 
-#pragma mark - Old Tests
-
-// TODO(bstpierre): Move all following tests to GULLASLLoggerTest
-/**
-
-#import <asl.h>
-
-extern const char *kGULLoggerASLClientFacilityName;
-
-extern void GULResetLogger(void);
-
-extern aslclient getGULLoggerClient(void);
-
-extern dispatch_queue_t getGULClientQueue(void);
-
-extern BOOL getGULLoggerDebugMode(void);
-
-static NSString *const kMessageCode = @"I-COR000001";
-
-@interface GULOldLoggerTest : XCTestCase
-
-@property(nonatomic) NSString *randomLogString;
-
-@property(nonatomic, strong) NSUserDefaults *defaults;
+#pragma mark -
 
+@interface GULLoggerTest : XCTestCase
+@property(nonatomic) id loggerSystemMock;
 @end
 
-@implementation GULOldLoggerTest
+@implementation GULLoggerTest
 
 - (void)setUp {
-  [super setUp];
-  GULResetLogger();
-
-  // Stub NSUserDefaults for cleaner testing.
-  _defaults = [[NSUserDefaults alloc] initWithSuiteName:@"com.google.logger_test"];
+  self.loggerSystemMock = OCMProtocolMock(@protocol(GULLoggerSystem));
+  GULLogger.logger = self.loggerSystemMock;
 }
 
 - (void)tearDown {
-  [super tearDown];
-
-  _defaults = nil;
+  GULLogger.logger = nil;
 }
 
-- (void)testMessageCodeFormat {
-  // Valid case.
-  XCTAssertNoThrow(GULLogError(@"my service", NO, @"I-APP000001", @"Message."));
-
-  // An extra dash or missing dash should fail.
-  XCTAssertThrows(GULLogError(@"my service", NO, @"I-APP-000001", @"Message."));
-  XCTAssertThrows(GULLogError(@"my service", NO, @"IAPP000001", @"Message."));
-
-  // Wrong number of digits should fail.
-  XCTAssertThrows(GULLogError(@"my service", NO, @"I-APP00001", @"Message."));
-  XCTAssertThrows(GULLogError(@"my service", NO, @"I-APP0000001", @"Message."));
+#pragma mark Initialization Tests
 
-  // Lowercase should fail.
-  XCTAssertThrows(GULLogError(@"my service", NO, @"I-app000001", @"Message."));
-
-// nil or empty message code should fail.
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wnonnull"
-  XCTAssertThrows(GULLogError(@"my service", NO, nil, @"Message."));
-#pragma clang diagnostic pop
-
-  XCTAssertThrows(GULLogError(@"my service", NO, @"", @"Message."));
-
-  // Android message code should fail.
-  XCTAssertThrows(GULLogError(@"my service", NO, @"A-APP000001", @"Message."));
+- (void)testInitializeEmpty {
+  [[self.loggerSystemMock expect] initializeLogger];
+  GULLoggerInitialize();
+  [self.loggerSystemMock verify];
 }
 
-- (void)testLoggerInterface {
-  XCTAssertNoThrow(GULLogError(@"my service", NO, kMessageCode, @"Message."));
-  XCTAssertNoThrow(GULLogError(@"my service", NO, kMessageCode, @"Configure %@.", @"blah"));
-
-  XCTAssertNoThrow(GULLogWarning(@"my service", NO, kMessageCode, @"Message."));
-  XCTAssertNoThrow(GULLogWarning(@"my service", NO, kMessageCode, @"Configure %@.", @"blah"));
-
-  XCTAssertNoThrow(GULLogNotice(@"my service", NO, kMessageCode, @"Message."));
-  XCTAssertNoThrow(GULLogNotice(@"my service", NO, kMessageCode, @"Configure %@.", @"blah"));
+- (void)testInitializeTwice {
+  [[self.loggerSystemMock expect] initializeLogger];
+  GULLoggerInitialize();
+  GULLoggerInitialize();
+  [self.loggerSystemMock verify];
+}
 
-  XCTAssertNoThrow(GULLogInfo(@"my service", NO, kMessageCode, @"Message."));
-  XCTAssertNoThrow(GULLogInfo(@"my service", NO, kMessageCode, @"Configure %@.", @"blah"));
+#pragma mark Forwarded Call Tests
 
-  XCTAssertNoThrow(GULLogDebug(@"my service", NO, kMessageCode, @"Message."));
-  XCTAssertNoThrow(GULLogDebug(@"my service", NO, kMessageCode, @"Configure %@.", @"blah"));
+- (void)testForceDebug {
+  [[self.loggerSystemMock expect] setForcedDebug:YES];
+  GULLoggerForceDebug();
+  [self.loggerSystemMock verify];
 }
 
-// asl_set_filter does not perform as expected in unit test environment with simulator. The
-// following test only checks whether the logs have been sent to system with the default settings in
-// the unit test environment.
-- (void)testSystemLogWithDefaultStatus {
-#if !(BUG128)  // Disable until https://github.com/firebase/firebase-ios-sdk/issues/128 is fixed
-  // Test fails on device and iOS 9 simulators - b/38130372
-  return;
-#else
-  // Sets the time interval that we need to wait in order to fetch all the logs.
-  NSTimeInterval timeInterval = 0.1f;
-  // Generates a random string each time and check whether it has been logged.
-  // Log messages with Notice level and below should be logged to system/device by default.
-  self.randomLogString = [NSUUID UUID].UUIDString;
-  GULLogError(@"my service", NO, kMessageCode, @"%@", self.randomLogString);
-  [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:timeInterval]];
-  XCTAssertTrue([self logExists]);
-
-  self.randomLogString = [NSUUID UUID].UUIDString;
-  GULLogWarning(@"my service", kMessageCode, @"%@", self.randomLogString);
-  [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:timeInterval]];
-  XCTAssertTrue([self logExists]);
-
-  self.randomLogString = [NSUUID UUID].UUIDString;
-  GULLogNotice(@"my service", kMessageCode, @"%@", self.randomLogString);
-  [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:timeInterval]];
-  XCTAssertTrue([self logExists]);
-
-  // Log messages with Info level and above should NOT be logged to system/device by default.
-  self.randomLogString = [NSUUID UUID].UUIDString;
-  GULLogInfo(@"my service", kMessageCode, @"%@", self.randomLogString);
-  [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:timeInterval]];
-  XCTAssertFalse([self logExists]);
-
-  self.randomLogString = [NSUUID UUID].UUIDString;
-  GULLogDebug(@"my service", kMessageCode, @"%@", self.randomLogString);
-  [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:timeInterval]];
-  XCTAssertFalse([self logExists]);
-#endif
+- (void)testEnableSTDERR {
+  [[self.loggerSystemMock expect] printToSTDERR];
+  GULLoggerEnableSTDERR();
+  [self.loggerSystemMock verify];
 }
 
-// The GULLoggerLevel enum must match the ASL_LEVEL_* constants, but we manually redefine
-// them in GULLoggerLevel.h since we cannot include <asl.h> (see b/34976089 for more details).
-// This test ensures the constants match.
-- (void)testGULLoggerLevelValues {
-  XCTAssertEqual(GULLoggerLevelError, ASL_LEVEL_ERR);
-  XCTAssertEqual(GULLoggerLevelWarning, ASL_LEVEL_WARNING);
-  XCTAssertEqual(GULLoggerLevelNotice, ASL_LEVEL_NOTICE);
-  XCTAssertEqual(GULLoggerLevelInfo, ASL_LEVEL_INFO);
-  XCTAssertEqual(GULLoggerLevelDebug, ASL_LEVEL_DEBUG);
+- (void)testSetLoggerLevel {
+  [[self.loggerSystemMock expect] setLogLevel:kLogLevel];
+  GULSetLoggerLevel(kLogLevel);
+  [self.loggerSystemMock verify];
 }
 
-// Helper functions.
-- (BOOL)logExists {
-  NSString *correctMsg =
-      [NSString stringWithFormat:@"%@[%@] %@", @"my service", kMessageCode, self.randomLogString];
-  return [self messageWasLogged:correctMsg];
+- (void)testIsLoggableLevel {
+  [[self.loggerSystemMock expect] isLoggableLevel:kLogLevel];
+  GULIsLoggableLevel(kLogLevel);
+  [self.loggerSystemMock verify];
 }
 
-- (BOOL)messageWasLogged:(NSString *)message {
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-Wdeprecated-declarations"
-  aslmsg query = asl_new(ASL_TYPE_QUERY);
-  asl_set_query(query, ASL_KEY_FACILITY, kGULLoggerASLClientFacilityName, ASL_QUERY_OP_EQUAL);
-  aslresponse r = asl_search(getGULLoggerClient(), query);
-  asl_free(query);
-  aslmsg m;
-  const char *val;
-  NSMutableArray *allMsg = [[NSMutableArray alloc] init];
-  while ((m = asl_next(r)) != NULL) {
-    val = asl_get(m, ASL_KEY_MSG);
-    if (val) {
-      [allMsg addObject:[NSString stringWithUTF8String:val]];
-    }
-  }
-  asl_free(m);
-  asl_release(r);
-  return [allMsg containsObject:message];
-#pragma clang pop
+- (void)testRegisterVersion {
+  [[self.loggerSystemMock expect] setVersion:kVersionString];
+  GULLoggerRegisterVersion(kVersionChar);
+  [self.loggerSystemMock verify];
 }
 
-@end */
-#endif
+// TODO(bstpierre): Test that LogBasic calls are piped through. OCMock does not currently support
+// the mocking of methods with variadic parameters: https://github.com/erikdoe/ocmock/issues/191
+
+@end