Moved probes, matchers and ciscoRttMonMIB modules to lib/Smokeping.

1 files changed, 282 insertions, 0 deletions

diff --git a/lib/Smokeping/probes/EchoPing.pm b/lib/Smokeping/probes/EchoPing.pm
new file mode 100644
index 0000000..f2aded2
--- /dev/null
+++ b/lib/Smokeping/probes/EchoPing.pm
@@ -0,0 +1,282 @@
+package Smokeping::probes::EchoPing;
+
+=head1 301 Moved Permanently
+
+This is a Smokeping probe module. Please use the command 
+
+C<smokeping -man Smokeping::probes::EchoPing>
+
+to view the documentation or the command
+
+C<smokeping -makepod Smokeping::probes::EchoPing>
+
+to generate the POD document.
+
+=cut
+
+use strict;
+use base qw(Smokeping::probes::basefork);
+use Carp;
+
+my $DEFAULTBIN = "/usr/bin/echoping";
+
+sub pod_hash {
+	return {
+		name => <<DOC,
+Smokeping::probes::EchoPing - an echoping(1) probe for SmokePing
+DOC
+		overview => <<DOC,
+Measures TCP or UDP echo (port 7) roundtrip times for SmokePing. Can also be 
+used as a base class for other echoping(1) probes.
+DOC
+		description => <<DOC,
+See echoping(1) for details of the options below.
+DOC
+		bugs => <<DOC,
+Should we test the availability of the service at startup? After that it's
+too late to complain.
+
+The location of the echoping binary should probably be a global variable
+instead of a probe-specific one. As things are, every EchoPing -derived probe 
+has to declare it if the default ($DEFAULTBIN) isn't correct.
+DOC
+		authors => <<'DOC',
+Niko Tyni <ntyni@iki.fi>
+DOC
+		see_also => <<DOC,
+echoping(1), Smokeping::probes::EchoPingHttp(3pm) etc., http://echoping.sourceforge.net/
+DOC
+	}
+}
+
+#
+# derived class will mess with this through the 'features' method below
+my $featurehash = {
+	waittime => "-w",
+	timeout => "-t",
+	size => "-s",
+	tos => "-P",
+	priority => "-p",
+	fill => "-f",
+};
+
+sub features {
+	my $self = shift;
+	my $newval = shift;
+	$featurehash = $newval if defined $newval;
+	return $featurehash;
+}
+
+sub new {
+	my $proto = shift;
+	my $class = ref($proto) || $proto;
+	my $self = $class->SUPER::new(@_);
+
+	$self->_init if $self->can('_init');
+
+	$self->test_usage;
+
+	return $self;
+}
+
+# warn about unsupported features
+sub test_usage {
+	my $self = shift;
+	my $bin = $self->{properties}{binary};
+	my @unsupported;
+
+	my $arghashref = $self->features;
+	my %arghash = %$arghashref;
+
+	for my $feature (keys %arghash) {
+		if (`$bin $arghash{$feature} 1 127.0.0.1 2>&1` =~ /invalid option|usage/i) {
+			push @unsupported, $feature;
+			$self->do_log("Note: your echoping doesn't support the $feature feature (option $arghash{$feature}), disabling it");
+		}
+	}
+	map { delete $arghashref->{$_} } @unsupported;
+
+	return;
+}
+
+sub ProbeDesc($) {
+	return "TCP or UDP Echo pings using echoping(1)";
+}
+
+# This can be overridden to tag the port number to the address
+# in derived classes (namely EchoPingHttp)
+sub make_host {
+	my $self = shift;
+	my $target = shift;
+	return $target->{addr};
+}
+
+
+# other than host, count and protocol-specific args come from here
+sub make_args {
+	my $self = shift;
+	my $target = shift;
+	my @args;
+	my %arghash = %{$self->features};
+
+	for (keys %arghash) {
+		my $val = $target->{vars}{$_};
+		push @args, ($arghash{$_}, $val) if defined $val;
+	}
+	push @args, $self->ipversion_arg($target);
+	push @args, $target->{vars}{extraopts} if exists $target->{vars}{extraopts};
+
+	return @args;
+}
+
+# this is separated to make it possible to test the service
+# at startup, although we don't do it at the moment.
+sub count_args {
+	my $self = shift;
+	my $count = shift;
+
+	$count = $self->pings() unless defined $count;
+	return ("-n", $count);
+}
+
+# This is what derived classes will override
+sub proto_args {
+	my $self = shift;
+	return $self->udp_arg(@_);
+}
+
+# UDP is defined only for echo and discard
+sub udp_arg {
+	my $self = shift;
+	my $target = shift;
+	my @args;
+
+	my $udp = $target->{vars}{udp};
+	push @args, "-u" if (defined $udp and $udp ne "no" and $udp ne "0");
+
+	return @args;
+}
+
+sub ipversion_arg {
+	my $self = shift;
+	my $target = shift;
+	my $vers = $target->{vars}{ipversion};
+	if (defined $vers and $vers =~ /^([46])$/) {
+		return ("-" . $1);
+	} else {
+		$self->do_log("Invalid `ipversion' value: $vers") if defined $vers;
+		return ();
+	}
+}
+
+sub make_commandline {
+	my $self = shift;
+	my $target = shift;
+	my $count = shift;
+
+	$count |= $self->pings($target);
+
+	my @args = $self->make_args($target);
+	my $host = $self->make_host($target);
+	push @args, $self->proto_args($target);
+	push @args, $self->count_args($count);
+	
+	return ($self->{properties}{binary}, @args, $host);
+}
+
+sub pingone {
+	my $self = shift;
+	my $t = shift;
+
+	my @cmd = $self->make_commandline($t);
+
+	my $cmd = join(" ", @cmd);
+
+	$self->do_debug("executing cmd $cmd");
+
+	my @times;
+
+	open(P, "$cmd 2>&1 |") or carp("fork: $!");
+	
+	# what should we do with error messages?
+	my $echoret;
+	while (<P>) {
+		$echoret .= $_;
+		/^Elapsed time: (\d+\.\d+) seconds/ and push @times, $1;
+	}
+	close P;
+	$self->do_log("WARNING: $cmd was not happy: $echoret") if $?;
+	# carp("Got @times") if $self->debug;
+	return sort { $a <=> $b } @times;
+}
+
+sub probevars {
+	my $class = shift;
+	my $h = $class->SUPER::probevars;
+	delete $h->{timeout};
+	return $class->_makevars($h, {
+		binary => {
+			_doc => "The location of your echoping binary.",
+			_default => $DEFAULTBIN,
+			_sub => sub {
+				my $val = shift;
+				-x $val or return "ERROR: binary '$val' is not executable";
+				return undef;
+			},
+		},
+	});
+}
+
+sub targetvars {
+	my $class = shift;
+	return $class->_makevars($class->SUPER::targetvars, {
+		timeout => {
+			_doc => 'The "-t" echoping(1) option.',
+			_example => 1,
+			_default => 5,
+			_re => '(\d*\.)?\d+',
+		},
+		waittime => {
+			_doc => 'The "-w" echoping(1) option.',
+			_example => 1,
+			_re => '\d+',
+		},
+		size => {
+			_doc => 'The "-s" echoping(1) option.',
+			_example => 510,
+			_re => '\d+',
+		},
+		udp => {
+			_doc => q{The "-u" echoping(1) option. Values other than '0' and 'no' enable UDP.},
+			_example => 'no',
+		},
+		fill => {
+			_doc => 'The "-f" echoping(1) option.',
+			_example => 'A',
+			_re => '.',
+		},
+		priority => {
+			_doc => 'The "-p" echoping(1) option.',
+			_example => 6,
+			_re => '\d+',
+		},
+		tos => {
+			_doc => 'The "-P" echoping(1) option.',
+			_example => '0xa0',
+		},
+		ipversion => {
+			_doc => <<DOC,
+The IP protocol used. Possible values are "4" and "6". 
+Passed to echoping(1) as the "-4" or "-6" options.
+DOC
+			_example => 4,
+			_re => '[46]'
+		},
+		extraopts => {
+			_doc => 'Any extra options specified here will be passed unmodified to echoping(1).',
+			_example => '-some-letter-the-author-did-not-think-of',
+		},
+	});
+}
+
+1;