python fabric2 の話 - /var/log/study

先日、おもむろに pipenv install fabric したら、fabricのver 2が落ちてきた。

今までのfabricのインターフェースとは大きく変わっていたのでざっくりとまとめておく。

TL;DL

fabric2は良い
- oopなインターフェースを備えた
- 1ライブラリというスタンスが明確になった
fabric1のユーザーは http://docs.fabfile.org/en/2.1/upgrading.html に目を通しましょう。
- デグレっぽいときはだいたい機能を削った理由が書いてある

どのような意図なのか？はわからないが、公式ドキュメントは2ドメインある

また2018年6月16日の段階では fabricの日本語ドキュメントは2対応していないので注意

すごく雑だが、パスワード認証でログインできるサーバーにrootで hello world を出力するサンプル

from fabric.api import run, env

env.hosts = ["192.168.0.1"]
env.user = "root"

def hello():
    run("echo hello world")

fabfile.pyのあるディレクトリで fab hello で実行可能

from invoke import task

@task
def hello(c):
    c.run("echo hello world")

fabfile.pyのあるディレクトリで fab --host root@192.168.0.1 --prompt-for-login-password hello

from fabric import Connection
c = Connection(host="192.168.0.1", user="root", connect_kwargs={"password": "xxxxxxx"})
c.run("echo hello world")

ver 1
- fab コマンドがメイン
- fabfile.py で、関数の中に fabric.api.run を書いて、 fab 関数名
- 改めて考えると、マジックな感じが多く、fabricに対する知識が求められる感じ
ver 2
- fab コマンドは使えるが、 invoke の機能を拡張した形
  - fab mytask:weird=custom,arg=format のような、 fabric特有の書き方は できなくなった
  - fabコマンドが invokeから拡張しているオプションは以下
  - http://docs.fabfile.org/en/2.1/cli.html
- fabric.Connection.run を使えばよく、標準のpython スクリプトとして実行可能
- API的に、OOP的な感じで、直感的にわかりやすいインターフェースになった

fabricの1と2では、機能的側面で互換性があるので、fabric 1の利用者は http://docs.fabfile.org/en/2.1/upgrading.html を読むことをおすすめする。自分が気になった非互換は以下

http://docs.fabfile.org/en/2.1/upgrading.html からの抜粋して雑に意訳とその感想

role がなくなった
- Group がいい感じで使えるようになったからそっちで賄えそう
--shell や env.shell でシェルを指定できなくなった
- fabric1のときはいろいろと指定する方法があったが面倒なので詳しくは調べていない
- fabric2では http://www.fabfile.org/upgrading.html#run にremoteでの実行のことが書いてある
  - google先生に翻訳してももらうと
    - 指定できるのは嬉しいけど、コマンドのエスケープがバグりがち？
    - runの引数にshellはあるけど、他のインターフェース(invoke.runners.Runner)のサブクラスだからあるだけで何もしないとのこと
      - たぶんココらへんにそのコードがある https://github.com/fabric/fabric/blob/2.0/fabric/runners.py#L18
- remoteに対しては runメソッドの引数などを利用せず、commandで明示的に指定するようにしてほしい感じだと思う
ディレクトリごとファイルを送れなくなった
- http://www.fabfile.org/upgrading.html#file-transfer の一番下に書いてある
- rsync + zip or tar みたいなコードをメンテするのが大変だったからやめたとのこと
- 自分はローカルでzipにして、リモートに送ってunzipするようにした

fabric ver 2では直感的にわかりやすいし、個人的には良いと思えるインターフェース設計になった印象があるので、積極的にfabric1から移行したい。