Connector/Hillstone.pm untested

filter: Statementstmt 0.0% 0 / 65 Branchbran 0.0% 0 / 12 Conditioncond 0.0% 0 / 3 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 0.0% 0 / 9 Podpod 0.0% 0 / 3 totaltotal 0.0% 0 / 94 CC 7 SCAR 25.2
CC
7
Cov
0%
execCommands
30.0
waitfor
6.0
getConfig
6.0
CRAP 12.4
1 package PDK::Connector::Hillstone;
2
3 use utf8;
4 use v5.30;
5 use Moose;
6 use Carp;
7 use Data::Dumper;
8 use Expect qw(exp_continue);
9
10 # 继承连接器常用功能
11 with 'PDK::Connector::Role';
12
13 # 登录成功提示符(Hillstone设备特有格式)
14 has prompt => (
15 is => 'ro',
16 required => 0,
17 default => '^.*?(\((?:M|B|F)\))?[>#]\s*$', # 匹配Hillstone设备的提示符格式
18 );
19
20 # 特权模式状态标志(Hillstone设备默认进入特权模式)
21 has _enable_ => (
22 is => 'ro',
23 required => 0,
24 default => 1, # Hillstone设备默认进入特权模式
25 );
26
27 # 等待设备响应,处理各种交互提示
28 sub waitfor {
29 my ($self, $prompt) = @_;
30 $prompt //= $self->{prompt}; # 使用提供的提示符或默认提示符
31
32 my $exp = $self->{exp};
33 my $buff = "";
34
35 # 等待设备响应,处理各种交互提示
36 my @ret = $exp->expect($self->{timeout},
37 # 处理分页提示(Hillstone特有格式)
38 [ qr/^.+more.+$/mi => sub {
39 $exp->send(" "); # 发送空格继续显示
40 $buff .= $exp->before(); # 保存当前输出
41 exp_continue;
42 } ],
43 # 自动输入 Y(处理确认提示)
44 [ qr/are you sure\?/i => sub {
45 $self->send("y"); # 发送y确认
46 $buff .= $exp->before() . $exp->match();
47 exp_continue;
48 } ],
49 # 匹配命令提示符
50 [ qr/$prompt/m => sub {
51 $buff .= $exp->before() . $exp->match(); # 保存完整输出
52 } ]
53 );
54
55 # 检查Expect操作是否出错
56 if (defined $ret[1]) {
57 croak("[等待回显捕捉异常]" . $ret[3] . $ret[1]);
58 }
59
60 # 清理输出内容(Hillstone设备特有控制字符)
61 $buff =~ s/\c@\cH+\s+\cH+//g; # 移除退格控制字符及其影响的文本
62 $buff =~ s/\cM//g; # 移除回车符(CR),保留换行符(LF)
63
64 return $buff;
65 }
66
67 # 执行多个命令
68 sub execCommands {
69 my ($self, $commands) = @_;
70
71 # 检查登录状态,如果未登录则先登录
72 if (!$self->{_login_}) {
73 my $ret = $self->login();
74 return $ret unless $ret->{success};
75 }
76
77 my $result = '';
78 # 逐个执行命令
79 for my $cmd (@{$commands}) {
80 $self->send("$cmd\n");
81
82 # 检查命令是否执行失败(Hillstone特有错误消息)
83 my $buff = $self->waitfor();
84 if ($buff =~ /incomplete|ambiguous|unrecognized keyword|\^-----/i) {
85 return {
86 success => 0,
87 failCommand => $cmd,
88 result => $result,
89 reason => $buff
90 };
91 }
92 elsif ($buff =~ /syntax error|missing argument|unknown command|\^Error:/i) {
93 return {
94 success => 0,
95 failCommand => $cmd,
96 result => $result,
97 reason => $buff
98 };
99 }
100 else {
101 $result .= $buff; # 保存命令执行结果
102 }
103 }
104
105 return { success => 1, result => $result };
106 }
107
108 # 获取设备配置方法(Hillstone特有命令)
109 sub getConfig {
110 my $self = shift;
111 my $commands = [
112 "terminal length 0", # 禁用分页
113 "show configuration" # 显示配置
114 ];
115 my $config = $self->execCommands($commands);
116 my $lines = "";
117
118 if ($config->{success} == 1) {
119 $lines = $config->{result};
120 }
121 else {
122 return $config; # 返回错误信息
123 }
124
125 return { success => 1, config => $lines };
126 }
127
128 # 使Moose类不可变
129 __PACKAGE__->meta->make_immutable;
130 1;
131
132 =encoding utf8
133 =head1 NAME
134
135 PDK::Connector::Hillstone - Hillstone 山石防火墙设备连接器
136
137 =head1 SYNOPSIS
138
139 use PDK::Connector::Hillstone;
140
141 # 创建 Hillstone 设备连接器实例
142 my $conn = PDK::Connector::Hillstone->new(
143 host => '192.168.1.1',
144 username => 'admin',
145 password => 'password'
146 );
147
148 # 登录设备
149 $conn->login;
150
151 # 获取设备配置
152 my $config = $conn->getConfig;
153
154 # 执行自定义命令
155 my $result = $conn->execCommands(['show version', 'show interface']);
156
157 =head1 DESCRIPTION
158
159 Hillstone 山石防火墙设备专用连接器,继承 L<PDK::Connector::Role> 角色,提供与 Hillstone 防火墙设备的交互功能。
160
161 支持设备登录、命令执行、配置获取等操作,自动处理 Hillstone 设备特有的交互提示、分页显示和控制字符。
162
163 =head1 ATTRIBUTES
164
165 =head2 prompt
166
167 Hillstone 设备命令行提示符的正则表达式模式,默认匹配包含模式标识(M/B/F)的提示符格式。
168
169 =head2 _enable_
170
171 特权模式状态标志,Hillstone 设备默认进入特权模式,值为 1。
172
173 =head1 METHODS
174
175 =head2 waitfor
176
177 my $output = $conn->waitfor($prompt);
178
179 等待设备响应,处理 Hillstone 设备特有的交互提示:
180 - 分页显示控制(more 提示)
181 - 操作确认提示(are you sure?)
182
183 自动清理输出中的控制字符,返回处理后的文本内容。
184
185 =head2 execCommands
186
187 my $result = $conn->execCommands(\@commands);
188
189 执行多个命令序列。自动检测 Hillstone 特有的错误消息(incomplete/ambiguous/unrecognized keyword/syntax error 等),返回包含执行结果的结构化数据。
190
191 =head2 getConfig
192
193 my $config = $conn->getConfig;
194
195 获取设备完整配置。使用 Hillstone 特有的命令序列:
196 - 禁用分页显示(terminal length 0)
197 - 显示配置(show configuration)
198
199 =head1 SEE ALSO
200
201 L<PDK::Connector::Role>, L<Expect>, L<Moose>
202
203 =head1 AUTHOR
204
205 WENWU YAN E<lt>968828@gmail.comE<gt>
206
207 =head1 LICENSE AND COPYRIGHT
208
209 版权所有 2025 WENWU YAN。
210
211 本软件按Perl自身许可条款发布。
212
213 =cut