keychain/ckks/tests/CKKSLoggerTests.m

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #if OCTAGON
  25
  26 #import "CKKSTests.h"
  27 #import "keychain/ckks/CKKSAnalytics.h"
  28 #import <Security/SFSQLite.h>
  29 #import <Foundation/Foundation.h>
  30 #import <CloudKit/CloudKit.h>
  31 #import <CloudKit/CloudKit_Private.h>
  32 #import <XCTest/XCTest.h>
  33 #import <OCMock/OCMock.h>
  34
  35 static NSString* tablePath = nil;
  36
  37 @interface SQLiteTests : XCTestCase
  38 @end
  39
  40 @implementation SQLiteTests
  41
  42 + (void)setUp
  43 {
  44     [super setUp];
  45
  46     tablePath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"test_table.db"];
  47 }
  48
  49 - (void)setUp
  50 {
  51     [super setUp];
  52
  53     [[NSFileManager defaultManager] removeItemAtPath:tablePath error:nil];
  54 }
  55
  56 - (void)tearDown
  57 {
  58     [[NSFileManager defaultManager] removeItemAtPath:tablePath error:nil];
  59
  60     [super tearDown];
  61 }
  62
  63 - (void)testCreateLoggingDatabase
  64 {
  65     NSString* schema = @"CREATE table test (test_column INTEGER);";
  66     SFSQLite* sqlTable = [[SFSQLite alloc] initWithPath:tablePath schema:schema];
  67     NSError* error = nil;
  68     XCTAssertTrue([sqlTable openWithError:&error], @"failed to open sql database");
  69     XCTAssertNil(error, "encountered error opening database: %@", error);
  70     XCTAssertTrue([[NSFileManager defaultManager] fileExistsAtPath:tablePath]);
  71     [sqlTable close];
  72 }
  73
  74 - (void)testInsertAndDelete
  75 {
  76     NSString* schema = @"CREATE table test (test_column INTEGER);";
  77     SFSQLite* sqlTable = [[SFSQLite alloc] initWithPath:tablePath schema:schema];
  78     NSError* error = nil;
  79     XCTAssertTrue([sqlTable openWithError:&error], @"failed to open sql database");
  80     XCTAssertNil(error, "encountered error opening database: %@", error);
  81
  82     [sqlTable insertOrReplaceInto:@"test" values:@{@"test_column" : @(1)}];
  83     [sqlTable insertOrReplaceInto:@"test" values:@{@"test_column" : @(2)}];
  84     [sqlTable insertOrReplaceInto:@"test" values:@{@"test_column" : @(3)}];
  85     XCTAssertTrue([[sqlTable selectAllFrom:@"test" where:nil bindings:nil] count] == 3);
  86
  87     [sqlTable deleteFrom:@"test" where:@"test_column = ?" bindings:@[@3]];
  88     XCTAssertTrue([[sqlTable selectAllFrom:@"test" where:nil bindings:nil] count] == 2);
  89
  90     [sqlTable executeSQL:@"delete from test"];
  91     XCTAssertTrue([[sqlTable selectAllFrom:@"test" where:nil bindings:nil] count] == 0);
  92 }
  93
  94 - (void)testDontCrashWhenThereAreNoWritePermissions
  95 {
  96     NSString* schema = @"CREATE table test (test_column INTEGER);";
  97     SFSQLite* sqlTable = [[SFSQLite alloc] initWithPath:tablePath schema:schema];
  98
  99     NSError* error = nil;
 100     XCTAssertNoThrow([sqlTable openWithError:&error], @"opening database threw an exception");
 101     XCTAssertNil(error, "encountered error opening database: %@", error);
 102     XCTAssertNoThrow([sqlTable close], @"closing database threw an exception");
 103
 104     NSDictionary* originalAttributes = [[NSFileManager defaultManager] attributesOfItemAtPath:tablePath error:&error];
 105     XCTAssertNil(error, @"encountered error getting database file attributes: %@", error);
 106
 107     [[NSFileManager defaultManager] setAttributes:@{NSFilePosixPermissions : @(400), NSFileImmutable : @(YES)} ofItemAtPath:tablePath error:&error];
 108     XCTAssertNil(error, @"encountered error setting database file attributes: %@", error);
 109     XCTAssertNoThrow([sqlTable openWithError:&error]);
 110     XCTAssertNil(error, @"encounterd error when opening file without permissions: %@", error);
 111
 112     XCTAssertFalse([sqlTable executeSQL:@"insert or replace into test (test_column) VALUES (1)"],
 113                    @"writing to read-only database succeeded");
 114
 115     [[NSFileManager defaultManager] setAttributes:originalAttributes ofItemAtPath:tablePath error:&error];
 116     XCTAssertNil(error, @"encountered error setting database file attributes back to original attributes: %@", error);
 117 }
 118
 119 - (void)testDontCrashFromInternalErrors
 120 {
 121     NSString* schema = @"CREATE table test (test_column INTEGER);";
 122     SFSQLite* sqlTable = [[SFSQLite alloc] initWithPath:tablePath schema:schema];
 123
 124     NSError* error = nil;
 125     XCTAssertTrue([sqlTable openWithError:&error], @"failed to open database");
 126     XCTAssertNil(error, "encountered error opening database: %@", error);
 127
 128     // delete the table to create havoc
 129     XCTAssertTrue([sqlTable executeSQL:@"drop table test;"], @"deleting test table should have worked");
 130
 131     XCTAssertNoThrow([sqlTable insertOrReplaceInto:@"test" values:@{@"test_column" : @(1)}], @"inserting into deleted table threw an exception");
 132 }
 133
 134 @end
 135
 136 @interface CKKSAnalyticsTests : CloudKitKeychainSyncingTestsBase
 137 @property id mockCKKSAnalytics;
 138 @end
 139
 140 @implementation CKKSAnalyticsTests
 141
 142 - (void)setUp
 143 {
 144     self.mockCKKSAnalytics = OCMClassMock([CKKSAnalytics class]);
 145     OCMStub([self.mockCKKSAnalytics databasePath]).andCall(self, @selector(databasePath));
 146     [super setUp];
 147 }
 148
 149 - (void)tearDown
 150 {
 151     [self.mockCKKSAnalytics stopMocking];
 152     self.mockCKKSAnalytics = nil;
 153     [super tearDown];
 154 }
 155
 156 - (NSString*)databasePath
 157 {
 158     return [NSTemporaryDirectory() stringByAppendingPathComponent:@"test_ckks_analytics_v2.db"];
 159 }
 160
 161 static void _XCTAssertTimeDiffWithInterval(CKKSAnalyticsTests* self, const char* filename, int line, NSDate* a, NSDate* b, int delta, NSString * _Nullable format, ...) NS_FORMAT_FUNCTION(7,8);
 162
 163 /*
 164  * Check if [a,b] are within expected time difference.
 165  * The actual acceptable range is (-1.0, d.0] -- to deal with rounding errors when stored in SQLite.
 166  */
 167
 168 #define XCTAssertTimeDiffWithInterval(a, b, delta, ...)          \
 169   _XCTAssertTimeDiffWithInterval(self, __FILE__, __LINE__, a, b, delta, @"" __VA_ARGS__)
 170
 171 static void _XCTAssertTimeDiffWithInterval(CKKSAnalyticsTests* self, const char* filename, int line, NSDate* a, NSDate* b, int delta, NSString * _Nullable format, ...) {
 172     NSTimeInterval interval = [b timeIntervalSinceDate:a];
 173     if (interval <= -1.0 || interval > delta) {
 174         NSString *comparison = [[NSString alloc] initWithFormat:@"time diff not expected (a=%@(%f), b=%@(%f), delta = %f) -- valid range (-1.0, %d.0]: ", a, [a timeIntervalSince1970], b, [b timeIntervalSince1970], interval, delta];
 175         NSString *arg = [[NSString alloc] init];
 176         if (format) {
 177             va_list args;
 178             va_start(args, format);
 179             va_end(args);
 180             arg = [[NSString alloc] initWithFormat: format arguments: args];
 181         }
 182         [self recordFailureWithDescription: [comparison stringByAppendingString: arg] inFile: [NSString stringWithUTF8String: filename] atLine: line expected: YES];
 183     }
 184 }
 185
 186 - (void)testLastSuccessfulXDate
 187 {
 188     [self createAndSaveFakeKeyHierarchy: self.keychainZoneID]; // Make life easy for this test.
 189     [self startCKKSSubsystem];
 190     CKRecord* ckr = [self createFakeRecord: self.keychainZoneID recordName:@"7B598D31-F9C5-481E-98AC-5A507ACB2D85"];
 191     [self.keychainZone addToZone: ckr];
 192
 193     // Trigger a notification (with hilariously fake data)
 194     [self.keychainView notifyZoneChange:nil];
 195
 196     [[[self.keychainView waitForFetchAndIncomingQueueProcessing] completionHandlerDidRunCondition] wait:4 * NSEC_PER_SEC];
 197
 198     NSDate* nowDate = [NSDate date];
 199
 200     /*
 201      * Check last sync date for class A
 202      */
 203     NSDate* syncADate = [[CKKSAnalytics logger] dateOfLastSuccessForEvent:CKKSEventProcessIncomingQueueClassA inView:self.keychainView];
 204     XCTAssertNotNil(syncADate, "Failed to get a last successful A sync date");
 205     XCTAssertTimeDiffWithInterval(syncADate, nowDate, 15, "Last sync A date should be recent");
 206
 207     /*
 208      * Check last sync date for class C
 209      */
 210     NSDate *syncCDate = [[CKKSAnalytics logger] dateOfLastSuccessForEvent:CKKSEventProcessIncomingQueueClassC inView:self.keychainView];
 211     XCTAssertNotNil(syncCDate, "Failed to get a last successful C sync date");
 212     XCTAssertTimeDiffWithInterval(syncCDate, nowDate, 15, "Last sync C date should be recent");
 213
 214     /*
 215      * Check last unlock date
 216      */
 217     NSDate* unlockDate = [[CKKSAnalytics logger] datePropertyForKey:CKKSAnalyticsLastUnlock];
 218     XCTAssertNotNil(unlockDate, "Failed to get a last unlock date");
 219     XCTAssertTimeDiffWithInterval(unlockDate, nowDate, 15, "Last unlock date should be recent");
 220
 221     sleep(2); // wait to be a different second (+/- 1s)
 222
 223     self.aksLockState = true;
 224     [self.lockStateTracker recheck];
 225
 226     NSDate* newUnlockDate = [[CKKSAnalytics logger] datePropertyForKey:CKKSAnalyticsLastUnlock];
 227     XCTAssertNotNil(newUnlockDate, "Failed to get a last unlock date");
 228
 229     XCTAssertTimeDiffWithInterval(newUnlockDate, unlockDate, 1, "unlock dates not the same (within one second)");
 230
 231     sleep(1); // wait to be a differnt second
 232
 233     self.aksLockState = false;
 234     [self.lockStateTracker recheck];
 235
 236     sleep(1); // wait for the completion block to have time to fire
 237
 238     newUnlockDate = [[CKKSAnalytics logger] datePropertyForKey:CKKSAnalyticsLastUnlock];
 239     XCTAssertNotNil(newUnlockDate, "Failed to get a last unlock date");
 240     XCTAssertNotEqualObjects(newUnlockDate, unlockDate, "unlock date the same");
 241 }
 242
 243 - (void)testRaceToCreateLoggers
 244 {
 245     dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
 246     for (NSInteger i = 0; i < 5; i++) {
 247         dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
 248             CKKSAnalytics* logger = [CKKSAnalytics logger];
 249             [logger logSuccessForEvent:(CKKSAnalyticsFailableEvent*)@"test_event" inView:self.keychainView];
 250             dispatch_semaphore_signal(semaphore);
 251         });
 252     }
 253
 254     for (NSInteger i = 0; i < 5; i++) {
 255         dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
 256     }
 257 }
 258
 259 - (void)testUnderlayingError
 260 {
 261     NSDictionary *errorString = nil;
 262     NSError *error = nil;
 263
 264     error = [NSError errorWithDomain:CKErrorDomain code:CKErrorPartialFailure userInfo:@{
 265         CKPartialErrorsByItemIDKey : @{
 266                 @"recordid" : [NSError errorWithDomain:CKErrorDomain code:1 userInfo:nil],
 267         }
 268     }];
 269
 270     errorString = [[CKKSAnalytics logger] errorChain:error depth:0];
 271
 272     XCTAssertEqualObjects(errorString[@"domain"], CKErrorDomain, "error domain");
 273     XCTAssertEqual([errorString[@"code"] intValue], CKErrorPartialFailure, "error code");
 274
 275     XCTAssertEqualObjects(errorString[@"oneCloudKitPartialFailure"][@"domain"], CKErrorDomain, "error domain");
 276     XCTAssertEqual([errorString[@"oneCloudKitPartialFailure"][@"code"] intValue], 1, "error code");
 277
 278     /* interal partial error leaks out of CK */
 279
 280     error = [NSError errorWithDomain:CKErrorDomain code:CKErrorPartialFailure userInfo:@{
 281         CKPartialErrorsByItemIDKey : @{
 282                 @"recordid1" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 283                 @"recordid2" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 284                 @"recordid3" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 285                 @"recordid4" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 286                 @"recordid5" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 287                 @"recordid6" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 288                 @"recordid7" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 289                 @"recordid8" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 290                 @"recordid9" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 291                 @"recordid0" : [NSError errorWithDomain:CKErrorDomain code:1 userInfo:nil],
 292                 @"recordid10" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 293                 @"recordid12" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 294                 @"recordid13" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 295                 @"recordid14" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 296                 @"recordid15" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 297                 @"recordid16" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 298                 @"recordid17" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 299                 @"recordid18" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 300                 @"recordid19" : [NSError errorWithDomain:CKErrorDomain code:CKErrorBatchRequestFailed userInfo:nil],
 301         }
 302     }];
 303
 304     errorString = [[CKKSAnalytics logger] errorChain:error depth:0];
 305
 306     XCTAssertEqualObjects(errorString[@"domain"], CKErrorDomain, "error domain");
 307     XCTAssertEqual([errorString[@"code"] intValue], CKErrorPartialFailure, "error code");
 308
 309     XCTAssertEqualObjects(errorString[@"oneCloudKitPartialFailure"][@"domain"], CKErrorDomain, "error domain");
 310     XCTAssertEqualObjects(errorString[@"oneCloudKitPartialFailure"][@"code"], @1, "error code");
 311
 312
 313
 314
 315     error = [NSError errorWithDomain:@"domain" code:1 userInfo:@{
 316         NSUnderlyingErrorKey : [NSError errorWithDomain:CKErrorDomain code:1 userInfo:nil],
 317     }];
 318
 319     errorString = [[CKKSAnalytics logger] errorChain:error depth:0];
 320
 321     XCTAssertEqualObjects(errorString[@"domain"], @"domain", "error domain");
 322     XCTAssertEqual([errorString[@"code"] intValue], 1, "error code");
 323
 324     XCTAssertEqualObjects(errorString[@"child"][@"domain"], CKErrorDomain, "error domain");
 325     XCTAssertEqual([errorString[@"child"][@"code"] intValue], 1, "error code");
 326 }
 327
 328
 329 @end
 330
 331 #endif