API Endpoints to submit arpnip and macsuck results (#942)

* Add macsuck worker to collect various PortAccessEntity (NAC) attributes

* Incorporate PAE feedback on #937

 * missing Result/Device.pm column added
 * pae_is... columns instead of pae_capabilities
 * moved most code to Util/PortAccessEntity.pm so the update can
   be done in discover and macsuck

* Refactor PAE attributes during discover as separate Plugin

* PortAccessEntity: don't use device->dns in log string

* Fix "Experimental keys on scalar is now forbidden" test failure

* Revamp pae_control and add missing attribute

 - device.pae_control (text) is now device.pae_is_enabled (bool)
 - also store pae_authconfig_port_control (port mode auto/force(un)Auth)

* Fix "Experimental keys on scalar is now forbidden" test failure

 - ... again because of botched merge
 - at least perlgolfed away a set of curly braces

* Update PortAccessEntity.pm

* Incorporate @ollyg PR feedback

* allow actions without transport to run when there are also no creds

* initial refactor for separate gather, process, store phases for macsuck

* factor out the vlan sanity check

* additional help with log of action workers

* cleanup logic in check macsuck

* refactor to make main phases only

* some fixes

* implement file slurp. amazingly the whole thing works

* remove outdated noop from test

* treat error as critical, use cancel to suppress further drivers

* big refactor to share mac sanity code to both paths

* fix inverted logic on vlan sanity filter

* some code tidy

* fix error in default value

* fix for vlan 0 nodes input from cli

* ensure imported MACs are IEEE format

* add api endpoint, no useful return status yet

* exit status if error from nodes PUT

* suppress other networked workers when direct workers are active

* better log showing worker

* fix status recording to get first error or last done message

* implement arpnip API PUT

* avoid package redeclaration error

* make sure write API methods require admin status

* add doc for passing JSON data to arpnip and macsuck

* update manifest

* remove option to do jobs in web handler; all by queue now

* use job entry timestamp for offline queued jobs

* fix store username and IP on api PUT

* never de-duplicate user-submitted jobs; never reset DeviceSkip for offline jobs

* myworker no longer needed

* make logic cleaner

Co-authored-by: Christian Ramseyer <ramseyer@netnea.com>

xt/30-backend-workers.t

@@ -19,7 +19,7 @@ use Dancer qw/:moose :script !pass/;
 # configure logging to force console output
 my $CONFIG = config();
 $CONFIG->{logger} = 'console';
-$CONFIG->{log} = 'error';
+$CONFIG->{log} = ($ENV{'DANCER_DEBUG'} ? 'debug' : 'error');
 Dancer::Logger->init('console', $CONFIG);
 
 {
@@ -93,6 +93,20 @@ is($j8->_last_priority, 100, 'priority is for snmp');
 is($j8->log, 'OK: SNMP driver is successful.',
   'add to an action');
 
+config->{'device_auth'} = [];
+
+my $j9 = do_job('TestSix');
+is($j9->status, 'done', 'status is done');
+is((scalar @{$j9->_statuslist}), 3, 'three workers ran');
+is($j9->_last_priority, 0, 'priority is for driverless action');
+is($j9->log, 'OK: second driverless action is successful.',
+  'driverless actions always run');
+
+my $j9 = do_job('TestSeven');
+is($j9->best_status, 'error', 'status is error');
+is((scalar @{$j9->_statuslist}), 2, 'two workers ran');
+is($j9->_last_priority, 1000000, 'priority is for direct action');
+
 done_testing;
 
 # TESTS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

xt/lib/App/NetdiscoX/Worker/Plugin/TestFive.pm

@@ -6,11 +6,11 @@ use aliased 'App::Netdisco::Worker::Status';
 
 # info 'test: add to an action';
 
-register_worker({ phase => 'main', driver => 'snmp' }, sub {
-  return Status->error('NOT OK: additional worker at SNMP level.');
+register_worker({ phase => 'main', driver => 'snmp', title => 'NOT OK' }, sub {
+  return Status->done('NOT OK: additional worker at SNMP level.');
 });
 
-register_worker({ phase => 'main', driver => 'snmp' }, sub {
+register_worker({ phase => 'main', driver => 'snmp', title => 'OK' }, sub {
   return Status->done('OK: SNMP driver is successful.');
 });
 

xt/lib/App/NetdiscoX/Worker/Plugin/TestOne.pm

@@ -7,7 +7,7 @@ use aliased 'App::Netdisco::Worker::Status';
 # info 'test: workers are run in decreasing priority until done';
 
 register_worker({ phase => 'main', driver => 'cli' }, sub {
-  return Status->noop('NOT OK: CLI driver is not the winner here.');
+  return Status->info('NOT OK: CLI driver is not the winner here.');
 });
 
 register_worker({ phase => 'main', driver => 'snmp' }, sub {

xt/lib/App/NetdiscoX/Worker/Plugin/TestSeven.pm

@@ -0,0 +1,17 @@
+package App::NetdiscoX::Worker::Plugin::TestSeven;
+
+use Dancer ':syntax';
+use App::Netdisco::Worker::Plugin;
+use aliased 'App::Netdisco::Worker::Status';
+
+# info 'test: add to an action';
+
+register_worker({ phase => 'main', driver => 'direct', title => 'cancelled' }, sub {
+  return (shift)->cancel('NOT OK: cancelled job at direct level.');
+});
+
+register_worker({ phase => 'main', driver => 'snmp', title => 'OK' }, sub {
+  return Status->done('OK: SNMP driver is successful.');
+});
+
+true;

xt/lib/App/NetdiscoX/Worker/Plugin/TestSix.pm

@@ -0,0 +1,21 @@
+package App::NetdiscoX::Worker::Plugin::TestSix;
+
+use Dancer ':syntax';
+use App::Netdisco::Worker::Plugin;
+use aliased 'App::Netdisco::Worker::Status';
+
+# info 'test: driverless actions always run';
+
+register_worker({ phase => 'main', title => 'first driverless action' }, sub {
+  return Status->done('OK: first driverless action is successful.');
+});
+
+register_worker({ phase => 'main', driver => 'snmp', title => 'worker at SNMP' }, sub {
+  return Status->error('NOT OK: additional worker at SNMP level.');
+});
+
+register_worker({ phase => 'main', title => 'second driverless action' }, sub {
+  return Status->done('OK: second driverless action is successful.');
+});
+
+true;