Merge lp:~charlesk/indicator-datetime/lp-1312775-comments-in-etc-timezone into lp:indicator-datetime/14.04

[Charles Kerr]

when src/timezone-file.c reads the contents of a file, skip lines that begin with '#'

when src/timezone-file.c reads the contents of a file, skip lines that begin with '#'

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:341
http://jenkins.qa.ubuntu.com/job/indicator-datetime-ci/227/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-utopic-amd64-ci/1
    SUCCESS: http://jenkins.qa.ubuntu.com/job/indicator-datetime-utopic-armhf-ci/1
        deb: http://jenkins.qa.ubuntu.com/job/indicator-datetime-utopic-armhf-ci/1/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/indicator-datetime-ci/227/rebuild

review: Approve (continuous-integration)

[Ted Gould (ted)]

Uhg, silly we have to do this.

review: Approve

Unmerged revisions

341. By Charles Kerr on 2014-05-05

when src/timezone-file.c reads the contents of a file, skip lines that begin with '#' because they're comments. Add test.

=== modified file 'src/timezone-file.cpp'
--- src/timezone-file.cpp	2014-02-02 21:28:52 +0000
+++ src/timezone-file.cpp	2014-05-05 15:07:52 +0000
@@ -22,6 +22,59 @@
 #include <cerrno>
 #include <cstdlib>
 
+namespace
+{
+    std::string get_timezone_from_file(const std::string& filename)
+    {
+        GError * error;
+        GIOChannel * io_channel;
+        std::string ret;
+
+        // read through filename line-by-line until we fine a nonempty non-comment line
+        error = nullptr;
+        io_channel = g_io_channel_new_file(filename.c_str(), "r", &error);
+        if (error == nullptr)
+        {
+            auto line = g_string_new(nullptr);
+
+            while(ret.empty())
+            {
+                const auto io_status = g_io_channel_read_line_string(io_channel, line, nullptr, &error);
+                if ((io_status == G_IO_STATUS_EOF) || (io_status == G_IO_STATUS_ERROR))
+                    break;
+                if (error != nullptr)
+                    break;
+
+                g_strstrip(line->str);
+
+                if (!line->len) // skip empty lines
+                    continue;
+
+                if (*line->str=='#') // skip comments
+                    continue;
+
+                ret = line->str;
+            }
+
+            g_string_free(line, true);
+        }
+
+        if (io_channel != nullptr)
+        {
+            g_io_channel_shutdown(io_channel, false, nullptr);
+            g_io_channel_unref(io_channel);
+        }
+
+        if (error != nullptr)
+        {
+            g_warning("%s Unable to read timezone file '%s': %s", G_STRLOC, filename.c_str(), error->message);
+            g_error_free(error);
+        }
+
+        return ret;
+    }
+}
+
 namespace unity {
 namespace indicator {
 namespace datetime {
@@ -95,20 +148,10 @@
 void
 FileTimezone::reload()
 {
-    GError * err = nullptr;
-    gchar * str = nullptr;
+    const auto new_timezone = get_timezone_from_file(m_filename);
 
-    if (!g_file_get_contents(m_filename.c_str(), &str, nullptr, &err))
-    {
-        g_warning("%s Unable to read timezone file '%s': %s", G_STRLOC, m_filename.c_str(), err->message);
-        g_error_free(err);
-    }
-    else
-    {
-        g_strstrip(str);
-        timezone.set(str);
-        g_free(str);
-    }
+    if (!new_timezone.empty())
+        timezone.set(new_timezone);
 }
 
 } // namespace datetime

=== modified file 'tests/test-timezone-file.cpp'
--- tests/test-timezone-file.cpp	2014-01-22 15:06:01 +0000
+++ tests/test-timezone-file.cpp	2014-05-05 15:07:52 +0000
@@ -131,3 +131,16 @@
   ASSERT_TRUE(changed);
   ASSERT_EQ(changed_timezone, tz.timezone.get());
 }
+
+
+/**
+ * Test that timezone-file picks up the initial value
+ */
+TEST_F(TimezoneFixture, IgnoreComments)
+{
+  const std::string comment = "# Created by cloud-init v. 0.7.5 on Thu, 24 Apr 2014 14:03:29 +0000";
+  const std::string expected_timezone = "Europe/Berlin";
+  set_file(comment + "\n" + expected_timezone);
+  FileTimezone tz(TIMEZONE_FILE);
+  ASSERT_EQ(expected_timezone, tz.timezone.get());
+}