NAME

Security::TLSCheck::Checks - Base class for all checks

SYNOPSIS

As check subclass:

 package Security::TLSCheck::Checks::MyCheck
 
 use Moose;
 extends 'Security::TLSCheck::Checks'

 has '+description' => ( default => "Checking my checks");

As caller:

 use Security::TLSCheck::Checks::MyCheck;
 
 my $check = Security::TLSCheck::Checks::MyCheck->new();
 say "Check Name:        " . $check->name;
 say "Check Description: " . $check->description;

 my @results = $check->run_check;
 
 say "Check runtime: " . $check->runtime;

DESCRIPTION

Base class for all checks. Defines all common attributes, and helper methods.

For a project overview, see the README.md of the Distribution.

METHODS

BUILD

_build_name

Default name is name of the package, without the basename.

_build_class

Default name is name of the package, without the basename.

_build_www

generaters "www.domain" from domain.

Very simple at the moment: only prepends www.

->runtime

Returns the runtime in seconds of this check.

->run_check

Default for runing all tests: the tests are started via the method calls of key_figures in the result method.

So, this method only calls the result method and returns its return value.

For more complex runs override run_check.

result

calculates the result, according to the "key_figures" attribute.

Returns a array(ref) of hashrefs:

  [
     {
     info  => { name => "My Name", type => "flag", ... },
     value => 3,
     },
  
  ]