ネットワークプログラマビリティ勉強会 #7での資料です タイトル詐欺ですｗ

1. 10分で作るクラスライブラリ
2015/12/9 npstudy#7!
@_norin_

2. 自己紹介
• データセンターのなかのひと
インフラもろもろ、クラウドとか作ってます
• 昔は広域イーサとかEoMPLSとかやってました

3. APIがない!!

4. 20年前から悩みが変わってない
by 50代エンジニア

5. 曰く
❖ CLIだって立派なAPI!
❖ teratermのマクロだってあるし!
❖ APIは自分で作るもの。無ければ作るのがエンジニア
!
※こういうこと言うのはたいていＢ型です

6. ちゃれんじ2015冬
おっさんベテランに対抗してイマドキっぽく（ネタも兼ねて）やってみた!
!
❖ 目標
使えそうなクラスライブラリ作り!
❖ 言語
ruby!
❖ ターゲット
CSR1000v（仮想ルータ）

7. まずはおさらい

8. 先祖代々受け継がれた
伝統と秘伝の
telnet + expect

9. require 'expect4r'
require 'pp'
!
ios = Expect4r::Ios.new(:telnet, host: "192.168.0.2",
user: "router", pwd: "router", enable: "router")
ios.login
pp ios.show_interface
時間がなくて外部ライブラリを使っちゃいました:-)
※expect4r!
C社やJ社向けのtelnet/ssh操作クラス!
踏み台経由のアクセスも出来たりします!
https://github.com/jesnault/expect4r

10. 出力
$ ruby show.rb
[["show interfacern",
"GigabitEthernet1 is up, line protocol is up rn",
" Hardware is CSR vNIC, address is 0050.5683.bb47 (bia 0050.5683.bb47)rn",
" Internet address is 192.168.0.2/24rn",
" MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec, rn",
" reliability 255/255, txload 1/255, rxload 1/255rn",
" Encapsulation ARPA, loopback not setrn",
" Keepalive set (10 sec)rn",
" Full Duplex, 1000Mbps, link type is auto, media type is RJ45rn",
" output flow-control is unsupported, input flow-control is unsupportedrn",
" ARP type: ARPA, ARP Timeout 04:00:00rn",
" Last input 00:00:00, output 00:06:00, output hang neverrn",
" Last clearing of "show interface" counters neverrn",
" Input queue: 0/375/0/0 (size/max/drops/flushes); Total output drops: 0rn",
" Queueing strategy: fiforn",
" Output queue: 0/40 (size/max)rn",
" 5 minute input rate 36000 bits/sec, 7 packets/secrn",
" 5 minute output rate 1000 bits/sec, 2 packets/secrn",
" 9015405 packets input, 6320804222 bytes, 0 no bufferrn",
" Received 0 broadcasts (0 IP multicasts)rn",

11. ❖ ここまでは大昔からできてる!
❖ あとは出力を解析して必要な情報をピックアップするだけ!
❖ この段階で止まってる人が大半では？!
!
!
!

12. 手が止まる理由
❖ メッセージフォーマットが不明確!
❖ 不要な情報が大量に出力される!
❖ default値が出力されない!
❖ 必要な情報を取得するには複数のコマンドが必要な場合も!
❖ なんとなくコマンド叩きつつそれっぽい値を見つけてる!
!

13. そもそも論
❖ メッセージフォーマットは可変といっても所 は機械が
出力しているもの。たかが知れている!
❖ 違いは機種、OS、バージョン、バグくらい!
❖ NWエンジニアならブラックボックステストはお手の物!
❖ 大量の不要情報は機械に取捨選択させればいいだけ!
❖ なんとなくじゃなくて手順・コマンドは明確に
自動化 ＝ 標準化

14. show interfaceの出力
"GigabitEthernet1 is up, line protocol is up rn",
" Hardware is CSR vNIC, address is 0050.5683.bb47 (bia 0050.5683.bb47)rn",
" Internet address is 1.1.1.1/24rn",
" MTU 1500 bytes, BW 1000000 Kbit/sec, DLY 10 usec, rn",
" reliability 255/255, txload 1/255, rxload 1/255rn",
" Encapsulation ARPA, loopback not setrn",
" Keepalive set (10 sec)rn",
" Full Duplex, 1000Mbps, link type is auto, media type is RJ45rn",
" output flow-control is unsupported, input flow-control is unsupportedrn",
" ARP type: ARPA, ARP Timeout 04:00:00rn",
" Last input 00:00:00, output 00:06:00, output hang neverrn",
" Last clearing of "show interface" counters neverrn",
" Input queue: 0/375/0/0 (size/max/drops/flushes); Total output drops: 0rn",
" Queueing strategy: fiforn",
" Output queue: 0/40 (size/max)rn",
" 5 minute input rate 36000 bits/sec, 7 packets/secrn",
" 5 minute output rate 1000 bits/sec, 2 packets/secrn",
" 9015405 packets input, 6320804222 bytes, 0 no bufferrn",
" Received 0 broadcasts (0 IP multicasts)rn",
" 0 runts, 0 giants, 0 throttles rn",
" 0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignoredrn",
" 0 watchdog, 0 multicast, 0 pause inputrn",

15. 片っぱしから書き下す
ShowInterfaceMessageFormatTable = [
[/^(w+) is (w+), line protocol is (w+)s*/, :ifStatus],
[/^ Hardware is (.+), address is ([^s]+) /, :ifPhy],
[/^ Description: (.+)/, :descr],
[/^ Internet address is (.+)/, :ipAddr],
[/^ MTU (d+) bytes, BW (d+) Kbit/sec/, :ifMtu_bw],
[/^ reliability (d+)/(d+), txload (d+)/(d+), rxload (d+)/(d+)/, nil],
[/^ Encapsulation ARPA/, nil],
[/^ Keepalive/, nil],
[/^ .*media type/, nil],
[/^ output flow-control/, nil],
[/^ ARP type/, nil],
[/^ Last/, nil],
[/^ Input/, nil],
[/^ Queueing strategy/, nil],
[/^ Output queue/, nil],
[/^ 5 minute/,nil],
[/^s{4}/, nil]
]
[メッセージの正規表現、マッチしたものを処理するメソッド]
を定義
メソッドがnilなのは力尽きたため orz

16. ShowInterfaceMessageFormatTable = [
[/^(w+) is (w+), line protocol is (w+)s*/, :ifStatus],
[/^ Hardware is (.+), address is ([^s]+) /, :ifPhy],
[/^ Description: (.+)/, :descr],
・・・
!
def ifStatus v
return {ifName: v[1].to_s, ifOper: v[2].to_s, ifAdmin: v[3].to_s}
end
・・・
!
def interfaceMsgAnalyzer msg
ret = {}
msg.each do |line|
next if pickupVal(line.chomp, ShowInterfaceMessageFormatTable, ret)
STDERR.puts “no format found => #{line}"
exit
end
return ret
end
!
def pickupVal line, fmtTable, ret
fmtTable.each do |tbl|
if (m = tbl[0].match(line))
ret.merge!(self.send(tbl[1], m)) if tbl[1] != nil
return true
end
end
false
end
ここまで５分

17. 設定
❖ ライブラリ(expect4r)がヨロシクやってくれます:-)!
!
!
!
❖ 確認は再度showで
ios.config %{
interface GigabitEthernet 1
ip address 1.1.1.1 255.255.255.0
}

18. require 'expect4r'
!
・・・
!
# ログイン
ios = Expect4r::Ios.new(:telnet, host: "192.168.56.254",
user: "router", pwd: "router", enable: "router")
ios.login
!
!
# show interface発行
msg = ios.show_interface_GigabitEthernet1
!
# メッセージ解析＆出力
pp interfaceMsgAnalyzer(msg[0][1..-2])
!
# 設定
ios.config %{
interface GigabitEthernet 1
ip address 2.2.2.2 255.255.255.0
}
!
# 再度確認
msg = ios.show_interface_GigabitEthernet1
pp interfaceMsgAnalyzer(msg[0][1..-2])
ここまで３分

19. クラス化
❖ べた書きをベースにクラス化してみる!
❖ NetDevice!
❖ ベースクラス!
❖ Interface!
❖ まんまインターフェースのクラス!
❖ MessageAnalyzer::Interface!
❖ まんまメッセージ解析用のクラス（モジュール）!
!

20. イメージ
router = NetDevice.new
!
router.connect(user: username, password: pass, enable: secpass)
!
router.interface("GigabitEthernet1")
router.interface("GigabitEthernet1").descr("test").ipaddr("1.2.3.4/24").noShutdown
!
!
!
!
全部は大変なのでinterfaceのIPとdescriptionを実装してみる
ここまで２時間（お風呂タイム含む）

21. class NetDevice
def initialize
@interfaces = {}
@device = nil
end
!
def connect var
return @device if @device != nil
@device = adapter var
@device.login
end
!
def interface name, refresh = nil
return @interfaces[name] if @interfaces.has_key?(name) and refresh == nil
msg = @device.send("show_interface_#{name}")
@interfaces[name] = Interface.new(
MessageAnalyzer::Interface::analyze((msg[0])[1..-2]))
@interfaces[name].adapter @device
@interfaces[name]
end
!
private
def adapter var
Expect4r::Ios.new(:telnet, var)
end
end 悩みながら打ち込んで15分くらい

22. SSH対応
❖ telnetとの違いはアクセスするプロトコルだけなのでadapterを
介して切り替える
class NetDevice
def connect var
@device = adapter var
end
・・・
private
def adapter var
Expect4r::Ios.new(:telnet, var)
end
!
class NetDevice::SSH < NetDevice
def adapter var
Expect4r::Ios.new(:ssh, var)
end
!
router = NetDevice::SSH.new
router.interface・・・（以下同文）
これは1分かからない

23. 結論
❖ 10分じゃライブラリは作れませんでした!
❖ コーディングだけならなんとか!
❖ クラス設計は１０倍の時間でも足りません!
❖ ドキュメントは間に合いません(納品後がデフォ)!
!
…普段のお仕事と変わりません

24. まとめと雑感
❖ やればできる、やらないとできない
一度作ってしまえば汎用性があるはずなので細々と作るのがお勧め!
❖ まずは動くコード
きれい・汚いは後から考える
そのうち誰かがリファクタリングしてくれます:-)!
❖ 全部実装しようとするのはイバラの道
追加の機能は必要になった時点で考える＆作る
#snmptrap設定を自動化したい人がどれだけいる？？

25. ❖ メソッド（使い方）はちょと考える必要があるかも!
❖ コンフィグをイメージすると引数並べたものができやすい
interface(desc:”test”, speed: 1000, ipaddr: 10.0.0.1/24, …)
１メソッド１機能で:-)!
❖ オブジェクト間の関係と使い方
switch.interface(“gi1”).vlan(2)
or
switch.vlan(2).interface(“gi1”)
両方実装してもいいけど循環参照はメモリリークへの近道。。。!
!

26. ❖ モデル化!
❖ クラス設計は結構悩む
思い付かないなら世の中のREST APIに合わせてみるのも手
イケテナイけどMIBをそのまま実装とか!
❖ エラー処理!
❖ 戻り値で判断 or 例外発生
ここは統一しておかないと後々後悔するところ!
❖ 用語が被る!
❖ オブジェクト指向用語とネットワーク用語
interface、クラス、etc

27. サンプルコード
❖ こちらから!
❖ https://github.com/nori-nori/npstudy7

28. Thank you!