Add integration tests

.github/workflows/integration-tests.yml

@@ -0,0 +1,56 @@
+name: Run Integration Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - 'Samples/Tests/**'
+      - 'Samples/Common/Sources/IntegrationTestsHelper/**'
+      - '.github/workflows/integration-tests.yml'
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '0 0 1 * *'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  integration-tests:
+    runs-on: macos-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: iOS
+          - platform: macOS
+          - platform: tvOS
+          - platform: watchOS
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Use Latest Stable Xcode
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: latest-stable
+
+      - name: Install Tuist
+        run: |
+          brew tap tuist/tuist
+          brew install tuist@4.18.0
+
+      - name: Generate Project
+        working-directory: ./Samples
+        run: tuist generate --verbose --no-open
+
+      - name: Run Build
+        uses: mxcl/xcodebuild@v3.0.0
+        with:
+          action: test
+          workspace: "Samples/KSCrashSamples.xcworkspace"
+          scheme: "Sample"
+          platform: ${{ matrix.platform }}

Samples/Common/Package.swift

@@ -19,6 +19,10 @@ let package = Package(
       name: "CrashTriggers",
       targets: ["CrashTriggers"]
     ),
+    .library(
+        name: "IntegrationTestsHelper",
+        targets: ["IntegrationTestsHelper"]
+    ),
     .library(
       name: "SampleUI",
       targets: ["SampleUI"]
@@ -40,11 +44,21 @@ let package = Package(
     .target(
       name: "CrashTriggers"
     ),
+    .target(
+        name: "IntegrationTestsHelper",
+        dependencies: [
+            .target(name: "CrashTriggers"),
+            .product(name: "Recording", package: "KSCrash"),
+            .product(name: "Reporting", package: "KSCrash"),
+            .product(name: "Logging", package: "swift-log"),
+        ]
+    ),
     .target(
       name: "SampleUI",
       dependencies: [
         .target(name: "LibraryBridge"),
         .target(name: "CrashTriggers"),
+        .target(name: "IntegrationTestsHelper"),
         .product(name: "Logging", package: "swift-log"),
       ]
     )

Samples/Common/Sources/CrashTriggers/KSCrashTriggersHelper.m

@@ -0,0 +1,86 @@
+//
+//  KSCrashTriggersHelper.mm
+//
+//  Created by Nikolay Volosatov on 2024-08-10.
+//
+//  Copyright (c) 2012 Karl Stenerud. All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall remain in place
+// in this source code.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#import "KSCrashTriggersHelper.h"
+#import "KSCrashTriggersList.h"
+
+@implementation KSCrashTriggersHelper
+
++ (NSArray<NSString *> *)groupIds
+{
+    return @[
+#define __PROCESS_GROUP(GROUP, NAME) @ #GROUP,
+        __ALL_GROUPS
+#undef __PROCESS_GROUP
+    ];
+}
+
++ (NSString *)nameForGroup:(NSString *)groupId
+{
+#define __PROCESS_GROUP(GROUP, NAME)          \
+    if ([groupId isEqualToString:@ #GROUP]) { \
+        return NAME;                          \
+    }
+    __ALL_GROUPS
+#undef __PROCESS_GROUP
+    return @"Unknown";
+}
+
++ (NSArray<KSCrashTriggerId> *)triggersForGroup:(NSString *)groupId
+{
+    NSMutableArray<KSCrashTriggerId> *result = [NSMutableArray array];
+#define __PROCESS_TRIGGER(GROUP, ID, NAME)        \
+    if ([groupId isEqualToString:@ #GROUP]) {     \
+        [result addObject:TRIGGER_ID(GROUP, ID)]; \
+    }
+    __ALL_TRIGGERS
+#undef __PROCESS_TRIGGER
+    return result;
+}
+
++ (NSString *)nameForTrigger:(KSCrashTriggerId)triggerId
+{
+#define __PROCESS_TRIGGER(GROUP, ID, NAME)                   \
+    if ([triggerId isEqualToString:TRIGGER_ID(GROUP, ID)]) { \
+        return NAME;                                         \
+    }
+    __ALL_TRIGGERS
+#undef __PROCESS_TRIGGER
+    return @"Unknown";
+}
+
++ (void)runTrigger:(KSCrashTriggerId)triggerId
+{
+#define __PROCESS_TRIGGER(GROUP, ID, NAME)                   \
+    if ([triggerId isEqualToString:TRIGGER_ID(GROUP, ID)]) { \
+        [KSCrashTriggersList trigger_##GROUP##_##ID];        \
+        return;                                              \
+    }
+    __ALL_TRIGGERS
+#undef __PROCESS_TRIGGER
+}
+
+@end

Samples/Common/Sources/CrashTriggers/KSCrashTriggersList.mm

@@ -0,0 +1,82 @@
+//
+//  KSCrashTriggersList.mm
+//
+//  Created by Nikolay Volosatov on 2024-06-23.
+//
+//  Copyright (c) 2012 Karl Stenerud. All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall remain in place
+// in this source code.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#import "KSCrashTriggersList.h"
+
+#import <mach/mach.h>
+#import <signal.h>
+#import <stdexcept>
+
+@implementation KSCrashTriggersList
+
++ (void)trigger_nsException_genericNSException
+{
+    NSException *exc = [NSException exceptionWithName:NSGenericException reason:@"Test" userInfo:@{ @"a" : @"b" }];
+    [exc raise];
+}
+
++ (void)trigger_nsException_nsArrayOutOfBounds
+{
+    NSArray *array = @[ @1, @2, @3 ];
+    [array objectAtIndex:10];  // This will throw an NSRangeException
+}
+
++ (void)trigger_cpp_runtimeException
+{
+    throw std::runtime_error("C++ exception");
+}
+
++ (void)trigger_mach_badAccess
+{
+    volatile int *ptr = (int *)0x42;
+    *ptr = 42;  // This will cause an EXC_BAD_ACCESS (SIGSEGV)
+}
+
++ (void)trigger_mach_busError
+{
+    char *ptr = (char *)malloc(sizeof(int));
+    int *intPtr = (int *)(ptr + 1);  // Misaligned pointer
+    *intPtr = 42;                    // This will cause an EXC_BAD_ACCESS (SIGBUS)
+    free(ptr);
+}
+
++ (void)trigger_mach_illegalInstruction
+{
+    void (*funcPtr)() = (void (*)())0xDEADBEEF;
+    funcPtr();  // This will cause an EXC_BAD_INSTRUCTION
+}
+
++ (void)trigger_signal_abort
+{
+    abort();  // This will raise a SIGABRT signal
+}
+
++ (void)trigger_other_stackOverflow
+{
+    [self trigger_other_stackOverflow];
+}
+
+@end

Samples/Common/Sources/CrashTriggers/include/KSCrashTriggersHelper.h

@@ -0,0 +1,51 @@
+//
+//  KSCrashTriggersHelper.h
+//
+//  Created by Nikolay Volosatov on 2024-08-10.
+//
+//  Copyright (c) 2012 Karl Stenerud. All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall remain in place
+// in this source code.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#import "KSCrashTriggersList.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef NSString *KSCrashTriggerId NS_TYPED_ENUM NS_SWIFT_NAME(CrashTriggerId);
+#define TRIGGER_ID(GROUP, ID) KSCrashTriggerId_##GROUP##_##ID
+#define __PROCESS_TRIGGER(GROUP, ID, NAME) \
+    static KSCrashTriggerId const TRIGGER_ID(GROUP, ID) NS_SWIFT_NAME(GROUP##_##ID) = @"trigger-" #GROUP "-" #ID;
+__ALL_TRIGGERS
+#undef __PROCESS_TRIGGER
+
+NS_SWIFT_NAME(CrashTriggersHelper)
+@interface KSCrashTriggersHelper : NSObject
+
++ (NSArray<NSString *> *)groupIds;
++ (NSString *)nameForGroup:(NSString *)groupId;
+
++ (NSArray<KSCrashTriggerId> *)triggersForGroup:(NSString *)groupId;
++ (NSString *)nameForTrigger:(KSCrashTriggerId)triggerId;
+
++ (void)runTrigger:(KSCrashTriggerId)triggerId;
+
+@end
+
+NS_ASSUME_NONNULL_END

Samples/Common/Sources/CrashTriggers/include/KSCrashTriggersList.h

@@ -0,0 +1,57 @@
+//
+//  KSCrashTriggersList.h
+//
+//  Created by Nikolay Volosatov on 2024-06-23.
+//
+//  Copyright (c) 2012 Karl Stenerud. All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall remain in place
+// in this source code.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+#define __ALL_GROUPS                             \
+    __PROCESS_GROUP(nsException, @"NSException") \
+    __PROCESS_GROUP(cpp, @"C++")                 \
+    __PROCESS_GROUP(mach, @"Mach")               \
+    __PROCESS_GROUP(signal, @"Signal")           \
+    __PROCESS_GROUP(other, @"Other")
+
+#define __ALL_TRIGGERS                                                           \
+    __PROCESS_TRIGGER(nsException, genericNSException, @"Generic NSException")   \
+    __PROCESS_TRIGGER(nsException, nsArrayOutOfBounds, @"NSArray out-of-bounds") \
+    __PROCESS_TRIGGER(cpp, runtimeException, @"Runtime Exception")               \
+    __PROCESS_TRIGGER(mach, badAccess, @"EXC_BAD_ACCESS (SIGSEGV)")              \
+    __PROCESS_TRIGGER(mach, busError, @"EXC_BAD_ACCESS (SIGBUS)")                \
+    __PROCESS_TRIGGER(mach, illegalInstruction, @"EXC_BAD_INSTRUCTION")          \
+    __PROCESS_TRIGGER(signal, abort, @"Abort")                                   \
+    __PROCESS_TRIGGER(other, stackOverflow, @"Stack overflow")
+
+NS_SWIFT_NAME(CrashTriggersList)
+@interface KSCrashTriggersList : NSObject
+
+#define __PROCESS_TRIGGER(GROUP, ID, NAME) +(void)trigger_##GROUP##_##ID;
+__ALL_TRIGGERS
+#undef __PROCESS_TRIGGER
+
+@end
+
+NS_ASSUME_NONNULL_END