Issue 5450 - introduce the Platform class

test/FilterEngine.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 eyeo GmbH
  *
  * Adblock Plus 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.
  *
  * Adblock Plus 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 General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "BaseJsTest.h"
+#include <AdblockPlus/DefaultLogSystem.h>
 #include <thread>
 #include <condition_variable>
 
 using namespace AdblockPlus;
 
 namespace AdblockPlus
 {
   namespace Utils
   {
     inline bool BeginsWith(const std::string& str, const std::string& beginning)
@@ skipping 14 matching lines @@
       {
         callback(StatResult(), "");
       });
     }
   };
 
   template<class LazyFileSystemT, class LogSystem>
   class FilterEngineTestGeneric : public ::testing::Test
   {
   protected:
+    std::unique_ptr<Platform> platform;
     FilterEnginePtr filterEngine;
 
     void SetUp() override
     {
       LazyFileSystemT* fileSystem;
-      JsEngineCreationParameters jsEngineParams;
-      jsEngineParams.fileSystem.reset(fileSystem = new LazyFileSystemT());
-      jsEngineParams.logSystem.reset(new LogSystem());
-      jsEngineParams.timer.reset(new NoopTimer());
-      jsEngineParams.webRequest.reset(new NoopWebRequest());
-      auto jsEngine = CreateJsEngine(std::move(jsEngineParams));
-      filterEngine = CreateFilterEngine(*fileSystem, jsEngine);
+      ThrowingPlatformCreationParameters platformParams;
+      platformParams.logSystem.reset(new LogSystem());
+      platformParams.timer.reset(new NoopTimer());
+      platformParams.fileSystem.reset(fileSystem = new LazyFileSystemT());
+      platformParams.webRequest.reset(new NoopWebRequest());
+      platform.reset(new Platform(std::move(platformParams)));
+      filterEngine = CreateFilterEngine(*fileSystem, platform->GetJsEngine());
     }
   };
 
   typedef FilterEngineTestGeneric<LazyFileSystem, AdblockPlus::DefaultLogSystem> FilterEngineTest;
   typedef FilterEngineTestGeneric<NoFilesFileSystem, LazyLogSystem> FilterEngineTestNoData;
 
   class FilterEngineWithFreshFolder : public ::testing::Test
   {
   protected:
+    std::unique_ptr<Platform> platform;
     FileSystemPtr fileSystem;
     std::list<SchedulerTask> fileSystemTasks;
     std::weak_ptr<JsEngine> weakJsEngine;
 
     void SetUp() override
     {
       fileSystem = CreateDefaultFileSystem([this](const SchedulerTask& task)
       {
         fileSystemTasks.emplace_back(task);
       });
       // Since there is neither in memory FS nor functionality to work with
       // directories use the hack: manually clean the directory.
       removeFileIfExists("patterns.ini");
       removeFileIfExists("prefs.json");
     }
     JsEnginePtr CreateJsEngine(const AppInfo& appInfo = AppInfo())
     {
-      JsEngineCreationParameters jsEngineParams;
-      jsEngineParams.appInfo = appInfo;
-      jsEngineParams.fileSystem = fileSystem;
-      jsEngineParams.logSystem.reset(new LazyLogSystem());
-      jsEngineParams.timer.reset(new NoopTimer());
-      jsEngineParams.webRequest.reset(new NoopWebRequest());
-      auto jsEngine = ::CreateJsEngine(std::move(jsEngineParams));
+      ThrowingPlatformCreationParameters platformParams;
+      platformParams.logSystem.reset(new LazyLogSystem());
+      platformParams.timer.reset(new NoopTimer());
+      platformParams.fileSystem = fileSystem;
+      platformParams.webRequest.reset(new NoopWebRequest());
+      platform.reset(new Platform(std::move(platformParams)));
+      platform->SetUpJsEngine(appInfo);
+      auto jsEngine = platform->GetJsEngine();
       weakJsEngine = jsEngine;
       return jsEngine;
     }
 
     FilterEnginePtr CreateFilterEngine(const JsEnginePtr& jsEngine,
       const FilterEngine::CreationParameters& creationParams = FilterEngine::CreationParameters())
     {
       FilterEnginePtr retValue;
       FilterEngine::CreateAsync(jsEngine, [&retValue](const FilterEnginePtr& filterEngine)
       {
@@ skipping 49 matching lines @@
   class FilterEngineIsSubscriptionDownloadAllowedTest : public ::testing::Test
   {
   protected:
     typedef std::vector<std::pair<bool, std::string>> ConnectionTypes;
     DelayedWebRequest::SharedTasks webRequestTasks;
     DelayedTimer::SharedTasks timerTasks;
     FilterEngine::CreationParameters createParams;
     ConnectionTypes capturedConnectionTypes;
     bool isConnectionAllowed;
     std::vector<std::function<void(bool)>> isSubscriptionDownloadAllowedCallbacks;
+    std::unique_ptr<Platform> platform;
     FilterEnginePtr filterEngine;
-    JsEnginePtr jsEngine;
     LazyFileSystem* fileSystem;
 
     void SetUp()
     {
       isConnectionAllowed = true;
 
-      JsEngineCreationParameters jsEngineParams;
-      jsEngineParams.logSystem.reset(new LazyLogSystem());
-      jsEngineParams.fileSystem.reset(fileSystem = new LazyFileSystem());
-      jsEngineParams.timer = DelayedTimer::New(timerTasks);
-      jsEngineParams.webRequest = DelayedWebRequest::New(webRequestTasks);
-      jsEngine = CreateJsEngine(std::move(jsEngineParams));
+      ThrowingPlatformCreationParameters platformParams;
+      platformParams.logSystem.reset(new LazyLogSystem());
+      platformParams.timer = DelayedTimer::New(timerTasks);
+      platformParams.fileSystem.reset(fileSystem = new LazyFileSystem());
+      platformParams.webRequest = DelayedWebRequest::New(webRequestTasks);
+      platform.reset(new Platform(std::move(platformParams)));
 
-      createParams.preconfiguredPrefs.emplace("first_run_subscription_auto_select", jsEngine->NewValue(false));
+      createParams.preconfiguredPrefs.emplace("first_run_subscription_auto_select", platform->GetJsEngine()->NewValue(false));
 
       createParams.isSubscriptionDownloadAllowedCallback = [this](const std::string* allowedConnectionType,
         const std::function<void(bool)>& isSubscriptionDownloadAllowedCallback){
         capturedConnectionTypes.emplace_back(!!allowedConnectionType, allowedConnectionType ? *allowedConnectionType : std::string());
         isSubscriptionDownloadAllowedCallbacks.emplace_back(isSubscriptionDownloadAllowedCallback);
       };
     }
 
     Subscription EnsureExampleSubscriptionAndForceUpdate(const std::string& apppendToUrl = std::string())
     {
       auto subscriptionUrl = "http://example" + apppendToUrl;
       bool isSubscriptionDownloadStatusReceived = false;
       if (!filterEngine)
       {
-        filterEngine = CreateFilterEngine(*fileSystem, jsEngine, createParams);
+        filterEngine = CreateFilterEngine(*fileSystem, platform->GetJsEngine(), createParams);
         filterEngine->SetFilterChangeCallback([&isSubscriptionDownloadStatusReceived, &subscriptionUrl](const std::string& action, JsValue&& item)
         {
           if (action == "subscription.downloadStatus" && item.GetProperty("url").AsString() == subscriptionUrl)
             isSubscriptionDownloadStatusReceived = true;
         });
       }
       auto subscription = filterEngine->GetSubscription(subscriptionUrl);
       EXPECT_EQ(0u, subscription.GetProperty("filters").AsList().size()) << subscriptionUrl;
       EXPECT_TRUE(subscription.GetProperty("downloadStatus").IsNull()) << subscriptionUrl;
       subscription.UpdateFilters();
@@ skipping 784 matching lines @@
   auto subscription = EnsureExampleSubscriptionAndForceUpdate();
   EXPECT_EQ("synchronize_connection_error", subscription.GetProperty("downloadStatus").AsString());
   EXPECT_EQ(0u, subscription.GetProperty("filters").AsList().size());
   EXPECT_EQ(1u, capturedConnectionTypes.size());
 }
 
 TEST_F(FilterEngineIsSubscriptionDownloadAllowedTest, PredefinedAllowedConnectionTypeIsPassedToCallback)
 {
   std::string predefinedAllowedConnectionType = "non-metered";
   createParams.preconfiguredPrefs.insert(std::make_pair("allowed_connection_type",
-    jsEngine->NewValue(predefinedAllowedConnectionType)));
+    platform->GetJsEngine()->NewValue(predefinedAllowedConnectionType)));
   auto subscription = EnsureExampleSubscriptionAndForceUpdate();
   EXPECT_EQ("synchronize_ok", subscription.GetProperty("downloadStatus").AsString());
   EXPECT_EQ(1u, subscription.GetProperty("filters").AsList().size());
   ASSERT_EQ(1u, capturedConnectionTypes.size());
   EXPECT_TRUE(capturedConnectionTypes[0].first);
   EXPECT_EQ(predefinedAllowedConnectionType, capturedConnectionTypes[0].second);
 }
 
 TEST_F(FilterEngineIsSubscriptionDownloadAllowedTest, ConfiguredConnectionTypeIsPassedToCallback)
 {
   // FilterEngine->RemoveSubscription is not usable here because subscriptions
   // are cached internally by URL. So, different URLs are used in diffirent
   // checks.
   {
     std::string predefinedAllowedConnectionType = "non-metered";
     createParams.preconfiguredPrefs.insert(std::make_pair(
-      "allowed_connection_type", jsEngine->NewValue(predefinedAllowedConnectionType)));
+      "allowed_connection_type", platform->GetJsEngine()->NewValue(predefinedAllowedConnectionType)));
     auto subscription = EnsureExampleSubscriptionAndForceUpdate();
     EXPECT_EQ("synchronize_ok", subscription.GetProperty("downloadStatus").AsString());
     EXPECT_EQ(1u, subscription.GetProperty("filters").AsList().size());
     ASSERT_EQ(1u, capturedConnectionTypes.size());
     EXPECT_TRUE(capturedConnectionTypes[0].first);
     EXPECT_EQ(predefinedAllowedConnectionType, capturedConnectionTypes[0].second);
   }
   capturedConnectionTypes.clear();
   {
     // set no value
@@ skipping 11 matching lines @@
     std::string testConnection = "test connection";
     filterEngine->SetAllowedConnectionType(&testConnection);
     auto subscription = EnsureExampleSubscriptionAndForceUpdate("subB");
     EXPECT_EQ("synchronize_ok", subscription.GetProperty("downloadStatus").AsString());
     EXPECT_EQ(1u, subscription.GetProperty("filters").AsList().size());
     ASSERT_EQ(1u, capturedConnectionTypes.size());
     EXPECT_TRUE(capturedConnectionTypes[0].first);
     EXPECT_EQ(testConnection, capturedConnectionTypes[0].second);
   }
 }