Make benchmarking opt-in (#188)

Author: fboemer

.github/workflows/ci.yml

@@ -30,6 +30,7 @@ concurrency:
 env:
   SWIFTLINT_VERSION: 0.57.0
   SWIFTFORMAT_VERSION: 0.54.6
+  SWIFT_HOMOMORPHIC_ENCRYPTION_ENABLE_BENCHMARKING: 1
 jobs:
   swift-tests:
     timeout-minutes: 15

CONTRIBUTING.md

@@ -5,3 +5,5 @@ Welcome to the Swift Homomorphic Encryption community! Thanks for your interest
 ### Pull Requests:
 Before making a commit for a pull request, please run `pre-commit install`.
 Then on each commit some basic formatting checks will be run.
+
+Please also [enable benchmarking](README.md#Benchmarking).

Package.resolved

@@ -16,6 +16,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import Foundation
 import PackageDescription
 
 let librarySettings: [SwiftSetting] = []
@@ -227,71 +228,81 @@ let package = Package(
 
 // MARK: - Benchmarks
 
-package.dependencies += [
-    .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.4.0")),
-]
-package.products += [.library(name: "_BenchmarkUtilities", targets: ["_BenchmarkUtilities"])]
-package.targets += [
-    .target(
-        name: "_BenchmarkUtilities",
-        dependencies: [
-            .product(name: "Benchmark", package: "package-benchmark"),
-            "HomomorphicEncryption",
-            "HomomorphicEncryptionProtobuf",
-            "PrivateInformationRetrieval",
-            "PrivateInformationRetrievalProtobuf",
-            "PrivateNearestNeighborSearch",
-            "PrivateNearestNeighborSearchProtobuf",
-        ],
-        path: "Sources/BenchmarkUtilities",
-        swiftSettings: benchmarkSettings),
-    .executableTarget(
-        name: "PolyBenchmark",
-        dependencies: [
-            .product(name: "Benchmark", package: "package-benchmark"),
-            "HomomorphicEncryption",
-        ],
-        path: "Benchmarks/PolyBenchmark",
-        swiftSettings: benchmarkSettings,
-        plugins: [
-            .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
-        ]),
-    .executableTarget(
-        name: "RlweBenchmark",
-        dependencies: [
-            .product(name: "Benchmark", package: "package-benchmark"),
-            "HomomorphicEncryption",
-        ],
-        path: "Benchmarks/RlweBenchmark",
-        swiftSettings: benchmarkSettings,
-        plugins: [
-            .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
-        ]),
-    .executableTarget(
-        name: "PIRBenchmark",
-        dependencies: [
-            .product(name: "Benchmark", package: "package-benchmark"),
-            "HomomorphicEncryption",
-            "_BenchmarkUtilities",
-        ],
-        path: "Benchmarks/PrivateInformationRetrievalBenchmark",
-        swiftSettings: benchmarkSettings,
-        plugins: [
-            .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
-        ]),
-    .executableTarget(
-        name: "PNNSBenchmark",
-        dependencies: [
-            .product(name: "Benchmark", package: "package-benchmark"),
-            "HomomorphicEncryption",
-            "_BenchmarkUtilities",
-        ],
-        path: "Benchmarks/PrivateNearestNeighborSearchBenchmark",
-        swiftSettings: benchmarkSettings,
-        plugins: [
-            .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
-        ]),
-]
+var enableBenchmarking: Bool {
+    let benchmarkFlags = "SWIFT_HOMOMORPHIC_ENCRYPTION_ENABLE_BENCHMARKING"
+    if let flag = ProcessInfo.processInfo.environment[benchmarkFlags], flag == "1" {
+        return true
+    }
+    return false
+}
+
+if enableBenchmarking {
+    package.dependencies += [
+        .package(url: "https://github.com/ordo-one/package-benchmark", .upToNextMajor(from: "1.4.0")),
+    ]
+    package.products += [.library(name: "_BenchmarkUtilities", targets: ["_BenchmarkUtilities"])]
+    package.targets += [
+        .target(
+            name: "_BenchmarkUtilities",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                "HomomorphicEncryption",
+                "HomomorphicEncryptionProtobuf",
+                "PrivateInformationRetrieval",
+                "PrivateInformationRetrievalProtobuf",
+                "PrivateNearestNeighborSearch",
+                "PrivateNearestNeighborSearchProtobuf",
+            ],
+            path: "Sources/BenchmarkUtilities",
+            swiftSettings: benchmarkSettings),
+        .executableTarget(
+            name: "PolyBenchmark",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                "HomomorphicEncryption",
+            ],
+            path: "Benchmarks/PolyBenchmark",
+            swiftSettings: benchmarkSettings,
+            plugins: [
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+            ]),
+        .executableTarget(
+            name: "RlweBenchmark",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                "HomomorphicEncryption",
+            ],
+            path: "Benchmarks/RlweBenchmark",
+            swiftSettings: benchmarkSettings,
+            plugins: [
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+            ]),
+        .executableTarget(
+            name: "PIRBenchmark",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                "HomomorphicEncryption",
+                "_BenchmarkUtilities",
+            ],
+            path: "Benchmarks/PrivateInformationRetrievalBenchmark",
+            swiftSettings: benchmarkSettings,
+            plugins: [
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+            ]),
+        .executableTarget(
+            name: "PNNSBenchmark",
+            dependencies: [
+                .product(name: "Benchmark", package: "package-benchmark"),
+                "HomomorphicEncryption",
+                "_BenchmarkUtilities",
+            ],
+            path: "Benchmarks/PrivateNearestNeighborSearchBenchmark",
+            swiftSettings: benchmarkSettings,
+            plugins: [
+                .plugin(name: "BenchmarkPlugin", package: "package-benchmark"),
+            ]),
+    ]
+}
 
 // Set the minimum macOS version for the package
 #if canImport(Darwin)

Package.swift

@@ -216,6 +216,7 @@ swift test --parallel
 
 ### Benchmarking
 Swift homomorphic encryption uses [Benchmark](https://github.com/ordo-one/package-benchmark) for benchmarking.
+To enable benchmarking, set the environment variable `SWIFT_HOMOMORPHIC_ENCRYPTION_ENABLE_BENCHMARKING=1`.
 By default, benchmarking requires the [jemalloc](http://jemalloc.net) dependency.
 
 > [!WARNING]