把一切脚本化之设计篇

诸多生活和工作中的琐事,都可以用命令行和脚本化来搞定, 我们常用的 Shell, Python, ruby, groovy 甚至 JavaScript 都是很好的胶水代码,以及其他curl,fabric ,scons,以及 scapy 等工具都可以加以利用

在写文档,画图和设计方面也是如此, 列举如下:

用 Markdown 来写文档

这个不多说, 简书就支持 markdown, 这篇小文也是用 markdown 写的

比如我在学 docker 的时候,打印了一个速查手册,就是用如下命令生成文档的

$ echo "| command| description | example |" > docker_manual.md
$ echo "|---|---|---|" >> docker_manual.md
$ docker help|grep -E "^[ ]+.+[ ]+.+$" | awk '{ a = $1; $1 = ""; print "| " a " | " $0 " |  |"}' >> docker_manual.md ​​​​

马上就生成了如下的表格, 我填了一个常用命令的例子, 一个速查手册就搞定了

command description example
checkpoint Manage checkpoints
container Manage containers
image Manage images
network Manage networks
node Manage Swarm nodes
plugin Manage plugins
secret Manage Docker secrets
service Manage services
stack Manage Docker stacks
swarm Manage Swarm
system Manage Docker
volume Manage volumes
attach Attach to a running container
build Build an image from a Dockerfile
commit Create a new image from a container's changes
cp Copy files/folders between a container and the local filesystem
create Create a new container
deploy Deploy a new stack or update an existing stack
diff Inspect changes to files or directories on a container's filesystem
events Get real time events from the server
exec Run a command in a running container
export Export a container's filesystem as a tar archive
history Show the history of an image
images List images
import Import the contents from a tarball to create a filesystem image
info Display system-wide information
inspect Return low-level information on Docker objects
kill Kill one or more running containers
load Load an image from a tar archive or STDIN
login Log in to a Docker registry
logout Log out from a Docker registry
logs Fetch the logs of a container
pause Pause all processes within one or more containers
port List port mappings or a specific mapping for the container
ps List containers
pull Pull an image or a repository from a registry
push Push an image or a repository to a registry
rename Rename a container
restart Restart one or more containers
rm Remove one or more containers
rmi Remove one or more images
run Run a command in a new container
save Save one or more images to a tar archive (streamed to STDOUT by default)
search Search the Docker Hub for images
start Start one or more stopped containers
stats Display a live stream of container(s) resource usage statistics
stop Stop one or more running containers
tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
top Display the running processes of a container
unpause Unpause all processes within one or more containers
update Update configuration of one or more containers
version Show the Docker version information
wait Block until one or more containers stop, then print their exit codes

用 plantuml, websequence 来画图

plantuml

用 plantuml 可以画大多数的 UML 图

  • 它依赖于 graphviz, 所以先安装依赖包
brew install libtool
brew install graphviz
  • 再从 http://plantuml.com 下载 plantuml.jar
  • 然后写一个python 文件封装一下使用方法
    • drawuml.py
import sys,os

def draw_uml(script_file):
    print "draw %s" % script_file
    cmd = "java -jar plantuml.jar %s" % script_file
    print cmd
    os.system(cmd)  


if __name__ == "__main__":
    argc = len(sys.argv)
    if( argc > 1):
        script_file = sys.argv[1]
        draw_uml(script_file)
    else:
        print "Usage: python {0} <uml_script_file>".format(sys.argv[0])

    
  • 再写一个 uml 脚本来生成一个活动图
    • activity_example.txt
@startuml
start
:host_start_meeting;
:attendee_join_meeting;
:host_mute_attendee;
:check_attendee_client_screen;

if (Is there "Your audio has been muted"?) then (yes)
  :assert pass;
else (no)
  :assert error;
endif

:host_end_meeting;
stop
@enduml

  • 使用方法
$ python drawuml.py activity_example.txt
draw activity_example.txt
java -jar plantuml.jar activity_example.txt

$ open activity_example.png

activity example

Websequence

https://www.websequencediagrams.com/ 这个网站几乎搞定了我所有的序列图

image.png

脚本如下:

title WebRTC and SIP Interaction

participant Browser as browser
participant WebServer as server
participant SIP Proxy as proxy
participant SIP UA as ua

autonumber

browser->server: HTTPS GET
server-->browser: 200 OK
browser->server: WebSocket (SDP offer)
server->proxy: SIP Invite(SDP offer)

proxy->ua: SIP Invite (SDP offer)
ua-->proxy: SIP 200(SDP answer)
proxy-->server: SIP 200 (SDP answer)
server-->browser: WebSocket (SDP answer)
server->proxy: SIP ACK
proxy->ua: SIP ACK
note over browser,ua: ICE, SRTP
ua->proxy:SIP BYE
proxy->server: SIP BYE
server<->browser: WebSocket(close) 
server-->proxy: SIP 200

其它

软件开发中的编译,部署,测试工作几乎都可以通过脚本和命令行完成, 这是不做赘述

  • Make
  • cmake
  • scons
  • maven

部署

  • Ansible
  • Puppet
  • fabric

测试与诊断

  • cUrl
  • Jmeter
  • SIPp
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容