Scan command test

Package.swift

@@ -33,10 +33,24 @@ frontendDependencies.append(.target(name: "XcodeSupport"))
 #endif
 
 var targets: [PackageDescription.Target] = [
-    .executableTarget(
+  .executableTarget(
+    name: "PeripheryMain",
+    dependencies: [
+      .target(name: "Commands"),
+      .target(name: "Shared"),
+    ]
+  ),
+    .target(
         name: "Frontend",
         dependencies: frontendDependencies
     ),
+    .target(name: "Commands",
+           dependencies: [
+            .product(name: "SystemPackage", package: "swift-system"),
+            .product(name: "ArgumentParser", package: "swift-argument-parser"),
+            .target(name: "Shared"),
+            .target(name: "Frontend")
+           ]),
     .target(
         name: "PeripheryKit",
         dependencies: [
@@ -96,6 +110,13 @@ var targets: [PackageDescription.Target] = [
             .target(name: "PeripheryKit")
         ]
     ),
+    .testTarget(
+      name: "FrontendTests",
+      dependencies: [
+        .target(name: "Commands")
+      ],
+      exclude: ["DefaultiOSProject"]
+    ),
     .testTarget(
         name: "SPMTests",
         dependencies: [
@@ -141,7 +162,7 @@ let package = Package(
     name: "Periphery",
     platforms: [.macOS(.v13)],
     products: [
-        .executable(name: "periphery", targets: ["Frontend"]),
+        .executable(name: "periphery", targets: ["PeripheryMain"]),
         .library(name: "PeripheryKit", targets: ["PeripheryKit"])
     ],
     dependencies: dependencies,

Sources/Frontend/Commands/CheckUpdateCommand.swift → Sources/Commands/CheckUpdateCommand.swift

@@ -1,14 +1,17 @@
 import ArgumentParser
+import Frontend
 import Foundation
 import Shared
 
-struct CheckUpdateCommand: FrontendCommand {
-    static let configuration = CommandConfiguration(
+public struct CheckUpdateCommand: FrontendCommand {
+    public static let configuration = CommandConfiguration(
         commandName: "check-update",
         abstract: "Check for available update"
     )
+
+  public init() { }
 
-    func run() throws {
+    public func run() throws {
         let logger = Logger()
         let checker = UpdateChecker()
         DispatchQueue.global().async { checker.run() }

Sources/Frontend/Commands/ClearCacheCommand.swift → Sources/Commands/ClearCacheCommand.swift

@@ -2,13 +2,15 @@ import ArgumentParser
 import Foundation
 import Shared
 
-struct ClearCacheCommand: FrontendCommand {
-    static let configuration = CommandConfiguration(
+public struct ClearCacheCommand: FrontendCommand {
+    public static let configuration = CommandConfiguration(
         commandName: "clear-cache",
         abstract: "Clear Periphery's build cache"
     )
+
+    public init() { }
 
-    func run() throws {
+    public func run() throws {
         try Shell.shared.exec(["rm", "-rf", Constants.cachePath().string])
     }
 }

Sources/Frontend/Commands/FrontendCommand.swift → Sources/Commands/FrontendCommand.swift

@@ -1,7 +1,7 @@
 import ArgumentParser
 import Shared
 
-protocol FrontendCommand: ParsableCommand {}
-extension FrontendCommand {
+public protocol FrontendCommand: ParsableCommand {}
+public extension FrontendCommand {
     static var _errorLabel: String { colorize("error", .boldRed) }
 }

Sources/Frontend/Commands/ScanCommand.swift → Sources/Commands/ScanCommand.swift

@@ -2,9 +2,10 @@ import ArgumentParser
 import Foundation
 import Shared
 import SystemPackage
+import Frontend
 
-struct ScanCommand: FrontendCommand {
-    static let configuration = CommandConfiguration(
+public struct ScanCommand: FrontendCommand {
+    public static let configuration = CommandConfiguration(
         commandName: "scan",
         abstract: "Scan for unused code"
     )
@@ -127,8 +128,10 @@ struct ScanCommand: FrontendCommand {
     var genericProjectConfig: FilePath?
 
     private static let defaultConfiguration = Configuration()
+
+  public init() { }
 
-    func run() throws {
+    public func run() throws {
         let scanBehavior = ScanBehavior()
 
         if !setup {

Sources/Commands/VersionCommand.swift

@@ -0,0 +1,16 @@
+import ArgumentParser
+import Foundation
+import Frontend
+
+public struct VersionCommand: FrontendCommand {
+    public static let configuration = CommandConfiguration(
+        commandName: "version",
+        abstract: "Display the version of Periphery"
+    )
+
+    public init() { }
+
+    public func run() throws {
+        print(PeripheryVersion)
+    }
+}

Sources/Frontend/Project.swift

@@ -7,7 +7,7 @@ import SystemPackage
 import XcodeSupport
 #endif
 
-final class Project {
+public final class Project {
     static func identify() throws -> Self {
         let configuration = Configuration.shared
 
@@ -34,7 +34,7 @@ final class Project {
             #if canImport(XcodeSupport)
             return try XcodeProjectDriver.build(projectPath: projectPath)
             #else
-            fatalError("Xcode projects are not supported on this platform.")
+            throw PeripheryError.xcodeProjectsAreUnsupported
             #endif
         case .spm:
             return try SPMProjectDriver.build()

Sources/Frontend/Scan.swift

@@ -4,17 +4,17 @@ import PeripheryKit
 import Shared
 import SourceGraph
 
-final class Scan {
+public final class Scan {
     private let configuration: Configuration
     private let logger: Logger
     private let graph = SourceGraph.shared
 
-    required init(configuration: Configuration = .shared, logger: Logger = .init()) {
+    public required init(configuration: Configuration = .shared, logger: Logger = .init()) {
         self.configuration = configuration
         self.logger = logger
     }
 
-    func perform(project: Project) throws -> [ScanResult] {
+    public func perform(project: Project) throws -> [ScanResult] {
         if !configuration.indexStorePath.isEmpty {
             logger.warn("When using the '--index-store-path' option please ensure that Xcode is not running. False-positives can occur if Xcode writes to the index store while Periphery is running.")
 

Sources/Frontend/Commands/ScanBehavior.swift → Sources/Frontend/ScanBehavior.swift

@@ -3,16 +3,16 @@ import PeripheryKit
 import Shared
 import SystemPackage
 
-final class ScanBehavior {
+public final class ScanBehavior {
     private let configuration: Configuration
     private let logger: Logger
 
-    required init(configuration: Configuration = .shared, logger: Logger = .init()) {
+    public required init(configuration: Configuration = .shared, logger: Logger = .init()) {
         self.configuration = configuration
         self.logger = logger
     }
 
-    func setup(_ configPath: FilePath?) -> Result<(), PeripheryError> {
+    public func setup(_ configPath: FilePath?) -> Result<(), PeripheryError> {
         do {
             try configuration.load(from: configPath)
         } catch let error as PeripheryError {
@@ -24,7 +24,7 @@ final class ScanBehavior {
         return .success(())
     }
 
-    func main(_ block: (Project) throws -> [ScanResult]) -> Result<(), PeripheryError> {
+    public func main(_ block: (Project) throws -> [ScanResult]) -> Result<(), PeripheryError> {
         logger.contextualized(with: "version").debug(PeripheryVersion)
 
         let project: Project

Sources/Frontend/UpdateChecker.swift

@@ -5,7 +5,7 @@ import Shared
 import FoundationNetworking
 #endif
 
-final class UpdateChecker {
+public final class UpdateChecker {
     private let logger: Logger
     private let debugLogger: ContextualLogger
     private let configuration: Configuration
@@ -15,7 +15,7 @@ final class UpdateChecker {
     private let semaphore: DispatchSemaphore
     private var error: Error?
 
-    required init(logger: Logger = .init(), configuration: Configuration = .shared) {
+    public required init(logger: Logger = .init(), configuration: Configuration = .shared) {
         self.logger = logger
         self.debugLogger = logger.contextualized(with: "update-check")
         self.configuration = configuration
@@ -29,7 +29,7 @@ final class UpdateChecker {
         urlSession.invalidateAndCancel()
     }
 
-    func run() {
+    public func run() {
         // We only perform the update check with xcode format because it may interfere with
         // parsing json and csv.
         guard !configuration.disableUpdateCheck,
@@ -92,7 +92,7 @@ final class UpdateChecker {
         logger.info("To disable update checks pass the \(boldOption) option to the \(boldScan) command.")
     }
 
-    func wait() -> Result<String, PeripheryError> {
+    public func wait() -> Result<String, PeripheryError> {
         let waitResult = semaphore.wait(timeout: .now() + 60)
 
         if let error {

Sources/Frontend/Version.swift

@@ -1 +1 @@
-let PeripheryVersion = "2.21.0"
+public let PeripheryVersion = "2.21.0"

Sources/Frontend/main.swift → Sources/PeripheryMain/main.swift

@@ -1,6 +1,7 @@
 import ArgumentParser
 import Foundation
 import Shared
+import Commands
 
 Logger.configureBuffering()
 

Sources/Shared/Configuration.swift

@@ -294,8 +294,8 @@ protocol AbstractSetting {
 }
 
 private let filePathSetter: (Any) -> FilePath? = { value in
-    if let value = value as? String {
-        return FilePath(value)
+    if let value = value as? FilePath {
+        return value
     }
 
     return nil

Sources/Shared/Logger.swift

@@ -4,6 +4,11 @@ import Foundation
 import os
 #endif
 
+public class LoggerStorage {
+  public static var collectedLogs: [String] = []
+
+}
+
 public enum ANSIColor: String {
     case bold = "\u{001B}[0;1m"
     case red = "\u{001B}[0;31m"
@@ -72,7 +77,10 @@ public final class BaseLogger {
 
     @inlinable
     func log(_ line: String, output: UnsafeMutablePointer<FILE>) {
-        _ = outputQueue.sync { fputs(line + "\n", output) }
+      outputQueue.sync {
+          fputs(line + "\n", output)
+          LoggerStorage.collectedLogs.append(line)
+        }
     }
 }
 

Sources/Shared/PeripheryError.swift

@@ -5,6 +5,7 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
     case shellCommandFailed(cmd: String, args: [String], status: Int32, output: String)
     case shellOutputEncodingFailed(cmd: String, args: [String], encoding: String.Encoding)
     case usageError(String)
+    case xcodeProjectsAreUnsupported
     case underlyingError(Error)
     case invalidScheme(name: String, project: String)
     case sourceGraphIntegrityError(message: String)
@@ -55,6 +56,8 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
             return "JSON deserialization failed: \(describe(error))\nJSON:\n\(json)"
         case let .indexStoreNotFound(derivedDataPath):
             return "Failed to find index datastore at path: \(derivedDataPath)"
+        case .xcodeProjectsAreUnsupported:
+            return "Xcode projects are not supported on this platform"
         }
     }
 

Tests/FrontendTests/AcceptanceTestCase.swift

@@ -0,0 +1,50 @@
+import XCTest
+import Commands
+import SystemPackage
+import ArgumentParser
+import Shared
+
+enum Fixture: String {
+    case defaultiOSProject = "Tests/FrontendTests/DefaultiOSProject/DefaultiOSProject.xcodeproj"
+}
+
+class AcceptanceTestCase: XCTestCase {
+    let packageRootPath = URL(fileURLWithPath: #file).pathComponents
+        .prefix(while: { $0 != "Tests" }).joined(separator: "/").dropFirst()
+
+    override class func setUp() {
+        Configuration.shared.reset()
+        super.setUp()
+    }
+
+    override class func tearDown() {
+        Configuration.shared.reset()
+        super.tearDown()
+    }
+
+    func run(command: FrontendCommand.Type, arguments: String...) throws {
+        var command = try command
+            .parse(arguments)
+        try command.run()
+    }
+
+    func setupFixture(fixture: Fixture) -> FilePath {
+        var file = FilePath(String(packageRootPath))
+        file.append(fixture.rawValue)
+        return file
+    }
+
+    func XCTOutputDefaultOutputWithoutUnusedCode(scheme: String) {
+        XCTAssertTrue(LoggerStorage.collectedLogs.contains(
+            [
+                "* Inspecting project...",
+                "* Building \(scheme)...",
+                "* Indexing...",
+                "* Analyzing...",
+                "",
+                "* No unused code detected."
+            ]
+        ))
+    }
+
+}