Skip to content

Commit a908c97

Browse files
jcavarjcavar
committed
Update CI and README
1 parent bb7de74 commit a908c97

2 files changed

Lines changed: 102 additions & 41 deletions

File tree

‎.github/workflows/tests.yml‎

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,55 @@
1-
name: Run Tests
1+
name: Tests
22

33
on:
44
push:
55
pull_request:
66

77
jobs:
8-
test:
8+
test-ios:
9+
name: Tests (iOS)
910
runs-on: macos-26
10-
11+
1112
steps:
1213
- name: Checkout code
1314
uses: actions/checkout@v4
14-
15+
1516
- name: List available simulators
1617
run: xcrun simctl list devices available
17-
18-
- name: Run tests
18+
19+
- name: Run tests on iOS Simulator
1920
run: |
2021
xcodebuild test \
2122
-scheme AudioSnapshotTesting \
2223
-destination 'platform=iOS Simulator,name=iPad Pro 13-inch (M5),OS=latest' \
23-
-resultBundlePath TestResults.xcresult
24-
continue-on-error: true
24+
-resultBundlePath TestResults-iOS.xcresult
25+
26+
- name: Upload test results
27+
if: always()
28+
uses: actions/upload-artifact@v4
29+
with:
30+
name: test-results-iOS
31+
path: TestResults-iOS.xcresult
32+
retention-days: 30
33+
34+
test-macos:
35+
name: Tests (macOS)
36+
runs-on: macos-26
37+
38+
steps:
39+
- name: Checkout code
40+
uses: actions/checkout@v4
41+
42+
- name: Run tests on macOS
43+
run: |
44+
xcodebuild test \
45+
-scheme AudioSnapshotTesting \
46+
-destination 'platform=macOS,name=Any Mac,OS=latest' \
47+
-resultBundlePath TestResults-macOS.xcresult
2548
2649
- name: Upload test results
2750
if: always()
2851
uses: actions/upload-artifact@v4
2952
with:
30-
name: test-results
31-
path: TestResults.xcresult
53+
name: test-results-macOS
54+
path: TestResults-macOS.xcresult
3255
retention-days: 30

‎README.md‎

Lines changed: 69 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
# AudioSnapshotTesting
22

3-
A Swift package for [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing) audio buffers in your iOS/macOS apps.
3+
A lightweight Swift package for snapshot testing audio buffers in your iOS/macOS apps with visual representations.
44

5-
<!--
6-
This is the status area for the project.
7-
Add project badges (if needed) to this part of the file.
8-
-->
5+
[![Tests (iOS)](https://github.com/infinum/AudioSnapshotTesting/actions/workflows/tests.yml/badge.svg?branch=main&event=push)](https://github.com/infinum/AudioSnapshotTesting/actions/workflows/tests.yml)
6+
[![Tests (macOS)](https://github.com/infinum/AudioSnapshotTesting/actions/workflows/tests.yml/badge.svg?branch=main&event=push)](https://github.com/infinum/AudioSnapshotTesting/actions/workflows/tests.yml)
97

108
## Description
119

12-
AudioSnapshotTesting provides snapshot strategies for testing audio-related functionality through visual snapshots. This makes it easier to verify audio processing and manipulation in a visual, deterministic way.
10+
AudioSnapshotTesting is a standalone snapshot testing library (no external dependencies) that works with Swift Testing framework. It provides strategies for waveform, spectrum, and spectrogram visualization, making it easy to verify audio processing and manipulation through deterministic snapshot comparisons. Snapshots are stored as lossless ALAC-encoded audio files with optional PNG visualizations for failure analysis.
1311

1412
## Table of contents
1513

@@ -36,37 +34,77 @@ dependencies: [
3634

3735
```swift
3836
import AudioSnapshotTesting
39-
import XCTest
40-
41-
class MyAudioTests: XCTestCase {
42-
func testAudioProcessing() {
43-
let buffer = // your AVAudioPCMBuffer
44-
assertSnapshot(
45-
of: buffer,
46-
as: .waveform(width: 3000, height: 800)
47-
)
48-
}
37+
import Testing
38+
39+
@Test
40+
func testAudioProcessing() async {
41+
let buffer = // your AVAudioPCMBuffer
42+
await assertAudioSnapshot(of: buffer, named: "my-audio")
43+
}
44+
```
45+
46+
### With Visualization Strategy
47+
48+
```swift
49+
@Test(.audioSnapshot(strategy: .waveform(width: 3000, height: 800)))
50+
func testWithVisualization() async {
51+
let buffer = // your AVAudioPCMBuffer
52+
await assertAudioSnapshot(of: buffer, named: "waveform")
53+
}
54+
```
55+
56+
### Recording Mode
57+
58+
```swift
59+
@Test(.audioSnapshot(record: true))
60+
func testRecording() async {
61+
let buffer = // your AVAudioPCMBuffer
62+
await assertAudioSnapshot(of: buffer, named: "recording")
4963
}
5064
```
5165

52-
Snapshot audio tests are snapshot tested itself. Please find many examples in: [AudioSnapshotTestingTests.swift](Tests/AudioSnapshotTestingTests/AudioSnapshotTestingTests.swift)
66+
### Multiple Buffers (Overlay)
67+
68+
```swift
69+
@Test(.audioSnapshot(strategy: .waveform(width: 1000, height: 300)))
70+
func testOverlay() async {
71+
let buffer1 = // first AVAudioPCMBuffer
72+
let buffer2 = // second AVAudioPCMBuffer
73+
await assertAudioSnapshot(of: (buffer1, buffer2), named: "overlay")
74+
}
75+
```
76+
77+
More examples can be found in: [AudioSnapshotTestingTests.swift](Tests/AudioSnapshotTestingTests/AudioSnapshotTestingTests.swift)
78+
79+
### Requirements
80+
81+
- iOS 16+ / macOS 13+ (for full visualization support)
82+
- Swift 6.2+ (for Swift Testing `Attachment` API)
83+
- No external dependencies
84+
85+
### Snapshot Format
86+
87+
Snapshots are stored in `__AudioSnapshots__/` directory (adjacent to test files) as ALAC-encoded CAF files:
88+
- Single buffer: `__AudioSnapshots__/{TestFile}/snapshot-name.caf`
89+
- Multiple buffers: `__AudioSnapshots__/{TestFile}/snapshot-name.1.caf`, `snapshot-name.2.caf`, etc.
90+
91+
Audio data is bit-exact through pre-quantization: source buffers are quantized (Float → Int → Float) to match ALAC's encoding, enabling exact sample-by-sample comparison without floating-point tolerance.
5392

5493
### Features
5594

56-
- [x] `AVAudioPCMBuffer` waveform snapshots
57-
- [x] `AVAudioPCMBuffer` overlayed waveform snapshots
58-
- [x] Spectrogram
59-
- [x] Spectra
60-
- [x] Different waveform rendering strategies
61-
- [x] Test against other reference implementations and with known audio files
62-
- [ ] Documentation
63-
- [ ] Mention JUCE
64-
- [ ] Link blog post and talk
65-
- [ ] review stashes
66-
- [x] Add a link to swift snapshot testing
67-
- [ ] Multi level comparison (first hash, then data, then image)
68-
- [ ] Use accelerate in downsampling
69-
- [x] Add file strategy
95+
- [x] **Standalone library** - No external dependencies (swift-snapshot-testing removed)
96+
- [x] **Swift Testing integration** - Works with Swift Testing framework via `AudioSnapshotTrait`
97+
- [x] **Waveform snapshots** - Visualize `AVAudioPCMBuffer` as waveforms
98+
- [x] **Multiple buffer overlays** - Compare and overlay multiple buffers with different colors
99+
- [x] **Spectrogram visualization** - Time-frequency representation of audio
100+
- [x] **Spectrum visualization** - Frequency domain analysis
101+
- [x] **ALAC compression** - Snapshots stored as lossless ALAC-encoded CAF files
102+
- [x] **Configurable bit depth** - 16-bit (default) or 32-bit ALAC encoding
103+
- [x] **Bit-exact comparison** - Pre-quantization ensures exact sample-by-sample matching
104+
- [x] **Auto-recording** - Missing snapshots are automatically recorded (test still fails to prevent CI passing)
105+
- [x] **Visualization on failure** - Optional PNG visualizations generated on comparison failures
106+
- [x] **Multi-channel rendering** - Different waveform rendering strategies (joined lines, individual lines)
107+
- [x] **macOS auto-open** - Optional automatic opening of visualizations in Preview
70108

71109
## Contributing
72110

0 commit comments

Comments
 (0)