FIRLoggerTest.m 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. // Copyright 2017 Google
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #ifdef DEBUG
  15. // The tests depend upon library methods only built with #ifdef DEBUG
  16. #import "FirebaseCore/Tests/Unit/FIRTestCase.h"
  17. // TODO - FIRLoggerTest should be split into a separate FIRLoggerTest and GULLoggerTest.
  18. // No test should include both includes.
  19. #import <GoogleUtilities/GULLogger.h>
  20. #import "FirebaseCore/Sources/Private/FIRLogger.h"
  21. #import <asl.h>
  22. // The following constants are exposed from FIRLogger for unit tests.
  23. extern NSString *const kFIRDisableDebugModeApplicationArgument;
  24. extern NSString *const kFIREnableDebugModeApplicationArgument;
  25. /// Key for the debug mode bit in NSUserDefaults.
  26. extern NSString *const kFIRPersistedDebugModeKey;
  27. extern const char *kGULLoggerASLClientFacilityName;
  28. extern void FIRResetLogger(void);
  29. extern void FIRSetLoggerUserDefaults(NSUserDefaults *defaults);
  30. extern aslclient getGULLoggerClient(void);
  31. extern dispatch_queue_t getGULClientQueue(void);
  32. extern BOOL getGULLoggerDebugMode(void);
  33. static NSString *const kMessageCode = @"I-COR000001";
  34. @interface FIRLoggerTest : FIRTestCase
  35. @property(nonatomic) NSString *randomLogString;
  36. @property(nonatomic, strong) NSUserDefaults *defaults;
  37. @end
  38. @implementation FIRLoggerTest
  39. - (void)setUp {
  40. [super setUp];
  41. FIRResetLogger();
  42. // Stub NSUserDefaults for cleaner testing.
  43. _defaults = [[NSUserDefaults alloc] initWithSuiteName:@"com.firebase.logger_test"];
  44. FIRSetLoggerUserDefaults(_defaults);
  45. }
  46. - (void)tearDown {
  47. [super tearDown];
  48. _defaults = nil;
  49. }
  50. // Test some stable variables to make sure they weren't accidently changed.
  51. - (void)testStableVariables {
  52. // Strings of type FIRLoggerServices.
  53. XCTAssertEqualObjects(kFIRLoggerAnalytics, @"[Firebase/Analytics]");
  54. XCTAssertEqualObjects(kFIRLoggerCore, @"[Firebase/Core]");
  55. }
  56. - (void)testInitializeASLForNonDebugMode {
  57. // Stub.
  58. id processInfoMock = [OCMockObject partialMockForObject:[NSProcessInfo processInfo]];
  59. NSArray *arguments = @[ kFIRDisableDebugModeApplicationArgument ];
  60. [[[processInfoMock stub] andReturn:arguments] arguments];
  61. // Test.
  62. FIRLogError(kFIRLoggerCore, kMessageCode, @"Some error.");
  63. // Assert.
  64. #if MAKE_THREAD_SAFE
  65. NSNumber *debugMode = [self.defaults objectForKey:kFIRPersistedDebugModeKey];
  66. XCTAssertNil(debugMode);
  67. XCTAssertFalse(getGULLoggerDebugMode());
  68. #endif
  69. // Stop.
  70. [processInfoMock stopMocking];
  71. }
  72. - (void)testInitializeASLForDebugModeWithArgument {
  73. // Stub.
  74. id processInfoMock = [OCMockObject partialMockForObject:[NSProcessInfo processInfo]];
  75. NSArray *arguments = @[ kFIREnableDebugModeApplicationArgument ];
  76. [[[processInfoMock stub] andReturn:arguments] arguments];
  77. // Test.
  78. FIRLogError(kFIRLoggerCore, kMessageCode, @"Some error.");
  79. #ifdef MAKE_THREAD_SAFE
  80. // Assert.
  81. NSNumber *debugMode = [self.defaults objectForKey:kGULPersistedDebugModeKey];
  82. XCTAssertTrue(debugMode.boolValue);
  83. XCTAssertTrue(getGULLoggerDebugMode());
  84. #endif
  85. // Stop.
  86. [processInfoMock stopMocking];
  87. }
  88. - (void)testInitializeASLForDebugModeWithUserDefaults {
  89. // Stub.
  90. NSNumber *debugMode = @YES;
  91. [self.defaults setBool:debugMode.boolValue forKey:kFIRPersistedDebugModeKey];
  92. // Test.
  93. GULLogError(@"my service", NO, kMessageCode, @"Some error.");
  94. // Assert.
  95. debugMode = [self.defaults objectForKey:kFIRPersistedDebugModeKey];
  96. XCTAssertTrue(debugMode.boolValue);
  97. }
  98. - (void)testMessageCodeFormat {
  99. // Valid case.
  100. XCTAssertNoThrow(FIRLogError(kFIRLoggerCore, @"I-APP000001", @"Message."));
  101. // An extra dash or missing dash should fail.
  102. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"I-APP-000001", @"Message."));
  103. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"IAPP000001", @"Message."));
  104. // Wrong number of digits should fail.
  105. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"I-APP00001", @"Message."));
  106. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"I-APP0000001", @"Message."));
  107. // Lowercase should fail.
  108. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"I-app000001", @"Message."));
  109. // nil or empty message code should fail.
  110. #pragma clang diagnostic push
  111. #pragma clang diagnostic ignored "-Wnonnull"
  112. XCTAssertThrows(FIRLogError(kFIRLoggerCore, nil, @"Message."));
  113. #pragma clang diagnostic pop
  114. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"", @"Message."));
  115. // Android message code should fail.
  116. XCTAssertThrows(FIRLogError(kFIRLoggerCore, @"A-APP000001", @"Message."));
  117. }
  118. - (void)testLoggerInterface {
  119. XCTAssertNoThrow(FIRLogError(kFIRLoggerCore, kMessageCode, @"Message."));
  120. XCTAssertNoThrow(FIRLogError(kFIRLoggerCore, kMessageCode, @"Configure %@.", @"blah"));
  121. XCTAssertNoThrow(FIRLogWarning(kFIRLoggerCore, kMessageCode, @"Message."));
  122. XCTAssertNoThrow(FIRLogWarning(kFIRLoggerCore, kMessageCode, @"Configure %@.", @"blah"));
  123. XCTAssertNoThrow(FIRLogNotice(kFIRLoggerCore, kMessageCode, @"Message."));
  124. XCTAssertNoThrow(FIRLogNotice(kFIRLoggerCore, kMessageCode, @"Configure %@.", @"blah"));
  125. XCTAssertNoThrow(FIRLogInfo(kFIRLoggerCore, kMessageCode, @"Message."));
  126. XCTAssertNoThrow(FIRLogInfo(kFIRLoggerCore, kMessageCode, @"Configure %@.", @"blah"));
  127. XCTAssertNoThrow(FIRLogDebug(kFIRLoggerCore, kMessageCode, @"Message."));
  128. XCTAssertNoThrow(FIRLogDebug(kFIRLoggerCore, kMessageCode, @"Configure %@.", @"blah"));
  129. }
  130. // The FIRLoggerLevel enum must match the ASL_LEVEL_* constants, but we manually redefine
  131. // them in FIRLoggerLevel.h since we cannot include <asl.h> (see b/34976089 for more details).
  132. // This test ensures the constants match.
  133. - (void)testFIRLoggerLevelValues {
  134. XCTAssertEqual(FIRLoggerLevelError, ASL_LEVEL_ERR);
  135. XCTAssertEqual(FIRLoggerLevelWarning, ASL_LEVEL_WARNING);
  136. XCTAssertEqual(FIRLoggerLevelNotice, ASL_LEVEL_NOTICE);
  137. XCTAssertEqual(FIRLoggerLevelInfo, ASL_LEVEL_INFO);
  138. XCTAssertEqual(FIRLoggerLevelDebug, ASL_LEVEL_DEBUG);
  139. }
  140. @end
  141. #endif