Раздан-3

前回の記事でPharo のプロジェクトを github.com で公開する方法について説明した。

今回は、 Travis CI を使ってテストを自動実行させる方法について説明する。

前提

• Travis のアカウントを持っていること。
• github.com と連携済みであること。
• 自分のプロジェクトにテストパッケージを作っていること。

【重要】パッケージを保存する

先に進む前に、Monticello などでパッケージが保存されていることを確認する。テストも含め、いつでもパッケージ内容を元に戻せる状態にしておく方が安全・安心。

設定ファイルを作る

Travis CI でテストを実行させるために、リポジトリに２つのテキストファイルを作成する。

１つめは、 .smalltalk.ston である。内容は以下のようなもの。

SmalltalkCISpec {
  #loading : [
    SCIMetacelloLoadSpec {
      #baseline : 'MyProject',
      #directory : 'src',
      #platforms : [ #pharo ]
    }
  ]
}

MyProject の箇所は適宜修正する必要がある。

２つめは、 .travis.yml である。

language: smalltalk
sudo: false

notifications:
  email:
    on_success: never
    on_failure: always

os:
  - linux

smalltalk:
  - Pharo32-8.0
  - Pharo64-8.0

変更する必要のある箇所は、osのところと、smalltalkのところ。osは、他に osx が指定できる。（きっとwindowsも。詳しくは Travis CI のドキュメントを参照のこと）

smalltalk にはテストしたいイメージのバージョンを書く。このあたりの情報は以下のサイトで確認できる。

https://github.com/hpi-swa/smalltalkCI

上記を適当なテキストエディタで作成して、ローカルレポジトリのフォルダに保存しておく。

Shellで作業する

ローカルレポジトリ内で行った修正作業は、Iceberg では Commit できないので、Shell でコミットとプッシュを行う必要がある。作成したファイルをadd したあと、適当なコメントで commit して push する。

% git add .smalltalk.ston .travis.yml
% git commit -a -m 'add travis ci settings'
% git push

プッシュが完了したら Travis CI が自動的にテストを始めるはず。

Pharo で作業する

Pharo の環境にもどり、Iceberg でレポジトリのエントリを右クリックして Fetch を選ぶと、Up to date だったステータスが赤色の Detached Working Copy になる。

再度、右クリックして、 Repair Repository を選ぶ。そこで、Discard image changes and load repository version を選ぶ。ここで、Monticello などに保存していないパッケージの変更があると全て失われてしまうので、必ず保存しておく。問題なければ OK を押す。

続く画面で Checkout を押してレポジトリの状態が Up to date に戻れば完了。これ以降は、Iceberg でもコミット＆プッシュ後に Travis CI が自動的に動き出すようになる。

SqueakMap とか、SmalltalkHub とか、Smalltalk のプロジェクトを残す方法はいろいろあったけど、いまは github.com に残すのがナウい。

今年、立て続けに何個かプロジェクトを登録したけど、毎回忘れてしまうので備忘のために残しておく。

参考にしたサイトはこちら。

前提

• 自分の github アカウントが存在すること。
• 登録するプロジェクトのパッケージが作ってあること。（この記事では MyProject とする）
• travis でCIするなら、テスト用のパッケージも作っておく。（推奨、この記事では MyProject-Tests とする）

転ばぬ先の杖

何かのトラブルでせっかくのコードが失われないように、Monticello Browser でパッケージ（Testsパッケージも）を保存しておく。（方法は省略）

github.com での仕事

レポジトリの作成

github.com にログインして、新しいレポジトリを作る。

• Repository name は適当なものでよし。
• Description は適当なものでよし。
• 無料アカウントなので Public 一択。
• Initialize this repository with a README はチェックを入れておく。
• Add .gitignore では、Smalltalk を選ぶ。
• Add a license では、適当なライセンスを選ぶ。（自分はいつも MIT License）
• おわったら Create repository をクリックする。

レポジトリURLのコピー

出来上がったばかりのレポジトリが開かれたら、そのgithubアドレスをコピーする。

Code をクリックして、 Clone with SSH の下の欄の git@github.com: のテキストを全てコピーするか、その隣のアイコンをクリックする。

Pharo での仕事

Iceberg でローカルレポジトリを作る

Pharo を起動して Tools – Iceberg を選んで Iceberg を起動する。

右上のAddをクリックする。

• Clone remote repository を選ぶ。
• Remote URL に、先ほどコピーしたgithubレポジトリのアドレスを貼り付ける。

このままOKを押すと、いま使っているイメージのあるフォルダの下にローカルレポジトリが作られる。PharoLauncher を使っていて、イメージごと削除するのがイヤな場合は、必要に応じて Local directory の場所を変えておく。

問題なければ OK を押す。

ローカルレポジトリに src フォルダを作成する

ソース群を格納するためのsrc フォルダを作る。

Iceberg で作成したばかりのレポジトリのエントリを右クリックし、Extra を選んで Inspect … をクリックする。

Inspector が現れたら Raw タブを押して、コードエリアに以下を入力して do it する。

(self location / 'src') ensureCreateDirectory

特に問題が生じなければ、 Inspector を閉じて構わない。

Meta データを生成する

次にプロジェクトのメタデータを生成するために、再度レポジトリのエントリを右クリックして Repair repository を選ぶ。現れたダイアログで、Create project meta-data を選んで、OKを押すと、Edit Project のダイアログが現れる。

Code directory に先ほど作成した src フォルダが選ばれており、Format が Tonel になっていることを確認したら OK を押す。

BaselineOf パッケージを作る

パッケージの依存関係を明確にするために、BaselineOf クラスのサブクラスを作成する。作成したいパッケージが MyProject なら、以下のようにクラス定義する。

BaselineOf subclass: #BaselineOfMyProject
    instanceVariableNames: ''
    classVariableNames: ''
    package: 'BaselineOfMyProject'

必要なインスタンスメソッドは２つで、１つ目は projectClass メソッドである。

projectClass
    ^ MetacelloCypressBaselineProject

もう一つは baseline: メソッドである。必要なパッケージに応じて内容を適宜修正する必要がある。他のパッケージを参考に依存関係を示せばよい。

baseline: spec
  spec
    for: #common
    do: [ spec
            package: 'MyProject';
            package: 'MyProject-Tests'
            with: [ spec requires: #('MyProject') ] ]

パッケージを追加する

最後に関係する全てのパッケージを追加する。レポジトリのエントリをダブルクリックして Working copy of のダイアログを表示し、右上の Add Packages ボタンでパッケージ（本体、テスト、BaselineOf）を全てチェックし、Add で追加する。（図のようにパッケージ名を入力して絞り込んで置くとラク）

Commit + Push する

Iceberg の作業もほぼ終わり。Commit ボタンを押してコミット内容を確認して適当なコメントを書いたら、再度右下の Commit ボタンでコミット完了し、Push ボタンで github にプッシュする。

なお、下図のように Push changes to origin/main をチェックしておけば、コミットと同時にプッシュが行われる。

以上で github.com にパッケージがアップロードされた。

パッケージの内容を変更したときは、同様に Commit + Push すれば、その都度 github.com の内容も更新されていく。