Xamarin.Forms または私は如何にして心配するのをやめてバグを愛するようになったか
この記事はQiitaで公開されている 初心者向けXamarin Advent Calendar その2 の16日の記事 である .
[初心者さん・学生さん大歓迎！] Xamarin その2 Advent Calendar 2016 - Qiita
1週間遅れの公開となってしまった. 待っていた方がいたら申し訳ない.
また, 同じくQiitaで公開されている 東京理科大学 Advent Calendar 2016 の4日目の記事である.
東京理科大学 Advent Calendar 2016 - Qiita
こちらは空いていたところを後日埋めただけなので遅れたわけではない.
なお, 私は東京理科大学の学生 ではない のだが, 縁があって『神楽坂一丁目通信局』というサークルに邪魔している. 『神楽坂一丁目通信局』には, ここで紹介するような技術を取り扱っている人間がいる (はずだ) .
初心者向けAdvent Calendarであるものの, この記事ではXamarin.Formsをすでに使ったことがある方を対象とする. そのため, Xamarin.Formsは何か, といったことは解説しないのでご了承願いたい.
また, 私はWindowsを使う. ほかの環境のユーザーは適宜読みかえてほしい.
なお, これを初心者向けAdvent Calendarに登録したのは, 私自身が初心者だからだ. 8月頃に1, 2週間ほど使い, それっきりである. 詳しい方から見れば改善点があるかもしれないので, その際は遠慮なく伝えてほしい.
tl; dr
- Xamarin.FormsはOSS. 自分で直せる.
- 最低限バグレポートはしよう.
- UnitTestsにはVisual SutdioではなくXamarin Studioを使うべし.
- ビルドが通らなかったので記事の一部は未完成となってしまっている. 情報求む.
思った通り動かない! もしかしてバグ?
これまでXamarin.Formsを使ってきて, 思った通り動かない, バグかも, といった挙動に遭遇したことはないだろうか. なければそれに越したことはないのだが, 私の場合そのたった数週間のXamarin.Forms体験の中でぶち当たってしまった. 私はキレた.
Xamarin love OSS!
そんなときあなたならどうするだろうか? ここで注目したいのが, Xamarin.Formsはオープンソースであり, ソースコードがMITライセンスの下で公開されているということだ.
GitHub - xamarin/Xamarin.Forms: Xamarin.Forms official home
もちろん, 諦めるのも選択肢の一つではある. バグ修正には手間がかかり, チームで開発しているのなら修正を共有する必要がある. だが, Xamarin.Formsは自分で直せる. 時間があるのなら一度バグ修正に挑戦してみるのはどうだろうか. 使っているプロダクトの内部を知ることは多少なりとも意味はあるし, 公開されたバグ修正によって, いざというときは自分で直せるだけの能力があるということも示せるだろう.
バグレポートをしよう
時間がないという場合でも, 最低限バグレポートすることをお勧めする. Xamarin.Formsのバグは Bugzilla で管理されている. Bugzillaは, OSSでよく使われているバグトラッカーである. Webのインターフェイスがあり, そこでバグの閲覧, 報告ができる.
バグを報告する前に, 既に報告されていないか確認しよう. バグレポートは英語だが, 日本の中学校で確実に学んだのなら問題ないはずだ.
バグを直そう
さて, バグを直そう. でも, その前に準備.
準備
Xamarin Studioをインストールする
Xamarin.FormsにはUnitTestsとUITestsの2つのテストの種類がある. 残念だが, Visual StudioでUnitTestsのテストを実行する方法を確認できなかった. 仕方がないので, Xamarin Studioをインストールする. しかし, Windowsユーザーにとってはこれが結構ややこしい. なお, UITestsは環境依存であり, WindowsのテストにはVisual Studioが必要だ.
まず, Xamarinの公式サイトに向かう. 右上に’Sign in’とあるので, これを選択. ‘Products’とかは罠なので無視する. もれなくVisual Studioをインストールさせられてしまう.
‘Sign in’のページに移ったら, 左下に’Create a new account’とあるのでここからアカウントを作成する.
アカウントを作成し, サインインしたら’Dashboard’に向かう.
‘Dashboard’から’Downloads’に向かい, ‘View all versions’を選ぶ. 大きい’Download Xamarin’のボタンは罠だ. 回避せよ.
すると各OSのプルダウンが現れるので, Windowsを選択する. そして, ‘Product Versions’から選ぶ. ‘Universal Installer’も罠だ. ‘Download (Recommended)’とか言ってるが無視すべし.
インストーラーを起動させると, Gtk#などを求めてくるようだ. 適宜インストールし, 環境を整えよう. WindowsのGtk#はMonoのページからダウンロードできる.
ソースコードをダウンロードする
次にソースコードをダウンロードしてくる. Xamarin Studioを起動し, 『バージョン管理(N)』から,
『チェックアウト(H)…』を選ぶ. リポジトリの種類はGit, URLは
https://github.com/xamarin/Xamarin.Forms.git である. それぞれ指定したら,
『チェックアウト』する.
バグ修正
ようやくバグ修正に取り掛かれる. ソースコードを読むなり, Debug.WriteLineデバッグするなり,
テキトーな方法 (?) でバグを特定しよう. Xamarin.Formsのコードは読みやすいので,
簡単に特定できるはずだ. 特定したら, 状況に合わせてテストコードを追加する.
.UnitTestsや.UITestsとあるプロジェクトがそれである. テストコードを追加したら,
テストを行い, 現時点でテストが通らないことを確認, 修正後に再度テストを実行して問題が解決していることを確認しよう.
また, その修正によって既存のテストが壊れないことを確認しよう.
Xamarin.Formsは.NET Foundationのコーディング規約に従う.
変更が完了したら, コミットを作成しよう.
使ってみる
実は, この項は完成していない. テストだけでなく, 実際に問題が発生したソフトウェアで修正したXamarin.Formsを使ってみるということが修正の検証には有用だし, 当然, バグ修正するときの最終目標のはずだ. しかしなぜか, この記事を書くために試したビルドが通らなかった. これではより詳細な情報はかけない. 以下に最低限の情報を記しておく.
まず第一に, ビルドにはVisual Studioを使うこと. そうしなければWindowsのビルドができない.
次に, ドキュメントの生成のために直下にあるMakefileを用いる, あるいは参考にすること.
Windowsではそのままでは使えない. コマンドは少ないので手で打ってもよいし,
修正を加えてCygwinやMSYSなどを用いてもよい. Windows Subsystem for Linuxを使えば全くの変更なしでも使えるだろう.
最後に, nupkgを生成するために.nuspecディレクトリ以下のspecを用いること.
以上が特に注意すべき点である. 私の環境では, Xamarin.Forms.Androidのビルドで失敗してしまった.
Xamarin.Androidのアセンブリ参照が狂っているのではないかと疑っているが, 解決していない.
解決策が思い浮かんだ方がいたらぜひ教えてほしい.
コントリビュートする
コントリビュートする前に, ‘Contribution License Agreement’ (CLA) に署名する必要がある. 内容は当り障りのないことだが, 短いので目を通しておくとよい.
https://cla2.dotnetfoundation.org/
CLAを署名, 提出したら準備は完了だ.
Xamarin.FormsのコントリビューションはGitHubのPull Request機能を用いる. GitHub上でXamarin.Formsをフォークし, それに変更をプッシュ, そしてPull Requestを発行しよう. あとはレビューが行われ, 適当と判断されたらマージされる.
最後に
ビルドが通らなかったのは非常に惜しい. それができないことには, NuGetにパッケージをアップロードしたり, NuGet.Serverを使ったりしてチームと修正を共有するとかいうことも書けない. クリスマスはぼっちなので, ビルドを直す方法をじっくり考えたいと思う.
最後に, 読者の方が楽しいクリスマスを過ごせることを願っている.
