Merge lp:~mikemc/unity-scope-click/cxx-test-fix into lp:unity-scope-click

[Mike McCracken]

- Fix linkage issues in building Qt test suite for new c++ scope

- Fix linkage issues in building Qt test suite for new c++ scope

also includes some preprocessor work to build correctly whether using latest trunk of libunity-api or the most recent package. This isn't ideal because it'll require a bit of extra typing and we'll have to make sure to put the same tests in any new files, so hopefully we can remove it soon and just have a hard requirement for building on v0.1.8 or later.

'make check' runs the tests now, which will fail. but hey, they run!

[dobey (dobey)]

576 +include_directories (${CMAKE_CURRENT_SOURCE_DIR}/..)
577 +include_directories (${CMAKE_CURRENT_BINARY_DIR}/..)

It's generally better to avoid using ".." and use more explicit things, so that when reading the build file you can understand more easily what exactly it's pointing at.

For example, here I think you'd probably want to use ${CMAKE_SOURCE_DIR}/scope and similar for BINARY_DIR, instead.

[lp:~mikemc/unity-scope-click/cxx-test-fix]

113. By Mike McCracken on 2014-01-14

remove unnecessary extra variable

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:112
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/166/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/64
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/64

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/166/rebuild

review: Approve (continuous-integration)

[lp:~mikemc/unity-scope-click/cxx-test-fix]

114. By Mike McCracken on 2014-01-14

- use explicit path to the scope dirs

[dobey (dobey)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:114
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/167/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/65
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/65

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/167/rebuild

review: Approve (continuous-integration)

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-01-13 21:55:16 +0000
+++ CMakeLists.txt	2014-01-14 21:01:26 +0000
@@ -7,7 +7,18 @@
 set(SCOPE_DATA_DIR share/unity/scopes) # FIXME, not correct.
 
 include(FindPkgConfig)
-pkg_check_modules(UNITY_SCOPES libunity-scopes REQUIRED)
+
+pkg_check_modules(UNITY_SCOPES REQUIRED libunity-scopes)
+
+# Config.h variables to account for breaking changes in 0.1.8:
+if (UNITY_SCOPES_VERSION VERSION_GREATER 0.1.7)
+  SET (UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY 1)
+  SET (UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE 1)
+else()
+  SET (UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY 0)
+  SET (UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE 0)
+endif ()
+
 
 pkg_check_modules(LIBSIGNON REQUIRED libsignon-qt5 accounts-qt5)
 add_definitions(${LIBSIGNON_CFLAGS} ${LIBSIGNON_CFLAGS_OTHER})

=== modified file 'scope/CMakeLists.txt'
--- scope/CMakeLists.txt	2014-01-13 19:14:10 +0000
+++ scope/CMakeLists.txt	2014-01-14 21:01:26 +0000
@@ -3,10 +3,12 @@
 find_package (Qt5Core REQUIRED)
 
 file (GLOB SCOPE_SOURCES *.cpp)
-file (GLOB SCOPE_HEADERS *.h)
 
 add_library (${SCOPE_LIB_NAME} SHARED ${SCOPE_SOURCES} )
 
+configure_file(Config.h.in Config.h)
+include_directories (${CMAKE_CURRENT_BINARY_DIR})
+
 qt5_use_modules (${SCOPE_LIB_NAME} Network)
 
 target_link_libraries (${SCOPE_LIB_NAME}
@@ -15,5 +17,4 @@
 
 set_property (TARGET ${SCOPE_LIB_NAME} PROPERTY COMPILE_FLAGS ${UNITY_SCOPES_CFLAGS})
 
-
 add_subdirectory (tests)

=== added file 'scope/Config.h.in'
--- scope/Config.h.in	1970-01-01 00:00:00 +0000
+++ scope/Config.h.in	2014-01-14 21:01:26 +0000
@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2014 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/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#ifndef _CONFIG_H_
+#define _CONFIG_H_
+
+#define UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY @UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY@
+#define UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE @UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE@
+
+#endif /* _CONFIG_H_ */ 

=== modified file 'scope/clickquery.cpp'
--- scope/clickquery.cpp	2014-01-13 22:00:30 +0000
+++ scope/clickquery.cpp	2014-01-14 21:01:26 +0000
@@ -27,13 +27,21 @@
  * files in the program, then also delete it here.
  */
 
-#include "clickquery.h"
+#include <clickquery.h>
+
+#if UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY
+#include <unity/scopes/Annotation.h>
+#include <unity/scopes/CategoryRenderer.h>
+#include <unity/scopes/CategorisedResult.h>
+#include <unity/scopes/Query.h>
+#include <unity/scopes/Reply.h>
+#else
 #include <scopes/Annotation.h>
 #include <scopes/CategoryRenderer.h>
 #include <scopes/CategorisedResult.h>
 #include <scopes/Query.h>
 #include <scopes/Reply.h>
-
+#endif
 
 ClickQuery::ClickQuery(string const& query) :
     query_(query)

=== added file 'scope/clickquery.h'
--- scope/clickquery.h	1970-01-01 00:00:00 +0000
+++ scope/clickquery.h	2014-01-14 21:01:26 +0000
@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2014 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/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#ifndef _CLICKQUERY_H_
+#define _CLICKQUERY_H_
+
+#include <Config.h>
+
+#if UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY
+#include <unity/scopes/QueryBase.h>
+#else 
+#include <scopes/QueryBase.h>
+#endif
+
+#if UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE
+using namespace unity::scopes;
+#else
+using namespace unity::api::scopes;
+#endif
+
+using namespace std;
+
+class ClickQuery : public QueryBase
+{
+public:
+    ClickQuery(string const& query);
+    ~ClickQuery();
+    virtual void cancelled() override;
+
+    virtual void run(ReplyProxy const& reply) override;
+
+private:
+    string query_;
+};
+
+#endif /* _CLICKQUERY_H_ */

=== removed file 'scope/clickquery.h'
--- scope/clickquery.h	2014-01-13 22:00:30 +0000
+++ scope/clickquery.h	1970-01-01 00:00:00 +0000
@@ -1,46 +0,0 @@
-/*
- * Copyright (C) 2014 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/>.
- *
- * In addition, as a special exception, the copyright holders give
- * permission to link the code of portions of this program with the
- * OpenSSL library under certain conditions as described in each
- * individual source file, and distribute linked combinations
- * including the two.
- * You must obey the GNU General Public License in all respects
- * for all of the code used other than OpenSSL.  If you modify
- * file(s) with this exception, you may extend this exception to your
- * version of the file(s), but you are not obligated to do so.  If you
- * do not wish to do so, delete this exception statement from your
- * version.  If you delete this exception statement from all source
- * files in the program, then also delete it here.
- */
-
-#include <scopes/QueryBase.h>
-
-using namespace std;
-using namespace unity::api::scopes;
-
-class ClickQuery : public QueryBase
-{
-public:
-    ClickQuery(std::string const& query);
-    ~ClickQuery();
-    virtual void cancelled() override;
-
-    virtual void run(ReplyProxy const& reply) override;
-
-private:
-    std::string query_;
-};

=== modified file 'scope/clickscope.cpp'
--- scope/clickscope.cpp	2014-01-13 22:00:30 +0000
+++ scope/clickscope.cpp	2014-01-14 21:01:26 +0000
@@ -30,8 +30,15 @@
 #include "clickscope.h"
 #include "clickquery.h"
 
-
-int ClickScope::start(std::string const&, unity::api::scopes::RegistryProxy const&)
+#if UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE
+using namespace unity::scopes;
+#else
+using namespace unity::api::scopes;
+#endif
+
+using namespace std;
+
+int ClickScope::start(string const&, RegistryProxy const&)
 {
     return VERSION;
 }
@@ -40,9 +47,8 @@
 {
 }
 
-unity::api::scopes::QueryBase::UPtr create_query(std::string const& q,
-                                                 unity::api::scopes::VariantMap const&)
+QueryBase::UPtr ClickScope::create_query(string const& q, VariantMap const&)
 {
-    unity::api::scopes::QueryBase::UPtr query(new ClickQuery(q));
+    QueryBase::UPtr query(new ClickQuery(q));
     return query;
 }

=== added file 'scope/clickscope.h'
--- scope/clickscope.h	1970-01-01 00:00:00 +0000
+++ scope/clickscope.h	2014-01-14 21:01:26 +0000
@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2014 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/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#ifndef CLICKSCOPE_H
+#define CLICKSCOPE_H
+
+#include <Config.h>
+
+#if UNITY_SCOPES_API_HEADERS_NOW_UNDER_UNITY
+#include <unity/scopes/ScopeBase.h>
+#include <unity/scopes/QueryBase.h>
+#else
+#include <scopes/ScopeBase.h>
+#include <scopes/QueryBase.h>
+#endif
+
+#if UNITY_SCOPES_API_NEW_SHORTER_NAMESPACE
+using namespace unity::scopes;
+#else
+using namespace unity::api::scopes;
+#endif
+
+using namespace std;
+
+class ClickScope : public ScopeBase
+{
+public:
+    virtual int start(string const&, RegistryProxy const&) override;
+
+    virtual void stop() override;
+
+    virtual QueryBase::UPtr create_query(string const& q, VariantMap const&) override;
+};
+
+#endif

=== removed file 'scope/clickscope.h'
--- scope/clickscope.h	2014-01-13 22:00:30 +0000
+++ scope/clickscope.h	1970-01-01 00:00:00 +0000
@@ -1,47 +0,0 @@
-/*
- * Copyright (C) 2014 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/>.
- *
- * In addition, as a special exception, the copyright holders give
- * permission to link the code of portions of this program with the
- * OpenSSL library under certain conditions as described in each
- * individual source file, and distribute linked combinations
- * including the two.
- * You must obey the GNU General Public License in all respects
- * for all of the code used other than OpenSSL.  If you modify
- * file(s) with this exception, you may extend this exception to your
- * version of the file(s), but you are not obligated to do so.  If you
- * do not wish to do so, delete this exception statement from your
- * version.  If you delete this exception statement from all source
- * files in the program, then also delete it here.
- */
-
-#ifndef CLICKSCOPE_H
-#define CLICKSCOPE_H
-
-#include <scopes/ScopeBase.h>
-#include <scopes/QueryBase.h>
-
-class ClickScope : public unity::api::scopes::ScopeBase
-{
-public:
-    virtual int start(std::string const&, unity::api::scopes::RegistryProxy const&) override;
-
-    virtual void stop() override;
-
-    virtual unity::api::scopes::QueryBase::UPtr create_query(std::string const& q,
-            unity::api::scopes::VariantMap const&) override;
-};
-
-#endif

=== added file 'scope/download-manager.h'
--- scope/download-manager.h	1970-01-01 00:00:00 +0000
+++ scope/download-manager.h	2014-01-14 21:01:26 +0000
@@ -0,0 +1,81 @@
+/*
+ * Copyright (C) 2014 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/>.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+
+#ifndef _DOWNLOAD_MANAGER_H_
+#define _DOWNLOAD_MANAGER_H_
+
+#include <Config.h>
+
+#include <QDebug>
+#include <QNetworkReply>
+#include <QObject>
+#include <QString>
+
+#include <ssoservice.h>
+#include <token.h>
+#include <requests.h>
+#include <errormessages.h>
+
+namespace ClickScope {
+
+class DownloadManager : public QObject
+{
+    Q_OBJECT
+
+public:
+
+    explicit DownloadManager(QObject *parent = 0);
+    ~DownloadManager();
+
+public slots:
+
+    void fetchClickToken(QString downloadUrl);
+
+signals:
+
+    void clickTokenFetched(QString clickToken);
+    void clickTokenFetchError(QString errorMessage);
+
+private slots:
+
+    void handleCredentialsFound(UbuntuOne::Token token);
+    void handleCredentialsNotFound();
+    void handleNetworkFinished(QNetworkReply *reply);
+
+private:
+
+    UbuntuOne::SSOService service;
+    QNetworkAccessManager nam;
+    QString _downloadUrl;
+
+};
+
+} // namespace ClickScope
+
+#endif /* _DOWNLOAD_MANAGER_H_ */

=== removed file 'scope/download-manager.h'
--- scope/download-manager.h	2014-01-13 20:00:41 +0000
+++ scope/download-manager.h	1970-01-01 00:00:00 +0000
@@ -1,79 +0,0 @@
-/*
- * Copyright (C) 2014 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/>.
- *
- * In addition, as a special exception, the copyright holders give
- * permission to link the code of portions of this program with the
- * OpenSSL library under certain conditions as described in each
- * individual source file, and distribute linked combinations
- * including the two.
- * You must obey the GNU General Public License in all respects
- * for all of the code used other than OpenSSL.  If you modify
- * file(s) with this exception, you may extend this exception to your
- * version of the file(s), but you are not obligated to do so.  If you
- * do not wish to do so, delete this exception statement from your
- * version.  If you delete this exception statement from all source
- * files in the program, then also delete it here.
- */
-
-#ifndef _DOWNLOAD_MANAGER_H_
-#define _DOWNLOAD_MANAGER_H_
-
-#include <QDebug>
-#include <QNetworkReply>
-#include <QObject>
-#include <QString>
-
-#include "ssoservice.h"
-#include "token.h"
-#include "requests.h"
-#include "errormessages.h"
-
-namespace ClickScope {
-
-class DownloadManager : public QObject
-{
-    Q_OBJECT
-
-public:
-
-    explicit DownloadManager(QObject *parent = 0);
-    ~DownloadManager();
-
-public slots:
-
-    void fetchClickToken(QString downloadUrl);
-
-signals:
-
-    void clickTokenFetched(QString clickToken);
-    void clickTokenFetchError(QString errorMessage);
-
-private slots:
-
-    void handleCredentialsFound(UbuntuOne::Token token);
-    void handleCredentialsNotFound();
-    void handleNetworkFinished(QNetworkReply *reply);
-
-private:
-
-    UbuntuOne::SSOService service;
-    QNetworkAccessManager nam;
-    QString _downloadUrl;
-
-};
-
-} // namespace ClickScope
-
-#endif /* _DOWNLOAD_MANAGER_H_ */

=== modified file 'scope/tests/CMakeLists.txt'
--- scope/tests/CMakeLists.txt	2014-01-13 20:02:28 +0000
+++ scope/tests/CMakeLists.txt	2014-01-14 21:01:26 +0000
@@ -5,6 +5,9 @@
 SET (CMAKE_AUTOMOC ON)
 find_package(Qt5Core REQUIRED)
 
+include_directories (${CMAKE_SOURCE_DIR}/scope)
+include_directories (${CMAKE_BINARY_DIR}/scope)
+
 FILE (GLOB TEST_SOURCES *.cpp)
 FILE (GLOB TEST_HEADERS *.h)
 
@@ -15,7 +18,6 @@
 
 qt5_use_modules (${TESTS_TARGET} Core DBus Network Test)
 
-target_include_directories ( ${TESTS_TARGET} PUBLIC ${CMAKE_SOURCE_DIR}/scope )
 target_link_libraries ( ${TESTS_TARGET}
   ${UNITY_SCOPES_LDFLAGS}
   ${UBUNTUONE_LDFLAGS}