Merge lp:~roadmr/checkbox/environ-test into lp:checkbox

[Daniel Manrique]

Added a unit test to verify that all environment variables referenced in a job's command are also properly "exported" using environ if the command specifies a user.

Added a unit test to verify that all environment variables referenced in a job's command are also properly "exported" using environ if the command specifies a user.

[Marc Tardif (cr3)]

This is getting borderline fuzzy, having to use a regular expression to find shell variables in the command, but it will certainly help to catch some omissions. Thanks!

review: Approve

=== modified file 'checkbox/tests/test_message_files.py'
--- checkbox/tests/test_message_files.py	2012-10-09 13:32:06 +0000
+++ checkbox/tests/test_message_files.py	2012-10-26 15:14:28 +0000
@@ -59,6 +59,25 @@
             if message['plugin'] == 'shell':
                 self.assertTrue("description" in message, message['name'])
 
+    def test_shell_jobs_with_root_have_needed_environ(self):
+        import re
+        shell_variables_regex = r'\$\{?([A-Z_]+)\}?'
+        environ_variables_regex = r'([A-Z_]+)'
+        for message in self.messages:
+            if message['plugin'] == 'shell' and 'user' in message:
+                shell_variables = []
+                environ_variables = []
+                for key in ['command', 'command_extended']:
+                    if key in message:
+                        shell_variables += re.findall(shell_variables_regex,
+                                                      message[key])
+                if 'environ' in message:
+                    environ_variables = re.findall(environ_variables_regex, 
+                                                   message['environ'])
+                self.assertEquals(set(environ_variables),
+                                  set(shell_variables),
+                                  message['name'])
+
     def test_jobs_comply_with_schema(self):
         globals = {}
         exec(open("plugins/jobs_info.py").read(), globals)

=== modified file 'debian/changelog'
--- debian/changelog	2012-10-26 14:28:19 +0000
+++ debian/changelog	2012-10-26 15:14:28 +0000
@@ -37,6 +37,8 @@
   * Added retrying pactl commands in case audio layer is not up yet
     (LP: #1065908)
   * Removed references to inexistent opts.verbose setting (LP: #1070829)
+  * Added unit test to catch jobs with mismatching environ and actual
+    variables used in shell command (LP: #955053)
 
   [Marc Tardif]
   * plugins/environment_info.py: Enabling environment to take precedence
@@ -92,7 +94,7 @@
   * checkbox/parsers/modinfo.py - added exception handling to address possible
     bad output from modinfo causing a ValueError to occur. (LP: #1066118)
 
- -- Daniel Manrique <[e-mail]>  Wed, 24 Oct 2012 10:00:12 -0400
+ -- Daniel Manrique <[e-mail]>  Thu, 25 Oct 2012 17:35:57 -0400
 
 checkbox (0.14.6) quantal; urgency=low
 

=== modified file 'jobs/power-management.txt.in'
--- jobs/power-management.txt.in	2012-10-23 09:46:09 +0000
+++ jobs/power-management.txt.in	2012-10-26 15:14:28 +0000
@@ -12,6 +12,7 @@
 
 plugin: shell
 name: power-management/fwts_wakealarm
+environ: CHECKBOX_DATA
 user: root
 _description: Test ACPI Wakealarm (fwts wakealarm)
 requires:

=== modified file 'jobs/stress.txt.in'
--- jobs/stress.txt.in	2012-10-19 13:28:52 +0000
+++ jobs/stress.txt.in	2012-10-26 15:14:28 +0000
@@ -11,6 +11,7 @@
 plugin: shell
 name: power-management/hibernate_30_cycles
 depends: power-management/rtc
+environ: CHECKBOX_DATA
 user: root
 command:
  if type -P fwts >/dev/null; then
@@ -33,6 +34,7 @@
 plugin: shell
 name: power-management/suspend_30_cycles
 depends: power-management/rtc
+environ: CHECKBOX_DATA
 user: root
 command: 
  if type -P fwts >/dev/null; then
@@ -55,6 +57,7 @@
 plugin: shell
 name: stress/hibernate_250_cycles
 depends: power-management/rtc
+environ: CHECKBOX_DATA
 user: root
 command:
  if type -P fwts >/dev/null; then
@@ -77,6 +80,7 @@
 plugin: shell
 name: stress/suspend_250_cycles
 depends: power-management/rtc
+environ: CHECKBOX_DATA
 user: root
 command:
  if type -P fwts >/dev/null; then