Share
Embed
Hacking Xcode Behaviors / macOS native symposium #08
プロジェクトのBuild PhasesにRun Scriptを追加することでターゲットのビルド時に特定の処理を挟み込むことができますが、Xcode Behaviorsはプロジェクト単位ではなくXcode全般でのイベントに処理を挟み込むことができます。そんなBehaviorsをハックして、ビルドやテストのイベントを別アプリから監視する仕組みを実現するまでの試行錯誤について紹介します。
Kyome (Takuto Nakamura)
August 27, 2022
Transcript
57 slides
-
ࣗݾհ RunCat activity indicator HandyPalette color picker ScreenPointer presentation tool
ShiftWindow window organizer -
Xcode Behaviors Build PhasesͷRun ScriptsͰ TARGETͷϏϧυ࣌ʹShell ScriptͰ ॲཧΛڬΈࠐΉ͜ͱ͕Մೳ LinterFormatterΛ࣮ߦͨ͠Γɺ Ϧιʔε༻ͷSwiftίʔυΛੜͨ͠
ΓɺϏϧυલͷԼॲཧʹར༻Մೳ ϓϩδΣΫτ͝ͱʹݸผʹࢦఆ͢Δ ͷ Run Scripts -
Xcode Behaviors ݱঢ়ҎԼͷΠϕϯτΛαϙʔτ #VJME 5FTUJOH 3VOOJOH (16'SBNF$BQUVSF 4FBSDI 9DPEF4FSWFS 9DPEFͰαϙʔτऴྃʁ
$* 9DPEF$MPVE 'JMF 6OMPDL 1MBZHSPVOET $PSF.- 9DPEF͔Β Behaviors -
Xcode Behaviors Swift Package Managerʹؔ͢Δ Πϕϯταϙʔτ͞Ε͍ͯͳ͍ ͷ͕೦ Reset Package Caches
Resolve Package Versions Update to Latest Package Versions Behaviors 🫤 -
XCHook & XCMonitor XCHookXcode BehaviorsͷBuildͱTestingΛϑοΫͯ͠ɺ ֎෦ΞϓϦʹ௨Λૹ৴Ͱ͖ΔΑ͏ʹ͢ΔSwift PackageϥΠϒϥϦ Swift Packageͱͯ͠ར༻Մೳɿhttps://github.com/kyome22/XCHook
XcodeͷPreferencesΛॻ͖͑ͯɺBehaviorsΠϕϯτʹScriptΛࢦఆ ΠϕϯτΛղऍͯ͠ใܗˍ֎෦ΞϓϦʹ͚ͯ௨ૹ৴ ௨ͷड৴पΓΛ؆୯ʹ͢Δ֎෦ΞϓϦ͚ͷAPI -
XCHook & XCMonitor ऴ͓ྃͯ͘͠ XCHook XCMonitor Xcode XcodeͷPreferencesΛ্ॻ͖ͯ͠ ScriptΛ֤ΠϕϯτͷRun߲ʹࢦఆ͢Δ
ڥઃఆ͔ΒXCHookΛ༗ޮʹ͢Δ ಋೖฤ Scriptͷ࣮ߦʹඞཁͳԼ४උΛ͢Δ -
XCHook & XCMonitor BehaviorsͷΠϕϯτൃՐ XCHook XCMonitor Xcode Script͕ΠϕϯτΛղऍͯ͠ใΛܗ ใΛ֎෦ΞϓϦʹ௨ͱͯ͠ૹ৴
Xcodeͷىಈঢ়ଶΛࢹͭͭ͠ɺ௨Λৗ࣌ػ ड৴࣍ୈɺදࣔΛߋ৽ˍΠϕϯτͷϩάΛஷΊΔ ར༻ฤ -
vs App Sandboxͷน XCMonitor Xcode App Sandbox App SandboxɺΞϓϦ͕ΞΫηεՄೳͳྖҬΛ੍ݶ͢Δ͜ͱͰɺ
γεςϜͷϦιʔεͱϢʔβʔͷσʔλΛอޢ͢ΔͨΊͷͷ ֎෦ΞϓϦΛૢ࡞ͨ͠Γঢ়ଶΛऔಘ͢Δ͜ͱ௨ৗෆՄೳ ࣗ࡞ΞϓϦͷ߹ɺApp Sandboxͷ༗ޮ/ແޮ։ൃऀʹҕͶΒΕ͍ͯΔ XcodeApp Sandboxʹอޢ͞Ε͍ͯΔͨΊɺ֎෦͔ΒΞΫηεͰ͖ͳ͍ -
vs App Sandboxͷน Xcodeଆ͔Β֎෦ΞϓϦʹ͚ͯ߹๏తʹσʔλΛૹ৴͢ΔΈ͕ඞཁ BehaviorsͷRun ScriptͰShell ScriptΛ࣮ߦ ͞ΒʹShell ScriptͰSwiftͷεΫϦϓτΛ࣮ߦ͠ DistributedNoti
fi cationCenterͰ֎෦ΞϓϦʹ͚ใΛൃ৴ XCMonitor Xcode App Sandbox Behaviors >_ Shell Script Swift Script -
vs App Sandboxͷน XCMonitor Xcode App Sandbox Behaviors
>_ Shell Script Swift Script ~/.xchook BehaviorsͷRun ScriptͰεΫϦϓτΛಈ͔͢߹ɺ Shell ScriptͱSwiftͷεΫϦϓτʹ࣮ߦݖݶΛ༩͢Δ chmod 744 ͜ΕΒͷεΫϦϓτϗʔϜσΟϨΫτϦԼʹ .xchook σΟϨΫτϦΛ ࡞ͯͦ͜͠ʹஔ -
vs App Sandboxͷน XCMonitor Xcode App Sandbox Plist App
Sandbox ಋೖϋʔυϧΛԼ͛ΔͨΊɺBehaviorsͷRun ScriptΛࣗಈͰࢦఆ͢Δ Έ͕ཉ͍͠ Preferencesͷ༰ ~/Library/Preferences/com.apple.dt.Xcode.plist ʹอଘ͞ΕΔ App SandboxΛແޮʹ͢Εɺ֎෦ΞϓϦ͔ΒϑΝΠϧΛಡΈॻ͖Մೳ -
vs App Sandboxͷน ಋೖϋʔυϧΛԼ͛ΔͨΊɺBehaviorsͷRun ScriptΛࣗಈͰࢦఆ͢Δ Έ͕ཉ͍͠ Preferencesͷ༰ ~/Library/Preferences/com.apple.dt.Xcode.plist ʹอଘ͞ΕΔ
App SandboxΛແޮʹ͢Εɺ֎෦ΞϓϦ͔ΒϑΝΠϧΛಡΈॻ͖Մೳ XCMonitor Xcode App Sandbox Plist App Sandbox Full Access -
ϓϩδΣΫτύεͷऔಘ ϓϩδΣΫτ໊ͱύεΛޙͰར༻͢ΔͨΊɺRun ScriptͷதͰऔಘ͍ͨ͠ XcodeͰ։͘ϓϩδΣΫτܗࣜʹɺXcode Projectʢ .xcodeproj ʣͱ Xcode Workspaceʢ .xcworkspace
ʣͱ Swift Package ͷ̏छྨ͕͋Δ Run ScriptͷதͰར༻ՄೳͳڥมΛ׆༻ͯ͠ύεΛղੳ -
ϓϩδΣΫτύεͷऔಘ Run ScriptΛ࣮ߦͨ͠ࡍͷڥม Xcode Projectͷ߹ ڥม XcodeProject PROJECT_NAME.xcodeproj XcodeProjectPath
PROJECT_ROOT/PROJECT_NAME.xcodeproj XcodeWorkspacePath PROJECT_ROOT/PROJECT_NAME.xcodeproj/project.xcworkspace PWD PROJECT_ROOT * PROJECT_ROOT = ϓϩδΣΫτͷϧʔτͷઈରύε * PROJECT_NAME = ϓϩδΣΫτ໊ -
ϓϩδΣΫτύεͷऔಘ Run ScriptΛ࣮ߦͨ͠ࡍͷڥม Xcode Workspaceͷ߹ʢCocoaPodsΛ͍ͬͯΔͳͲʣ ڥม XcodeWorkspace PROJECT_NAME.xcworkspace XcodeWorkspacePath
PROJECT_ROOT/PROJECT_NAME.xcworkspace PWD PROJECT_ROOT * PROJECT_ROOT = ϓϩδΣΫτͷϧʔτͷઈରύε * PROJECT_NAME = ϓϩδΣΫτ໊ -
ϓϩδΣΫτύεͷऔಘ Run ScriptΛ࣮ߦͨ͠ࡍͷڥม Swift Packageܗࣜͷ߹ ڥม XcodeWorkspace package.xcworkspace XcodeWorkspacePath
PROJECT_ROOT/.swiftpm/xcode/package.xcworkspace PWD PROJECT_ROOT/.swiftpm/xcode * PROJECT_ROOT = ϓϩδΣΫτͷϧʔτͷઈରύε -
ϓϩδΣΫτύεͷऔಘ if (ڥมXcodeProject͕औಘՄೳ) { Xcode Project } else if (xcworkspaceϑΝΠϧͷ໊લ͕package.xcworkspace)
{ Swift Package } else { Xcode Workspace } Run ScriptΛ࣮ߦͨ͠ࡍͷڥมͷಛ ڥม XcodeProject ͕औಘͰ͖ΔͷXcode Projectܗࣜͷ߹ͷΈ Swift Packageܗࣜͷ߹ɺxcworkspaceϑΝΠϧͷ໊લ package.xcworkspace Ͱݻఆ -
ϓϩδΣΫτύεͷऔಘ ҎԼͷShell ScriptͰϓϩδΣΫτ໊ͱύε͕औಘͰ͖Δ #!/bin/sh - if [ "$XcodeProject" ]; then
# Normal Xcode Project PROJECT_NAME=`basename "$XcodeProject" .xcodeproj` PROJECT_PATH=$XcodeProjectPath elif [ "$XcodeWorkspace" = "package.xcworkspace" ]; then # Swift Package Library PROJECT_NAME=`basename $(dirname "$XcodeWorkspacePath" | sed -r "s/\.swiftpm.+//")` PROJECT_PATH=$XcodeWorkspacePath else # XCWorkspace (Probably using CocoaPods.) PROJECT_NAME=`basename "$XcodeWorkspace" .xcworkspace` PROJECT_PATH=$XcodeWorkspacePath fi ࢀরɿhttps://github.com/Kyome22/XCHook/blob/main/Sources/XCHook/run_scripts/build_start.sh -
XcodeͷPreferencesΛॻ͖͑Δ { "Xcode.AlertEvents.4_1": { "Xcode.AlertEvents.BuildStart": { "Xcode.Alert.RunScript": { "enabled": boolean,
"path": "Shell Scriptͷύε" } }, "Xcode.AlertEvents.TestingSucceeds": { "Xcode.Alert.RunScript": { "enabled": boolean, "path": "Shell Scriptͷύε" } } } } Plist ͷ༰ΛJSONܗࣜͰൈਮͨ͠ͷ BehaviorsʹRun ScriptΛઃఆ͢Δʹɺ Xcode.AlertEvents ͱ Xcode.AlertEvents.4_1 ͷ༰Λॻ͖͑Εྑ͍ ྫ͑ɺXcode.AlertEvent.BuildStart ͷத ͷ Xcode.Alert.RunScript ʹ࣮ߦ͍ͨ͠ Shell ScriptͷύεΛॻ͖ࠐΉ -
XcodeͷPreferencesΛॻ͖͑Δ { "Xcode.AlertEvents.4_1": { "Xcode.AlertEvents.BuildStart": { "Xcode.Alert.RunScript": { "enabled": boolean,
"path": "Shell Scriptͷύε" } }, "Xcode.AlertEvents.TestingSucceeds": { "Xcode.Alert.RunScript": { "enabled": boolean, "path": "Shell Scriptͷύε" } } } } Plist ͷ༰ΛJSONܗࣜͰൈਮͨ͠ͷ BehaviorsʹRun ScriptΛઃఆ͢Δʹɺ Xcode.AlertEvents ͱ Xcode.AlertEvents.4_1 ͷ༰Λॻ͖͑Εྑ͍ ྫ͑ɺXcode.AlertEvent.BuildStart ͷத ͷ Xcode.Alert.RunScript ʹ࣮ߦ͍ͨ͠ Shell ScriptͷύεΛॻ͖ࠐΉ ֊ߏͷਂ͍෦ͷॻ͖͕͑ඞཁ ଞͷ෦ͦͷ··อ͍ͪͨ -
XcodeͷPreferencesΛॻ͖͑Δ 4_1 ͬͯͳΜͩʁ 🧐 Xcode.AlertEvents ͱ Xcode.AlertEvents.4_1 ΄΅ಉ͡σʔλߏ͕ͩɺ ͓ͦΒׂ͕͘ҧ͏ Xcode.AlertEvents.4_1
Ϣʔβʔ͕ࢦఆͨ͠શͯͷઃఆ͕ೖΔͷͰຊମ Xcode.AlertEvents 4_1ͷόοΫΞοϓʁʢҰ෦ͷઃఆ͚͕ͩೖΔʣ -
XcodeͷPreferencesΛॻ͖͑Δ Command LineͰProperty ListΛॻ͖͑Δ߹ɺplutil PlistBuddy Λ ༻͢Δ͜ͱ͕ଟ͍ plutil ̍֊·Ͱ͔͠ૢ࡞Ͱ͖ͳ͍
😩 → ֎ PlistBuddy ̎֊Ҏ্͋ͬͯૢ࡞͕Մೳ 😃 อଘܗ͕ࣜXMLʹͳͬͯ͠·͏ ☹ ্ॻ͖͍ͨ͠ՕॴͷΈΛॻ͖͑ΔΑ͏ͳϚʔδ͕Ͱ͖ͳ͍ 🤯 ʢ߲̍ͣͭͷॻ͖͑ͱ·ͩଘࡏ͍ͯ͠ͳ͍σʔλͷՃͰ͖Δʣ -
্ॻ͖͍ͨ͠ՕॴͷΈΛॻ͖͑ΔΑ͏ͳϚʔδ͕Ͱ͖ͳ͍ͷҙຯ XcodeͷPreferencesΛॻ͖͑Δ { "Apple": { "Price": 100, "Color": "Green" },
"Banana": { "Price": 100, "Color": "Yellow" }, "Cherry": { "Price": 100, "Color": "Red" } } { "Apple": { "Price": 150 }, "Banana": { "Price": 150 }, "Cherry": { "Price": 150 } } { "Apple": { "Price": 150, "Color": "Green" }, "Banana": { "Price": 150, "Color": "Yellow" }, "Cherry": { "Price": 150, "Color": "Red" } } ΦϦδφϧ ॻ͖͍͑ͨ༰ ཧͷϚʔδ݁Ռ -
্ॻ͖͍ͨ͠ՕॴͷΈΛॻ͖͑ΔΑ͏ͳϚʔδ͕Ͱ͖ͳ͍ͷҙຯ XcodeͷPreferencesΛॻ͖͑Δ { "Apple": { "Price": 100, "Color": "Green" },
"Banana": { "Price": 100, "Color": "Yellow" }, "Cherry": { "Price": 100, "Color": "Red" } } { "Apple": { "Price": 150 }, "Banana": { "Price": 150 }, "Cherry": { "Price": 150 } } ΦϦδφϧ ॻ͖͍͑ͨ༰ طʹಉ໊ͷΩʔ͕ଘࡏͯ͠ ͍Δ߹Ϛʔδ͕Ͱ͖ͳ͍ PlistBuddyͰͷϚʔδ݁Ռ -
XcodeͷPreferencesΛॻ͖͑Δ let saveURL = URL(fileURLWithPath: "sample.plist") var dict: [String: Any]
= [:] // dictΛฤूʢதུʣ let data = try! PropertyListSerialization.data(fromPropertyList: dict, format: .binary, options: .zero) try! data.write(to: saveURL, options: .atomic) طଘͷCommand LineπʔϧΛΘͣSwiftͰࣗલ࣮͢Δ SwiftͰProperty ListΛॻ͖͑Δ߹ɺPropertyListSerialization Λ͑ BinaryܗࣜͷProperty ListΛฤूՄೳ -
ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ ͍͟ɺXcodeͷΠϕϯτΛࢹͯ͠ϩάΛऩूͯ͠ΈΔͱɺ ͨ·ʹΠϕϯτͷಧ͘ॱং͕લޙͯ͠͠·͏͜ͱʹؾ͍ͮͨ Ϗϧυ։࢝ Ϗϧυޭ ςετޭ
Ϗϧυ։࢝ Ϗϧυޭ ςετޭ ٯॱʹͳ͍ͬͯΔ😫 ςετ։࢝ ςετ։࢝ -
ςετ։࢝ ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ Run Scriptͷ࣮ߦΠϕϯτͷൃՐ࣌Ͱ͋Δ͕ɺஞ࣍ॲཧͰͳ͘ฒྻॲཧ ͞ΕΔͨΊɺRun Scriptͷ࣮ߦྃΛͨͣʹΠϕϯτ͕ਐΉ
Ϗϧυ։࢝ ஞ࣍ॲཧͷΠϝʔδ Ϗϧυޭ Ϗϧυ Run Script A >_ Run Script B >_ -
ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ Run Scriptͷ࣮ߦΠϕϯτͷൃՐ࣌Ͱ͋Δ͕ɺஞ࣍ॲཧͰͳ͘ฒྻॲཧ ͞ΕΔͨΊɺRun Scriptͷ࣮ߦྃΛͨͣʹΠϕϯτ͕ਐΉ Ϗϧυ։࢝ Ϗϧυޭ
Run Script A ςετ։࢝ Ϗϧυ Run Script B ฒྻॲཧͷΠϝʔδ ࣍ͷॲཧʹॏͳ͍ͬͯΔ -
Run Scriptͷ࣮ߦΠϕϯτͷൃՐ࣌Ͱ͋Δ͕ɺஞ࣍ॲཧͰͳ͘ฒྻॲཧ ͞ΕΔͨΊɺRun Scriptͷ࣮ߦྃΛͨͣʹΠϕϯτ͕ਐΉ ͠͠Πϕϯτͷॱং͕લޙ͢Δݱ͕ى͖ಘΔ ʢApple Silicon MacͷϏϧυ͕ߴ͗ͯ͢௨ॲཧͷํ͕ෛ͚Δʁʣ ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ
Ϗϧυ։࢝ Ϗϧυޭ Run Script A ςετ։࢝ Ϗϧυ Run Script B ॲཧͷ͕ྃٯస -
ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ Πϕϯτͷ௨ॱংΛอূ͢ΔͨΊɺಧ͍ͨॱ৴༻ͤͣɺ λΠϜελϯϓΛجʹฒͼସ͑Δ ࣮ߦ͢ΔShell Scriptͷ಄Ͱ date ίϚϯυΛͬͯλΠϜελϯϓΛ औಘͯ͠Έͨ ҰॠͰϏϧυ͕ྃ͢Δ߹ɺΛղফͰ͖ͳ͔ͬͨ 😧
macOS ͷ date ίϚϯυϛϦඵϨϕϧ·ͰऔಘͰ͖ͳ͍͜ͱ͕໌ -
ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ func run(_ args: String...) { let task = Process()
task.launchPath = "/bin/sh" task.arguments = ["-c", args.joined(separator: " ")] task.launch() task.waitUntilExit() } run("gcc", "timestamp.c", "-o", "ts") CݴޠͰϛϦඵϨϕϧͷλΠϜελϯϓΛऔಘ͢ΔʢϏϧυฤʣ Process() ΛͬͯSwift͔ΒShellΛୟ͘ ༻ҙ͓͍ͯͨ͠CݴޠͷίʔυΛ gcc ͰίϯύΠϧ͢Δ -
CݴޠͰϛϦඵϨϕϧͷλΠϜελϯϓΛऔಘ͢Δʢ࣮ߦฤʣ ίϯύΠϧ࣮ͨ͠ߦϑΝΠϧΛ ~/.xchook ʹஔ͍͓ͯ͘ Run Scriptͷ࣮ߦ࣌ʹShell Scriptͷ಄Ͱ࣮ߦϑΝΠϧΛ͏ ΠϕϯτͷώετϦʔΛਖ਼͍͠ॱংͰऔಘ͢Δ XCMonitor Xcode
App Sandbox Behaviors >_ Shell Script Swift Script ~/.xchook $ C fi le & -
ҙͷϓϩδΣΫτΠϯυΛ࠷લ໘ʹදࣔͤ͞Δ ϓϩδΣΫτϑΝΠϧΛXcodeͰ։͘ NSWorkspace.shared.openApplication(at:con fi guration:) Ͱ XcodeΛ։͚ͩ͘ͰҙͷϑΝΠϧ։͚ͳ͍ NSWorkspace.shared.open(_:withApplicationAt:con fi guration:)
Ͱ ϑΝΠϧͷύεͱΞϓϦͷύεํΛࢦఆͯ͠։͘ ͜ͷ࣌ͷͨΊʹRun ScriptͰϓϩδΣΫτϑΝΠϧͷύεΛऔಘ͍ͯͨ͠ -
Run Scriptͷσόοάํ๏ BehaviorsͷRun Scriptʹ͓͍ͯඪ४ग़ྗ֬ೝͷํ๏͕ͳ͍ cat echo ίϚϯυɺSwift.print() Λͬͯ֬ೝͰ͖Δॴʹग़ྗ͞Εͳ͍ Console.appͰϩάϝοηʔδΛ֬ೝ͢Δ
Shell ScriptͰ logger -s Λ͏ SwiftͷεΫϦϓτͰ NSLog() Λ͏ Console.app