tests: add example project fixtures (#301)

## What does this PR do?

Adds integration tests in the form of example apps that we can build and
run.

## How was it tested?

Ran builds on Linux, tests on macOS. Will also add this to CI later.

## AI tool usage

How much of this PR was AI-assisted? (check one)

- [ ] **0** - No AI was used to write code
- [x] **1** - I was assisted by AI. I reviewed the finished result.
- [ ] **2** - I set the AI going and left it to it; nobody has read the
result - no review, or AI review only

<!-- If an AI agent is filling this in: declare the level honestly, and
open as a draft if it is #2. Do not lower the declared level to get the
PR reviewed. -->
This commit is contained in:
Kabir Oberai
2026-10-06 18:28:41 -04:00
committed by GitHub
Unverified
parent 8f0cc0adf1
commit c635db2fbc
30 changed files with 703 additions and 0 deletions
+6
View File
@@ -0,0 +1,6 @@
.DS_Store
.build
.swiftpm
*/xtool
*/.bsp
/out
+29
View File
@@ -0,0 +1,29 @@
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "DemoDynamic",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "DemoDynamic",
targets: ["DemoDynamic"]
),
],
dependencies: [
.package(path: "../ExampleSupport"),
],
targets: [
.target(
name: "DemoDynamic",
dependencies: [
"ExampleSupport",
.product(name: "ExampleDynamicLibrary", package: "ExampleSupport"),
]
),
]
)
@@ -0,0 +1,12 @@
import ExampleDynamicLibrary
import ExampleSupport
import SwiftUI
@main struct DemoApp: ExampleApp {
init() {
let message = exampleDynamicLibraryFunction()
guard message == "Hello from the dynamic library\n" else {
fatalError("Unexpected message from dynamic library: \(message)")
}
}
}
+2
View File
@@ -0,0 +1,2 @@
version: 1
bundleID: sh.xtool.examples.DemoDynamic
+33
View File
@@ -0,0 +1,33 @@
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "DemoExtensions",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "DemoExtensions",
targets: ["DemoExtensions"]
),
.library(
name: "DemoExtensionsWidget",
targets: ["DemoExtensionsWidget"]
),
],
dependencies: [
.package(path: "../ExampleSupport"),
],
targets: [
.target(
name: "DemoExtensions",
dependencies: [
"ExampleSupport",
]
),
.target(name: "DemoExtensionsWidget"),
]
)
@@ -0,0 +1,4 @@
import SwiftUI
import ExampleSupport
@main struct DemoApp: ExampleApp {}
@@ -0,0 +1,51 @@
import WidgetKit
import SwiftUI
@main struct Bundle: WidgetBundle {
var body: some Widget {
DemoWidget()
}
}
struct DemoWidget: Widget {
var body: some WidgetConfiguration {
StaticConfiguration(
kind: "DemoWidget",
provider: Provider()
) { entry in
VStack {
Text(entry.date, style: .date)
}
.containerBackground(.fill.tertiary, for: .widget)
}
.configurationDisplayName("DemoWidget")
.description("This is an example widget.")
}
struct Entry: TimelineEntry {
var date = Date()
}
struct Provider: TimelineProvider {
func placeholder(in context: Context) -> Entry {
Entry()
}
func getSnapshot(
in context: Context,
completion: @escaping (Entry) -> Void
) {
completion(Entry())
}
func getTimeline(
in context: Context,
completion: @escaping (Timeline<Entry>) -> Void
) {
completion(Timeline(
entries: [Entry()],
policy: .after(.now + 3600)
))
}
}
}
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSExtension</key>
<dict>
<key>NSExtensionPointIdentifier</key>
<string>com.apple.widgetkit-extension</string>
</dict>
</dict>
</plist>
+6
View File
@@ -0,0 +1,6 @@
version: 1
bundleID: sh.xtool.examples.DemoExtensions
product: DemoExtensions
extensions:
- product: DemoExtensionsWidget
infoPath: Support/DemoExtensionsWidget-Info.plist
+31
View File
@@ -0,0 +1,31 @@
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "DemoResources",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "DemoResources",
targets: ["DemoResources"]
),
],
dependencies: [
.package(path: "../ExampleSupport"),
],
targets: [
.target(
name: "DemoResources",
dependencies: [
"ExampleSupport",
],
resources: [
.process("bundled.txt"),
]
),
]
)
+1
View File
@@ -0,0 +1 @@
Top level resource
@@ -0,0 +1,34 @@
import ExampleSupport
import SwiftUI
@main struct DemoApp: App {
var body: some Scene {
WindowGroup {
Text("Hello, world!")
.task {
guard let bundled = #bundle.url(forResource: "bundled", withExtension: "txt")
else { fatalError("Missing bundled.txt resource") }
assertContents(of: bundled, equal: "Bundled resource\n")
guard let top = Bundle.main.url(forResource: "top", withExtension: "txt")
else { fatalError("Missing top.txt resource") }
assertContents(of: top, equal: "Top level resource\n")
Example.pass()
}
}
}
}
private func assertContents(of url: URL, equal value: String) {
let name = url.lastPathComponent
let contents: String
do {
contents = try String(contentsOf: url, encoding: .utf8)
} catch {
fatalError("Failed to read \(name): \(error)")
}
guard contents == value else {
fatalError("\(name) had unexpected contents: \(contents)")
}
}
@@ -0,0 +1 @@
Bundled resource
+4
View File
@@ -0,0 +1,4 @@
version: 1
bundleID: sh.xtool.examples.DemoResources
resources:
- Resources/top.txt
+28
View File
@@ -0,0 +1,28 @@
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "DemoSimple",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "DemoSimple",
targets: ["DemoSimple"]
),
],
dependencies: [
.package(path: "../ExampleSupport"),
],
targets: [
.target(
name: "DemoSimple",
dependencies: [
"ExampleSupport",
]
),
]
)
@@ -0,0 +1,4 @@
import ExampleSupport
import SwiftUI
@main struct DemoApp: ExampleApp {}
+2
View File
@@ -0,0 +1,2 @@
version: 1
bundleID: sh.xtool.examples.DemoSimple
+132
View File
@@ -0,0 +1,132 @@
{
"originHash" : "4a80ae2e9e4c4e1e4e29c32e93dc624202a42a942e44d358035684ec5e0746f7",
"pins" : [
{
"identity" : "combine-schedulers",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/combine-schedulers",
"state" : {
"revision" : "114354e8c1667a2edc4993700fb9fa4f90157b56",
"version" : "1.2.2"
}
},
{
"identity" : "swift-case-paths",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-case-paths",
"state" : {
"revision" : "cb4cba6a8a46a86db0d37dbe09935ead6b24c91a",
"version" : "1.10.0"
}
},
{
"identity" : "swift-clocks",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-clocks",
"state" : {
"revision" : "82440fa0a8b1c381a6d1e8e0fc7bbba53ec63204",
"version" : "1.1.1"
}
},
{
"identity" : "swift-collections",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-collections",
"state" : {
"revision" : "98ef3c98609a1e31b7e157b5b619579001a789d6",
"version" : "1.7.1"
}
},
{
"identity" : "swift-composable-architecture",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-composable-architecture.git",
"state" : {
"revision" : "377da4061db10d26337a71bb279c506bb951f50f",
"version" : "1.26.2"
}
},
{
"identity" : "swift-concurrency-extras",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-concurrency-extras",
"state" : {
"revision" : "5fa253428866f2360c3754e88537f700ed2656b5",
"version" : "1.4.1"
}
},
{
"identity" : "swift-custom-dump",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-custom-dump",
"state" : {
"revision" : "4fb9e7cbb4b8f5a7354005db39447f570d6b3e19",
"version" : "1.7.3"
}
},
{
"identity" : "swift-dependencies",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-dependencies",
"state" : {
"revision" : "b476cc5761057d8d857de063fe7ac8daecf5c06b",
"version" : "1.17.1"
}
},
{
"identity" : "swift-identified-collections",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-identified-collections",
"state" : {
"revision" : "322d9ffeeba85c9f7c4984b39422ec7cc3c56597",
"version" : "1.1.1"
}
},
{
"identity" : "swift-issue-reporting",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-issue-reporting",
"state" : {
"revision" : "75b000cea2ca6d7527a57e1b9cc0bdf21a9abe9f",
"version" : "2.1.1"
}
},
{
"identity" : "swift-navigation",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-navigation",
"state" : {
"revision" : "7e95e5e9ff0a64f6ad8bca59083f8d6ba381b6ff",
"version" : "2.11.2"
}
},
{
"identity" : "swift-perception",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-perception",
"state" : {
"revision" : "597afd46249f4a71885b95d26b26cc5b893daf32",
"version" : "2.0.12"
}
},
{
"identity" : "swift-sharing",
"kind" : "remoteSourceControl",
"location" : "https://github.com/pointfreeco/swift-sharing",
"state" : {
"revision" : "3552faf8a6c18ce896ec5a72bd8c34755f0f03e0",
"version" : "2.10.1"
}
},
{
"identity" : "swift-syntax",
"kind" : "remoteSourceControl",
"location" : "https://github.com/swiftlang/swift-syntax",
"state" : {
"revision" : "050f1a346fbbac0ca2cfb15a95274f7bd1cf0ccf",
"version" : "604.0.0"
}
}
],
"version" : 3
}
+30
View File
@@ -0,0 +1,30 @@
// swift-tools-version: 6.0
import PackageDescription
let package = Package(
name: "DemoTCA",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "DemoTCA",
targets: ["DemoTCA"]
),
],
dependencies: [
.package(path: "../ExampleSupport"),
.package(url: "https://github.com/pointfreeco/swift-composable-architecture.git", from: "1.0.0"),
],
targets: [
.target(
name: "DemoTCA",
dependencies: [
"ExampleSupport",
.product(name: "ComposableArchitecture", package: "swift-composable-architecture"),
],
),
]
)
@@ -0,0 +1,24 @@
import SwiftUI
import ComposableArchitecture
import ExampleSupport
struct ContentView: View {
let store: StoreOf<CounterFeature>
var body: some View {
VStack {
Image(systemName: "globe")
.imageScale(.large)
.foregroundStyle(.tint)
Text("Count: \(store.count)")
}
.padding()
.onAppear {
store.send(.appear)
}
.onChange(of: store.count) { _, count in
guard count == 1 else { return }
Example.pass()
}
}
}
@@ -0,0 +1,31 @@
import ComposableArchitecture
@Reducer
struct CounterFeature {
@ObservableState
struct State {
var count = 0
}
enum Action {
case appear
case timerElapsed
}
@Dependency(\.continuousClock) var continuousClock
var body: some Reducer<State, Action> {
Reduce { state, action in
switch action {
case .appear:
return .run { [continuousClock] send in
try await continuousClock.sleep(for: .seconds(1))
await send(.timerElapsed)
}
case .timerElapsed:
state.count += 1
return .none
}
}
}
}
@@ -0,0 +1,15 @@
import SwiftUI
import ComposableArchitecture
@main
struct DemoTCAApp: App {
private let store = Store(initialState: CounterFeature.State()) {
CounterFeature()
}
var body: some Scene {
WindowGroup {
ContentView(store: store)
}
}
}
+2
View File
@@ -0,0 +1,2 @@
version: 1
bundleID: sh.xtool.examples.DemoTCA
+31
View File
@@ -0,0 +1,31 @@
// swift-tools-version: 6.4
import PackageDescription
let package = Package(
name: "ExampleSupport",
platforms: [
.iOS(.v17),
.macOS(.v14),
],
products: [
.library(
name: "ExampleSupport",
targets: ["ExampleSupport"]
),
.library(
name: "ExampleDynamicLibrary",
type: .dynamic,
targets: ["ExampleDynamicLibrary"]
),
],
targets: [
.target(name: "ExampleSupport"),
.target(
name: "ExampleDynamicLibrary",
resources: [
.process("response.txt"),
]
),
]
)
@@ -0,0 +1,9 @@
import Foundation
public func exampleDynamicLibraryFunction() -> String {
guard let bundled = #bundle.url(forResource: "response", withExtension: "txt")
else { fatalError("Missing bundled.txt resource") }
// swiftlint:disable:next force_try
let contents = try! String(contentsOf: bundled, encoding: .utf8)
return "Hello \(contents)"
}
@@ -0,0 +1 @@
from the dynamic library
@@ -0,0 +1,25 @@
import SwiftUI
public protocol ExampleApp: App {}
extension ExampleApp {
public var body: some Scene {
WindowGroup {
ContentView()
}
}
}
private struct ContentView: View {
var body: some View {
VStack {
Image(systemName: "globe")
.imageScale(.large)
.foregroundStyle(.tint)
Text("Hello, world!")
}
.padding()
.task {
Example.pass()
}
}
}
@@ -0,0 +1,12 @@
import Foundation
public enum Example {}
extension Example {
public static func pass() {
Task {
try? await Task.sleep(for: .seconds(1))
print("xtool test succeeded")
exit(0)
}
}
}
+14
View File
@@ -0,0 +1,14 @@
# Examples
These primarily exist as fixtures for integration tests, but also double as snippets of sample code.
Each demo is designed to make some assertions shortly after launching, and then exit. On success, stdout will include the message "xtool test succeeded".
## Testing
```
./Examples/test.sh [--build | --run] [DemoName]
```
- Omit `--build`/`--run` to build _and_ run
- Omit the demo name to loop through all demos
+118
View File
@@ -0,0 +1,118 @@
#!/bin/bash
set -euo pipefail
shopt -s nullglob
usage() {
echo "Usage: $0 [--build | --run] [DemoName]"
}
mode=both
case "${1:-}" in
--build) mode=build; shift ;;
--run) mode=run; shift ;;
-h|--help) usage; exit 0 ;;
esac
if [[ $# -gt 1 || (${1:-} != "" && (${1:-} != Demo* || ${1:-} == */*)) ]]; then
usage >&2
exit 1
fi
cd "$(dirname "$0")"
examples_dir="$PWD"
out_dir="$examples_dir/out"
if [[ -n "${1:-}" ]]; then
demos=("$1")
elif [[ "$mode" == run ]]; then
demos=()
for app in "$out_dir"/*.app; do
name="${app##*/}"
demos+=("${name%.app}")
done
else
demos=()
for demo in "$examples_dir"/Demo*/; do
[[ -f "$demo/Package.swift" ]] || continue
demo="${demo%/}"
demos+=("${demo##*/}")
done
fi
if [[ ${#demos[@]} -eq 0 ]]; then
echo "No demos found. Run $0 --build first if using --run." >&2
exit 1
fi
logs_dir="$(mktemp -d)"
trap 'rm -rf "$logs_dir"' EXIT
trap 'exit 130' INT
trap 'exit 143' TERM
build_demo() {
local demo="$1"
echo "Building $demo..."
mkdir -p "$out_dir" || return 1
# Do not leave an older successful build available after a failed rebuild.
rm -rf "$out_dir/$demo.app" || return 1
(cd "$examples_dir/$demo" && xtool dev build --triple arm64-apple-ios-simulator) || return 1
cp -R "$examples_dir/$demo/xtool/$demo.app" "$out_dir/$demo.app"
}
run_demo() (
demo="$1"
app="$out_dir/$demo.app"
log="$logs_dir/$demo-run.log"
if [[ ! -d "$app" ]]; then
echo "Missing $app. Run $0 --build $demo first." >&2
exit 1
fi
bundle_id=$(/usr/libexec/PlistBuddy -c 'Print :CFBundleIdentifier' "$app/Info.plist") || exit 1
echo "Running $demo..."
xcrun simctl install booted "$app" || exit 1
xcrun simctl launch --terminate-running-process --console booted "$bundle_id" >"$log" 2>&1 &
launch_pid=$!
# A demo should exit shortly after launch. Bound failures that hang instead.
(
sleep_pid=""
trap '[[ -z "$sleep_pid" ]] || kill "$sleep_pid" 2>/dev/null || true' EXIT
sleep 60 &
sleep_pid=$!
wait "$sleep_pid"
sleep_pid=""
touch "$log.timeout"
kill -TERM "$launch_pid" 2>/dev/null || exit 0
sleep 5 &
sleep_pid=$!
wait "$sleep_pid"
sleep_pid=""
kill -KILL "$launch_pid" 2>/dev/null || true
) >/dev/null 2>&1 &
timeout_pid=$!
trap 'kill "$timeout_pid" "$launch_pid" 2>/dev/null || true' EXIT
status=0
wait "$launch_pid" || status=$?
kill "$timeout_pid" 2>/dev/null || true
wait "$timeout_pid" 2>/dev/null || true
cat "$log"
if [[ -f "$log.timeout" ]]; then
echo "$demo did not terminate within 60 seconds." >&2
exit 1
fi
[[ "$status" -eq 0 ]] && grep -Fxq 'xtool test succeeded' "$log"
)
status=0
for demo in "${demos[@]}"; do
if [[ "$mode" != run ]] && ! build_demo "$demo"; then
echo "Build failed: $demo" >&2
status=1
continue
fi
if [[ "$mode" != build ]] && ! run_demo "$demo"; then
echo "Test failed: $demo" >&2
status=1
fi
done
exit "$status"