运行插件
下面描述了如何运行插件,并继续使用示例插件插件规范。
icon-plugin工具
更多的文档icon-plugin
可在插件工具
关于icon-plugin
- 方法的最佳工具
- 的
icon-plugin
工具是主要的插件开发工具,应该用来管理任何插件 - 安装说明
icon-plugin
可在开始文档。
运行和测试插件
现在已经构建好了插件shell,让我们来看看一些插件命令,它们是由插件shell生成的代码生成的。
帮助命令
要查看插件可执行文件支持哪些命令,请运行以下命令:
1$ icon-plugin run——help2使用:icon-plugin run [] [ …] 3.4运行插件56国旗:7显示上下文敏感的帮助(也可以尝试——help-long和——help-man)。8-v,——verbose verbose模式。9——version显示应用版本。10-f,——specfile= specfile要使用的插件规格的路径(例如./plugin.spec.yaml)。11围绕给定的-T/-R选项创建PR评估。12启用缓存(def: /var/cache)。13-c,——command= command在container info中运行命令|sample|samples|test|run|http|bash14-d,——debug调试模式。15-j,——jq通过jq管道。16-m,——rebuild在执行之前生成插件。17-V,——volume= volume卷挂载(例如:/src/dst)。18-p,——port= port端口转发(例如:8000:8888/udp)。19- t,测试=测试……运行JSON测试方法(例如 20.- r, =跑……运行JSON运行方法(例如 2122参数:23[]命令标志的附加参数
Info命令
info命令将打印插件元数据。
1$ icon-plugin run -c info2INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 INFO <3.名称:Base644供应商:rapid75版本:1.1.16描述:使用base64字母表编码和解码数据78行动(2):9├─├─decode (decode Base64 to data)10├─生物学家(1)
测试命令
你可以使用测试
命令来测试插件测试()
方法,除非连接文件中有测试方法。请注意,测试()
应该在连接中设置,而不是在动作或触发器中。它通常用于测试网络访问和验证任何用户提供的凭据。
对于本例,我们将对以下代码进行更改komand_example /动作/ say_goodbye / action.py
然后用使
:
python
1。。。23.def测试(自我):4# TODO:实现测试功能5自我。日志记录器。信息(“对%s说再见”,“测试”)6返回{“消息”:“再见了考验!”}
测试
使用icon-plugin运行插件的测试方法:
1$ icon-plugin运行-T tests/decode。json - j2INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 test < tests/decode.json3.信息[0003]输出:4{5“数据”:“base64”6}
运行命令
的运行
命令用于通过执行run ()
方法在动作/触发器文件中。当开发时,请确保您使用——调试
标志,以便所有输出显示为stdin和stdout
。
请注意:——调试
用于从命令行测试触发器,必须用于绕过URL回调。
对于本例,我们对以下代码进行了更改komand_example /动作/ say_goodbye / action.py
然后用使
:
python
1。。。2def运行(自我,参数个数={}):3.# TODO:实现运行函数4的名字=参数个数。得到(“名字”)5自我。日志记录器。信息(“对%s说再见”,的名字)6味精=“再见{}!”。格式(的名字)7返回{“消息”:味精}
运行
使用icon-plugin运行插件的Run方法:
1$ icon-plugin run -R tests/decode。json - j2INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 run < tests/decode.json3.信息[0002]输出:4{5“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”6}
执行所有运行和测试
要运行所有操作和触发器,请使用all参数,而不是选择一个特定的文件。
1$ icon-plugin run -R all -T all -j2INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 run < tests/decode.json3.信息[0003]输出:4{5“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”6}7INFO[0003]运行命令:docker run——rm -i rapid7/base64:1.1.1 run < tests/encode.json8信息[0006]输出:9{10“数据”:“bGV0cyBlbmNvZGUgdGhpcyBtZXNzYWdlCnNpbGx5IGJveQ = =”11}12INFO[0006]运行命令:docker run——rm -i rapid7/base64:1.1.1 test < tests/decode.json13信息[0010]输出:14{15“数据”:“base64”16}17INFO[0010]运行命令:docker run——rm -i rapid7/base64:1.1.1 test < tests/encode.json18信息[0013]输出:19{20.“数据”:“YmFzZTY0”21}
创建评估
当分支准备好被合并时主
在开源Github repo上,每个pull请求都需要一个评估。这可以通过使用标志的icon-plugin生成——一个
。
生成一个评价:
1$ icon-plugin run -R tests/decode。json - a - j2INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 run < tests/decode.json3.信息[0002]输出:4{5“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”6}78# #评估9# # #运行1011<详细>1213```14{15“身体”:{16“日志”:“rapid7 / Base64:1.1.1。步骤名称:解码\ n”,17“元”:{},18"输出":{19“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”20.},21“状态”:“ok”22},23“类型”:“action_event”,24“版本”:“v1”25}2627```2829<摘要>30.Docker运行——rm -i rapid7/base64:1.1.1运行31> < /总结32< / >详细信息3334# # # UI3536在Komand中用来验证使用的插件的屏幕截图在这一行以下。3738# # # #工作流生成器394041# # # #的工作424344# # # #工件
这个页面对你有帮助吗?