Merge ~bladernr/plainbox-provider-checkbox:add-sosreport-job into plainbox-provider-checkbox:master

[Jeff Lane ]

Add new sosreport job to generate a baseline sosreport for support to use if needed for support cases.

[Jonathan Cave (jocave)]

I think miscellanea/sosreport needs resource requirements added to make sure sosreport is available.

Given we are moving to provide support for the server plans in checkbox delivered both by deb and snap the pattern we have been using is:

requires:
 package.name == 'sosreport' or executable.name == 'sosreport'

(Excutable may not always be same as package name!)

review: Needs Fixing

[Jeff Lane  (bladernr)]

Added. I don't get specifcying exectuable.name if it's the same, nor can I see specifcying both, when one is sufficient.

For example, why is:

requires: executable.name == 'foo'
OR
requires package.name == 'bar'

not sufficient on their own?

If it's requires: package.name = 'bar'

it's pretty safe to assume that the script knows to call executable foo, otherwise it won't work.

IN any case, sosreport is part of the default server seed, so it's always there. I've added a requirement for the package to be there, that should be sufficient, and the executable will always be called 'sosreport'. That is unlikely to ever change, as it is an industry wide recognized tool for gathering support information.

[Jeff Lane  (bladernr)]

review: Needs Resubmitting

[Jonathan Cave (jocave)]

Thanks for the requires field.

review: Approve

diff --git a/jobs/miscellanea.txt.in b/jobs/miscellanea.txt.in
index dc79a32..6dec07d 100644
--- a/jobs/miscellanea.txt.in
+++ b/jobs/miscellanea.txt.in
@@ -334,3 +334,23 @@ _steps:
     2. Compare items on System Manifest to the devices known to udev
 _verification:
     Do the devices reported by udev match the devices on the Manifest?
+
+plugin: shell
+category_id: com.canonical.plainbox::miscellanea
+estimated_duration: 20.0
+id: miscellanea/sosreport
+user: root
+requires: executable.name == 'sosreport'
+command: sosreport --batch --tmp-dir $PLAINBOX_SESSION_SHARE
+_summary: Generate baseline sosreport
+_description: Generates a baseline sosreport of logs and system data
+
+plugin: attachment
+category_id: com.canonical.plainbox::miscellanea
+estimated_duration: 5.0
+id: miscellanea/sosreport_attachment
+depends: miscellanea/sosreport
+user: root
+command:
+ SOSFILE=`ls -t $PLAINBOX_SESSION_SHARE/sosreport*xz | head -1`; [ -e ${SOSFILE} ] && base64 $SOSFILE
+_summary: Attach the baseline sosreport file