From 5d82055b67a4f2aa18abacad0f0b9330f7a90688 Mon Sep 17 00:00:00 2001 From: qgarnier Date: Wed, 5 Jul 2023 10:24:34 +0200 Subject: [PATCH] new(plugin): add tosca restapi plugin (#4508) --- .../deb.json | 4 + .../pkg.json | 9 + .../rpm.json | 4 + src/apps/tosca/restapi/custom/api.pm | 277 ++++++++++++++++++ .../tosca/restapi/mode/executionliststatus.pm | 147 ++++++++++ src/apps/tosca/restapi/mode/scenariostatus.pm | 152 ++++++++++ src/apps/tosca/restapi/plugin.pm | 50 ++++ 7 files changed, 643 insertions(+) create mode 100644 packaging/centreon-plugin-Applications-Tosca-Restapi/deb.json create mode 100644 packaging/centreon-plugin-Applications-Tosca-Restapi/pkg.json create mode 100644 packaging/centreon-plugin-Applications-Tosca-Restapi/rpm.json create mode 100644 src/apps/tosca/restapi/custom/api.pm create mode 100644 src/apps/tosca/restapi/mode/executionliststatus.pm create mode 100644 src/apps/tosca/restapi/mode/scenariostatus.pm create mode 100644 src/apps/tosca/restapi/plugin.pm diff --git a/packaging/centreon-plugin-Applications-Tosca-Restapi/deb.json b/packaging/centreon-plugin-Applications-Tosca-Restapi/deb.json new file mode 100644 index 000000000..9757fe112 --- /dev/null +++ b/packaging/centreon-plugin-Applications-Tosca-Restapi/deb.json @@ -0,0 +1,4 @@ +{ + "dependencies": [ + ] +} diff --git a/packaging/centreon-plugin-Applications-Tosca-Restapi/pkg.json b/packaging/centreon-plugin-Applications-Tosca-Restapi/pkg.json new file mode 100644 index 000000000..a37de53cc --- /dev/null +++ b/packaging/centreon-plugin-Applications-Tosca-Restapi/pkg.json @@ -0,0 +1,9 @@ +{ + "pkg_name": "centreon-plugin-Applications-Tosca-Restapi", + "pkg_summary": "Centreon Plugin to monitor Tosca throught Tosca Commander REST Webservice (TCRS)", + "plugin_name": "centreon_tosca_restapi.pl", + "files": [ + "centreon/plugins/script_custom.pm", + "apps/tosca/restapi/" + ] +} diff --git a/packaging/centreon-plugin-Applications-Tosca-Restapi/rpm.json b/packaging/centreon-plugin-Applications-Tosca-Restapi/rpm.json new file mode 100644 index 000000000..9757fe112 --- /dev/null +++ b/packaging/centreon-plugin-Applications-Tosca-Restapi/rpm.json @@ -0,0 +1,4 @@ +{ + "dependencies": [ + ] +} diff --git a/src/apps/tosca/restapi/custom/api.pm b/src/apps/tosca/restapi/custom/api.pm new file mode 100644 index 000000000..160fe6188 --- /dev/null +++ b/src/apps/tosca/restapi/custom/api.pm @@ -0,0 +1,277 @@ +# +# Copyright 2023 Centreon (http://www.centreon.com/) +# +# Centreon is a full-fledged industry-strength solution that meets +# the needs in IT infrastructure and application monitoring for +# service performance. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +package apps::tosca::restapi::custom::api; + +use strict; +use warnings; +use centreon::plugins::http; +use JSON::XS; + +sub new { + my ($class, %options) = @_; + my $self = {}; + bless $self, $class; + + if (!defined($options{output})) { + print "Class Custom: Need to specify 'output' argument.\n"; + exit 3; + } + if (!defined($options{options})) { + $options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument."); + $options{output}->option_exit(); + } + + if (!defined($options{noptions})) { + $options{options}->add_options(arguments => { + 'hostname:s' => { name => 'hostname' }, + 'port:s' => { name => 'port' }, + 'proto:s' => { name => 'proto' }, + 'api-username:s' => { name => 'api_username' }, + 'api-password:s' => { name => 'api_password' }, + 'url-path:s' => { name => 'url_path' }, + 'timeout:s' => { name => 'timeout' }, + 'unknown-http-status:s' => { name => 'unknown_http_status' }, + 'warning-http-status:s' => { name => 'warning_http_status' }, + 'critical-http-status:s' => { name => 'critical_http_status' } + }); + } + $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1); + + $self->{output} = $options{output}; + $self->{http} = centreon::plugins::http->new(%options, default_backend => 'curl'); + + return $self; +} + +sub set_options { + my ($self, %options) = @_; + + $self->{option_results} = $options{option_results}; +} + +sub set_defaults {} + +sub check_options { + my ($self, %options) = @_; + + $self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : ''; + $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 80; + $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'http'; + $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10; + $self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : ''; + $self->{api_password} = (defined($self->{option_results}->{api_password})) ? $self->{option_results}->{api_password} : ''; + $self->{url_path} = (defined($self->{option_results}->{url_path})) ? $self->{option_results}->{url_path} : '/rest/toscacommander'; + $self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300'; + $self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : ''; + $self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : ''; + + if ($self->{hostname} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option."); + $self->{output}->option_exit(); + } + if ($self->{api_username} eq '' || $self->{api_password} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --api-username and --api-password options."); + $self->{output}->option_exit(); + } + + return 0; +} + +sub build_options_for_httplib { + my ($self, %options) = @_; + + $self->{option_results}->{hostname} = $self->{hostname}; + $self->{option_results}->{timeout} = $self->{timeout}; + $self->{option_results}->{port} = $self->{port}; + $self->{option_results}->{proto} = $self->{proto}; + $self->{option_results}->{timeout} = $self->{timeout}; + if ($self->{api_username} ne '') { + $self->{option_results}->{credentials} = 1; + $self->{option_results}->{basic} = 1; + $self->{option_results}->{username} = $self->{api_username}; + $self->{option_results}->{password} = $self->{api_password}; + } +} + +sub settings { + my ($self, %options) = @_; + + return if (defined($self->{settings_done})); + $self->build_options_for_httplib(); + $self->{http}->add_header(key => 'Accept', value => 'application/json'); + $self->{http}->set_options(%{$self->{option_results}}); + $self->{settings_done} = 1; +} + +sub get_hostname { + my ($self, %options) = @_; + + return $self->{hostname}; +} + +sub request_api { + my ($self, %options) = @_; + + $self->settings(); + + my $content = $self->{http}->request( + url_path => $options{endpoint}, + unknown_status => $self->{unknown_http_status}, + warning_status => $self->{warning_http_status}, + critical_status => $self->{critical_http_status} + ); + + if (!defined($content) || $content eq '') { + $self->{output}->add_option_msg(short_msg => "API returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']"); + $self->{output}->option_exit(); + } + + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($content); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)"); + $self->{output}->option_exit(); + } + + return $decoded; +} + +sub get_object_representation { + my ($self, %options) = @_; + + my $response = $self->request_api( + endpoint => $self->{url_path} . "/" . $options{workspace} . "/object/" . $options{object_id} + ); + + if (!defined($response->{TypeName}) || $response->{TypeName} ne $options{object_type}) { + $self->{output}->add_option_msg(short_msg => "Retrieved '" . $response->{TypeName} . "' object type, expected '" . $options{object_type} . "'"); + $self->{output}->option_exit(); + } + + if (!defined($response->{Attributes}) || ref($response->{Attributes}) ne 'ARRAY') { + $self->{output}->add_option_msg(short_msg => "Cannot retrieve object representation attributes"); + $self->{output}->option_exit(); + } + + my %results; + foreach my $attribute (@{$response->{Attributes}}) { + $results{$attribute->{Name}} = $attribute->{Value}; + } + + return %results; +} + +sub get_association_object_id { + my ($self, %options) = @_; + + my $response = $self->request_api( + endpoint => $self->{url_path} . "/" . $options{workspace} . "/object/" . $options{object_id} . "/association/" . $options{association} + ); + + if (!defined(@$response[0]) || !defined(@$response[0]->{UniqueId})) { + $self->{output}->add_option_msg(short_msg => "Cannot retrieve association object ID"); + $self->{output}->option_exit(); + } + + return @$response[0]->{UniqueId}; +} + +sub get_scenario_last_log { + my ($self, %options) = @_; + + my $scenario_last_log_id = $self->get_association_object_id( + workspace => $options{workspace}, + object_id => $options{scenario_id}, + association => 'ActualLog' + ); + + my %log = $self->get_object_representation( + workspace => $options{workspace}, + object_id => $scenario_last_log_id, + object_type => 'ExecutionTestCaseLog' + ); + + return %log; +} + +sub get_execution_list { + my ($self, %options) = @_; + + my %execution_list = $self->get_object_representation( + workspace => $options{workspace}, + object_id => $options{execution_list_id}, + object_type => 'ExecutionList' + ); + + return %execution_list; +} + +1; + +__END__ + +=head1 NAME + +Tosca Commander REST Webservice (TCRS) + +=head1 REST API OPTIONS + +Tosca Commander REST Webservice (TCRS) + +=over 8 + +=item B<--hostname> + +Tosca hostname. + +=item B<--port> + +Port used (Default: 80) + +=item B<--proto> + +Specify https if needed (Default: 'http') + +=item B<--api-username> + +Tosca Commander API username. + +=item B<--api-password> + +Tosca Commander API password. + +=item B<--url-path> + +API base url path (Default: '/rest/toscacommander'). + +=item B<--timeout> + +Set timeout in seconds (Default: 10). + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/src/apps/tosca/restapi/mode/executionliststatus.pm b/src/apps/tosca/restapi/mode/executionliststatus.pm new file mode 100644 index 000000000..c4b630a6d --- /dev/null +++ b/src/apps/tosca/restapi/mode/executionliststatus.pm @@ -0,0 +1,147 @@ +# +# Copyright 2023 Centreon (http://www.centreon.com/) +# +# Centreon is a full-fledged industry-strength solution that meets +# the needs in IT infrastructure and application monitoring for +# service performance. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +package apps::tosca::restapi::mode::executionliststatus; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; + +sub prefix_output { + my ($self, %options) = @_; + + return sprintf("Execution list '" . $options{instance_value}->{name} . "' entries "); +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'global', type => 0, cb_prefix_output => 'prefix_output' } + ]; + + $self->{maps_counters}->{global} = [ + { label => 'entries-passed', nlabel => 'entries.passed.count', set => { + key_values => [ { name => 'passed' }, { name => 'name' } ], + output_template => 'passed: %s', + perfdatas => [ + { template => '%s', min => 0 } + ] + } + }, + { label => 'entries-failed', nlabel => 'entries.failed.count', set => { + key_values => [ { name => 'failed' }, { name => 'name' } ], + output_template => 'failed: %s', + perfdatas => [ + { template => '%s', min => 0 } + ] + } + }, + { label => 'entries-not-executed', nlabel => 'entries.not_executed.count', set => { + key_values => [ { name => 'not_executed' }, { name => 'name' } ], + output_template => 'not executed: %s', + perfdatas => [ + { template => '%s', min => 0 } + ] + } + }, + { label => 'entries-unknown', nlabel => 'entries.unknown.count', set => { + key_values => [ { name => 'unknown' }, { name => 'name' } ], + output_template => 'unknown: %s', + perfdatas => [ + { template => '%s', min => 0 } + ] + } + } + ]; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1); + bless $self, $class; + + $options{options}->add_options(arguments => { + 'workspace:s' => { name => 'workspace' }, + 'execution-list-id:s' => { name => 'execution_list_id' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{execution_list_id}) || $self->{option_results}->{execution_list_id} eq '') { + $self->{output}->add_option_msg(short_msg => 'Please set --execution-list-id option.'); + $self->{output}->option_exit(); + } + + if (!defined($self->{option_results}->{workspace}) || $self->{option_results}->{workspace} eq '') { + $self->{output}->add_option_msg(short_msg => 'Please set --workspace option.'); + $self->{output}->option_exit(); + } +} + +sub manage_selection { + my ($self, %options) = @_; + + my %scenario_log = $options{custom}->get_execution_list( + workspace => $self->{option_results}->{workspace}, + execution_list_id => $self->{option_results}->{execution_list_id} + ); + + $self->{global} = { + name => $scenario_log{Name}, + passed => $scenario_log{NumberOfTestCasesPassed}, + failed => $scenario_log{NumberOfTestCasesFailed}, + not_executed => $scenario_log{NumberOfTestCasesNotExecuted}, + unknown => $scenario_log{NumberOfTestCasesWithUnknownState} + }; +} + +1; + +__END__ + +=head1 MODE + +Check execution list status. + +=over 8 + +=item B<--workspace> + +Workspace name of the provided execution list. + +=item B<--execution-list-id> + +Execution list unique ID. + +=item B<--warning-entries-*> B<--critical-entries-*> + +Thresholds. +Can be: 'passed', 'failed', 'not-executed', 'unknown'. + +=back + +=cut diff --git a/src/apps/tosca/restapi/mode/scenariostatus.pm b/src/apps/tosca/restapi/mode/scenariostatus.pm new file mode 100644 index 000000000..044c73df3 --- /dev/null +++ b/src/apps/tosca/restapi/mode/scenariostatus.pm @@ -0,0 +1,152 @@ +# +# Copyright 2023 Centreon (http://www.centreon.com/) +# +# Centreon is a full-fledged industry-strength solution that meets +# the needs in IT infrastructure and application monitoring for +# service performance. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +package apps::tosca::restapi::mode::scenariostatus; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng); + +sub prefix_output { + my ($self, %options) = @_; + + return sprintf("Scenario '" . $options{instance_value}->{name} . "' "); +} + +sub custom_status_output { + my ($self, %options) = @_; + + return sprintf( + "result is '%s' [start time:'%s', end time:'%s']", + $self->{result_values}->{result}, + $self->{result_values}->{start_time}, + $self->{result_values}->{end_time} + ); +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'global', type => 0, cb_prefix_output => 'prefix_output' } + ]; + + $self->{maps_counters}->{global} = [ + { label => 'status', type => 2, critical_default => '%{result} !~ /Passed/', set => { + key_values => [ { name => 'result' }, { name => 'start_time' }, { name => 'end_time' }, { name => 'name' } ], + closure_custom_output => $self->can('custom_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold_ng + } + }, + { label => 'duration', nlabel => 'scenario.duration.seconds', set => { + key_values => [ { name => 'duration' }, { name => 'name' } ], + output_template => 'duration: %.2f seconds', + perfdatas => [ + { template => '%.2f', min => 0, unit => 's' } + ] + } + } + ]; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1); + bless $self, $class; + + $options{options}->add_options(arguments => { + 'workspace:s' => { name => 'workspace' }, + 'scenario-id:s' => { name => 'scenario_id' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{scenario_id}) || $self->{option_results}->{scenario_id} eq '') { + $self->{output}->add_option_msg(short_msg => 'Please set --scenario-id option.'); + $self->{output}->option_exit(); + } + + if (!defined($self->{option_results}->{workspace}) || $self->{option_results}->{workspace} eq '') { + $self->{output}->add_option_msg(short_msg => 'Please set --workspace option.'); + $self->{output}->option_exit(); + } +} + +sub manage_selection { + my ($self, %options) = @_; + + my %scenario_log = $options{custom}->get_scenario_last_log( + workspace => $self->{option_results}->{workspace}, + scenario_id => $self->{option_results}->{scenario_id} + ); + + $self->{global} = { + name => $scenario_log{Name}, + result => $scenario_log{Result}, + start_time => $scenario_log{StartTime}, + end_time => $scenario_log{EndTime}, + duration => $scenario_log{Duration} / 1000 + }; +} + +1; + +__END__ + +=head1 MODE + +Check scenario status. + +=over 8 + +=item B<--workspace> + +Workspace name of the provided scenario. + +=item B<--scenario-id> + +Scenario unique ID. + +=item B<--warning-status> + +Define the conditions to match for the status to be WARNING. +You can use the following variables: %{result} + +=item B<--critical-status> + +Define the conditions to match for the status to be CRITICAL (default: '%{result} !~ /Passed/'). +You can use the following variables: %{result} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'duration'. + +=back + +=cut diff --git a/src/apps/tosca/restapi/plugin.pm b/src/apps/tosca/restapi/plugin.pm new file mode 100644 index 000000000..e06f79732 --- /dev/null +++ b/src/apps/tosca/restapi/plugin.pm @@ -0,0 +1,50 @@ +# +# Copyright 2023 Centreon (http://www.centreon.com/) +# +# Centreon is a full-fledged industry-strength solution that meets +# the needs in IT infrastructure and application monitoring for +# service performance. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +package apps::tosca::restapi::plugin; + +use strict; +use warnings; +use base qw(centreon::plugins::script_custom); + +sub new { + my ( $class, %options ) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $self->{version} = '0.1'; + $self->{modes} = { + 'execution-list-status' => 'apps::tosca::restapi::mode::executionliststatus', + 'scenario-status' => 'apps::tosca::restapi::mode::scenariostatus' + }; + + $self->{custom_modes}{api} = 'apps::tosca::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check Tosca scenarii using Tosca Commander REST Webservice (TCRS). + +=cut