firebase-ios-sdk/Crashlytics/UnitTests/FIRCLSReportAdapterTests.m

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#import <Foundation/Foundation.h>
#import <XCTest/XCTest.h>

#import "Crashlytics/Crashlytics/Models/Record/FIRCLSRecordApplication.h"
#import "Crashlytics/Crashlytics/Models/Record/FIRCLSRecordHost.h"
#import "Crashlytics/Crashlytics/Models/Record/FIRCLSRecordIdentity.h"
#import "Crashlytics/Crashlytics/Models/Record/FIRCLSReportAdapter.h"
#import "Crashlytics/Crashlytics/Models/Record/FIRCLSReportAdapter_Private.h"

#import "Crashlytics/Crashlytics/Helpers/FIRCLSFile.h"

#import "Crashlytics/UnitTests/Mocks/FIRMockInstallations.h"

#import <GoogleDataTransport/GoogleDataTransport.h>

@interface FIRCLSReportAdapterTests : XCTestCase
@property(nonatomic, strong) FIRCLSInstallIdentifierModel *installIDModel;
@end

static NSString *const TestFIID = @"TEST_FIID";
static NSString *const TestAuthToken = @"TEST_AUTH_TOKEN";

@implementation FIRCLSReportAdapterTests

- (void)setUp {
  FIRMockInstallations *iid = [[FIRMockInstallations alloc] initWithFID:@"test_token"];
  self.installIDModel = [[FIRCLSInstallIdentifierModel alloc] initWithInstallations:iid];
}

- (FIRCLSReportAdapter *)constructAdapterWithPath:(NSString *)path
                                      googleAppId:(NSString *)googleAppID
                                   installIDModel:(FIRCLSInstallIdentifierModel *)installIDModel {
  return [[FIRCLSReportAdapter alloc] initWithPath:path
                                       googleAppId:googleAppID
                                    installIDModel:installIDModel
                                              fiid:TestFIID
                                         authToken:TestAuthToken];
}

/// Attempt sending a proto report to the reporting endpoint
- (void)testSendProtoReport {
  NSString *minCrash =
      [[FIRCLSReportAdapterTests resourcePath] stringByAppendingPathComponent:@"bare_min_crash"];

  FIRCLSReportAdapter *adapter =
      [self constructAdapterWithPath:minCrash
                         googleAppId:@"1:17586535263:ios:83778f4dc7e8a26ef794ea"
                      installIDModel:self.installIDModel];

  GDTCORTransport *transport = [[GDTCORTransport alloc] initWithMappingID:@"1206"
                                                             transformers:nil
                                                                   target:kGDTCORTargetCSH];
  GDTCOREvent *event = [transport eventForTransport];
  event.dataObject = adapter;
  event.qosTier = GDTCOREventQoSFast;  // Bypass batching and have the event get sent out ASAP
  [transport sendDataEvent:event];
}

/// This test is useful for testing the binary output of the proto message
- (void)testProtoOutput {
  NSString *minCrash =
      [[FIRCLSReportAdapterTests resourcePath] stringByAppendingPathComponent:@"bare_min_crash"];

  FIRCLSReportAdapter *adapter =
      [self constructAdapterWithPath:minCrash
                         googleAppId:@"1:17586535263:ios:83778f4dc7e8a26ef794ea"
                      installIDModel:self.installIDModel];

  NSData *data = adapter.transportBytes;

  NSError *error = nil;
  NSString *outputPath =
      [[FIRCLSReportAdapterTests resourcePath] stringByAppendingPathComponent:@"output.proto"];

  [data writeToFile:outputPath options:NSDataWritingAtomic error:&error];
  NSLog(@"Output path: %@", outputPath);
  if (error) {
    NSLog(@"Write returned error: %@", [error localizedDescription]);
  }

  // Put a breakpoint here to copy the file from the output path.
}

/// It is important that a crash does not occur when reading persisted crash files
/// Verify various invalid input cases.
- (void)testInvalidRecordCases {
  id adapter __unused = [self constructAdapterWithPath:@"nonExistentPath"
                                           googleAppId:@"appID"
                                        installIDModel:self.installIDModel];

  id application __unused = [[FIRCLSRecordApplication alloc] initWithDict:nil];
  id host __unused = [[FIRCLSRecordHost alloc] initWithDict:nil];
  id identity __unused = [[FIRCLSRecordIdentity alloc] initWithDict:nil];

  NSDictionary *emptyDict = [[NSDictionary alloc] init];
  id application2 __unused = [[FIRCLSRecordApplication alloc] initWithDict:emptyDict];
  id host2 __unused = [[FIRCLSRecordHost alloc] initWithDict:emptyDict];
  id identity2 __unused = [[FIRCLSRecordIdentity alloc] initWithDict:emptyDict];
}

- (void)testCorruptMetadataCLSRecordFile {
  id adapter __unused = [self adapterForCorruptMetadata];
}

- (void)testRecordMetadataFile {
  FIRCLSReportAdapter *adapter = [self adapterForValidMetadata];

  // Verify identity
  XCTAssertTrue([adapter.identity.build_version isEqualToString:@"4.0.0-beta.1"]);

  // Verify host
  XCTAssertTrue([adapter.host.platform isEqualToString:@"ios"]);

  // Verify application
  XCTAssertTrue([adapter.application.build_version isEqualToString:@"1"]);
  XCTAssertTrue([adapter.application.display_version isEqualToString:@"1.0"]);
}

- (void)testReportProto {
  FIRCLSReportAdapter *adapter = [self adapterForAllCrashes];
  google_crashlytics_Report report = [adapter protoReport];
  XCTAssertTrue([self isPBData:report.sdk_version equalToString:adapter.identity.build_version]);
  XCTAssertTrue([self isPBData:report.gmp_app_id equalToString:@"appID"]);
  XCTAssertEqual(report.platform, google_crashlytics_Platforms_IOS);
  XCTAssertTrue([self isPBData:report.installation_uuid
                 equalToString:self.installIDModel.installID]);
  XCTAssertTrue([self isPBData:report.firebase_installation_id equalToString:TestFIID]);
  XCTAssertTrue([self isPBData:report.display_version
                 equalToString:adapter.application.display_version]);

  // Files payload
  XCTAssertEqual(report.apple_payload.files_count, 11);

  NSArray<NSString *> *clsRecords = adapter.clsRecordFilePaths;
  for (NSUInteger i = 0; i < clsRecords.count; i++) {
    XCTAssertTrue([self isPBData:report.apple_payload.files[i].filename
                   equalToString:clsRecords[i].lastPathComponent]);
    NSData *data = [NSData dataWithContentsOfFile:clsRecords[i] options:0 error:nil];
    XCTAssertTrue([self isPBData:report.apple_payload.files[i].contents equalToData:data]);
  }
}

// Helper functions
#pragma mark - Helper Functions

- (FIRCLSReportAdapter *)adapterForAllCrashes {
  return [self constructAdapterWithPath:[[FIRCLSReportAdapterTests resourcePath]
                                            stringByAppendingPathComponent:@"ios_all_files_crash"]
                            googleAppId:@"appID"
                         installIDModel:self.installIDModel];
}

- (FIRCLSReportAdapter *)adapterForCorruptMetadata {
  return [self constructAdapterWithPath:[[FIRCLSReportAdapterTests resourcePath]
                                            stringByAppendingPathComponent:@"corrupt_metadata"]
                            googleAppId:@"appID"
                         installIDModel:self.installIDModel];
}

- (FIRCLSReportAdapter *)adapterForValidMetadata {
  return [self constructAdapterWithPath:[[FIRCLSReportAdapterTests resourcePath]
                                            stringByAppendingPathComponent:@"valid_metadata"]
                            googleAppId:@"appID"
                         installIDModel:self.installIDModel];
}

+ (NSString *)resourcePath {
#if SWIFT_PACKAGE
  NSBundle *bundle = SWIFTPM_MODULE_BUNDLE;
  return [bundle.resourcePath stringByAppendingPathComponent:@"Data"];
#else
  NSBundle *bundle = [NSBundle bundleForClass:[self class]];
  return bundle.resourcePath;
#endif
}

#pragma mark - Assertion Helpers for NanoPB Types

- (BOOL)isPBData:(pb_bytes_array_t *)pbString equalToString:(NSString *)str {
  pb_bytes_array_t *expected = FIRCLSEncodeString(str);
  return [self isPBArray:pbString equalToArray:expected];
}

- (BOOL)isPBData:(pb_bytes_array_t *)pbString equalToData:(NSData *)data {
  pb_bytes_array_t *expected = FIRCLSEncodeData(data);
  return [self isPBArray:pbString equalToArray:expected];
}

- (BOOL)isPBArray:(pb_bytes_array_t *)array equalToArray:(pb_bytes_array_t *)expected {
  // Treat the empty string as the same as a missing field
  if ((!array) && expected->size == 0) {
    return true;
  }

  if (array->size != expected->size) {
    return false;
  }

  for (int i = 0; i < array->size; i++) {
    if (expected->bytes[i] != array->bytes[i]) {
      return false;
    }
  }

  return true;
}

@end