crashpad/client/crashpad_client_ios_test.mm
Ben Hamilton ca3cf2f4e3 [ios] Add an optional upload complete observation callback to the in-process handler
Breakpad offers a callback when uploads complete:
    https://source.chromium.org/chromium/chromium/src/+/main:third_party/breakpad/breakpad/src/client/ios/BreakpadController.h;l=103;drc=1fc9cc0d0e1dfafb8d29dba8d01f09587d870026

This adds an equivalent observation callback to Crashpad on iOS which is invoked each time an upload attempt completes (whether it succeeds or fails).

I couldn't find any existing unit tests for the upload thread, but
I tested this manually by integrating it into a client. Please
let me know the best way to test this.

Change-Id: I17822af5e63c8634484606a6470ce83b2c385676
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/3852399
Reviewed-by: Justin Cohen <justincohen@chromium.org>
Commit-Queue: Justin Cohen <justincohen@chromium.org>
Reviewed-by: Robert Sesek <rsesek@chromium.org>
2022-09-12 23:08:02 +00:00

158 lines
4.9 KiB
Plaintext

// Copyright 2020 The Crashpad Authors
//
// 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.
#include "client/crashpad_client.h"
#import <Foundation/Foundation.h>
#include <vector>
#include "base/strings/sys_string_conversions.h"
#include "client/crash_report_database.h"
#include "client/ios_handler/exception_processor.h"
#include "client/simulate_crash.h"
#include "gtest/gtest.h"
#include "test/scoped_temp_dir.h"
#include "testing/platform_test.h"
#include "util/thread/thread.h"
namespace crashpad {
namespace test {
namespace {
class CrashpadIOSClient : public PlatformTest {
protected:
// testing::Test:
void SetUp() override {
ASSERT_TRUE(client_.StartCrashpadInProcessHandler(
base::FilePath(database_dir.path()),
"",
{},
CrashpadClient::ProcessPendingReportsObservationCallback()));
database_ = CrashReportDatabase::Initialize(database_dir.path());
}
void TearDown() override { client_.ResetForTesting(); }
auto& Client() { return client_; }
auto& Database() { return database_; }
private:
std::unique_ptr<CrashReportDatabase> database_;
CrashpadClient client_;
ScopedTempDir database_dir;
};
TEST_F(CrashpadIOSClient, DumpWithoutCrash) {
std::vector<CrashReportDatabase::Report> reports;
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 0u);
CRASHPAD_SIMULATE_CRASH();
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 1u);
}
TEST_F(CrashpadIOSClient, DumpWithoutCrashAndDefer) {
std::vector<CrashReportDatabase::Report> reports;
CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING();
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 0u);
Client().ProcessIntermediateDumps();
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 1u);
}
TEST_F(CrashpadIOSClient, DumpWithoutCrashAndDeferAtPath) {
std::vector<CrashReportDatabase::Report> reports;
ScopedTempDir crash_dir;
UUID uuid;
uuid.InitializeWithNew();
CRASHPAD_SIMULATE_CRASH_AND_DEFER_PROCESSING_AT_PATH(
crash_dir.path().Append(uuid.ToString()));
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 0u);
NSError* error = nil;
NSArray* paths = [[NSFileManager defaultManager]
contentsOfDirectoryAtPath:base::SysUTF8ToNSString(
crash_dir.path().value())
error:&error];
ASSERT_EQ([paths count], 1u);
Client().ProcessIntermediateDump(
crash_dir.path().Append([paths[0] fileSystemRepresentation]));
reports.clear();
EXPECT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
ASSERT_EQ(reports.size(), 1u);
}
class RaceThread : public Thread {
public:
explicit RaceThread() : Thread() {}
private:
void ThreadMain() override {
for (int i = 0; i < 10; ++i) {
CRASHPAD_SIMULATE_CRASH();
}
}
};
TEST_F(CrashpadIOSClient, MultipleThreadsSimulateCrash) {
RaceThread race_threads[2];
for (RaceThread& race_thread : race_threads) {
race_thread.Start();
}
for (int i = 0; i < 10; ++i) {
CRASHPAD_SIMULATE_CRASH();
}
for (RaceThread& race_thread : race_threads) {
race_thread.Join();
}
std::vector<CrashReportDatabase::Report> reports;
ASSERT_EQ(Database()->GetPendingReports(&reports),
CrashReportDatabase::kNoError);
EXPECT_EQ(reports.size(), 30u);
}
// This test is covered by a similar XCUITest, but for development purposes it's
// sometimes easier and faster to run in Google Test. However, there's no way
// to correctly run this in Google Test. Leave the test here, disabled, for use
// during development only.
TEST_F(CrashpadIOSClient, DISABLED_ThrowNSException) {
[NSException raise:@"GoogleTestNSException" format:@"ThrowException"];
}
// This test is covered by a similar XCUITest, but for development purposes it's
// sometimes easier and faster to run in Google Test. However, there's no way
// to correctly run this in Google Test. Leave the test here, disabled, for use
// during development only.
TEST_F(CrashpadIOSClient, DISABLED_ThrowException) {
std::vector<int> empty_vector;
empty_vector.at(42);
}
} // namespace
} // namespace test
} // namespace crashpad