List of Cli [text.Baldanders.info]

“Philosophers” を Go で解く（CLI）

2025-09-03T09:34:53+00:00

コマンドライン・インタフェース

実際に問題を解く前にコマンドライン・インタフェースを整えておく。 CLI には spf13/cobra パッケージを使用する。詳細については，ちょっと古い内容だが「Cobra でテストしやすい CLI を構成する」を参考にどうぞ。この記事では結果だけ示す。

$ go run github.com/spiegel-im-spiegel/philo -h
Simulation for philosophers' problem.

Usage:
  philo [flags]
  philo [command]

Available Commands:
  help        Help about any command
  version     print the version number

Flags:
      --debug   for debug
  -h, --help    help for philo

Use "philo [command] --help" for more information about a command.

なおリポジトリは以下にある。

Philosophers - I never thought philosophy would be so deadly

パラメータの定義

問題で指示されているパラメータを今一度挙げる。

シンボル型説明

NumPhilos int 哲学者およびフォークの数（$\ge 2$）

TimeDie int 餓死するまでの時間（$\gt 0\,\mathrm{ms}$）

TimeEat int 「食べる」時間（$\gt 0\,\mathrm{ms}$）

TimeSleep int 「眠る」時間（$\gt 0\,\mathrm{ms}$）

TimeThink int 「考える」時間（$\ge 0\,\mathrm{ms}$）

NumEat int 各哲学者が最低限食事を行う回数（$\ge 0$）

シンボル	型	説明
`NumPhilos`	`int`	哲学者およびフォークの数（$\ge 2$）
`TimeDie`	`int`	餓死するまでの時間（$\gt 0\,\mathrm{ms}$）
`TimeEat`	`int`	「食べる」時間（$\gt 0\,\mathrm{ms}$）
`TimeSleep`	`int`	「眠る」時間（$\gt 0\,\mathrm{ms}$）
`TimeThink`	`int`	「考える」時間（$\ge 0\,\mathrm{ms}$）
`NumEat`	`int`	各哲学者が最低限食事を行う回数（$\ge 0$）

これをコマンドラインから設定できるようにする。先に指定したパラメータを格納する型を定義しよう。

// Params holds tunable configuration values for a Dining Philosophers simulation.
type Params struct {
	NumPhilos int // Total number of philosophers (and forks). Must be >= 2.
	TimeDie   int // Maximum time in milliseconds a philosopher can go without eating before being considered dead.
	TimeEat   int // Time in milliseconds a philosopher spends eating (holding both forks).
	TimeSleep int // Time in milliseconds a philosopher sleeps after eating.
	TimeThink int // Optional target time in milliseconds a philosopher thinks after sleeping.
	NumEat    int // Optional target number of meals each philosopher must consume; if == 0 the simulation runs until a death occurs.
}

// String returns a human-readable summary of the Params configuration,
// listing the number of philosophers, each lifecycle duration (die, eat,
// sleep, think in milliseconds), and the required number of meals.
// Example:
//
//	Philosophers: 5, Die: 800ms, Eat: 200ms, Sleep: 200ms, Think: 0ms, Eat Count: 3
func (p *Params) String() string {
	return fmt.Sprintf("Philosophers: %d, Die: %dms, Eat: %dms, Sleep: %dms, Think: %dms, Eat Count: %d",
		p.NumPhilos, p.TimeDie, p.TimeEat, p.TimeSleep, p.TimeThink, p.NumEat)
}

いやぁ，今どきは AI がコメントを書いてくれるから楽でいいね（笑）これを前節の CLI と接続する。こんな感じ。

$ go run github.com/spiegel-im-spiegel/philo -h
Simulation for philosophers' problem.

Usage:
  philo [flags]
  philo [command]

Available Commands:
  help        Help about any command
  version     print the version number

Flags:
      --debug              for debug
  -h, --help               help for philo
  -m, --must-eat int       number of times each philosopher must eat (default 3)
  -p, --philosophers int   number of philosophers (default 5)
  -d, --to-die int         time to die (ms) (default 200)
  -e, --to-eat int         time to eat (ms) (default 20)
  -s, --to-sleep int       time to sleep (ms) (default 80)
  -t, --to-think int       time to think (ms) (default 80)

Use "philo [command] --help" for more information about a command.

デフォルト値は適当で。今のところはパラメータの内容を表示するだけの処理にしておく。

$ go run github.com/spiegel-im-spiegel/philo -h
Philosophers: 5, Die: 200ms, Eat: 20ms, Sleep: 80ms, Think: 80ms, Eat Count: 3

CLI 部分はここまで。これで本来のシミュレーション・ロジックを組み込む準備は完了である。次回から実際に問題を解いていく。

参考図書

Go言語で学ぶ並行プログラミング　他言語にも適用できる原則とベストプラクティス impress top gearシリーズ: James Cutajar (著), 柴田芳樹 (著); インプレス 2024-12-04 (Release 2024-12-04); Kindle版; B0DNYMMBBQ (ASIN); 評価

読書会のために購入。インプレス社の本は Kindle 版より版元で PDF 版を買うのがオススメ。「並行処理」について原理的な解説から丁寧に書かれている。 Go で解説されているが Go 以外の言語でも応用できる。

reviewed by Spiegel on 2025-01-25 (powered by PA-APIv5)

Go言語による並行処理: Katherine Cox-Buday (著), 山口能迪 (翻訳); オライリージャパン 2018-10-26; 単行本（ソフトカバー）; 4873118468 (ASIN), 9784873118468 (EAN), 4873118468 (ISBN); 評価

Eブック版もある。感想はこちら。 Go 言語で並行処理を書くならこの本は必読書になるだろう。

reviewed by Spiegel on 2020-01-13 (powered by PA-APIv5)

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

著者のひとりは（あの「バイブル」とも呼ばれる）通称 “K&R” の K のほうである。この本は Go 言語の教科書と言ってもいいだろう。と思ったら絶版状態らしい（2025-01 現在）。復刊を望む！

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Go言語 100Tips ありがちなミスを把握し、実装を最適化する impress top gearシリーズ: Teiva Harsanyi (著), 柴田芳樹 (著); インプレス 2023-08-18 (Release 2023-08-18); Kindle版; B0CFL1DK8Q (ASIN); 評価

版元で PDF 版を購入可能。事実上の Effective Go とも言える充実の内容。オリジナルは敢えてタイトルに “tips” という単語を入れるのを避けたのに邦題が「100 Tips」とかなっていて，原作者がお怒りとの噂（あくまで噂）

reviewed by Spiegel on 2023-08-18 (powered by PA-APIv5)

Goならわかるシステムプログラミング第2版: 渋川よしき (著), ごっちん (イラスト); ラムダノート 2022-03-23; 単行本（ソフトカバー）; 4908686122 (ASIN), 9784908686122 (EAN), 4908686122 (ISBN); 評価

第1版はとてもためになる内容だったので第2版も PDF 版で確保しておく。

reviewed by Spiegel on 2022-10-08 (powered by PA-APIv5)

Go 製のツールとパッケージをまとめてアップデートした

2020-10-02T07:40:54+00:00

GitHub リポジトリにある Go 言語製のツールやパッケージについて GitHub Actions で CI (Continuous Integration) を回す目処が立ったので，設定を変更しリリースし直すことにした。今回リリースしたツール・パッケージのうち主なものは以下の通り。

若干 lint に叱られたり軽微なバグを指摘されたりしたものもあるが，機能上の追加・変更はない。

それじゃあ，次のステージに行きましょう♪

ブックマーク

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

射手座☆午後九時Don't be late: シェリル・ノーム starring May'n (メインアーティスト); FlyingDog 2008-05-08 (Release 2017-01-16); MP3 ダウンロード; B01MZ8UA8O (ASIN); 評価

移動中に聴くとノリノリになれる（笑）

reviewed by Spiegel on 2020-10-02 (powered by PA-APIv5)

Go 言語用 CLI プログラミング支援パッケージ

2019-09-07T02:55:58+00:00

goark/gocli: Minimal Packages for Command-Line Interface

本パッケージ gocli は Go 言語で CLI (Command-Line Interface) を構成する際に必要になるであろう細々とした機能をまとめたライブラリである。ただし，このパッケージをそのまま使うことは想定しておらず（そのまま使ってもいいけど）何らかのアレンジを加えた上で，それぞれの CLI ツール用に組み込むことを念頭に置いている。

このため gocli では Go コンパイラが提供する標準パッケージ以外の外部パッケージはなるべく使わないようにし，ライセンスも，あらゆる権利を放棄した CC0 を設定している。

なお gocli パッケージは Go 1.13 以上を要求する。ご注意を。

標準入出力と終了コード

gocli/rwi パッケージは標準入出力をコンテキスト情報として格納する構造体を提供する。また gocli/exitcode パッケージは CLI 終了時の終了コードを定義する。

両者は以下のように使う。

package main

import (
    "os"

    "github.com/goark/gocli/exitcode"
    "github.com/goark/gocli/rwi"
)

func run(ui *rwi.RWI) exitcode.ExitCode {
    ui.Outputln("Hello world")
    return exitcode.Normal
}

func main() {
    run(rwi.New(
        rwi.WithReader(os.Stdin),
        rwi.WithWriter(os.Stdout),
        rwi.WithErrorWriter(os.Stderr),
    )).Exit()
}

gocli/rwi パッケージを使うメリットはテストで発揮される。たとえば上述の run() 関数をテストするのであれば

outBuf := new(bytes.Buffer)
outErrBuf := new(bytes.Buffer)
code := run(rwi.New(
    rwi.WithWriter(outBuf),
    rwi.WithErrorWriter(outErrBuf),
))

として実行結果を code, outBuf および outErrBuf から取り出し評価することができる。

SIGNAL をハンドリングする

【2021-09-19 追記】

Go 1.16 から signal.NotifyContext() が導入され context パッケージと連携できるようになった。本節の機能は既に deprecated であり，利用はおすすめしない。

gocli/signal パッケージは標準の context パッケージと組み合わせて SIGNAL のハンドリングを行う。たとえば，こんな感じ

package main

import (
    "context"
    "fmt"
    "os"
    "time"

    "github.com/goark/gocli/signal"
)

func ticker(ctx context.Context) error {
    t := time.NewTicker(1 * time.Second) // 1 second cycle
    defer t.Stop()

    for {
        select {
        case now := <-t.C: // ticker event
            fmt.Println(now.Format(time.RFC3339))
        case <-ctx.Done(): // cancel event from context
            fmt.Println("Stop ticker")
            return ctx.Err()
        }
    }
}

func Run() error {
    errCh := make(chan error, 1)
    defer close(errCh)

    go func() {
        child, cancelChild := context.WithTimeout(
            signal.Context(context.Background(), os.Interrupt), // cancel event by SIGNAL
            10*time.Second, // timeout after 10 seconds
        )
        defer cancelChild()
        errCh <- ticker(child)
    }()

    err := <-errCh
    fmt.Println("Done")
    return err
}

func main() {
    if err := Run(); err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
}

このコードでは signal.Context() 関数で指定した SIGNAL 用の context.Context インスタンスを生成している。 SIGNAL または親 context.Context インスタンスによるキャンセルイベントを受信した場合は，子 context.Context インスタンスにキャンセルが伝搬する。

context パッケージを使ったキャンセルの伝搬については以下を参照のこと。

time.Ticker で遊ぶ

ワイルドカードを含むファイルの検索

gocli/file パッケージを使ったファイル検索は標準の filepath.Glob() 関数を拡張する形で実装している。こんな感じに使える。

package main

import (
    "fmt"

    "github.com/goark/gocli/file"
)

func main() {
    result := file.Glob("**/*.[ch]", nil)
    fmt.Println(result)
    // Output:
    // [testdata/include/source.h testdata/source.c]
}

file.Glob() 関数の第2引数には検索時の条件を設定できる。こんな感じ。

package main

import (
    "fmt"

    "github.com/goark/gocli/file"
)

func main() {
    result := file.Glob(
        "**/*.[ch]",
        file.NewGlobOption(file.WithFlags(file.GlobStdFlags|file.GlobAbsolutePath)))
    fmt.Println(result)
    // Output:
    // [/home/username/work/gocli/file/testdata/include/source.h /home/username/work/gocli/file/testdata/source.c]
}

指定できるフラグは以下の通り。

//Operation flag in Glob() function.
const (
    GlobContainsFile GlobFlag = 1 << iota
    GlobContainsDir
    GlobSeparatorSlash
    GlobAbsolutePath
    GlobStdFlags = GlobContainsFile | GlobContainsDir
)

file.Glob() 関数の第2引数に nil をセットするか file.NewGlobOption() を引数なしで呼び出した場合は file.GlobStdFlags のみがセットされる。

gocli/file パッケージはファイル操作の練習用に作ったもので，それなりには使えるとは思うが，正直に言って素朴すぎて効率はよくない。実際に使うにはもう少しアレンジが必要になるだろう。

設定ファイルのパスを取得する

Go 1.13 から os.UserConfigDir() 関数が追加されたので，これを使って設定ファイルのパスを取得するパッケージ gocli/config を作ってみた。こんな感じで使う。

package main

import (
    "fmt"

    "github.com/goark/gocli/config"
)

func main() {
    path := config.Path("app", "config.json")
    fmt.Println(path)
    // Output:
    // /home/username/.config/app/config.json
}

アプリケーション名を指定して設定用ディレクトリのパスを取得する config.Dir(appName string) 関数も用意した。

os.UserConfigDir() 関数で取得したパスにアプリケーション名と設定ファイル名をくっ付けただけの簡単なお仕事である。 Go 1.13 では os.UserConfigDir() 関数は以下のように記述されている。

// UserConfigDir returns the default root directory to use for user-specific
// configuration data. Users should create their own application-specific
// subdirectory within this one and use that.
//
// On Unix systems, it returns $XDG_CONFIG_HOME as specified by
// https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html if
// non-empty, else $HOME/.config.
// On Darwin, it returns $HOME/Library/Application Support.
// On Windows, it returns %AppData%.
// On Plan 9, it returns $home/lib.
//
// If the location cannot be determined (for example, $HOME is not defined),
// then it will return an error.
func UserConfigDir() (string, error) {
    var dir string

    switch runtime.GOOS {
    case "windows":
        dir = Getenv("AppData")
        if dir == "" {
            return "", errors.New("%AppData% is not defined")
        }

    case "darwin":
        dir = Getenv("HOME")
        if dir == "" {
            return "", errors.New("$HOME is not defined")
        }
        dir += "/Library/Application Support"

    case "plan9":
        dir = Getenv("home")
        if dir == "" {
            return "", errors.New("$home is not defined")
        }
        dir += "/lib"

    default: // Unix
        dir = Getenv("XDG_CONFIG_HOME")
        if dir == "" {
            dir = Getenv("HOME")
            if dir == "" {
                return "", errors.New("neither $XDG_CONFIG_HOME nor $HOME are defined")
            }
            dir += "/.config"
        }
    }

    return dir, nil
}

キャッシュ用のディレクトリ・ファイルのパスを取得する

os.UserCacheDir() 関数を使ってキャッシュ用のディレクトリ・ファイルのパスを取得するパッケージ gocli/cache を作ってみた。こんな感じで使う。

package main

import (
    "fmt"

    "github.com/goark/gocli/cache"
)

func main() {
    path := cache.Path("app", "access.log")
    fmt.Println(path)
    // Output:
    // /home/username/.cache/app/access.log
}

os.UserCacheDir() 関数で取得したパスにアプリケーション名とファイル名をくっ付けただけの簡単なお仕事である。 Go 1.13 では os.UserCacheDir() 関数は以下のように記述されている。

// UserCacheDir returns the default root directory to use for user-specific
// cached data. Users should create their own application-specific subdirectory
// within this one and use that.
//
// On Unix systems, it returns $XDG_CACHE_HOME as specified by
// https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if
// non-empty, else $HOME/.cache.
// On Darwin, it returns $HOME/Library/Caches.
// On Windows, it returns %LocalAppData%.
// On Plan 9, it returns $home/lib/cache.
//
// If the location cannot be determined (for example, $HOME is not defined),
// then it will return an error.
func UserCacheDir() (string, error) {
    var dir string

    switch runtime.GOOS {
    case "windows":
        dir = Getenv("LocalAppData")
        if dir == "" {
            return "", errors.New("%LocalAppData% is not defined")
        }

    case "darwin", "ios":
        dir = Getenv("HOME")
        if dir == "" {
            return "", errors.New("$HOME is not defined")
        }
        dir += "/Library/Caches"

    case "plan9":
        dir = Getenv("home")
        if dir == "" {
            return "", errors.New("$home is not defined")
        }
        dir += "/lib/cache"

    default: // Unix
        dir = Getenv("XDG_CACHE_HOME")
        if dir == "" {
            dir = Getenv("HOME")
            if dir == "" {
                return "", errors.New("neither $XDG_CACHE_HOME nor $HOME are defined")
            }
            dir += "/.cache"
        }
    }

    return dir, nil
}

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

spiegel-im-spiegel/gocli v0.10.1 のリリース

2019-09-07T02:55:58+00:00

Go 言語用 CLI プログラミング支援パッケージ gocli v0.10.1 をリリースした。

Release v0.10.1 · spiegel-im-spiegel/gocli · GitHub

実は『改訂2版みんなのGo言語』を読んで「そろそろ設定ファイルの置き場所を何とかしなくちゃ」と思ってこっそり v0.10.0 をリリースしたのだが， Go 1.13 で os.UserConfigDir() 関数が用意されているのを知って「もうこれでいいぢゃん」てな感じになり，書き直した。こんな感じに使える。

package main

import (
	"fmt"

	"github.com/spiegel-im-spiegel/gocli/config"
)

func main() {
	path := config.Path("app", "config.json")
	fmt.Println(path)
	// Output:
	// /home/username/.config/app/config.json
}

書き直した結果 os.UserConfigDir() 関数で取得したパスにアプリケーション名と設定ファイル名をくっ付けただけの簡単なお仕事になった（笑）私は設定ファイルと CLI との連携に spf13/viper を使っているので，これで必要十分。

gocli の使い方について詳しくは以下を参照のこと。

Go 言語用 CLI プログラミング支援パッケージ

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

改訂2版みんなのGo言語: 松木雅幸 (著), mattn (著), 藤原俊一郎 (著), 中島大一 (著), 上田拓也 (著), 牧大輔 (著), 鈴木健太 (著); 技術評論社 2019-08-01 (Release 2019-08-01); Kindle版; B07VPSXF6N (ASIN); 評価

改訂2版の目玉は7章の「データベースの扱い方」が追加されたことだろう。他の章では，大まかな構成は1版と同じだが細かい部分が変わっていて Go 1.12 への言及まであるのには驚いた。

reviewed by Spiegel on 2019-08-12 (powered by PA-APIv5)

gjq v0.2.0 をリリースした

2019-03-17T12:34:01+00:00

昨日の今日で恐縮だが [spiegel-im-spiegel/gjq] v0.2.0 をリリースした。

Release v0.2.0 · spiegel-im-spiegel/gjq · GitHub

2つほどオプションを追加した。

$ gjq -h
Usage:
  gjq [flags] <filter string>

Flags:
  -c, --clipboard     copy to clipboard in interactive mode
  -C, --color         colorize JSON
      --debug         for debug
  -f, --file string   JSON data (file path)
  -h, --help          help for gjq
  -i, --indent int    indent size for formatted JSON string (default 2)
  -I, --interactive   interactive mode
  -t, --tab           use tabs for indentation
  -u, --url string    JSON data (URL)
  -v, --version       output version of gjq

小文字の -c をつけると対話モード時にフィルタリング結果をクリップボードにコピーする。逆にこのオプションを付けないとクリップボードへのコピーは行わないようにした。対話モードは Ctrl+C を入力するまで続くが，この割り込みタイミングで直前の結果をクリップボードにコピーする。

大文字の -C オプションでフィルタリング結果をカラー表示できるようにした。ファイルやクリップボードへの出力には影響しない（筈）。

JSON 文字列のカラー化には以下の2つのパッケージを利用している。

いやぁ，おかげさまで実装がめっさ簡単だったわ（笑）

あと Windows とそれ以外のプラットフォームとの差を吸収するために

mattn/go-colorable

を利用している。たとえば

fmt.Fprintln(colorable.NewColorableStdout(), string(coloredJSONbytes))

とかすればプラットフォームに関係なく ANSI 標準のエスケープシーケンスを使って文字に色を付けることができる。

これで「jq ぽい何か」でやりたいことはだいたい実装できたので本来の作業へ戻るとしよう。

ブックマーク

jq ぽい何かを書いてみた

[spiegel-im-spiegel/gjq]: https://github.com/spiegel-im-spiegel/gjq “spiegel-im-spiegel/gjq: Another Implementation of “jq” by golang”

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

jq ぽい何かを書いてみた

2019-03-16T14:12:32+00:00

ウソです。ほとんど自力じゃありません（笑）

JSON データを操作できる jq はとても高機能で使い勝手もいいのだが，純粋にフィルタとして機能するため Windows 環境では微妙に使いづらい場合がある。具体的には

入力が標準入力のみなのでリダイレクトやパイプと組み合わせる必要がある
対話モードがない

といったところ。大した問題ではないのだがどうにかならないかなぁ，と思っていた。

んで，どなたか Go 言語で書いている人がいるんじゃないかと思って探してみたら以下のツール/パッケージを見つけた。

simeji/jid はよく出来ていると思うのだが，残念なことに ConEmu 上で動かすと表示がぶっ壊れる（コマンドプロンプトでは問題ない）。 savaki/jq と apang1992/jq はパッケージだが，ここ2,3年は更新されていないようである。

私が Windows を捨てれば simeji/jid で全然 OK なのだが（そのうち捨てる），鼻の先はそういうわけにもいかないので，自分用に CLI を書いてみることにした。

spiegel-im-spiegel/gjq

コマンドライン・オプションは以下の通り。

$ gjq -h
Usage:
  gjq [flags] <filter string>

Flags:
      --debug         for debug
  -f, --file string   JSON data (file path)
  -h, --help          help for gjq
  -i, --indent int    indent size for formatted JSON string (default 2)
  -I, --interactive   interactive mode
  -t, --tab           use tabs for indentation
  -u, --url string    JSON data (URL)
  -v, --version       output version of gjq

パーサには savaki/jq を使っている。フィルタの文法は以下の通り。

syntax	meaning
`.`	unchanged input
`.foo`	value at key
`.foo.bar`	value at nested key
`.[0]`	value at specified element of array
`.[0:1]`	array of specified elements of array, inclusive
`.foo.[0]`	nested value

まずは jq と同じようにフィルタとして使うならこんな感じ。

$ cat testdata/test.json
{
  "string": "a",
  "number": 1.23,
  "simple": ["a", "b", "c"],
  "mixed": [
    "a",
    1,
    {"hello":"world"}
  ],
  "object": {
    "first": "joe",
    "array": [1,2,3]
  }
}

$ gjq .object.array < testdata/test.json
[
  1,
  2,
  3
]

$ cat testdata/test.json | gjq .mixed
[
  "a",
  1,
  {
    "hello": "world"
  }
]

インデントは -i オプションで調整できるが 0 をセットすると

$ gjq -i 0 .mixed < testdata/test.json
["a",1,{"hello":"world"}]

とコンパクトになる。

また -f オプションでファイルを直接指定することもできる。

$ gjq -f testdata/test.json .object.array
[
  1,
  2,
  3
]

さらに -u オプションで URL を指定すれば Web 上のファイルも対象になる¹。

$ gjq -u https://text.baldanders.info/index.json .entry.[0]
{
  "title": "猫を殺すに猫を以ってせよ",
  "section": "remark",
  "description": "分かるかな。分っかんねーだろうな（反語）",
  "author": "Spiegel",
  "license": "http://creativecommons.org/licenses/by-sa/4.0/",
  "url": "https://text.baldanders.info/remark/2019/03/no-cat-no-life/",
  "published": "2019-03-11T13:51:41+00:00",
  "update": "2019-03-11T13:53:40+00:00"
}

さらにさらに -I オプションを付けると対話モードになる。

$ gjq -u https://text.baldanders.info/index.json -I
Press Ctrl+C to stop
Filter> .title
"text.Baldanders.info"
Filter> .entry.[0]
{
  "title": "猫を殺すに猫を以ってせよ",
  "section": "remark",
  "description": "分かるかな。分っかんねーだろうな（反語）",
  "author": "Spiegel",
  "license": "http://creativecommons.org/licenses/by-sa/4.0/",
  "url": "https://text.baldanders.info/remark/2019/03/no-cat-no-life/",
  "published": "2019-03-11T13:51:41+00:00",
  "update": "2019-03-11T13:53:40+00:00"
}
Filter>

対話モードではクリップボードにも出力されるのでターミナル上でコピペする必要はない。また JSON データは起動時に1度だけ GET するので，安心して対話モードで弄れる（笑）

さて次は色を付けてみるかな。 Go 言語でターミナル出力に色を付けるってどうやるんだろ。調べてみるか。

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

-u オプションは HTTP/HTTPS の GET で対象を取得する。 POST には対応してないのであしからず。 POST で取ってくる必要があるなら潔く curl を使ったほうがいいだろう。 ↩︎

spiegel-im-spiegel/gocli v0.9.1 をリリースした

2019-02-09T13:00:33+00:00

CLI で使える細々した機能を詰め合わせた自作パッケージ spiegel-im-spiegel/gocli の v0.9.1 をリリースした。

spiegel-im-spiegel/gocli: Minimal Packages for Command-Line Interface

対話モードで動かしたいツールがあって，それ用に使えるサブパッケージ gocli/prompt を追加してみた。

こんな感じに書ける。

package main

import (
    "fmt"
    "os"

    "github.com/spiegel-im-spiegel/gocli/prompt"
    "github.com/spiegel-im-spiegel/gocli/rwi"
)

func main() {
    p := prompt.New(
        rwi.New(
            rwi.WithReader(os.Stdin),
            rwi.WithWriter(os.Stdout),
        ),
        func(s string) (string, error) {
            if s == "q" || s == "quit" {
                return "quit prompt", prompt.ErrTerminate
            }
            runes := []rune(s)
            for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 {
                runes[i], runes[j] = runes[j], runes[i]
            }
            return string(runes), nil
        },
        prompt.WithPromptString("Sample> "),
        prompt.WithHeaderMessage("Input 'q' or 'quit' to stop"),
    )
    if !p.IsTerminal() {
        fmt.Fprintln(os.Stderr, "not terminal (or pipe?)")
        return
    }
    if err := p.Run(); err != nil {
        fmt.Fprintln(os.Stderr, err)
    }
}

このコードでは入力した文字列を逆順に並べ替えて出力する。 “q” または “quit” を入力するとプログラムを終了する。

これを動かすとこんな感じ。

$ go run prompt/sample/sample.go
Input 'q' or 'quit' to stop
Sample> abcdef
fedcba
Sample> quit
quit prompt

ちなみに github.com/atotto/clipboard と組み合わせて

package main

import (
    "fmt"
    "os"

    "github.com/atotto/clipboard"
    "github.com/spiegel-im-spiegel/gocli/prompt"
    "github.com/spiegel-im-spiegel/gocli/rwi"
)

func main() {
    p := prompt.New(
        rwi.New(
            rwi.WithReader(os.Stdin),
            rwi.WithWriter(os.Stdout),
        ),
        func(s string) (string, error) {
            if s == "q" || s == "quit" {
                return "quit prompt", prompt.ErrTerminate
            }
            runes := []rune(s)
            for i, j := 0, len(runes)-1; i < j; i, j = i+1, j-1 {
                runes[i], runes[j] = runes[j], runes[i]
            }
            res := string(runes)
            return res, clipboard.WriteAll(res)
        },
        prompt.WithPromptString("Sample> "),
        prompt.WithHeaderMessage("Input 'q' or 'quit' to stop"),
    )
    if !p.IsTerminal() {
        fmt.Fprintln(os.Stderr, "not terminal (or pipe?)")
        return
    }
    if err := p.Run(); err != nil {
        fmt.Fprintln(os.Stderr, err)
    }
}

とか書けば標準出力への出力と同時にクリップボードにも出力される。

spiegel-im-spiegel/gocli パッケージは CLI を組む際に（主に自分が）便利な細々とした機能を収録している。他の人には使いにくいかもしれないし大した内容でもないため CC0 で公開している。一切の権利を放棄しているので自由に持っていって弄っていただいて構わない。

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Gocli Package v0.8.0 Released

2018-03-08T13:28:19+00:00

この前 v0.7.0 をリリースしたばかりだが，舌の根も乾かぬうちに v0.8.0 をリリースしてしまった。

Release v0.8.0 Released · spiegel-im-spiegel/gocli

今回はファイル・ディレクトリ操作用の gocli/file サブパッケージを追加した。

実は mattn/jvgrep を使ってみてディレクトリの再帰検索はなかなか便利なことに気づき，自分でも実装してみようと思ったのだ。

Go 言語標準の filepath.Glob() 関数はなかなか性能がよくて，パス検索に以下のワイルドカードが使える。

pattern:
    { term }
term:
    '*'         matches any sequence of non-Separator characters
    '?'         matches any single non-Separator character
    '[' [ '^' ] { character-range } ']'
                character class (must be non-empty)
    c           matches character c (c != '*', '?', '\\', '[')
    '\\' c      matches character c
character-range:
c           matches character c (c != '\', '-', ']')
'\' c      matches character c
lo '-' hi   matches character c for lo <= c <= hi

filepath - The Go Programming Language

しかし，残念ながら Ruby の Dir.glob にあるようなディレクトリの再帰検索（**/）は用意されていない。そこで今回 filepath.Glob() と filepath.Walk() を組み合わせる形で file.Glob() 関数を作ってみた。

こんなふうに使える。

package main

import (
    "fmt"
    "os"

    "github.com/spiegel-im-spiegel/gocli/file"
)

func main() {
    if len(os.Args) < 2 {
        fmt.Fprintln(os.Stderr, os.ErrInvalid)
    }

    for _, path := range os.Args[1:] {
        paths := file.Glob(path, file.NewGlobOption())
        if len(paths) > 0 {
            for _, path := range paths {
                fmt.Println(path)
            }
        }
    }
}

これを実行するとこんな感じになる。

$ go run /path/to/search.go  **/*.lua
nyagos.d\aliasandset.lua
nyagos.d\aliases.lua
nyagos.d\backquote.lua
nyagos.d\box.lua
nyagos.d\brace.lua
nyagos.d\catalog\autocd.lua
nyagos.d\catalog\autols.lua
nyagos.d\catalog\cho.lua
nyagos.d\catalog\dollar.lua
nyagos.d\catalog\ezoe.lua
nyagos.d\catalog\git.lua
nyagos.d\catalog\gogit.lua
nyagos.d\catalog\neco.lua
nyagos.d\catalog\nyagosini.lua
nyagos.d\catalog\peco.lua
nyagos.d\catalog\subcomplete.lua
nyagos.d\cdlnk.lua
nyagos.d\comspec.lua
nyagos.d\lns.lua
nyagos.d\open.lua
nyagos.d\start.lua
nyagos.d\su.lua
nyagos.d\suffix.lua
nyagos.d\swapstdfunc.lua
nyagos.d\trash.lua
nyagos.d\use.lua

Go 言語製なので，フォルダの区切り文字には '/' と '\' の両方が使える。また出力結果の内，フォルダについては末尾にフォルダ区切り文字（'/' または '\'）を付加している。その他，細かい使い方については glob_test.go を参照のこと。

本当はもう少しスマートなコードを書きたかったんだけど，行き当たりばったりで書いてたらエラく汚いコードになってしまった。まぁ，これが今の私の実力，ということで。そのうち refactoring できる機会もあるかもしれない。

spiegel-im-spiegel/gocli パッケージは CLI (Command-Line Interface) を組む際に（主に自分が）便利な細々とした機能を収録している。他の人には使いにくいかもしれないし大した内容でもないため CC0 で公開している。一切の権利を放棄しているので自由に持っていって弄っていただいて構わない。

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Gocli Package v0.7.0 Released

2018-03-03T12:12:41+00:00

spiegel-im-spiegel/gocli パッケージ v0.7.0 をリリースした。

spiegel-im-spiegel/gocli: Minimal Packages for Command-Line Interface

v0.7.0 では SIGNAL 制御を行う gocli/signal サブパッケージを追加した。具体的には context パッケージと組み合わせてキャンセル・イベントとして実装している。

例えば，こんな感じで使う。

package main

import (
	"context"
	"fmt"
	"os"
	"time"

	"github.com/spiegel-im-spiegel/gocli/signal"
)

func ticker(ctx context.Context) error {
	t := time.NewTicker(1 * time.Second) // 1 second cycle
	defer t.Stop()

	for {
		select {
		case now := <-t.C: // ticker event
			fmt.Println(now.Format(time.RFC3339))
		case <-ctx.Done(): // cancel event from context
			fmt.Println("Stop ticker")
			return ctx.Err()
		}
	}
}

func Run() error {
	errCh := make(chan error, 1)
	defer close(errCh)

	go func() {
		child, cancelChild := context.WithTimeout(
			signal.Context(context.Background(), os.Interrupt), // cancel event by SIGNAL
			10*time.Second,                                     // timeout after 10 seconds
		)
		defer cancelChild()
		errCh <- ticker(child)
	}()

	err := <-errCh
	fmt.Println("Done")
	return err
}

func main() {
	if err := Run(); err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
}

Windows 環境では SIGNAL 周りのテストが出来ないので結構困ってたり。

ブックマーク

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Cobra の使い方とテスト

2017-12-06T12:01:33+00:00

だいぶ spf13/cobra の扱いに慣れてきたので，そろそろブログにまとめておこうかなと。以前に CLI (Command-Line Interface) とファサード・パターンについては以下の記事に

コマンドライン・インタフェースとファサード・パターン

spf13/cobra の使い方については，触りの部分を以下の記事に書いた。

モンテカルロ法による円周率の推定（その2 CLI）
Codic API を利用するパッケージを作ってみた（spf13/viper との連携について）

ただ spf13/cobra そのものについてちゃんと書いてない気がするので，今回はコードの書き方からテストまでをひと通り紹介していく。漫然と紹介するのもアレなので，今回は以下の CLI を作ることを目標にする。

$ cli-demo show -i 123 -s 文字列 -b
Integer option value: 123
 String option value: 文字列
Boolean option value: true

なお，この記事の作業の結果は以下のリポジトリに置いてある。

spiegel-im-spiegel/cli-demo: Demonstration for Command Line Interface

spf13/cobra のインストール

spf13/cobra には CLI ツールもあるのだがバイナリは提供されていないので，自前で取ってきてコンパイルする。といっても

$ go get -u github.com/spf13/cobra/cobra

とするだけだが。 github.com/spf13/cobra で get しようとすると CLI のコンパイルを行わないので注意が必要である。 CLI の Usage はこんな感じ。

$ cobra -h
Cobra is a CLI library for Go that empowers applications.
This application is a tool to generate the needed files
to quickly create a Cobra application.

Usage:
  cobra [command]

Available Commands:
  add         Add a command to a Cobra Application
  help        Help about any command
  init        Initialize a Cobra Application

Flags:
  -a, --author string    author name for copyright attribution (default "YOUR NAME")
      --config string    config file (default is $HOME/.cobra.yaml)
  -h, --help             help for cobra
  -l, --license string   name of license for the project
      --viper            use Viper for configuration (default true)

Use "cobra [command] --help" for more information about a command.

初期化処理

まずは init サブコマンドで雛形となるソースコードを展開する。ソースを展開したいフォルダで

cobra --viper=false init .

とする。今回は spf13/viper は使わないので --viper オプションは無効にしておく。

これで対象のフォルダに3つのファイルが出力される

main.go
LICENSE
cmd/root.go

LICENSE はライセンス・ファイルなのでそのまま利用するなり他のファイルに差し替えるなりすればいい。 main.go と cmd/root.go が実際の雛形になるのだが，やたらコメントが多いので，整理したものを以下に示す。

まずは main.go。

package main

import "github.com/spiegel-im-spiegel/cli-demo/cmd"

func main() {
    cmd.Execute()
}

次に cmd/root.go。

package cmd

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

// RootCmd represents the base command when called without any subcommands
var RootCmd = &cobra.Command{
    Use:   "cli-demo",
    Short: "Short comment",
    Long:  "Long comment",
    //Run: func(cmd *cobra.Command, args []string) { },
}

//Execute is called from main function
func Execute() {
    if err := RootCmd.Execute(); err != nil {
        fmt.Println(err)
        os.Exit(1)
    }
}

func init() {
}

呼び出し関係は以下の通り。

graph LR main["main()"] exec1["cmd.Execute()"] exec2["cmd.RootCmd.Execute()"] main-->exec1 exec1-->exec2

もちろん main() 関数から直接 cmd.RootCmd.Execute() 関数を呼んでも構わない（このままであれば）。この状態でコマンドを起動すると以下のようになる。

$ go run main.go -h
Long comment

まぁ，当然だよね。現状での問題は3つある。

cmd.RootCmd を他パッケージから直接操作できてしまう
引数と標準入出力を cmd.RootCmd が握っていてコントロールできない（ように見える）
cmd.RootCmd.Execute() 関数がエラー時に os.Exit() 関数で強制終了してしまう

特に2番目が致命的。何故ならこのままではテストができないからだ。そこで cmd.Execute() 関数を改造することにする。

spiegel-im-spiegel/gocli の導入

その前に標準入出力の取り回しを簡単にするために，手前味噌で申し訳ないが， spiegel-im-spiegel/gocli を導入する。これを使えば標準入出力をひとつのインスタンスで取り回しできる¹。

package main

import (
    "github.com/spiegel-im-spiegel/gocli/exitcode"
    "github.com/spiegel-im-spiegel/gocli/rwi"
)

func run(ui *rwi.RWI) exitcode.ExitCode {
    ui.Outputln("Hello world")
    return exitcode.Normal
}

func main() {
    run(rwi.New(
        rwi.WithReader(os.Stdin),
        rwi.WithWriter(os.Stdout),
        rwi.WithErrorWriter(os.Stderr),
    )).Exit()
}

rwi.New() の初期化は Functional Options パターンを使っている。 Functional Options パターンについて詳しくは以下を参照のこと。

インスタンスの生成と Functional Options パターン

cmd.Execute() 関数を改造する

では cmd.Execute() 関数の改造を行おう。途中を省いて結果は以下の通り。

var (
    cui = rwi.New() //CUI instance
)

//Execute is called from main function
func Execute(ui *rwi.RWI, args []string) (exit exitcode.ExitCode) {
    defer func() {
        //panic hundling
        if r := recover(); r != nil {
            cui.OutputErrln("Panic:", r)
            for depth := 0; ; depth++ {
                pc, src, line, ok := runtime.Caller(depth)
                if !ok {
                    break
                }
                cui.OutputErrln(" ->", depth, ":", runtime.FuncForPC(pc).Name(), ":", src, ":", line)
            }
            exit = exitcode.Abnormal
        }
    }()

    //execution
    cui = ui
    rootCmd.SetArgs(args)
    rootCmd.SetOutput(ui.ErrorWriter())
    exit = exitcode.Normal
    if err := rootCmd.Execute(); err != nil {
        exit = exitcode.Abnormal
    }
    return
}

前半は panic 時のハンドリングで，スタック追跡できるようにしている。 panic 時のハンドリングについて詳しくは以下を参照のこと。

スタック追跡とパニック・ハンドリング

後半では cmd.rootCmd に引数と標準出力をセットしてから cmd.rootCmd.Execute() 関数を起動している²。エラー時は os.Exit() 関数で強制終了するのではなく，ちゃんとステータスを返すようにした。

そうそう。 cmd.RootCmd ではパッケージ外から直接操作できてしまうので cmd.rootCmd と小文字にしている。小さなことからコツコツと（笑）

これで main() 関数もこのように書き換えることができる。

func main() {
    cmd.Execute(
        rwi.New(
            rwi.WithReader(os.Stdin),
            rwi.WithWriter(os.Stdout),
            rwi.WithErrorWriter(os.Stderr),
        ),
        os.Args[1:],
    ).Exit()
}

サブコマンドの追加

ではいよいよサブコマンド show を追加する。サブコマンドの追加は main.go のあるフォルダで以下のコマンドを実行する。

$ cobra add show

これにより cmd/show.go ファイルが追加された。これも中身はコメントが山ほどあるので，整理したものを以下に示す。

package cmd

import (
    "fmt"

    "github.com/spf13/cobra"
)

// showCmd represents the show command
var showCmd = &cobra.Command{
    Use:   "show",
    Short: "Short comment for show sub-command",
    Long:  "Long comment for show sub-command",
    Run: func(cmd *cobra.Command, args []string) {
        fmt.Println("show called")
    },
}

func init() {
    rootCmd.AddCommand(showCmd)
}

この状態で実際に動かしてみるとこうなる。

$ go run main.go -h
Long comment

Usage:
  cli-demo [flags]
  cli-demo [command]

Available Commands:
  help        Help about any command
  show        Short comment for show sub-command

Flags:
  -h, --help   help for cli-demo

Use "cli-demo [command] --help" for more information about a command.

$ go run main.go show -h
Long comment for show sub-command

Usage:
  cli-demo show [flags]

Flags:
  -h, --help   help for show

$ go run main.go show
show called

オプションの追加

このコードに対してオプションを追加していく。こんな感じでいいだろう。

package cmd

import (
    "github.com/spf13/cobra"
)

// showCmd represents the show command
var showCmd = &cobra.Command{
    Use:   "show",
    Short: "Short comment for show sub-command",
    Long:  "Long comment for show sub-command",
    RunE: func(cmd *cobra.Command, args []string) error {
        i, err := cmd.Flags().GetInt("integer")
        if err != nil {
            return err
        }
        b, err := cmd.Flags().GetBool("boolean")
        if err != nil {
            return err
        }
        s, err := cmd.Flags().GetString("string")
        if err != nil {
            return err
        }
        cui.Outputln("Integer option value:", i)
        cui.Outputln(" String option value:", s)
        cui.Outputln("Boolean option value:", b)

        return nil
    },
}

func init() {
    rootCmd.AddCommand(showCmd)

    showCmd.Flags().IntP("integer", "i", 0, "integer option")
    showCmd.Flags().BoolP("boolean", "b", false, "boolean option")
    showCmd.Flags().StringP("string", "s", "", "string option")
}

cmd.showCmd 内の Run が RunE に変わってる点に注目。これにより，関数内で error が発生した場合に，それを返り値で渡すことができる。

試しにちょろんと動かしてみよう。

$ go run main.go show -h
Long comment for show sub-command

Usage:
  cli-demo show [flags]

Flags:
  -b, --boolean         boolean option
  -h, --help            help for show
  -i, --integer int     integer option
  -s, --string string   string option

$ go run main.go show -i 123 -s 日本語 -b
Integer option value: 123
 String option value: 日本語
Boolean option value: true

おおっ。なんか動いてるような気がする。

じゃあテストを始めようか。

cobra.Command を返す関数を作る。

と言いたいところだけど，このままではまだテストができない。何故かというと， cmd.rootCmd も cmd.showCmd も static な変数として定義されているので，そのままテストを繰り返すと前回の状態が残ってしまって正しいテストにならないからだ。

じゃあどうすればいいかというと， cobra.Command を返す関数を作って，その中で cmd.rootCmd や cmd.showCmd に相当するインスタンスを作ればいいのである。

じゃあ，まずは cmd/root.go の完全版から。

package cmd

import (
    "runtime"

    "github.com/pkg/errors"
    "github.com/spf13/cobra"
    "github.com/spiegel-im-spiegel/gocli/exitcode"
    "github.com/spiegel-im-spiegel/gocli/rwi"
)

var (
    cui = rwi.New() //CUI instance
)

//newRootCmd returns cobra.Command instance for root command
func newRootCmd(ui *rwi.RWI, args []string) *cobra.Command {
    cui = ui
    rootCmd := &cobra.Command{
        Use:   "cli-demo",
        Short: "Short comment",
        Long:  "Long comment",
        RunE: func(cmd *cobra.Command, args []string) error {
            return errors.New("no command")
        },
    }
    rootCmd.SetArgs(args)
    rootCmd.SetOutput(ui.ErrorWriter())

    rootCmd.AddCommand(newShowCmd())

    return rootCmd
}

//Execute is called from main function
func Execute(ui *rwi.RWI, args []string) (exit exitcode.ExitCode) {
    defer func() {
        //panic hundling
        if r := recover(); r != nil {
            cui.OutputErrln("Panic:", r)
            for depth := 0; ; depth++ {
                pc, src, line, ok := runtime.Caller(depth)
                if !ok {
                    break
                }
                cui.OutputErrln(" ->", depth, ":", runtime.FuncForPC(pc).Name(), ":", src, ":", line)
            }
            exit = exitcode.Abnormal
        }
    }()

    //execution
    exit = exitcode.Normal
    if err := newRootCmd(ui, args).Execute(); err != nil {
        exit = exitcode.Abnormal
    }
    return
}

次は cmd/show.go の完全版。

package cmd

import (
    "github.com/spf13/cobra"
)

//newShowCmd returns cobra.Command instance for show sub-command
func newShowCmd() *cobra.Command {
    showCmd := &cobra.Command{
        Use:   "show",
        Short: "Short comment for show sub-command",
        Long:  "Long comment for show sub-command",
        RunE: func(cmd *cobra.Command, args []string) error {
            i, err := cmd.Flags().GetInt("integer")
            if err != nil {
                return err
            }
            b, err := cmd.Flags().GetBool("boolean")
            if err != nil {
                return err
            }
            s, err := cmd.Flags().GetString("string")
            if err != nil {
                return err
            }
            cui.Outputln("Integer option value:", i)
            cui.Outputln(" String option value:", s)
            cui.Outputln("Boolean option value:", b)

            return nil
        },
    }

    showCmd.Flags().IntP("integer", "i", 0, "integer option")
    showCmd.Flags().BoolP("boolean", "b", false, "boolean option")
    showCmd.Flags().StringP("string", "s", "", "string option")

    return showCmd
}

なんで spf13/cobra が最初からこういう雛形を作ってくれないかというと，おそらく cobra add コマンドで cmd/root.go を触るわけにはいかないため（たぶん既にユーザが触ってる）， static 変数にして init() 関数でコマンドを繋げるような組み方しかできなかったんだと思う。でも手作業でこういう雛形を作ってしまえば以後はコピペでいくらでも量産できるので，テストのことを考えれば，面倒でも最初に手間を掛けたほうがいいかもしれない。

テストを書く

ようやくテストが書けるよ。とりあえず正常系のみ。

package cmd

import (
    "bytes"
    "testing"

    "github.com/spiegel-im-spiegel/gocli/exitcode"
    "github.com/spiegel-im-spiegel/gocli/rwi"
)

func TestShowNormal(t *testing.T) {
    testCases := []struct {
        args []string
        want string
    }{
        {args: []string{"show", "-i", "123", "-s", "日本語", "-b"}, want: "Integer option value: 123\n String option value: 日本語\nBoolean option value: true\n"},
        {args: []string{"show", "-i", "123", "-s", "日本語"}, want: "Integer option value: 123\n String option value: 日本語\nBoolean option value: false\n"},
        {args: []string{"show", "-i", "123"}, want: "Integer option value: 123\n String option value: \nBoolean option value: false\n"},
        {args: []string{"show"}, want: "Integer option value: 0\n String option value: \nBoolean option value: false\n"},
    }

    for _, c := range testCases {
        out := new(bytes.Buffer)
        errOut := new(bytes.Buffer)
        ui := rwi.New(
            rwi.WithWriter(out),
            rwi.WithErrorWriter(errOut),
        )
        exit := Execute(ui, c.args)
        if exit != exitcode.Normal {
            t.Errorf("Execute() err = \"%v\", want \"%v\".", exit, exitcode.Normal)
        }
        if out.String() != c.want {
            t.Errorf("Execute() Stdout = \"%v\", want \"%v\".", out.String(), c.want)
        }
        if errOut.String() != "" {
            t.Errorf("Execute() Stderr = \"%v\", want \"%v\".", errOut.String(), "")
        }
    }
}

標準出力と標準エラー出力を bytes.Buffer で代替えしているのがお分かりだろうか。これなら CLI でもかなりの部分をテストでカバーできる。ここには挙げていないが，当然パイプのテストも可能である。

dep で spf13/cobra を管理する

spf13/cobra をはじめとする外部パッケージを dep を使って vendor/ 配下に置くのなら， Gopkg.toml の記述は以下でいいだろう。

[[constraint]]
  name = "github.com/spf13/cobra"
  version = "0.0.*"

[[constraint]]
  name = "github.com/spiegel-im-spiegel/gocli"
  version = "0.7.*"

[[constraint]]
  name = "github.com/pkg/errors"
  version = "0.8.*"

[prune]
  go-tests = true
  unused-packages = true

ちなみに今回のデモのパッケージ依存関係はこんな感じになっている。

$ dep status -dot | dot -Tpng -o dependency.png

ブックマーク

Golangのコマンドライブラリcobraを使って少しうまく実装する - Qiita : cobra.Command の関数化のアイデアはこちらからいただいた。感謝
cobra / pflags でフラグをパースせずに args に残す - Qiita

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

改訂2版みんなのGo言語: 松木雅幸 (著), mattn (著), 藤原俊一郎 (著), 中島大一 (著), 上田拓也 (著), 牧大輔 (著), 鈴木健太 (著); 技術評論社 2019-08-01 (Release 2019-08-01); Kindle版; B07VPSXF6N (ASIN); 評価

reviewed by Spiegel on 2019-08-12 (powered by PA-APIv5)

コードを見れば分かると思うが spiegel-im-spiegel/gocli には最小限のコードしかないので，たとえば複数の goroutine が動いている状態で単一の入出力インスタンスを取り回すとか考えたくもない。なので，取り扱いには十分注意すること。その代わり spiegel-im-spiegel/gocli では CC0 つまり著作者人格権も含めて完全に権利を放棄しているので，自由に使っていただいて構わない。 ↩︎
cobra.Command には出力先がひとつしかなく何故か標準出力と標準エラー出力を区別していない。そこで cmd.rootCmd には標準エラー出力をセットして標準出力へのアクセスは cui を cmd パッケージ内のどのメソッドからも参照できるようにした（つまり，少なくとも cmd パッケージ内は単一の goroutine で動くことが前提）。 spf13/cobra 側が標準出力と標準エラー出力をちゃんと区別してくれれば，もう少しスマートにできるんだけどねぇ。（あと標準入力用の Reader も付けて欲しい。まぁなくても何とかなってるけどw） ↩︎

List of Cli [text.Baldanders.info]

“Philosophers” を Go で解く（CLI）

目次

コマンドライン・インタフェース

パラメータの定義

参考図書

Go 製のツールとパッケージをまとめてアップデートした

ブックマーク

参考図書

Go 言語用 CLI プログラミング支援パッケージ

標準入出力と終了コード

SIGNAL をハンドリングする

ワイルドカードを含むファイルの検索

設定ファイルのパスを取得する

キャッシュ用のディレクトリ・ファイルのパスを取得する

参考図書

spiegel-im-spiegel/gocli v0.10.1 のリリース

参考図書

gjq v0.2.0 をリリースした

ブックマーク

参考図書

jq ぽい何か を書いてみた

参考図書

spiegel-im-spiegel/gocli v0.9.1 をリリースした

参考図書

Gocli Package v0.8.0 Released

参考図書

Gocli Package v0.7.0 Released

ブックマーク

参考図書

Cobra の使い方とテスト

spf13/cobra のインストール

初期化処理

spiegel-im-spiegel/gocli の導入

cmd.Execute() 関数を改造する

サブコマンドの追加

オプションの追加

cobra.Command を返す関数を作る。

テストを書く

dep で spf13/cobra を管理する

ブックマーク

参考図書

jq ぽい何かを書いてみた