Merge lp:~alecu/unity-scope-click/show-purchaseable-flag into lp:unity-scope-click/devel

[Alejandro J. Cura]

Hide purchaseable apps behind an envvar flag

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[lp:~alecu/unity-scope-click/show-purchaseable-flag]

376. By Alejandro J. Cura on 2014-07-31

Remove garbage left while devel

[dobey (dobey)]

58 + ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);

You also need to add this line in the tests in tests_query.cpp where the environment variable is being set. As the tests are a single process, setting the environment, and not unsetting it at the end of each test where it is set, can bleed the value over to other tests.

review: Needs Fixing

[lp:~alecu/unity-scope-click/show-purchaseable-flag]

377. By Alejandro J. Cura on 2014-07-31

Unset the environ variable to enable purchases in every test

[dobey (dobey)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:375
http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-ci/242/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-amd64-ci/217
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/216
        deb: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/216/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-i386-ci/216

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:377
http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-ci/243/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-amd64-ci/218
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/217
        deb: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-armhf-ci/217/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-scope-click-devel-utopic-i386-ci/217

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

review: Approve (continuous-integration)

=== modified file 'libclickscope/click/configuration.cpp'
--- libclickscope/click/configuration.cpp	2014-07-07 12:10:34 +0000
+++ libclickscope/click/configuration.cpp	2014-07-31 19:37:19 +0000
@@ -106,6 +106,15 @@
     return arch;
 }
 
+bool Configuration::get_purchases_enabled()
+{
+    const char* env_value = std::getenv(PURCHASES_ENVVAR);
+    if (env_value == NULL) {
+        return PURCHASES_DEFAULT;
+    }
+    return std::string("1") == env_value;
+}
+
 std::string Configuration::get_language_base()
 {
     std::string language = get_language();

=== modified file 'libclickscope/click/configuration.h'
--- libclickscope/click/configuration.h	2014-07-15 08:57:57 +0000
+++ libclickscope/click/configuration.h	2014-07-31 19:37:19 +0000
@@ -44,10 +44,13 @@
     constexpr static const int FRAMEWORKS_EXTENSION_LENGTH = 10; // strlen(".framework")
     constexpr static const char* ARCH_ENVVAR {"U1_SEARCH_ARCH"};
     constexpr static const char* LANGUAGE_ENVVAR {"LANGUAGE"};
+    constexpr static const char* PURCHASES_ENVVAR {"CLICK_STORE_ENABLE_PURCHASES"};
+    constexpr static const bool PURCHASES_DEFAULT = false;
     static const std::vector<const char*> FULL_LANG_CODES;
 
     virtual std::vector<std::string> get_available_frameworks();
     virtual std::string get_architecture();
+    static bool get_purchases_enabled();
 
     virtual std::string get_language_base();
     virtual std::string get_language();

=== modified file 'libclickscope/tests/test_configuration.cpp'
--- libclickscope/tests/test_configuration.cpp	2014-07-07 12:10:34 +0000
+++ libclickscope/tests/test_configuration.cpp	2014-07-31 19:37:19 +0000
@@ -224,3 +224,23 @@
     ASSERT_EQ(unsetenv(Configuration::ARCH_ENVVAR), 0);
     ASSERT_NE("otherarch", Configuration().get_architecture());
 }
+
+TEST(Configuration, getPurchasesEnabledOverrideTrue)
+{
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "1", 1), 0);
+    EXPECT_EQ(true, Configuration().get_purchases_enabled());
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
+}
+
+TEST(Configuration, getPurchasesEnabledOverrideFalse)
+{
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "0", 1), 0);
+    EXPECT_EQ(false, Configuration().get_purchases_enabled());
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
+}
+
+TEST(Configuration, getPurchasesEnabledDefault)
+{
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
+    ASSERT_EQ(false, Configuration().get_purchases_enabled());
+}

=== modified file 'scope/clickstore/store-query.cpp'
--- scope/clickstore/store-query.cpp	2014-07-22 10:23:44 +0000
+++ scope/clickstore/store-query.cpp	2014-07-31 19:37:19 +0000
@@ -276,6 +276,10 @@
 
         bool purchased = false;
         if (pkg.price > 0.00f) {
+            if (!Configuration::get_purchases_enabled()) {
+                // Don't show priced apps if flag not set
+                return;
+            }
             // Check if the priced app was already purchased.
             purchased = impl->pay_package.verify(pkg.name);
         }

=== modified file 'scope/tests/test_query.cpp'
--- scope/tests/test_query.cpp	2014-07-21 20:49:18 +0000
+++ scope/tests/test_query.cpp	2014-07-31 19:37:19 +0000
@@ -104,6 +104,7 @@
                                                             const std::string &icon,
                                                             const scopes::CategoryRenderer &renderer_template));
     using click::Query::get_installed_packages; // allow tests to access protected method
+    using click::Query::push_package;
 };
 
 class MockQueryRun : public MockQueryBase {
@@ -358,6 +359,7 @@
 
 TEST(QueryTest, testQueryRunCallsPayPackageVerify)
 {
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "1", 1), 0);
     click::Packages packages {
         {"name", "title", 0.99, "icon", "uri"}
     };
@@ -386,10 +388,12 @@
     EXPECT_CALL(q, finished(_));
 
     q.wrap_add_available_apps(reply, no_installed_packages, FAKE_CATEGORY_TEMPLATE);
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
 }
 
 TEST(QueryTest, testQueryRunPurchased)
 {
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "1", 1), 0);
     click::Packages packages {
         {"name", "title", 0.99, "icon", "uri"}
     };
@@ -419,10 +423,12 @@
     EXPECT_CALL(q, finished(_));
 
     q.wrap_add_available_apps(reply, no_installed_packages, FAKE_CATEGORY_TEMPLATE);
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
 }
 
 TEST(QueryTest, testQueryRunPurchasedAndInstalled)
 {
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "1", 1), 0);
     click::Packages packages {
         {"name", "title", 0.99, "icon", "uri"}
     };
@@ -454,4 +460,69 @@
     EXPECT_CALL(q, finished(_));
 
     q.wrap_add_available_apps(reply, one_installed_package, FAKE_CATEGORY_TEMPLATE);
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
+}
+
+TEST(QueryTest, testPushPackageSkipsPricedApps)
+{
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "0", 1), 0);
+
+    click::Packages packages {
+        {"org.example.app1", "app title1", 1.99, "icon", "uri"},
+        {"org.example.app2", "app title2", 0.0, "icon", "uri"}
+    };
+    MockIndex mock_index(packages);
+    scopes::SearchMetadata metadata("en_EN", "phone");
+    PackageSet no_installed_packages;
+    click::DepartmentLookup dept_lookup;
+    click::HighlightList highlights;
+    MockPayPackage pay_pkg;
+    const unity::scopes::CannedQuery query("foo.scope", FAKE_QUERY, "");
+    MockQuery q(query, mock_index, dept_lookup, nullptr, highlights, metadata, pay_pkg);
+    EXPECT_CALL(mock_index, do_search(FAKE_QUERY, _));
+
+    scopes::CategoryRenderer renderer("{}");
+    auto ptrCat = std::make_shared<FakeCategory>("id", "", "", renderer);
+    EXPECT_CALL(q, register_category(_, _, _, _, _)).Times(2).WillRepeatedly(Return(ptrCat));
+
+    scopes::testing::MockSearchReply mock_reply;
+    scopes::SearchReplyProxy reply(&mock_reply, [](unity::scopes::SearchReply*){});
+    auto expected_name2 = packages.back().name;
+    EXPECT_CALL(q, push_result(_, HasPackageName(expected_name2)));
+    q.wrap_add_available_apps(reply, no_installed_packages, FAKE_CATEGORY_TEMPLATE);
+
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
+}
+
+TEST(QueryTest, testPushPackagePushesPricedApps)
+{
+    ASSERT_EQ(setenv(Configuration::PURCHASES_ENVVAR, "1", 1), 0);
+
+    click::Packages packages {
+        {"org.example.app1", "app title1", 1.99, "icon", "uri"},
+        {"org.example.app2", "app title2", 0.0, "icon", "uri"}
+    };
+    MockIndex mock_index(packages);
+    scopes::SearchMetadata metadata("en_EN", "phone");
+    PackageSet no_installed_packages;
+    click::DepartmentLookup dept_lookup;
+    click::HighlightList highlights;
+    MockPayPackage pay_pkg;
+    const unity::scopes::CannedQuery query("foo.scope", FAKE_QUERY, "");
+    MockQuery q(query, mock_index, dept_lookup, nullptr, highlights, metadata, pay_pkg);
+    EXPECT_CALL(mock_index, do_search(FAKE_QUERY, _));
+
+    scopes::CategoryRenderer renderer("{}");
+    auto ptrCat = std::make_shared<FakeCategory>("id", "", "", renderer);
+    EXPECT_CALL(q, register_category(_, _, _, _, _)).Times(2).WillRepeatedly(Return(ptrCat));
+
+    scopes::testing::MockSearchReply mock_reply;
+    scopes::SearchReplyProxy reply(&mock_reply, [](unity::scopes::SearchReply*){});
+    auto expected_name1 = packages.front().name;
+    EXPECT_CALL(q, push_result(_, HasPackageName(expected_name1)));
+    auto expected_name2 = packages.back().name;
+    EXPECT_CALL(q, push_result(_, HasPackageName(expected_name2)));
+    q.wrap_add_available_apps(reply, no_installed_packages, FAKE_CATEGORY_TEMPLATE);
+
+    ASSERT_EQ(unsetenv(Configuration::PURCHASES_ENVVAR), 0);
 }