chore: project cleanup (#2)

* fix: update README

* feat: add basic testing

* feat: update ci to support tests

Author: willswire

.github/workflows/release.yml

@@ -28,11 +28,11 @@ jobs:
         run: brew install just
 
       # Debug build for PRs or normal pushes to 'main'
-      - name: Build (Debug) for PR/Main
+      - name: Build & Test (Debug) for PR/Main
         if: >
           github.event_name == 'pull_request' ||
           (github.event_name == 'push' && startsWith(github.ref, 'refs/heads/'))
-        run: just build debug
+        run: just test
 
       # Release build for Tag pushes
       - name: Build (Release) for Tag

Package.swift

@@ -1,5 +1,4 @@
 // swift-tools-version: 5.10.0
-// The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
@@ -9,10 +8,13 @@ let package = Package(
         .macOS(.v11)
     ],
     targets: [
-        // Targets are the basic building blocks of a package, defining a module or a test suite.
-        // Targets can depend on other targets in this package and products from dependencies.
         .executableTarget(
             name: "teemoji",
-            resources: [.copy("TeemojiClassifier.mlmodelc")])
+            resources: [.copy("TeemojiClassifier.mlmodelc")]
+        ),
+        .testTarget(
+            name: "TeemojiTests",
+            dependencies: ["teemoji"]
+        ),
     ]
 )

README.md

@@ -14,7 +14,7 @@
 You can install `teemoji` via [Homebrew](https://brew.sh/):
 
 ```bash
-brew install willswire/teemoji
+brew install willswire/tap/teemoji
 ```
 
 ## Usage

Tests/TeemojiTests.swift

@@ -0,0 +1,61 @@
+import XCTest
+
+import class Foundation.Bundle
+
+final class TeemojiTests: XCTestCase {
+    /// Helper function to run the Teemoji executable with given input and arguments.
+    func runTeemoji(input: String, arguments: [String] = []) throws -> String {
+        let teemojiBinary = productsDirectory.appendingPathComponent("teemoji")
+
+        let process = Process()
+        process.executableURL = teemojiBinary
+        process.arguments = arguments
+
+        let inputPipe = Pipe()
+        let outputPipe = Pipe()
+
+        process.standardInput = inputPipe
+        process.standardOutput = outputPipe
+        process.standardError = outputPipe
+
+        try process.run()
+
+        // Send the input to the process
+        let inputHandle = inputPipe.fileHandleForWriting
+        inputHandle.write(input.data(using: .utf8)!)
+        inputHandle.closeFile()
+
+        // Read the output
+        if let outputData = try outputPipe.fileHandleForReading.readToEnd() {
+            return String(data: outputData, encoding: .utf8) ?? "UNKNOWN"
+        } else {
+            return "UNKNOWN"
+        }
+    }
+
+    func testBasicEmojiPrediction() throws {
+        let input = "Hello World"
+        let output = try runTeemoji(input: input)
+        // Adjust the test to allow for any predicted emoji
+        XCTAssertTrue(output.contains("🌍 Hello World"), "Output should contain: Hello World")
+    }
+
+    func testHelpOption() throws {
+        let output = try runTeemoji(input: "", arguments: ["-h"])  // Ensure correct flag
+        XCTAssertTrue(output.contains("Usage: teemoji"), "Output should contain usage instructions")
+    }
+
+    // Additional tests could include checking append behavior, etc.
+}
+
+/// Returns path to the built products directory.
+var productsDirectory: URL {
+    #if os(macOS)
+        for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
+            return bundle.bundleURL.deletingLastPathComponent()
+        }
+        fatalError("couldn't find the products directory")
+    #else
+        return Bundle.main.bundleURL
+    #endif
+}

justfile

@@ -7,3 +7,6 @@ build mode="debug":
     xcrun coremlcompiler generate Resources/TeemojiClassifier.mlpackage Sources --language Swift
     xcrun coremlcompiler compile Resources/TeemojiClassifier.mlpackage Sources
     swift build --configuration {{mode}} --verbose --disable-sandbox
+
+test: (build "debug")
+    swift test