From e0a666668a80012d1905905244de2ebb5e01f96f Mon Sep 17 00:00:00 2001
From: Oliver Gorwits <oliver@cpan.org>
Date: Sun, 3 Sep 2017 18:54:44 +0100
Subject: [PATCH] fix pod; set status defaults; stub runner mixin

---
 lib/App/Netdisco/Backend/Runner.pm         | 15 +++++++++++++++
 lib/App/Netdisco/Manual/WritingWorkers.pod |  8 ++++----
 lib/App/Netdisco/Worker/Status.pm          | 11 ++++++++---
 3 files changed, 27 insertions(+), 7 deletions(-)
 create mode 100644 lib/App/Netdisco/Backend/Runner.pm

diff --git a/lib/App/Netdisco/Backend/Runner.pm b/lib/App/Netdisco/Backend/Runner.pm
new file mode 100644
index 00000000..42443947
--- /dev/null
+++ b/lib/App/Netdisco/Backend/Runner.pm
@@ -0,0 +1,15 @@
+package App::Netdisco::Backend::Runner;
+
+use Dancer ':moose :syntax';
+use App::Netdisco::Worker::Status;
+
+use Try::Tiny;
+use Role::Tiny;
+use namespace::clean;
+
+# mixin code to run workers loaded via plugins
+sub run {
+  return App::Netdisco::Worker::Status->new({done => true, message => 'ok'});
+}
+
+true;
diff --git a/lib/App/Netdisco/Manual/WritingWorkers.pod b/lib/App/Netdisco/Manual/WritingWorkers.pod
index 89f9471d..02a32c37 100644
--- a/lib/App/Netdisco/Manual/WritingWorkers.pod
+++ b/lib/App/Netdisco/Manual/WritingWorkers.pod
@@ -119,7 +119,7 @@ namespace and set C<primary> to be C<true>.
 
 =back
 
-=head2 Worker Execution and Return Code
+=head1 Worker Execution and Return Code
 
 Workers are configured as an ordered list. They are grouped by C<action> and
 C<phase> (as in Package Naming Convention, above).
@@ -137,7 +137,7 @@ Remember that a worker is only run if it matches the hardware platform of the
 target device and the user's configuration, and is not also excluded by the
 user's configuration. This filtering takes place before inspecting C<primary>.
 
-=head2 Accessing Transports
+=head1 Accessing Transports
 
 From your worker you will want to connect to a device to gather data. This is
 done using a transport protocol session (SNMP, SSH, etc). Transports are
@@ -154,7 +154,7 @@ L<App::Netdisco::Transport::SNMP>
 
 =back
 
-=head2 Review of Terminology
+=head1 Review of Terminology
 
 In summary, Worker code is defined in a package namespace specifying the
 Action and Phase, and registered as a plugin with configuration which may
@@ -197,7 +197,7 @@ by setting this option and returning true from your worker.
 
 =back
 
-=head2 Database Connections
+=head1 Database Connections
 
 The Netdisco database is available via the C<netdisco> schema key, as below.
 You can also use the C<external_databases> configuration item to set up
diff --git a/lib/App/Netdisco/Worker/Status.pm b/lib/App/Netdisco/Worker/Status.pm
index cfed571c..495bf900 100644
--- a/lib/App/Netdisco/Worker/Status.pm
+++ b/lib/App/Netdisco/Worker/Status.pm
@@ -10,14 +10,19 @@ foreach my $slot (qw/
       done
       error
       defer
-      message
     /) {
 
   has $slot => (
     is => 'rw',
+    default => 0,
   );
 }
 
+has 'log' => (
+  is => 'rw',
+  default => '',
+);
+
 =head1 METHODS
 
 =head2 ok
@@ -53,7 +58,7 @@ sub status {
 
 =head2 update_job
 
-Updates an L<App::Netdisco::Backend::Job> with status and message.
+Updates an L<App::Netdisco::Backend::Job> with status and log.
 
 =cut
 
@@ -61,7 +66,7 @@ sub update_job {
   my $self = shift;
   my $job = shift or return;
   $job->status( $self->status );
-  $job->log( $self->message );
+  $job->log( $self->log );
 }
 
 1;