Bring the esctest test suite, it was finally time to bring it

over and automate it.   Thanks AI!

The old test suite based on Python 2.7 stopped working on recent
MacOS, and I had been driving blind, and I did not like that.

So this fixes that, and in the process, it spotted that the
recent fix for color parsing was not quite complete and introduced
an error, we needed to use the current terminator for escape
sequences, not hardcode to BEL.

Author: migueldeicaza

.github/workflows/xcode.yml

@@ -8,9 +8,6 @@ on:
 
 env:
   DEVELOPER_DIR: /Applications/Xcode_16.4.app/Contents/Developer
-  # for testing - Removed, as this is no longer a python 2.7 on new systems
-  # I need to update esctest to 3.0
-  #PYTHON_BIN: /usr/local/bin/python
 
 jobs:
   build:
@@ -24,6 +21,7 @@ jobs:
       uses: actions/checkout@v4
       with:
         repository: migueldeicaza/esctest
+        ref: python3
         path: esctest
 
     - name: List all files, because this is driving me insane, this does not repro anywhere but github
@@ -45,6 +43,5 @@ jobs:
     - name: Coverage
       run: |
         swift test --enable-code-coverage
-        BINDIR=`swift build --show-bin-path`
-        TESTDIR=`find $BINDIR -name '*.xctest'`
-        xcrun llvm-cov report $TESTDIR/Contents/MacOS/SwiftTermPackageTests --instr-profile=.build/debug/codecov/default.profdata -use-color
+        BINDIR=$(swift build --show-bin-path)
+        xcrun llvm-cov report "$BINDIR/SwiftTermPackageTests.xctest/Contents/MacOS/SwiftTermPackageTests" --instr-profile=.build/debug/codecov/default.profdata -use-color

.gitignore

@@ -10,3 +10,4 @@ DerivedData
 .build
 .DS_Store
 *~
+esctest/

Makefile

@@ -47,3 +47,11 @@ build-fuzzer:
 
 run-fuzzer:
 	./.build/debug/SwiftTermFuzz ../SwiftTermFuzzerCorpus -rss_limit_mb=40480 -jobs=12
+
+clone-esctest:
+	@if [ -d esctest ]; then \
+		echo "esctest directory already exists, updating..."; \
+		cd esctest && git fetch && git checkout python3 && git pull; \
+	else \
+		git clone --branch python3 https://github.com/migueldeicaza/esctest.git esctest; \
+	fi

Sources/SwiftTerm/Terminal.swift

@@ -1877,7 +1877,7 @@ open class Terminal {
     }
 
     func reportColor (oscCode: Int, color: Color) {
-        sendResponse(cc.OSC, "\(oscCode);\(color.formatAsXcolor ())", ControlCodes.BEL)
+        sendResponse(cc.OSC, "\(oscCode);\(color.formatAsXcolor ())", cc.ST)
     }
 
     // This handles both setting the foreground, but spill into background and cursor color

Tests/SwiftTermTests/BufferTests.swift

@@ -5,25 +5,35 @@ import Testing
 @testable import SwiftTerm
 
 final class SwiftTermTests {
-    static var esctest = "esctest/esctest/esctest.py"
+    static let esctest = "esctest/esctest/esctest.py"
     static let queue: DispatchQueue = {
         let queue = DispatchQueue(label: "Runner", qos: .userInteractive, attributes: .concurrent, autoreleaseFrequency: .inherit, target: nil)
-        if !FileManager.default.fileExists(atPath: esctest) {
-            esctest = "/Users/miguel/cvs/SwiftTerm/esctest/esctest/esctest.py"
-        }
         // Ignore SIGCHLD
         signal(SIGCHLD, SIG_IGN)
         return queue
     }()
     let termConfig = "--expected-terminal xterm --xterm-checksum=334"
     let logfile = NSTemporaryDirectory() + "log"
 
-    func python27Bin() -> String? {
+    func pythonBin() -> String? {
         // Check environment variable first
-        if let python27 = getenv("PYTHON_BIN") {
-            return String(validatingUTF8: python27)
+        if let pythonEnv = getenv("PYTHON_BIN") {
+            return String(validatingUTF8: pythonEnv)
         }
-        
+
+        // Check common Python 3 locations
+        let candidates = [
+            "/usr/bin/python3",
+            "/usr/local/bin/python3",
+            "/opt/homebrew/bin/python3"
+        ]
+
+        for candidate in candidates {
+            if FileManager.default.isExecutableFile(atPath: candidate) {
+                return candidate
+            }
+        }
+
         return nil
     }
 
@@ -35,8 +45,8 @@ final class SwiftTermTests {
             return nil
         }
 
-        guard let python27 = python27Bin() else {
-            print("Skipping test - Python executable not found")
+        guard let python = pythonBin() else {
+            print("Skipping test - Python 3 executable not found")
             return nil
         }
 
@@ -59,7 +69,7 @@ final class SwiftTermTests {
         }
         print ("Starting \(SwiftTermTests.esctest) with \(args)")
         args.insert(SwiftTermTests.esctest, at: 0)
-        t.process.startProcess(executable: python27, args: args, environment: nil)
+        t.process.startProcess(executable: python, args: args, environment: nil)
 
         psem.wait ()
         print ("Does the file exist? \(FileManager.default.fileExists (atPath: logfile))")

Tests/SwiftTermTests/SwiftTermTests.swift

@@ -152,7 +152,7 @@ final class SwiftTermUnicode {
         #expect(char0_0 == "👩‍❤️‍👨")
     }
 
-    func testCJKCharacterPositioning ()
+    @Test func testCJKCharacterPositioning ()
     {
         let h = HeadlessTerminal (queue: SwiftTermTests.queue) { exitCode in }
         let t = h.terminal!
@@ -162,23 +162,23 @@ final class SwiftTermUnicode {
         t.feed (text: "あいう")
 
         // Verify character positions
-        XCTAssertEqual(t.getCharacter(col: 0, row: 0), "あ")
-        XCTAssertEqual(t.getCharacter(col: 1, row: 0), "\u{0}")  // placeholder
-        XCTAssertEqual(t.getCharacter(col: 2, row: 0), "い")
-        XCTAssertEqual(t.getCharacter(col: 3, row: 0), "\u{0}")  // placeholder
-        XCTAssertEqual(t.getCharacter(col: 4, row: 0), "う")
-        XCTAssertEqual(t.getCharacter(col: 5, row: 0), "\u{0}")  // placeholder
+        #expect(t.getCharacter(col: 0, row: 0) == "あ")
+        #expect(t.getCharacter(col: 1, row: 0) == "\u{0}")  // placeholder
+        #expect(t.getCharacter(col: 2, row: 0) == "い")
+        #expect(t.getCharacter(col: 3, row: 0) == "\u{0}")  // placeholder
+        #expect(t.getCharacter(col: 4, row: 0) == "う")
+        #expect(t.getCharacter(col: 5, row: 0) == "\u{0}")  // placeholder
 
         // Verify character widths
-        XCTAssertEqual(t.getCharData(col: 0, row: 0)?.width, 2)
-        XCTAssertEqual(t.getCharData(col: 2, row: 0)?.width, 2)
-        XCTAssertEqual(t.getCharData(col: 4, row: 0)?.width, 2)
+        #expect(t.getCharData(col: 0, row: 0)?.width == 2)
+        #expect(t.getCharData(col: 2, row: 0)?.width == 2)
+        #expect(t.getCharData(col: 4, row: 0)?.width == 2)
 
         // Cursor should be at column 6 after 3 double-width characters
-        XCTAssertEqual(t.buffer.x, 6)
+        #expect(t.buffer.x == 6)
     }
 
-    func testCJKMixedWithAscii ()
+    @Test func testCJKMixedWithAscii ()
     {
         let h = HeadlessTerminal (queue: SwiftTermTests.queue) { exitCode in }
         let t = h.terminal!
@@ -187,59 +187,48 @@ final class SwiftTermUnicode {
         t.feed (text: "aあbいc")
 
         // 'a' at col 0 (width 1)
-        XCTAssertEqual(t.getCharacter(col: 0, row: 0), "a")
-        XCTAssertEqual(t.getCharData(col: 0, row: 0)?.width, 1)
+        #expect(t.getCharacter(col: 0, row: 0) == "a")
+        #expect(t.getCharData(col: 0, row: 0)?.width == 1)
 
         // 'あ' at col 1 (width 2)
-        XCTAssertEqual(t.getCharacter(col: 1, row: 0), "あ")
-        XCTAssertEqual(t.getCharData(col: 1, row: 0)?.width, 2)
+        #expect(t.getCharacter(col: 1, row: 0) == "あ")
+        #expect(t.getCharData(col: 1, row: 0)?.width == 2)
 
         // 'b' at col 3 (width 1)
-        XCTAssertEqual(t.getCharacter(col: 3, row: 0), "b")
-        XCTAssertEqual(t.getCharData(col: 3, row: 0)?.width, 1)
+        #expect(t.getCharacter(col: 3, row: 0) == "b")
+        #expect(t.getCharData(col: 3, row: 0)?.width == 1)
 
         // 'い' at col 4 (width 2)
-        XCTAssertEqual(t.getCharacter(col: 4, row: 0), "い")
-        XCTAssertEqual(t.getCharData(col: 4, row: 0)?.width, 2)
+        #expect(t.getCharacter(col: 4, row: 0) == "い")
+        #expect(t.getCharData(col: 4, row: 0)?.width == 2)
 
         // 'c' at col 6 (width 1)
-        XCTAssertEqual(t.getCharacter(col: 6, row: 0), "c")
-        XCTAssertEqual(t.getCharData(col: 6, row: 0)?.width, 1)
+        #expect(t.getCharacter(col: 6, row: 0) == "c")
+        #expect(t.getCharData(col: 6, row: 0)?.width == 1)
 
         // Cursor should be at column 7
-        XCTAssertEqual(t.buffer.x, 7)
+        #expect(t.buffer.x == 7)
     }
 
-    func testChineseCharacterPositioning ()
+    @Test func testChineseCharacterPositioning ()
     {
         let h = HeadlessTerminal (queue: SwiftTermTests.queue) { exitCode in }
         let t = h.terminal!
 
         // Test Chinese characters (also double-width)
         t.feed (text: "中文字")
 
-        XCTAssertEqual(t.getCharacter(col: 0, row: 0), "中")
-        XCTAssertEqual(t.getCharacter(col: 2, row: 0), "文")
-        XCTAssertEqual(t.getCharacter(col: 4, row: 0), "字")
+        #expect(t.getCharacter(col: 0, row: 0) == "中")
+        #expect(t.getCharacter(col: 2, row: 0) == "文")
+        #expect(t.getCharacter(col: 4, row: 0) == "字")
 
         // All should be width 2
-        XCTAssertEqual(t.getCharData(col: 0, row: 0)?.width, 2)
-        XCTAssertEqual(t.getCharData(col: 2, row: 0)?.width, 2)
-        XCTAssertEqual(t.getCharData(col: 4, row: 0)?.width, 2)
+        #expect(t.getCharData(col: 0, row: 0)?.width == 2)
+        #expect(t.getCharData(col: 2, row: 0)?.width == 2)
+        #expect(t.getCharData(col: 4, row: 0)?.width == 2)
 
-        XCTAssertEqual(t.buffer.x, 6)
+        #expect(t.buffer.x == 6)
     }
-
-    static var allTests = [
-        ("testCombiningCharacters", testCombiningCharacters),
-        ("testEmoji", testEmoji),
-        ("testEmojiWithModifierBase", testEmojiWithModifierBase),
-        ("testEmojiZWJSequence", testEmojiZWJSequence),
-        ("testEmojiZWJSequenceSimple", testEmojiZWJSequenceSimple),
-        ("testCJKCharacterPositioning", testCJKCharacterPositioning),
-        ("testCJKMixedWithAscii", testCJKMixedWithAscii),
-        ("testChineseCharacterPositioning", testChineseCharacterPositioning),
-    ]
     @Test func testZwJSequencePreservesVariationSelector16() {
         let h = HeadlessTerminal (queue: SwiftTermTests.queue) { exitCode in }
         let t = h.terminal!