fix(patch): Provide better feedback when benchmark init hooks fails (#…

…162)
ordo-one · Jun 13, 2023 · 5bc62b1 · 5bc62b1
1 parent 874ee0c
commit 5bc62b1
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/Sources/Benchmark/BenchmarkRunner.swift b/Sources/Benchmark/BenchmarkRunner.swift
@@ -179,7 +179,20 @@ public struct BenchmarkRunner: AsyncParsableCommand, BenchmarkRunnerReadWrite {
                             try await setup()
                         }
                     } catch {
-                        try channel.write(.error("Benchmark.setup or local benchmark setup failed: \(error)"))
+                        let description = """
+                                          Benchmark.setup or local benchmark setup failed:
+
+                                          \(error)
+
+                                          If it is a filesystem permissioning error or if the benchmark uses networking, you may need
+                                          to give permissions or even disable SwiftPM's sandbox environment and run the benchmark using:
+
+                                          swift package --allow-writing-to-package-directory benchmark
+                                          or
+                                          swift package --disable-sandbox benchmark
+                                          """
+
+                        try channel.write(.error(description))
                         return
                     }