add multiple test runs, one with and one without the address sanitizer

Author: arik-so

.github/workflows/swift.yml

@@ -97,14 +97,26 @@ jobs:
                     LDK_C_BINDINGS_BASE: /home/runner/work/ldk-swift/ldk-swift/ldk-c-bindings
                     LLVM_CLANG_ASAN_PATH: /usr/lib/llvm-11/lib/clang/11.0.0/lib/linux/libclang_rt.asan-x86_64.a
                     RUST_BACKTRACE: 1
-            -   name: Test Swift bindings package
+            -   name: Test Swift bindings package without address sanitizer
                 run: |
+                    python ci/toggle_address_sanitation_library.py off
                     cd ci/LDKSwift
                     ../../swift-5.6-RELEASE-ubuntu20.04/usr/bin/swift test -v
+                    cd ../../
                 env:
                     LDK_C_BINDINGS_BASE: /home/runner/work/ldk-swift/ldk-swift/ldk-c-bindings
                     LLVM_CLANG_ASAN_PATH: /usr/lib/llvm-11/lib/clang/11.0.0/lib/linux/libclang_rt.asan-x86_64.a
                     RUST_BACKTRACE: 1
+            -   name: Test Swift bindings package with address sanitizer
+                run: |
+                    python ci/toggle_address_sanitation_library.py on
+                    cd ci/LDKSwift
+                    ../../swift-5.6-RELEASE-ubuntu20.04/usr/bin/swift test -v
+                env:
+                    LDK_C_BINDINGS_BASE: /home/runner/work/ldk-swift/ldk-swift/ldk-c-bindings
+                    LLVM_CLANG_ASAN_PATH: /usr/lib/llvm-11/lib/clang/11.0.0/lib/linux/libclang_rt.asan-x86_64.a
+                    RUST_BACKTRACE: 1
+
             -   name: Check that the latest headers are in the swift repo
                 run: |
                     git diff --exit-code

ci/LDKSwift/Package.swift

@@ -13,7 +13,7 @@ let package = Package(
             // .library(name: "LDKSwift", type: .dynamic, targets: ["LDKSwift"])
         ],
         dependencies: [
-        	.package(url: "https://github.com/apple/swift-crypto.git", "1.0.0" ..< "3.0.0")
+            .package(url: "https://github.com/apple/swift-crypto.git", "1.0.0"..<"3.0.0")
         ],
         targets: [
             // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -46,17 +46,15 @@ let package = Package(
                     swiftSettings: nil,
                     linkerSettings: [
                         .linkedLibrary(String(utf8String: getenv("LDK_C_BINDINGS_BASE")!)! + "/lightning-c-bindings/target/debug/libldk.a"),
-                        // .linkedLibrary(String(utf8String: getenv("LDK_C_BINDINGS_BASE") ?? "~/Developer/ldk-c-bindings")! + "/lightning-c-bindings/target/debug/libldk.a"),
-                        // .linkedLibrary("/usr/lib/llvm-11/lib/clang/11.0.0/lib/linux/libclang_rt.asan-x86_64.a")
-                        .linkedLibrary(String(utf8String: getenv("LLVM_CLANG_ASAN_PATH")!)!)
+                        .linkedLibrary(String(utf8String: getenv("LLVM_CLANG_ASAN_PATH")!)!),
                     ]),
             .testTarget(
                     name: "LDKSwiftTests",
                     dependencies: [
-                    	"LDKSwift",
-                    	"LDKHeaders",
-                    	.product(name: "Crypto", package: "swift-crypto")
-					],
+                        "LDKSwift",
+                        "LDKHeaders",
+                        .product(name: "Crypto", package: "swift-crypto")
+                    ],
                     path: nil,
                     exclude: [],
                     // exclude: ["SampleTest.swift"],

ci/toggle_address_sanitation_library.py

@@ -0,0 +1,34 @@
+import re
+import os
+import sys
+
+directory_path = os.path.dirname(os.path.realpath(__file__))
+file_path = f'{directory_path}/LDKSwift/Package.swift'
+if len(sys.argv) != 2:
+	sys.exit('Usage: python3 toggle_address_sanitation_library.py [on/off]')
+
+if not os.path.isfile(file_path):
+	sys.exit(f'Package.swift file is missing')
+
+should_enable_string = sys.argv[1]
+if not should_enable_string.lower() in ['on', 'off']:
+	sys.exit(f'{should_enable_string} is not a valid on/off value')
+
+should_enable = True if should_enable_string.lower() == 'on' else False
+
+file_in = open(file_path, 'rt', encoding='utf-8')
+original_contents = file_in.read()
+file_in.close()
+
+regex = re.compile("(\/\/)?([^\S\r\n]*)(\.linkedLibrary\(String\(utf8String: getenv\(\"LLVM_CLANG_ASAN_PATH\"\)!\)!\))", re.MULTILINE)
+matches = regex.search(original_contents)
+
+comment_prefix = ''
+if not should_enable:
+	comment_prefix = '//'
+
+toggle_result = regex.sub(f'\g<2>{comment_prefix}\g<3>', original_contents)
+
+file_out = open(file_path, 'wt', encoding='utf-8')
+file_out.write(toggle_result)
+file_out.close()