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

[Daniel Manrique]

OK, here's another stab at setting env variables for user: root jobs.

If environ: is specified in a job description, the specified environment variables will be taken from the frontend's environment and put in the backend's env prior to running the job.

I modified the wireless job files (the ones that prompted this madness) to use the new mechanism.

To test this, one could define a job like this:

plugin: shell
user: root
environ: WHATEVER
command: echo "the variable is $WHATEVER"
description: nothing really

put this on a whitelist or something and run:

WHATEVER="anything" checkbox-gtk -W my.whitelist

The test result should contain "the variable is anything" with the environ fix in place, and just "the variable is" without it.

The change is pretty much self-contained, doesn't really interact with any other code in checkbox, and can hopefully be easily backportable to any required branches.

[lp:~roadmr/checkbox/897889-environ]

1146. By Daniel Manrique on 2011-12-08

Fixed borked indenting

[Brendan Donegan (brendan-donegan)]

Yeah, we got it!

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2011-12-07 21:25:59 +0000
+++ debian/changelog	2011-12-08 22:34:26 +0000
@@ -19,8 +19,10 @@
   [Daniel Manrique]
   * Update control files under debian/ to eliminate (most) lintian warnings
     (LP: #352986)
+  * Environment variables specified with environ: in a job description will be
+    passed to the backend for it to add to its environment. (LP: #897889)
 
- -- Daniel Manrique <[e-mail]>  Tue, 06 Dec 2011 16:31:47 -0500
+ -- Daniel Manrique <[e-mail]>  Thu, 08 Dec 2011 16:43:28 -0500
 
 checkbox (0.13) precise; urgency=low
 

=== modified file 'jobs/wireless.txt.in'
--- jobs/wireless.txt.in	2011-11-29 21:32:22 +0000
+++ jobs/wireless.txt.in	2011-12-08 22:34:26 +0000
@@ -23,6 +23,7 @@
 name: wireless/wireless_connection_wpa_bg
 requires: device.category == 'WIRELESS'
 user: root
+environ: WPA_BG_SSID WPA_BG_PSK
 command: create_connection $WPA_BG_SSID --security=wpa --key=$WPA_BG_PSK && nmcli con up id $WPA_BG_SSID && internet_test
 _description:
  Tests that the systems wireless hardware can connect to a router using WPA
@@ -32,6 +33,7 @@
 name: wireless/wireless_connection_open_bg
 requires: device.category == 'WIRELESS'
 user: root
+environ: OPEN_BG_SSID
 command: create_connection $OPEN_BG_SSID && nmcli con up id $OPEN_BG_SSID && internet_test
 _description:
  Tests that the systems wireless hardware can connect to a router using no
@@ -41,6 +43,7 @@
 name: wireless/wireless_connection_wpa_n
 requires: device.category == 'WIRELESS'
 user: root
+environ: WPA_N_SSID WPA_N_PSK
 command: create_connection $WPA_N_SSID --security=wpa --key=$WPA_N_PSK && nmcli con up id $WPA_N_SSID && internet_test
 _description:
  Tests that the systems wireless hardware can connect to a router using WPA
@@ -50,6 +53,7 @@
 name: wireless/wireless_connection_open_n
 requires: device.category == 'WIRELESS'
 user: root
+environ: OPEN_N_SSID
 command: create_connection $OPEN_N_SSID && nmcli con up id $OPEN_N_SSID && internet_test
 _description:
  Tests that the systems wireless hardware can connect to a router using no

=== modified file 'plugins/backend_info.py'
--- plugins/backend_info.py	2011-07-15 13:33:45 +0000
+++ plugins/backend_info.py	2011-12-08 22:34:26 +0000
@@ -113,6 +113,16 @@
 
     def message_exec(self, message):
         if "user" in message:
+            if "environ" in message:
+                #Prepare variables to be "exported" from my environment
+                #to the backend's.
+                backend_environ=["%s=%s" % (key, os.environ[key])
+                             for key in message["environ"] 
+                             if key in os.environ]
+                message=dict(message) #so as to not wreck the
+                                      #original message
+                message["environ"]=backend_environ
+
             if (self.backend_is_alive and not self.ping_backend()):
                 self.backend_is_alive = False