Merge lp:~renatofilho/indicator-datetime/hide-non-selected-sources into lp:indicator-datetime

[Renato Araujo Oliveira Filho]

Does not show events from non selected sources.

How to test:

1 - Add your google account to calendar app
2 - Make sure to sync your calendar events
3 - Check if the next 4 events appear on the indicator
4 - Go to calendar app "calendars" page and unselect your google calendar
5 - Make sure that the events get removed from indicator

[Charles Kerr (charlesk)]

Looks okay to me, but a couple of caveats:

1. Most important, agree with what you said in IRC about adding integration tests

2. I haven't done manual testing with this

3. If there's a bug associated with this MR, it should be linked

[lp:~renatofilho/indicator-datetime/hide-non-selected-sources]

452. By Renato Araujo Oliveira Filho on 2016-06-21

Implemented unit test.

[Charles Kerr (charlesk)]

review: Approve

=== modified file 'src/engine-eds.cpp'
--- src/engine-eds.cpp	2016-05-14 02:07:10 +0000
+++ src/engine-eds.cpp	2016-06-21 21:40:23 +0000
@@ -120,6 +120,11 @@
 
             auto& source = kv.first;
             auto extension = e_source_get_extension(source, E_SOURCE_EXTENSION_CALENDAR);
+            // check source is selected
+            if (!e_source_selectable_get_selected(E_SOURCE_SELECTABLE(extension))) {
+                g_debug("Soure is not selected, ignore it: %s", e_source_get_display_name(source));
+                continue;
+            }
             const auto color = e_source_selectable_get_color(E_SOURCE_SELECTABLE(extension));
 
             e_cal_client_generate_instances(

=== added file 'tests/test-eds-ics-non-selected-source.cpp'
--- tests/test-eds-ics-non-selected-source.cpp	1970-01-01 00:00:00 +0000
+++ tests/test-eds-ics-non-selected-source.cpp	2016-06-21 21:40:23 +0000
@@ -0,0 +1,94 @@
+/*
+ * Copyright 2015 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *   Renato Araujo Oliveira Filh <[e-mail]>
+ */
+
+#include <algorithm>
+
+#include <datetime/engine-eds.h>
+#include <datetime/myself.h>
+#include <datetime/planner-range.h>
+
+#include <libedataserver/libedataserver.h>
+
+#include <gtest/gtest.h>
+
+#include "glib-fixture.h"
+#include "timezone-mock.h"
+
+using namespace unity::indicator::datetime;
+using VAlarmFixture = GlibFixture;
+
+/***
+****
+***/
+
+TEST_F(VAlarmFixture, NonSelectedSources)
+{
+    // start the EDS engine
+    auto engine = std::make_shared<EdsEngine>(std::make_shared<Myself>());
+
+    // we need a consistent timezone for the planner and our local DateTimes
+    constexpr char const * zone_str {"America/Chicago"};
+    auto tz = std::make_shared<MockTimezone>(zone_str);
+    auto gtz = g_time_zone_new(zone_str);
+
+    // make a planner that looks at the first half of 2015 in EDS
+    auto planner = std::make_shared<SimpleRangePlanner>(engine, tz);
+    const DateTime range_begin {gtz, 2015,1, 1, 0, 0, 0.0};
+    const DateTime range_end   {gtz, 2015,6,31,23,59,59.5};
+    planner->range().set(std::make_pair(range_begin, range_end));
+
+    // give EDS a moment to load
+    if (planner->appointments().get().empty()) {
+        g_message("waiting a moment for EDS to load...");
+        auto on_appointments_changed = [this](const std::vector<Appointment>& appointments){
+            g_message("ah, they loaded");
+            if (!appointments.empty())
+                g_main_loop_quit(loop);
+        };
+        core::ScopedConnection conn(planner->appointments().changed().connect(on_appointments_changed));
+        constexpr int max_wait_sec = 10;
+        wait_msec(max_wait_sec * G_TIME_SPAN_MILLISECOND);
+    }
+
+    // appointmes are visible
+    auto appts = planner->appointments().get();
+    EXPECT_TRUE(appts.size() > 0);
+
+    // Unselect all sources
+    auto registry = e_source_registry_new_sync(NULL, NULL);
+    auto sources = e_source_registry_list_sources(registry, E_SOURCE_EXTENSION_TASK_LIST);
+    for (auto l=sources; l!=nullptr; l=l->next) {
+        auto source =  static_cast<ESource*>(l->data);
+        auto extension = e_source_get_extension(source, E_SOURCE_EXTENSION_CALENDAR);
+        e_source_selectable_set_selected(E_SOURCE_SELECTABLE(extension), FALSE);
+        e_source_write_sync(source, NULL, NULL);
+    }
+
+    g_list_free_full(sources, g_object_unref);
+    g_object_unref(registry);
+
+    // give some time to planner update
+    wait_msec(5 * G_TIME_SPAN_MILLISECOND);
+
+    // the planner should be empty at this point
+    appts = planner->appointments().get();
+    EXPECT_TRUE(appts.size() == 0);
+    // cleanup
+    g_time_zone_unref(gtz);
+}

=== added file 'tests/test-eds-ics-non-selected-source.ics.in'
--- tests/test-eds-ics-non-selected-source.ics.in	1970-01-01 00:00:00 +0000
+++ tests/test-eds-ics-non-selected-source.ics.in	2016-06-21 21:40:23 +0000
@@ -0,0 +1,28 @@
+BEGIN:VCALENDAR
+CALSCALE:GREGORIAN
+PRODID:-//Ximian//NONSGML Evolution Calendar//EN
+VERSION:2.0
+X-EVOLUTION-DATA-REVISION:2015-05-07T21:14:49.315443Z(0)
+BEGIN:VTODO
+UID:20150507T211449Z-4262-32011-1418-1@ubuntu-phablet
+DTSTAMP:20150508T211449Z
+DTSTART:20150508T164000
+RRULE:FREQ=WEEKLY;BYDAY=FR
+SUMMARY:Alarm
+CATEGORIES:x-canonical-alarm
+CREATED:20150507T211449Z
+LAST-MODIFIED:20150507T211449Z
+BEGIN:VALARM
+X-EVOLUTION-ALARM-UID:20150507T211449Z-4262-32011-1418-2@ubuntu-phablet
+ACTION:AUDIO
+ATTACH:file://@ALARM_DEFAULT_SOUND@
+TRIGGER;VALUE=DURATION;RELATED=START:PT0S
+END:VALARM
+BEGIN:VALARM
+X-EVOLUTION-ALARM-UID:20150507T211449Z-4262-32011-1418-3@ubuntu-phablet
+ACTION:DISPLAY
+DESCRIPTION:Alarm
+TRIGGER;VALUE=DURATION;RELATED=START:PT0S
+END:VALARM
+END:VTODO
+END:VCALENDAR