运行插件

下面介绍如何运行插件,并继续使用中的示例插件插件规范.

图标插件工具

更多文档用于图标插件可在插件工具

关于icon-plugin

  • 方法的最佳工具
  • 的图标插件工具是应该用来管理任何插件的主要插件开发工具
  • 安装说明图标插件可在开始文件

运行和测试插件

现在已经构建好了插件shell,让我们来看看一些插件命令,它们是由插件shell生成的代码生成的。

帮助命令

要查看插件可执行文件支持哪些命令,请尝试运行:

         
1
$icon插件运行--帮助
2
使用:icon-plugin run [] […]
3.
4
运行插件
5
6
旗帜:
7
显示上下文敏感的帮助(也可以尝试——help-long和——help-man)。
8
-v,——verbose verbose模式。
9
——version显示应用版本。
10
-f、 --specfile=要使用的插件规范的specfile路径(例如../plugin.spec.yaml)。
11
-A、 --评估围绕给定的-T/-R选项创建PR评估。
12
启用缓存(def: /var/cache)。
13
-c,——command= command在container info中运行命令|sample|samples|test|run|http|bash
14
-d,——debug调试模式。
15
-j,——jq通过jq管道。
16
-m、 --在执行之前重建构建插件。
17
-五、 --卷=卷装载(例如:/src/dst)。
18
-p,——port= port端口转发(例如:8000:8888/udp)。
19
- t,测试=测试……运行JSON测试方法(例如
20
-R、 --运行=运行。。。运行JSON运行方法(例如| all)all-可以通过tests/order.txt指定执行顺序。
21
22
参数:
23
[]命令标志的附加参数

信息命令

info命令将打印插件元数据。

         
1
$ icon-plugin run -c info
2
INFO[0000]运行命令:docker run——rm -i rapid7/base64:1.1.1 INFO <
3.
姓名:Base64
4
供应商:rapid7
5
版本:1.1.1
6
描述:使用base64字母表对数据进行编码和解码
7
8
行动(2):
9
└── 解码(将Base64解码为数据)
10
├─生物学家(1)

测试命令

你可以使用测试命令通过运行测试()方法,除非连接文件中有测试方法。请注意,测试()应该在连接中设置,而不是在操作或触发器中设置。通常用于测试网络访问和验证任何用户提供的凭据。

对于本例,我们将对以下代码进行更改komand_example /动作/ say_goodbye / action.py然后用制作:

         
python
1
...
2
3.
def测试(自己):
4
# TODO:实现测试功能
5
自己.记录器.信息('向%s说再见',“测试”)
6
返回{“消息”:“再见了考验!”}

测试

使用图标插件运行插件的测试方法:

         
1
$icon plugin run-T tests/decode.json-j
2
INFO[0000]Running命令:docker run--rm-i rapid7/base64:1.1.1 test
3.
信息[0003]输出:
4
{
5
“数据”:“base64”
6
}

运行命令

的跑命令用于通过执行运行()方法在动作/触发器文件中。当开发时,请确保您使用--调试标记,以便将所有输出显示给标准输入/标准输出.

请注意:--调试用于从命令行测试触发器,必须用于绕过URL回调。

对于本例,我们对komand_example /动作/ say_goodbye / action.py然后用制作:

         
python
1
...
2
def跑(自己,参数个数={}):
3.
#TODO:实现运行函数
4
名称=参数个数.收到(“姓名”)
5
自己.记录器.信息('向%s说再见',名称)
6
味精=“再见{}!”.总体安排(名称)
7
返回{“消息”:味精}

跑

使用图标插件运行插件的运行方法:

         
1
$icon plugin run-R tests/decode.json-j
2
INFO[0000]Running命令:docker run--rm-i rapid7/base64:1.1.1 run
3.
信息[0002]输出:
4
{
5
“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”
6
}

执行所有运行和测试

要运行所有操作和触发器,请使用all参数,而不是选择特定文件。

         
1
$icon插件运行-R all-T all-j
2
INFO[0000]Running命令:docker run--rm-i rapid7/base64:1.1.1 run
3.
信息[0003]输出:
4
{
5
“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”
6
}
7
INFO[0003]运行命令:docker run——rm -i rapid7/base64:1.1.1 run < tests/encode.json
8
信息[0006]输出:
9
{
10
“数据”:“bGV0cyBlbmNvZGUgdGhpcyBtZXNzYWdlCnNpbGx5IGJveQ = =”
11
}
12
INFO[0006]运行命令:docker run——rm -i rapid7/base64:1.1.1 test < tests/decode.json
13
信息[0010]输出:
14
{
15
“数据”:“base64”
16
}
17
INFO[0010]运行命令:docker run--rm-i rapid7/base64:1.1.1 test
18
信息[0013]输出:
19
{
20
“数据”:“YmFzZTY0”
21
}

创建评估

分支准备合并到中时主人在开源Github repo上,每个pull请求都需要一个评估。这可以通过使用标志的icon-plugin生成——一个.

生成评估:

         
1
$ icon-plugin run -R tests/decode。json - a - j
2
INFO[0000]Running命令:docker run--rm-i rapid7/base64:1.1.1 run
3.
信息[0002]输出:
4
{
5
“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”
6
}
7
8
# #评估
9
# # #运行
10
11
<详细>
12
13
```
14
{
15
“正文”:{
16
“日志”:“rapid7 / Base64:1.1.1。步骤名称:解码\ n”,
17
“元”:{},
18
“产出”:{
19
“数据”:“嘿,这,是,酷吧\ ntell,我,什么,你认为\ n”
20
},
21
“状态”:“ok”
22
},
23
“类型”:“操作事件”,
24
“版本”:“v1”
25
}
26
27
```
28
29
30
docker运行--rm-i rapid7/base64:1.1.1运行
31
> < /总结
32
33
34
# # # UI
35
36
Komand中用于验证使用的插件的屏幕截图如下所示。
37
38
####工作流生成器
39
40
41
# # # #的工作
42
43
44
# # # #工件