Goのtemplateパッケージ簡易チートシート

Tue, 19 Nov 2013 19:19:57 JST

goに標準でついてるtemplateパッケージは便利なのだけど、マニュアルが長すぎるのでよく使う機能だけまとめておく。

そろそろだれかテンプレートエンジンを標準化してほしい。

基本
変数展開
関数呼び出し
ループ
組み込み関数

基本

package main

import (
    "os"
    "text/template"
)

func main() {
    tmpl := "Hello, {{.template}}!"
    t := template.New("t")
    template.Must(t.Parse(tmpl))
    t.Execute(os.Stdout, map[string]string{"template": "World"})
}

ちなみに、template.Must(t.Parse(tmpl))は以下のショートカット

_, err := t.Parse(tmpl)
if err != nil {
    panic(err)
}

変数展開

通常はmapのキーかstructのメンバを.Keyのようにドット付きで指定するとでその値が展開される。ただし、該当するキーが見つからなかった場合、mapではという文字列が出力されるが、structではエラーになる。

type T struct {
    Name string
}

tmpl := "Hello, {{.Name}}!\n"
t := template.New("t")
template.Must(t.Parse(tmpl))

t.Execute(os.Stdout, map[string]string{"Name": "map"})
t.Execute(os.Stdout, T{Name: "struct"})
t.Execute(os.Stdout, &T{Name: "struct reference"})

.のようにドットだけを渡すと変数それ自体が展開される。

tmpl := "Hello, {{.}}!\n"
t := template.New("t")
template.Must(t.Parse(tmpl))
t.Execute(os.Stdout, "World")

関数呼び出し

関数はシェルのパイプのように連結させて呼びだせる。テンプレート内で呼ぶ関数はtemplate.FuncMapで渡す。

tmpl := `Now {{now}}, {{"hello" | toupper}}`
t := template.New("t")
t.Funcs(template.FuncMap{
    "now":     func() string { return time.Now().String() },
    "toupper": strings.ToUpper,
})
template.Must(t.Parse(tmpl))
t.Execute(os.Stdout, nil) // => Now 2013-11-19 19:17:51.378063751 +0900 JST, HELLO

ループ

組み込みのrange Actionをつかえばよい。

type T struct{ Name string }
tmpl := `
{{range .}}- {{.Name}}
{{end}}
`
t := template.New("t")
template.Must(t.Parse(tmpl))
t.Execute(os.Stdout, []T{
    {Name: "Alice"},
    {Name: "Bob"},
    {Name: "Charlie"},
    {Name: "Dave"},
})

その他、条件分岐等のActionはマニュアルのActionsの参照

組み込み関数

こちらもマニュアルのFunctionsの項を参照

GoConveyでGoプロジェクトをブラウザからテストする

Sun, 17 Nov 2013 00:30:57 JST

GoConvey を試してみたらなかなかよかったので紹介します。

goconveyとは

gopherのためのかっこいいテストツールです。以下のような特徴があります。

go testをそのまま実行できる
リグレッションテストのための一式
見やすく色付けされた出力
完全に自動化されたWeb UI
テストコードジェネレータ
デスクトップ通知
ターミナル上で動く自動テストスクリプト
Sublime Textとの連携

クイックスタート

$ go get github.com/smartystreets/goconvey # install
$ $GOPATH/bin/goconvey

上記コマンドを実行して http://localhost:8080 にブラウザからWeb UIアクセスすると、goconveyを起動したディレクトリ以下のファイルの更新を自動的に検知してテストを起動してくれます。

Web UIの右上にあるベルのアイコンをクリックすると、デスクトップ通知も有効にできます。

また、テストが失敗した場合はその部分をクリックすることで、Sublime Textで直接そこにジャンプできます。¹

特定のディレクトリ以下のテストを実行しないようにすることもできます。テストに時間がかかるような大きなプロジェクトでも適当に必要なところだけ有効にできるので、ストレスがたまりにくいと思います。

テストを書く

goconveyのWeb UIはgo testで起動できるテストならなんにでも使えますが² 、goconveyのテスティングフレームワークをつかうとさらにわかりやすい結果を出力できます。

package goconveytest

import (
    . "github.com/smartystreets/goconvey/convey"
    "testing"
)

func TestSpec(t *testing.T) {
    var x int

    // Only pass t into top-level Convey calls
    Convey("Given some integer with a starting value", t, func() {
        x = 1

        Convey("When the integer is incremented", func() {
            x++

            Convey("The value should be greater by one", func() {
                So(x, ShouldEqual, 1)
            })
        })
    })
}

Web UIから文章を入力することでテストコードをある程度自動生成することもできます。

BDDスタイルはあんまり得意ではないので詳細は省略します。

ターミナルから自動テスト

ブラウザなんて立ちあげたくない硬派な人向けにターミナルでファイル監視してテストを起動できるスクリプトも提供されています。 emacsのロックファイルがあると落ちてしまう問題があったのですが、さっきpull requestだしたらすぐマージしてくれました。 https://github.com/smartystreets/goconvey/pull/88

$GOPATH/src/github.com/smartystreets/goconvey/scripts/idle.py -v

tips

localhost:8080/latestにアクセスするとjsonでテスト結果がとれます
goconveyのWeb UIはGOPATH以下のパッケージのディレクトリで起動する必要があります (例えば、$GOPATH/src/github.com/yourname/packagename)

まとめ

goconveyを簡単に紹介しました。Web UIだけでも試す価値はあると思います。

ビデオでの解説もあります。ぶっちゃけこの記事を読むより動画を見たほうが早いです。

その他参考

残念なことにemacsやvimには対応していない ↩
ginkgoやtestifyのテストも実行できます。ただし、ginkgoのテスト結果はデフォルトだとエスケープシーケンスがそのまま表示されてしまいます ↩

mojavy.com