Merge lp:unity-scopes-api/staging into lp:unity-scopes-api

[Paweł Stołowski]

Support for preview widget updates. Disable tests on ppc and ppc64el.

Merge devel changes.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:298
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/633/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-amd64-ci/21
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/21
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/21/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-i386-ci/21

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/633/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Looks good, thanks!

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-08-17 14:07:35 +0000
+++ CMakeLists.txt	2015-08-24 13:38:51 +0000
@@ -218,7 +218,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 1)  # Major official release number
 set(UNITY_SCOPES_MINOR 0)  # Must be changed for ABI incompatible changes
-set(UNITY_SCOPES_MICRO 0)  # For ABI compatible changes
+set(UNITY_SCOPES_MICRO 1)  # For ABI compatible changes
 set(UNITY_SCOPES_SOVERSION ${UNITY_SCOPES_MAJOR}.${UNITY_SCOPES_MINOR})
 
 # Version for testing, with all symbols visible

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2015-07-01 10:59:49 +0000
+++ RELEASE_NOTES.md	2015-08-24 13:38:51 +0000
@@ -1,6 +1,10 @@
 Release notes
 =============
 
+Changes in version 0.6.20
+=========================
+  - Support preview widget updates via ActivationResponse.
+
 Changes in version 0.6.19
 =========================
   - Support UNITY_SCOPES_CONFIG_DIR environment variable.
@@ -39,7 +43,7 @@
     swiping to the scope while the device has no network access, or the scope's
     data source is off-line.
 
-    Note: This is change is ABI compatible with gcc and clang despite the addition 
+    Note: This is change is ABI compatible with gcc and clang despite the addition
           a new virtual function.
 
 Changes in version 0.6.13
@@ -116,7 +120,7 @@
   - New setting to enable/disable of location data being fed to scopes.
 
   - New DebugMode scope configuration option.
- 
+
 Changes in version 0.6.1
 ========================
   - Clear any signal masks inherited from the parent process when forking.
@@ -304,7 +308,7 @@
 
 - Preliminary API for filters has been added via OptionSelectorFilter and
   FilterState classes. This part of the API is not yet supported by Unity shell
-  and should be considered highly experimental. 
+  and should be considered highly experimental.
 
 - ScopeBase::create_query() method now takes Query object instance instead of
   just a search query string. Search query string is now encapsulated in the

=== modified file 'STRUCTS'
--- STRUCTS	2015-05-29 10:17:42 +0000
+++ STRUCTS	2015-08-24 13:38:51 +0000
@@ -88,12 +88,12 @@
  'query_string'  : string
  'department_id' : string
  'filter_state'  : dictionary (serialized FilterState)
- 
+
 Link (returned by serialize())
 ==============================
  'label'      : string
  'query'      : Query
- 
+
 Annotation (returned by serialize())
 ====================================
  'type'       : string
@@ -160,6 +160,7 @@
  'scope_data'     : variant
  'query'          : variant (optional)
  'updated_result' : variant (optional)
+ 'updated_widgets': variant (optional)
 
 QueryMetadata (returned by serialize())
 =======================================

=== modified file 'debian/changelog'
--- debian/changelog	2015-08-21 22:11:51 +0000
+++ debian/changelog	2015-08-24 13:38:51 +0000
@@ -1,3 +1,9 @@
+unity-scopes-api (1.0.1-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Added support for preview widget updates via ActivationResponse.
+
+ -- Pawel Stolowski <[e-mail]>  Tue, 20 Jul 2015 17:15:39 +0200
+
 unity-scopes-api (1.0.0+15.10.20150821.3-0ubuntu1) wily; urgency=medium
 
   [ Michi Henning ]

=== modified file 'debian/rules'
--- debian/rules	2015-07-20 11:17:15 +0000
+++ debian/rules	2015-08-24 13:38:51 +0000
@@ -5,6 +5,9 @@
 #export DH_VERBOSE=1
 export DPKG_GENSYMBOLS_CHECK_LEVEL=4
 
+# Skip tests on the archs they are known to be flaky with current configuration
+testskip_architectures := powerpc ppc64el
+
 %:
 	dh $@ --parallel --fail-missing --with click
 
@@ -13,7 +16,9 @@
 
 # Tests are not written to be run in parallel.
 override_dh_auto_test:
+ifeq (,$(filter $(testskip_architectures),$(DEB_HOST_ARCH)))
 	dh_auto_test --max-parallel=1 -- ARGS="--verbose"
+endif
 
 override_dh_click:
 	dh_click --name scope

=== modified file 'demo/stand-alone/stand-alone-client.cpp'
--- demo/stand-alone/stand-alone-client.cpp	2014-07-28 08:30:35 +0000
+++ demo/stand-alone/stand-alone-client.cpp	2015-08-24 13:38:51 +0000
@@ -85,12 +85,19 @@
         // Syntax: ipc://<endpoint>#<identity>!<timeout>!<category>
         //
         // "ipc://"         - prefix for all proxies
-        // "/tmp/scope-A    - endpoint at which the scope listens
+        // "/path/scope-A   - endpoint at which the scope listens
         // "scope-A         - scope ID (must be the same as last component of endpoint path)
         // "t=300"          - optional timeout (infinite if not specified)
         // "c=Scope"        - type of proxy (must be "c=Scope")
 
-        ObjectProxy p = rt->string_to_proxy("ipc:///tmp/scope-A#scope-A!t=300!c=Scope");
+        char* xdg_runtime_dir = getenv("XDG_RUNTIME_DIR");
+        if (!xdg_runtime_dir || *xdg_runtime_dir == '\0')
+        {
+            throw ConfigException("No endpoint directories specified, and XDG_RUNTIME_DIR "
+                                  "environment variable not set");
+        }
+        string stringified_proxy = string("ipc://") + xdg_runtime_dir + "/zmq/priv/scope-A#scope-A!t=300!c=Scope";
+        ObjectProxy p = rt->string_to_proxy(stringified_proxy);
         assert(p);
 
         // The returned proxy is of type ObjectProxy and must be down-cast to a scope proxy:

=== modified file 'include/unity/scopes/ActivationResponse.h'
--- include/unity/scopes/ActivationResponse.h	2015-06-02 05:06:25 +0000
+++ include/unity/scopes/ActivationResponse.h	2015-08-24 13:38:51 +0000
@@ -21,6 +21,7 @@
 #include <unity/scopes/Variant.h>
 #include <unity/scopes/CannedQuery.h>
 #include <unity/scopes/Result.h>
+#include <unity/scopes/PreviewWidget.h>
 #include <memory>
 
 namespace unity
@@ -53,6 +54,7 @@
         ShowPreview,  /**< Preview should be requested for this result */
         PerformQuery, /**< Perform new search. This state is implied if creating ActivationResponse with CannedQuery object and is invalid otherwise */
         UpdateResult, /**< Update the result. This state is implied if creating ActivationResponse with Result object and is invalid otherwise */
+        UpdatePreview /**< Update the preview. This state is implied if creating ActivationResponse with PreviewWidgetList and is invalid otherwise */
     };
 
     /**
@@ -77,6 +79,16 @@
      */
     ActivationResponse(Result const& updated_result);
 
+    /**
+    \brief Creates ActivationResponse with status Status::UpdatePreview and an updated list of preview widgets
+    that replace the original widgets in the preview. Widgets not included in this list stay intact and are still
+    displayed in the preview. Responding with this type of ActivationResponse outside of a preview context will not
+    have any effect.
+    \param updated_widgets The updated widgets to replace the original widgets in the preview.
+    \throws unity::InvalidArgumentException if updated_widgets list is empty.
+    */
+    ActivationResponse(PreviewWidgetList const& updated_widgets);
+
     /**@name Copy and assignment
     Copy and assignment operators (move and non-move versions) have the usual value semantics.
     */
@@ -124,6 +136,13 @@
     */
     Result updated_result() const;
 
+    /**
+     \brief The updated widgets if status is Status::UpdatePreview.
+     \throws unity::LogicException if the status of this ActivationResponse is anything other than Status::UpdatePreview.
+     \return The widgets to be displayed instead of the original widgets with same IDs.
+     */
+    PreviewWidgetList updated_widgets() const;
+
     /// @cond
     VariantMap serialize() const;
 

=== modified file 'include/unity/scopes/Result.h'
--- include/unity/scopes/Result.h	2015-07-13 08:44:43 +0000
+++ include/unity/scopes/Result.h	2015-08-24 13:38:51 +0000
@@ -240,6 +240,12 @@
     */
     bool is_account_login_result() const;
 
+    /**
+    \brief Compare result.
+    \return True if results have all attributes equal.
+    */
+    bool operator==(Result const& other) const;
+
     /// @cond
 protected:
     explicit Result(const VariantMap &variant_map);

=== modified file 'include/unity/scopes/internal/ActivationResponseImpl.h'
--- include/unity/scopes/internal/ActivationResponseImpl.h	2015-06-08 14:05:12 +0000
+++ include/unity/scopes/internal/ActivationResponseImpl.h	2015-08-24 13:38:51 +0000
@@ -21,6 +21,7 @@
 #include <unity/scopes/ActivationResponse.h>
 #include <unity/scopes/CannedQuery.h>
 #include <unity/scopes/Result.h>
+#include <unity/scopes/PreviewWidget.h>
 
 namespace unity
 {
@@ -39,6 +40,7 @@
     ActivationResponseImpl(ActivationResponse::Status status);
     ActivationResponseImpl(CannedQuery const& query);
     ActivationResponseImpl(Result const& result);
+    ActivationResponseImpl(PreviewWidgetList const& updated_widgets);
     ActivationResponseImpl(VariantMap const& var, RuntimeImpl const* runtime);
     ~ActivationResponseImpl() = default;
 
@@ -52,6 +54,7 @@
     Variant scope_data() const;
     CannedQuery query() const;
     Result updated_result() const;
+    PreviewWidgetList updated_widgets() const;
 
     VariantMap serialize() const;
 
@@ -62,6 +65,7 @@
     CannedQuery::SPtr query_;
     Variant scope_data_;
     Result::SPtr updated_result_;
+    std::shared_ptr<PreviewWidgetList> updated_widgets_;
 };
 
 } // namespace internal

=== modified file 'include/unity/scopes/internal/ResultImpl.h'
--- include/unity/scopes/internal/ResultImpl.h	2015-06-08 14:05:12 +0000
+++ include/unity/scopes/internal/ResultImpl.h	2015-08-24 13:38:51 +0000
@@ -81,6 +81,8 @@
 
     VariantMap serialize() const;
 
+    bool compare(ResultImpl *other) const;
+
     // a public static method, so there's access to the private constructor
     // without the need to define too many classes as friends
     static Result create_result(VariantMap const&);

=== modified file 'src/scopes/ActivationResponse.cpp'
--- src/scopes/ActivationResponse.cpp	2015-05-29 10:17:42 +0000
+++ src/scopes/ActivationResponse.cpp	2015-08-24 13:38:51 +0000
@@ -41,6 +41,11 @@
 {
 }
 
+ActivationResponse::ActivationResponse(PreviewWidgetList const& updated_widgets)
+    :p(new internal::ActivationResponseImpl(updated_widgets))
+{
+}
+
 /// @cond
 ActivationResponse::ActivationResponse(internal::ActivationResponseImpl* pimpl)
     : p(pimpl)
@@ -98,6 +103,11 @@
     return p->updated_result();
 }
 
+PreviewWidgetList ActivationResponse::updated_widgets() const
+{
+    return p->updated_widgets();
+}
+
 } // namespace scopes
 
 } // namespace unity

=== modified file 'src/scopes/PreviewWidget.cpp'
--- src/scopes/PreviewWidget.cpp	2015-05-19 09:19:13 +0000
+++ src/scopes/PreviewWidget.cpp	2015-08-24 13:38:51 +0000
@@ -87,11 +87,14 @@
 \arg \c gallery
 \arg \c header
 \arg \c actions
+\arg \c icon-actions
 \arg \c progress
 \arg \c text
 \arg \c rating-input
 \arg \c rating-edit
 \arg \c reviews
+\arg \c comment-input
+\arg \c comment
 \arg \c expandable
 
 \subsection audio audio widget
@@ -242,6 +245,17 @@
 }
 \endcode
 
+\subsection icon-actions icon-actions widget
+
+The icon-actions widget displays one or more buttons represented by icons and/or labels. It's similar to actions widget, but uses different layout.
+Every button can provide an optional temporary icon to be displayed immediately after user taps it.
+
+List of attributes:
+
+\arg \c actions A composite attribute containing an array of tuples, where each tuple has at least
+these fields: \c id (a mandatory string that is passed to unity::scopes::ScopeBase::activate_preview_action()),
+\c label (optional string), \c icon (optional URI, required if label is missing), \c temporaryIcon (optional URI).
+
 \subsection progress progress widget
 
 The progress widget displays the progress of an action, such as download progress.
@@ -378,6 +392,39 @@
 }
 \endcode
 
+\subsection comment-input comment-input widget
+
+The comment-input widget allows users to add comments. It displays an input box along with "Send" button.
+
+When a user presses the "Send" button, the scope receives a preview
+action activation with the id \c "commented".  The actual comment
+can be accessed via unity::scopes::ActionMetadata::scope_data.
+The scope data will be a VariantMap with the \c "comment" field holding
+the text entered by the user.
+
+List of attributes:
+
+\arg \c submit-label String for the label of the submit button (optional, uses "Submit" by default).
+
+\code{.cpp}
+{
+    PreviewWidget w1("cmt", "comment-input");
+
+    w1.add_attribute_value("submit-label", Variant("Comment it!"));
+    ...
+}
+\endcode
+
+\subsection comment comment widget
+
+The comment widget shows an avatar, author name, subtitle and a comment text.
+
+List of attributes:
+\arg \c source URI for an avatar icon (optional)
+\arg \c author A string specifying the author of the comment (mandatory)
+\arg \c subtitle A string for the subtitle (optional)
+\arg \c comment A string for the comment text (mandatory)
+
 \subsection expandable expandable widget
 
 The expandable widget is used to group several widgets into an expandable pane.

=== modified file 'src/scopes/Result.cpp'
--- src/scopes/Result.cpp	2015-04-15 10:05:42 +0000
+++ src/scopes/Result.cpp	2015-08-24 13:38:51 +0000
@@ -119,6 +119,11 @@
     return p->value(key);
 }
 
+bool Result::operator==(Result const& other) const
+{
+    return p->compare(other.p.get());
+}
+
 std::string Result::uri() const noexcept
 {
     return p->uri();

=== modified file 'src/scopes/internal/ActivationResponseImpl.cpp'
--- src/scopes/internal/ActivationResponseImpl.cpp	2015-06-08 14:05:12 +0000
+++ src/scopes/internal/ActivationResponseImpl.cpp	2015-08-24 13:38:51 +0000
@@ -17,6 +17,7 @@
 */
 
 #include <unity/scopes/internal/ActivationResponseImpl.h>
+#include <unity/scopes/internal/PreviewWidgetImpl.h>
 #include <unity/UnityExceptions.h>
 #include <unity/scopes/internal/CannedQueryImpl.h>
 #include <unity/scopes/internal/ResultImpl.h>
@@ -42,6 +43,10 @@
     {
         throw unity::InvalidArgumentException("ActivationResponse(): Status::UpdateResult allowed only with Result object");
     }
+    if (status == ActivationResponse::Status::UpdatePreview)
+    {
+        throw unity::InvalidArgumentException("ActivationResponse(): Status::UpdatePreview allowed only with PreviewWidgetList object");
+    }
 }
 
 ActivationResponseImpl::ActivationResponseImpl(CannedQuery const& query)
@@ -56,6 +61,16 @@
 {
 }
 
+ActivationResponseImpl::ActivationResponseImpl(PreviewWidgetList const& updated_widgets)
+    : status_(ActivationResponse::Status::UpdatePreview),
+      updated_widgets_(std::make_shared<PreviewWidgetList>(updated_widgets))
+{
+    if (updated_widgets.size() == 0)
+    {
+        throw InvalidArgumentException("ActivationResponse(): the list of widgets to update cannot be empty");
+    }
+}
+
 ActivationResponseImpl::ActivationResponseImpl(VariantMap const& var, RuntimeImpl const* runtime)
 {
     auto it = var.find("scope_data");
@@ -92,6 +107,20 @@
         impl->set_runtime(runtime);
         updated_result_ = std::make_shared<Result>(ResultImpl::create_result(impl));
     }
+    else if (status_ == ActivationResponse::Status::UpdatePreview)
+    {
+        it = var.find("updated_widgets");
+        if (it == var.end())
+        {
+            throw LogicException("ActivationResponseImpl(): Invalid data, missing 'updated_widgets'");
+        }
+        updated_widgets_.reset(new PreviewWidgetList());
+        VariantArray arr = it->second.get_array();
+        for (unsigned i = 0; i < arr.size(); i++)
+        {
+            updated_widgets_->emplace_back(PreviewWidgetImpl::create(arr[i].get_dict()));
+        }
+    }
 }
 
 ActivationResponse::Status ActivationResponseImpl::status() const
@@ -129,6 +158,16 @@
     throw LogicException("ActivationResponse::updated_result(): updated result is only available for status of Status::UpdateResult");
 }
 
+PreviewWidgetList ActivationResponseImpl::updated_widgets() const
+{
+    if (updated_widgets_)
+    {
+        assert(status_ == ActivationResponse::Status::UpdatePreview);
+        return *updated_widgets_;
+    }
+    throw LogicException("ActivationResponse::updated_widgets(): updated widgets are only available for status of Status::UpdatePreview");
+}
+
 VariantMap ActivationResponseImpl::serialize() const
 {
     VariantMap vm;
@@ -142,6 +181,15 @@
     {
         vm["updated_result"] = updated_result_->serialize();
     }
+    else if (updated_widgets_)
+    {
+        VariantArray arr;
+        for (auto const& widget : *updated_widgets_)
+        {
+            arr.push_back(Variant(widget.serialize()));
+        }
+        vm["updated_widgets"] = arr;
+    }
     return vm;
 }
 

=== modified file 'src/scopes/internal/RegistryConfig.cpp'
--- src/scopes/internal/RegistryConfig.cpp	2015-07-01 10:59:49 +0000
+++ src/scopes/internal/RegistryConfig.cpp	2015-08-24 13:38:51 +0000
@@ -51,10 +51,6 @@
     ConfigBase(configfile, DFLT_REGISTRY_INI)
 {
     identity_ = identity;
-    if (identity.empty())
-    {
-        throw InvalidArgumentException("Registry identity cannot be an empty string");
-    }
     mw_kind_ = get_middleware(registry_config_group, mw_kind_key);
     mw_configfile_ = get_optional_string(registry_config_group, mw_kind_ + configfile_key);
     scope_installdir_ = get_optional_string(registry_config_group, scope_installdir_key, DFLT_SCOPE_INSTALL_DIR);

=== modified file 'src/scopes/internal/ResultImpl.cpp'
--- src/scopes/internal/ResultImpl.cpp	2015-06-08 14:05:12 +0000
+++ src/scopes/internal/ResultImpl.cpp	2015-08-24 13:38:51 +0000
@@ -474,6 +474,26 @@
     }
 }
 
+bool ResultImpl::compare(ResultImpl *other) const
+{
+    // Compare all attributes and stored result (if set).
+    // Ignore origin, runtime and flags.
+    if (this == other)
+    {
+        return true;
+    }
+
+    if ((stored_result_  == nullptr) != (other->stored_result_ == nullptr))
+    {
+        return false;
+    }
+    if (stored_result_ != nullptr && *stored_result_ != *(other->stored_result_))
+    {
+        return false;
+    }
+    return attrs_ == other->attrs_;
+}
+
 Result ResultImpl::create_result(VariantMap const& variant_map)
 {
     return Result(variant_map);

=== modified file 'src/scopes/internal/zmq_middleware/ZmqObject.cpp'
--- src/scopes/internal/zmq_middleware/ZmqObject.cpp	2015-07-01 11:02:46 +0000
+++ src/scopes/internal/zmq_middleware/ZmqObject.cpp	2015-08-24 13:38:51 +0000
@@ -212,7 +212,7 @@
 
     // If a registry is configured and this object is not a registry itself,
     // attempt to locate the scope before invoking it.
-    if (!this_is_registry && !this_is_ss_registry)
+    if (registry_proxy && !this_is_registry && !this_is_ss_registry)
     {
         try
         {

=== modified file 'test/gtest/scopes/ActivationResponse/ActivationResponse_test.cpp'
--- test/gtest/scopes/ActivationResponse/ActivationResponse_test.cpp	2015-06-08 14:20:04 +0000
+++ test/gtest/scopes/ActivationResponse/ActivationResponse_test.cpp	2015-08-24 13:38:51 +0000
@@ -68,7 +68,6 @@
         EXPECT_EQ(res.uri(), resp.updated_result().uri());
     }
 
-
     // Search only allowed with CannedQuery
     {
         try
@@ -88,10 +87,49 @@
         }
         catch (unity::InvalidArgumentException const&) {}
     }
+
+    // UpdatePreview only allowed with PreviewWidgetList
+    {
+        try
+        {
+            ActivationResponse resp(ActivationResponse::Status::UpdatePreview);
+            FAIL();
+        }
+        catch (unity::InvalidArgumentException const&) {}
+    }
+}
+
+TEST(ActivationResponse, with_updated_widgets)
+{
+    {
+        PreviewWidget w("w1", "foo");
+        PreviewWidgetList const widgets {w};
+
+        ActivationResponse resp(widgets);
+        EXPECT_EQ(ActivationResponse::Status::UpdatePreview, resp.status());
+        EXPECT_EQ(1, resp.updated_widgets().size());
+        EXPECT_EQ("w1", resp.updated_widgets().begin()->id());
+    }
+
+    {
+        PreviewWidgetList const widgets;
+
+        try
+        {
+            ActivationResponse resp(widgets);
+            FAIL();
+        }
+        catch (unity::InvalidArgumentException const&)
+        {
+        }
+    }
 }
 
 TEST(ActivationResponse, serialize)
 {
+    // just to make ResultImpl::set_runtime() happy, runtime must not be null.
+    auto runtime = internal::RuntimeImpl::create("fooscope", TEST_DIR "/Runtime.ini");
+
     {
         ActivationResponse resp(ActivationResponse::Status::HideDash);
         {
@@ -123,6 +161,18 @@
         EXPECT_EQ(ActivationResponse::Status::UpdateResult, static_cast<ActivationResponse::Status>(var["status"].get_int()));
         EXPECT_EQ("foo", var["updated_result"].get_dict()["attrs"].get_dict()["uri"].get_string());
     }
+    {
+        PreviewWidget const w("w1", "foo");
+        PreviewWidgetList const widgets {w};
+
+        ActivationResponse resp(widgets);
+        auto var = resp.serialize();
+
+        ActivationResponse resp2 = internal::ActivationResponseImpl::create(var, runtime.get());
+        EXPECT_EQ(ActivationResponse::Status::UpdatePreview, resp2.status());
+        EXPECT_EQ(1, resp2.updated_widgets().size());
+        EXPECT_EQ("w1", resp2.updated_widgets().begin()->id());
+    }
 }
 
 TEST(ActivationResponse, deserialize)

=== modified file 'test/gtest/scopes/CMakeLists.txt'
--- test/gtest/scopes/CMakeLists.txt	2015-04-09 15:59:17 +0000
+++ test/gtest/scopes/CMakeLists.txt	2015-08-24 13:38:51 +0000
@@ -34,6 +34,7 @@
 add_subdirectory(Runtime)
 add_subdirectory(ScopeBase)
 add_subdirectory(ScopeExceptions)
+add_subdirectory(StandAloneScope)
 add_subdirectory(StripLocation)
 add_subdirectory(SwitchFilter)
 add_subdirectory(ThrowingClient)

=== modified file 'test/gtest/scopes/CategorisedResult/CategorisedResult_test.cpp'
--- test/gtest/scopes/CategorisedResult/CategorisedResult_test.cpp	2015-02-25 03:38:29 +0000
+++ test/gtest/scopes/CategorisedResult/CategorisedResult_test.cpp	2015-08-24 13:38:51 +0000
@@ -105,6 +105,38 @@
     }
 }
 
+TEST(CategorisedResult, compare)
+{
+    CategoryRegistry reg;
+    CategoryRenderer rdr;
+    auto cat = reg.register_category("1", "title", "icon", nullptr, rdr);
+
+    {
+        CategorisedResult result1(cat);
+        result1.set_uri("uri a");
+        result1.set_title("title a");
+        result1.set_art("icon a");
+        result1["common"] = "o";
+
+        CategorisedResult result2(cat);
+        result2.set_uri("uri a");
+        result2.set_title("title a");
+        result2.set_art("icon a");
+        result2["common"] = "o";
+
+        EXPECT_TRUE(result1 == result2);
+
+        CategorisedResult result3(cat);
+        result3.set_uri("uri b");
+        result3.set_title("title a");
+        result3.set_art("icon a");
+        result3["common"] = "o";
+
+        EXPECT_FALSE(result1 == result3);
+        EXPECT_FALSE(result2 == result3);
+    }
+}
+
 TEST(CategorisedResult, copy)
 {
     CategoryRegistry reg;

=== added directory 'test/gtest/scopes/StandAloneScope'
=== added file 'test/gtest/scopes/StandAloneScope/CMakeLists.txt'
--- test/gtest/scopes/StandAloneScope/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/CMakeLists.txt	2015-08-24 13:38:51 +0000
@@ -0,0 +1,15 @@
+configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
+configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
+
+add_definitions(-DTEST_RUNTIME_PATH="${CMAKE_CURRENT_BINARY_DIR}")
+add_definitions(-DTEST_RUNTIME_FILE="${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini")
+add_definitions(-DTEST_SCOPERUNNER_PATH="${PROJECT_BINARY_DIR}/scoperunner")
+
+add_executable(StandAloneScope_test StandAloneScope_test.cpp)
+target_link_libraries(StandAloneScope_test ${TESTLIBS})
+add_dependencies(StandAloneScope_test scoperunner)
+
+add_test(StandAloneScope StandAloneScope_test)
+
+configure_file(SimpleScope.ini.in ${CMAKE_CURRENT_BINARY_DIR}/SimpleScope.ini)
+add_library(SimpleScope MODULE SimpleScope.cpp)

=== added file 'test/gtest/scopes/StandAloneScope/Runtime.ini.in'
--- test/gtest/scopes/StandAloneScope/Runtime.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/Runtime.ini.in	2015-08-24 13:38:51 +0000
@@ -0,0 +1,2 @@
+[Runtime]
+Zmq.ConfigFile=@CMAKE_CURRENT_BINARY_DIR@/Zmq.ini

=== added file 'test/gtest/scopes/StandAloneScope/SimpleScope.cpp'
--- test/gtest/scopes/StandAloneScope/SimpleScope.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/SimpleScope.cpp	2015-08-24 13:38:51 +0000
@@ -0,0 +1,99 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#include "SimpleScope.h"
+
+#include <unity/scopes/CategorisedResult.h>
+#include <unity/scopes/ScopeBase.h>
+#include <unity/scopes/SearchReply.h>
+
+using namespace std;
+using namespace unity;
+using namespace unity::scopes;
+
+namespace
+{
+
+class TestQuery : public SearchQueryBase
+{
+public:
+    TestQuery(CannedQuery const& query,
+              SearchMetadata const& metadata)
+        : SearchQueryBase(query, metadata)
+    {
+    }
+
+    virtual void cancelled() override
+    {
+    }
+
+    virtual void run(SearchReplyProxy const& reply) override
+    {
+        auto cat = reply->register_category("cat", "", "");
+        CategorisedResult res(cat);
+        res.set_uri("uri");
+        res.set_title(query().query_string());
+        if (valid())
+        {
+            reply->push(res);
+        }
+    }
+};
+
+}  // namespace
+
+void EchoScope::start(string const& /* scope_id */)
+{
+}
+
+void EchoScope::stop()
+{
+}
+
+void EchoScope::run()
+{
+}
+
+SearchQueryBase::UPtr EchoScope::search(CannedQuery const& query, SearchMetadata const& metadata)
+{
+    return SearchQueryBase::UPtr(new TestQuery(query, metadata));
+}
+
+PreviewQueryBase::UPtr EchoScope::preview(Result const& /* result */, ActionMetadata const& /* metadata */)
+{
+    abort();
+    return nullptr;
+}
+
+extern "C"
+{
+
+    unity::scopes::ScopeBase*
+    // cppcheck-suppress unusedFunction
+    UNITY_SCOPE_CREATE_FUNCTION()
+    {
+        return new EchoScope;
+    }
+
+    void
+    // cppcheck-suppress unusedFunction
+    UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope_base)
+    {
+        delete scope_base;
+    }
+}

=== added file 'test/gtest/scopes/StandAloneScope/SimpleScope.h'
--- test/gtest/scopes/StandAloneScope/SimpleScope.h	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/SimpleScope.h	2015-08-24 13:38:51 +0000
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#pragma once
+
+#include <unity/scopes/ScopeBase.h>
+
+class EchoScope : public unity::scopes::ScopeBase
+{
+public:
+    virtual void start(std::string const&) override;
+
+    virtual void stop() override;
+
+    virtual void run() override;
+
+    virtual unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const &,
+                                                        unity::scopes::SearchMetadata const &) override;
+
+    virtual unity::scopes::PreviewQueryBase::UPtr preview(unity::scopes::Result const&,
+                                                          unity::scopes::ActionMetadata const &) override;
+};

=== added file 'test/gtest/scopes/StandAloneScope/SimpleScope.ini.in'
--- test/gtest/scopes/StandAloneScope/SimpleScope.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/SimpleScope.ini.in	2015-08-24 13:38:51 +0000
@@ -0,0 +1,4 @@
+[ScopeConfig]
+DisplayName = SimpleScope
+Description = Simple scope. Returns a single result containing the query string.
+Author = Michi

=== added file 'test/gtest/scopes/StandAloneScope/StandAloneScope_test.cpp'
--- test/gtest/scopes/StandAloneScope/StandAloneScope_test.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/StandAloneScope_test.cpp	2015-08-24 13:38:51 +0000
@@ -0,0 +1,132 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser 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 warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Michi Henning <[e-mail]>
+ */
+
+#include <unity/scopes/Runtime.h>
+#include <unity/scopes/Scope.h>
+#include <unity/scopes/ScopeExceptions.h>
+#include <unity/scopes/SearchListenerBase.h>
+#include <unity/scopes/SearchMetadata.h>
+
+#include <gtest/gtest.h>
+
+#include <chrono>
+#include <condition_variable>
+
+using namespace std;
+using namespace unity::scopes;
+
+class Receiver : public SearchListenerBase
+{
+public:
+    Receiver()
+        : done_(false)
+        , finished_ok_(false)
+    {
+    }
+
+    virtual void push(CategorisedResult /* result */) override
+    {
+    }
+
+    virtual void finished(CompletionDetails const& details) override
+    {
+        std::lock_guard<std::mutex> lock(mutex_);
+
+        EXPECT_EQ(CompletionDetails::OK, details.status());
+        EXPECT_EQ("", details.message());
+        finished_ok_ = details.status() == CompletionDetails::OK;
+        done_ = true;
+        cond_.notify_all();
+    }
+
+    bool wait_until_finished()
+    {
+        std::unique_lock<std::mutex> lock(mutex_);
+        auto now = std::chrono::steady_clock::now();
+        auto expiry_time = now + std::chrono::seconds(5);
+        EXPECT_TRUE(cond_.wait_until(lock, expiry_time, [this]{ return done_; })) << "finished message not delivered";
+        done_ = false;
+        return finished_ok_;
+    }
+
+private:
+    bool done_;
+    bool finished_ok_;
+    std::mutex mutex_;
+    std::condition_variable cond_;
+};
+
+TEST(StandAloneScope, reachable)
+{
+    Runtime::UPtr rt = Runtime::create(TEST_RUNTIME_FILE);  // No registry configured.
+
+    try
+    {
+        rt->registry();
+        FAIL();
+    }
+    catch (ConfigException const& e)
+    {
+        ASSERT_STREQ("unity::scopes::ConfigException: registry(): no registry configured", e.what());
+    }
+
+    string stringified_proxy = "ipc:///tmp/priv/SimpleScope#SimpleScope!t=1000!c=Scope";
+    ObjectProxy p = rt->string_to_proxy(stringified_proxy);
+    ASSERT_TRUE(bool(p));
+
+    ScopeProxy sp = dynamic_pointer_cast<Scope>(p);
+    ASSERT_TRUE(bool(sp));
+
+    // We must be able to reach the scope even though the registry is not running.
+    shared_ptr<Receiver> reply(new Receiver);
+    auto ctrl = sp->search("", SearchMetadata("", ""), reply);
+    EXPECT_TRUE(reply->wait_until_finished());
+}
+
+int main(int argc, char **argv)
+{
+    ::testing::InitGoogleTest(&argc, argv);
+
+    int rc = 1;
+
+    // Set the "TEST_DESKTOP_FILES_DIR" env var before forking as not to create desktop files in ~/.local
+    putenv(const_cast<char*>("TEST_DESKTOP_FILES_DIR=" TEST_RUNTIME_PATH));
+
+    auto rpid = fork();
+    if (rpid == 0)
+    {
+        // Start a scoperunner without any registry config.
+        const char* const args[] = {"scoperunner [StandAloneScope test]", TEST_RUNTIME_FILE, "SimpleScope.ini", nullptr};
+        if (execv(TEST_SCOPERUNNER_PATH "/scoperunner", const_cast<char* const*>(args)) < 0)
+        {
+            perror("Error starting scoperunner:");
+        }
+    }
+    else if (rpid > 0)
+    {
+        rc = RUN_ALL_TESTS();
+        kill(rpid, SIGTERM);
+        waitpid(rpid, nullptr, 0);
+    }
+    else
+    {
+        perror("Failed to fork:");
+    }
+
+    return rc;
+}

=== added file 'test/gtest/scopes/StandAloneScope/Zmq.ini.in'
--- test/gtest/scopes/StandAloneScope/Zmq.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/StandAloneScope/Zmq.ini.in	2015-08-24 13:38:51 +0000
@@ -0,0 +1,2 @@
+[Zmq]
+EndpointDir = /tmp

=== modified file 'test/gtest/scopes/internal/RegistryConfig/RegistryConfig_test.cpp'
--- test/gtest/scopes/internal/RegistryConfig/RegistryConfig_test.cpp	2014-08-28 00:20:56 +0000
+++ test/gtest/scopes/internal/RegistryConfig/RegistryConfig_test.cpp	2015-08-24 13:38:51 +0000
@@ -39,16 +39,7 @@
 
 TEST(RegistryConfig, RegistryIDEmpty)
 {
-    try
-    {
-        RegistryConfig c("", TEST_REGISTRY_PATH);
-        FAIL();
-    }
-    catch (InvalidArgumentException const& e)
-    {
-        EXPECT_STREQ("unity::InvalidArgumentException: Registry identity cannot be an empty string",
-                     e.what());
-    }
+    RegistryConfig c("", TEST_REGISTRY_PATH);
 }
 
 TEST(RegistryConfig, HomeNotSet)