Merge lp:~roadmr/checkbox/1306793-fix-requirements-job into lp:checkbox

[Daniel Manrique]

    provider:resource: Fixed command and improved description for requirement job

    Requirement job will now only fail if it actually has trouble reading
    the requirements file.

    The documentation (in the job's description) was expanded to make it
    clearer.

    provider:resource: Fixed command and improved description for requirement job

    Requirement job will now only fail if it actually has trouble reading
    the requirements file.

    The documentation (in the job's description) was expanded to make it
    clearer.

[Zygmunt Krynicki (zyga)]

+1

review: Approve

=== modified file 'providers/plainbox-provider-resource-generic/jobs/resource.txt'
--- providers/plainbox-provider-resource-generic/jobs/resource.txt	2014-04-08 19:49:46 +0000
+++ providers/plainbox-provider-resource-generic/jobs/resource.txt	2014-06-10 14:06:32 +0000
@@ -183,15 +183,32 @@
 id: requirements
 estimated_duration: 0.01
 plugin: resource
-command: [ -f $PLAINBOX_SESSION_SHARE/requirements_docs.txt ] && cat $PLAINBOX_SESSION_SHARE/requirements_docs.txt
+command:
+ if [ -f $PLAINBOX_SESSION_SHARE/requirements_docs.txt ];then
+    cat $PLAINBOX_SESSION_SHARE/requirements_docs.txt
+ else
+    true
+ fi
 _description:
  Provide links to requirements documents.
  .
+ The requirement document should contain sets of name/link pairs.
+ .
  Each requirement should have two keys with their respective
  values:
  name: (to be used as the anchor text)
  link: (the actual URL)
  .
+ Each set should be separated from the previous one by a new line.
+ .
+ Example:
+ .
+ name: Requirement 1
+ link: http://example.com/requirement1
+ .
+ name: requirement 2
+ link: http://example.com/requirement2
+ .
  Providers wishing to use this feature need to:
  1- Write a job that places a suitably-formatted file in $PLAINBOX_SESSION_SHARE
  2- Update their whitelists to run that job *before* miscellanea/submission-resources