Merge lp:~roadmr/checkbox/templates-utf8-encoding into lp:checkbox

[Daniel Manrique]

This fixes the linked bug by explicitly setting the encoding when opening a job/template file.

It would in theory be better to honor the system's encoding, however note that the encoding set in /etc/default/locale is not necessarily the same as that of files that are shipped with a package. Also, since the encoding for the C locale, which is what upstart jobs have, is bogus, assuming UTF-8 in all cases seems safe enough.

Just for kicks, I tried seeing if the system had an invalid encoding set, to fall back to UTF-8 only in that case. But none of the things I tried (locale.getpreferredencoding, sys.getdefaultencoding and sys.getfilesystemencoding) let us discern between an incorrectly set (or unset) encoding and a valid but funky one; i.e. if the user *actually* has LANG=en_US.ANSI_X3.4-1968. So just assuming UTF-8 seems to offer the least chances of us shooting ourselves in the foot by trying to be too clever.

I tested this on a server (where the problem was first observed) by applying these changes manually and then rebooting the server, and there were no errors in the logfile; all jobs were loaded correctly.

[lp:~roadmr/checkbox/templates-utf8-encoding]

1440. By Daniel Manrique on 2012-06-19

Merged from trunk

1441. By Daniel Manrique on 2012-06-19

Fix crappy changelog formatting

[Marc Tardif (cr3)]

Looks perfectly reasonable, thanks for testing this extensively. Merging and building packages.

review: Approve

=== modified file 'checkbox/lib/template.py'
--- checkbox/lib/template.py	2012-06-01 13:35:12 +0000
+++ checkbox/lib/template.py	2012-06-19 19:41:20 +0000
@@ -139,5 +139,5 @@
     def load_filename(self, filename):
         logging.info("Loading elements from filename: %s", filename)
 
-        file = open(filename, "r")
+        file = open(filename, "r", encoding="utf-8")
         return self.load_file(file, filename)

=== modified file 'debian/changelog'
--- debian/changelog	2012-06-19 18:28:47 +0000
+++ debian/changelog	2012-06-19 19:41:20 +0000
@@ -38,6 +38,8 @@
     hunting through process lists.
   * [FEATURE] Added script and jobs to collect and attach output from
     alsa-info.sh.
+  * Assume utf-8 encoding always, when opening template files. 
+    (LP: #1015174) 
 
   [Javier Collado]
   * Submission screen in Qt interface updated to support certification client:
@@ -126,7 +128,7 @@
   * jobs/stress.txt.in: add OEM team's stress tests (including reboot and poweroff)
     and log analysis jobs      
 
- -- Jeff Lane <[e-mail]>  Tue, 19 Jun 2012 14:02:37 -0400
+ -- Daniel Manrique <[e-mail]>  Tue, 19 Jun 2012 14:28:40 -0400
 
 checkbox (0.13.8) precise; urgency=low
 

=== modified file 'plugins/message_info.py'
--- plugins/message_info.py	2012-06-01 21:38:37 +0000
+++ plugins/message_info.py	2012-06-19 19:41:20 +0000
@@ -125,7 +125,7 @@
             self._manager.reactor.fire("report-messages", messages)
 
     def message_filename(self, filename):
-        file = open(filename, "r")
+        file = open(filename, "r", encoding="utf-8")
         try:
             self._manager.reactor.fire("message-file", file, filename)
         finally: