Swift
swtws

Swift Foundationにコントリビュートする

本エントリは Swift Tweets 2018 Winter でのツイートをまとめ、加筆修正したものです。実際のツイートについては、 2018/1/20 #swtws Swift Tweets 2018 Winter - Togetter をご覧下さい。

はじめに

これは昨年末、発見したFoundationのバグを見つけてPRを出した経験をまとめた発表です。
ちなみにまだマージされていないので、発表タイトルは過去形ではなく現在形です…。

あなたがSwiftのFoundation frameworkの挙動にバグを発見したとします。

さあ、どうしますか?
ひとつの方法としては、バグレポがあります。 https://bugs.swift.org/ に報告しましょう。
また、自分で直すというのも手です。Swiftはオープンソースです。Foundationリポジトリにも "We welcome contributions to Foundation!" とあります。やっちゃいましょう。

と言っても、まずはこれまでの議論のログを辿って、既知のバグではないことを確認する必要があります。
議論は、メーリングリストで行われています。それをたぐるのは正直かなり、相当めんどくさいです。
…が、朗報です!
つい昨日、メーリングリストの全議論は https://forums.swift.org/ へとインポートされ、検索しやすくなりました!
なおバグレポの https://bugs.swift.org/ は別管理のようですので、そちらはそちらで要チェック。

検索の結果、それが未知あるいは既知であっても未着手のバグで、それが自分で直せるものだった場合、コントリビュートチャンス到来です。バグを修正しましょう。


ここでSwiftコミッタの @rintaro さんより一言。

とのことですので、やっぱりバグレポは重複気にせずバンバン上げましょう!

コントリビューションの手順

手順はだいたい Getting Started に書かれているとおりなのですが、一応日本語で説明します。

環境構築

環境構築に必要なのは、

  • 最新バージョンのXcode
  • 最新バージョンのmacOS SDK
  • 現在のSwift toolchainのsnapshot (これは Trunk Development (master) のものという意味)

です。

Swift toolchainのsnapshot のダウンロード

https://swift.org/download/#snapshots にあるsnapshotのリストの、「Xcode」をクリックしてダウンロード。
👇これです。

dl_toolchain.png

だいぶサイズが大きいので気長に待ちつつ、並行してリポジトリのクローンの準備をしましょうか。


ここで Foundationコミッタ且つswiftenvコミッタの @ikesyo さんからの一言。

swiftenv はSwiftのVersion Managerです。

swiftenv install --list-snapshots でインストール可能なsnapshotのバージョンを一覧することができ、
swiftenv install <バージョン名> でそれをインストールできます。

リポジトリのクローン

話は戻ってリポジトリのクローンについてです。
https://github.com/apple/swift-corelibs-foundation をクローンして終わり……ではありません。
一点気をつける必要があるのは、 Foundation.xcworkspace には Foundation だけでなく XCTest も含まれているということ。
https://github.com/apple/swift-corelibs-xctest もクローンしてください。
クローンしたふたつのディレクトリは隣接させて配置し、 Foundation.xcworkspace を開いてください。

SwiftFoundation targetを選択してビルドすると、赤いビルドエラーが大量に出ます。

build_failed.png

toolchainのせいですね。snapshotのダウンロードが終わるまで何もできなさそうです。休憩!


☕️


さて、そろそろtoolchainのダウンロード終わりましたかね。休憩終わり!
toolchainの導入は簡単です。pkgを入れたら、Xcodeのメニューから画像のように選択するだけ。

toolchains.png

再度SwiftFoundation targetのビルドを試みれば、無事に成功です🎉

いよいよバグ修正本番!

バグ修正の手順は、実際に私が修正した https://github.com/apple/swift-corelibs-foundation/pull/1386 を元に解説します。
PRの内容は、Decimal型の極小値の定数が間違っていた(もっと小さな数を作ることができてしまう)のを直すというものです。
定数が記述された Decimal.swift を修正します。

なお、修正コミットのメッセージはリンク先のガイドラインに準じましょう。
https://swift.org/contributing/#contributing-code

実装ファイルを修正すれば終わり?
もちろんそれだけではなく、テストも必要ですね。 TestDecimal.swift も辻褄合わせて、あとはいつものように Product -> Test (⌘U) すれば…

no_test.png

…⁉️

Foundation のテスト

注意。
Foundationのテストは、普段Xcodeで書いているSwiftのプロジェクトとは違い、TestFoundation targetの Run で行います。
テスト結果はコンソールに出力されます。

test_console.png

どうやら18個のfailがあるようですね。
……えっマジで?
"failed" でコンソールをフィルタして確認してみると、

fails.png

どうやら16個のfailは元々のようです。…よくないけれど、ここはとりあえず無視しましょう。
ただ、もうふたつ(赤枠)は今回の修正の影響っぽいですね。これは通るように直しました。

これで対応は完璧! 
…と思ってPRを投げたところ、コアチームからコメントがつきました

pr_comments1.png

「この挙動が正しいことを保証するテストをいくつか、我々は追加できる?」

…どういうことだろう🤔と思いつつ「OK、やっといて!」とぶん投げたところ…

pr_comments2.png

「お前がテストを書くんだよ!」

😱
…今回のケース、既存テストの修正だけでなく、テストケース追加が必要みたいです。

Foundation のテスト(advanced)

テストの追加方法ですが、先述したとおり、普段の Xcode のテストとは少し勝手が違います。
普段であれば test で始まる func を実装すればテストスイートが自動認識してくれますが、 Foundation の場合、それを手作業で行う必要があります。
Foundation のテストケースは、 static var allTests : [(String, (TestDecimal) -> () throws -> Void)] に纏められています。ここにケースを追加し、該当するメソッドに適切なテスト内容を記述。

add_test.png

これで、今度こそ作業完了!…のはずです。

おわりに

正直なところ、本当にこれですべての正しい手順を踏めているのかはわかりません。なぜなら最後の対応をしてから半月経っても、コアチームからは対応へのレスポンスがないからです…たぶん大丈夫だとは思うんですが。
さらなるリテイクが来た場合には、このQiita記事を修正して続報を追記する予定です。尻切れトンボで申し訳ないです。🙇

とはいえ、Foundationのビルドは思ったよりも簡単です。Swiftコンパイラ開発環境構築のようにCUIコマンドを駆使する必要もなく、普段のOSS利用の延長線上で気軽に触ることができます。
ですので、ものは試しにFoundationのプロジェクトのビルドをしてみたり、テストを実行してみるだけでも面白いのではないでしょうか。

…以上で発表を終わります。ごTwee聴ありがとうございました!