Implemented update checking functionality

test/UpdateCheck.cpp

+/*
+ * This file is part of Adblock Plus <http://adblockplus.org/>,
+ * Copyright (C) 2006-2013 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 <AdblockPlus/tr1_functional.h>
+
+#include "BaseJsTest.h"
+
+namespace
+{
+  typedef std::tr1::shared_ptr<AdblockPlus::FilterEngine> FilterEnginePtr;
+
+  void FindAndReplace(std::string& source, const std::string& find, const std::string& replace)
+  {
+    for (size_t pos = 0; (pos = source.find(find), pos) != std::string::npos; pos += replace.size())
+      source.replace(pos, find.size(), replace);
+  }
+
+  std::string previousRequestUrl;
+  class TestWebRequest : public LazyWebRequest
+  {
+  public:
+    AdblockPlus::ServerResponse response;
+    AdblockPlus::ServerResponse GET(const std::string& url, const AdblockPlus::HeaderList& requestHeaders) const
+    {
+      if (url.find("easylist") != std::string::npos)
+        return LazyWebRequest::GET(url, requestHeaders);
+
+      previousRequestUrl = url;
+      return response;
+    }
+  };
+
+  class UpdateCheckTest : public ::testing::Test
+  {
+  protected:
+    AdblockPlus::AppInfo appInfo;
+    TestWebRequest* webRequest;
+    AdblockPlus::WebRequestPtr webRequestPtr;
+    AdblockPlus::JsEnginePtr jsEngine;
+    FilterEnginePtr filterEngine;
+
+    bool eventCallbackCalled;
+    AdblockPlus::JsValueList eventCallbackParams;
+    static bool updateCallbackCalled;
+    static std::string updateError;
+
+    void SetUp()
+    {
+      webRequest = new TestWebRequest();
+      webRequestPtr.reset(webRequest);
+
+      eventCallbackCalled = false;
+      updateCallbackCalled = false;
+      Reset();
+    }
+
+    void Reset()
+    {
+      jsEngine = AdblockPlus::JsEngine::New(appInfo);
+      jsEngine->SetLogSystem(AdblockPlus::LogSystemPtr(new LazyLogSystem));
+      jsEngine->SetFileSystem(AdblockPlus::FileSystemPtr(new LazyFileSystem));
+      jsEngine->SetWebRequest(webRequestPtr);
+      jsEngine->SetEventCallback("updateAvailable",
+          std::tr1::bind(&UpdateCheckTest::EventCallback, this, std::tr1::placeholders::_1));
+
+      filterEngine.reset(new AdblockPlus::FilterEngine(jsEngine));
+    }
+
+    void ForceUpdateCheck()
+    {
+      filterEngine->ForceUpdateCheck(&UpdateCheckTest::UpdateCallback);
+    }
+
+    void EventCallback(AdblockPlus::JsValueList& params)
+    {
+      eventCallbackCalled = true;
+      eventCallbackParams = params;
+    }
+
+    // This really shouldn't be static but I couldn't make std::bind() work for it.
+    static void UpdateCallback(const std::string& error)
+    {
+      updateCallbackCalled = true;
+      updateError = error;
+    }
+  };
+
+  bool UpdateCheckTest::updateCallbackCalled = false;
+  std::string UpdateCheckTest::updateError;
+}
+
+TEST_F(UpdateCheckTest, RequestFailure)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_ERROR_FAILURE;
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = false;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_FALSE(eventCallbackCalled);
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_FALSE(updateError.empty());
+
+  std::string expectedUrl(filterEngine->GetPref("update_url_release")->AsString());
+  FindAndReplace(expectedUrl, "%NAME%", appInfo.name);
+  FindAndReplace(expectedUrl, "%ID%", appInfo.id);
+  FindAndReplace(expectedUrl, "%VERSION%", appInfo.version);
+  FindAndReplace(expectedUrl, "%APP%", appInfo.platform);
+  FindAndReplace(expectedUrl, "%TYPE%", "1");   // manual update
+  ASSERT_EQ(expectedUrl, previousRequestUrl);
+}
+
+TEST_F(UpdateCheckTest, UpdateAvailable)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
+  webRequest->response.responseStatus = 200;
+  webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = true;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_TRUE(eventCallbackCalled);
+  ASSERT_EQ(1u, eventCallbackParams.size());
+  ASSERT_EQ("https://foo.bar/", eventCallbackParams[0]->AsString());
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_TRUE(updateError.empty());
+
+  std::string expectedUrl(filterEngine->GetPref("update_url_devbuild")->AsString());
+  FindAndReplace(expectedUrl, "%NAME%", appInfo.name);
+  FindAndReplace(expectedUrl, "%ID%", appInfo.id);
+  FindAndReplace(expectedUrl, "%VERSION%", appInfo.version);
+  FindAndReplace(expectedUrl, "%APP%", appInfo.platform);
+  FindAndReplace(expectedUrl, "%TYPE%", "1");   // manual update
+  ASSERT_EQ(expectedUrl, previousRequestUrl);
+}
+
+TEST_F(UpdateCheckTest, PlatformUpdateAvailable)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
+  webRequest->response.responseStatus = 200;
+  webRequest->response.responseText = "{\"1/4\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = true;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_TRUE(eventCallbackCalled);
+  ASSERT_EQ(1u, eventCallbackParams.size());
+  ASSERT_EQ("https://foo.bar/", eventCallbackParams[0]->AsString());
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_TRUE(updateError.empty());
+}
+
+TEST_F(UpdateCheckTest, WrongPlatform)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
+  webRequest->response.responseStatus = 200;
+  webRequest->response.responseText = "{\"1/3\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = true;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_FALSE(eventCallbackCalled);
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_TRUE(updateError.empty());
+}
+
+TEST_F(UpdateCheckTest, WrongVersion)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
+  webRequest->response.responseStatus = 200;
+  webRequest->response.responseText = "{\"1\": {\"version\":\"3\",\"url\":\"https://foo.bar/\"}}";
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = true;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_FALSE(eventCallbackCalled);
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_TRUE(updateError.empty());
+}
+
+TEST_F(UpdateCheckTest, WrongURL)
+{
+  webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
+  webRequest->response.responseStatus = 200;
+  webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"http://insecure/\"}}";
+
+  appInfo.name = "1";
+  appInfo.id = "2";
+  appInfo.version = "3";
+  appInfo.platform = "4";
+  appInfo.developmentBuild = true;
+
+  Reset();
+  ForceUpdateCheck();
+
+  AdblockPlus::Sleep(100);
+
+  ASSERT_FALSE(eventCallbackCalled);
+  ASSERT_TRUE(updateCallbackCalled);
+  ASSERT_FALSE(updateError.empty());
+}