Re-introduce alert functionality (#1470)

Re-introduce alert functionality removed from Bitcoin upstream

1 files changed, 198 insertions, 0 deletions

diff --git a/src/test/alert_tests.cpp b/src/test/alert_tests.cpp
new file mode 100644
index 000000000..376567efb
--- /dev/null
+++ b/src/test/alert_tests.cpp
@@ -0,0 +1,198 @@
+// Copyright (c) 2013-2015 The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+// Unit tests for alert system
+
+#include "alert.h"
+#include "chain.h"
+#include "chainparams.h"
+#include "clientversion.h"
+#include "data/alertTests.raw.h"
+#include "serialize.h"
+#include "streams.h"
+#include "utilstrencodings.h"
+
+#include "test/testutil.h"
+#include "test/test_bitcoin.h"
+
+#include <fstream>
+
+#include <boost/filesystem/operations.hpp>
+#include <boost/foreach.hpp>
+#include <boost/test/unit_test.hpp>
+
+extern std::map<std::string, std::string> mapArgs;
+
+#if 0
+//
+// alertTests contains 7 alerts, generated with this code:
+// (SignAndSave code not shown, alert signing key is secret)
+//
+{
+    CAlert alert;
+    alert.nRelayUntil   = 60;
+    alert.nExpiration   = 24 * 60 * 60;
+    alert.nID           = 1;
+    alert.nCancel       = 0;   // cancels previous messages up to this ID number
+    alert.nMinVer       = 0;  // These versions are protocol versions
+    alert.nMaxVer       = 999001;
+    alert.nPriority     = 1;
+    alert.strComment    = "Alert comment";
+    alert.strStatusBar  = "Alert 1";
+
+    SignAndSave(alert, "test/alertTests");
+
+    alert.setSubVer.insert(std::string("/Satoshi:0.1.0/"));
+    alert.strStatusBar  = "Alert 1 for Satoshi 0.1.0";
+    SignAndSave(alert, "test/alertTests");
+
+    alert.setSubVer.insert(std::string("/Satoshi:0.2.0/"));
+    alert.strStatusBar  = "Alert 1 for Satoshi 0.1.0, 0.2.0";
+    SignAndSave(alert, "test/alertTests");
+
+    alert.setSubVer.clear();
+    ++alert.nID;
+    alert.nCancel = 1;
+    alert.nPriority = 100;
+    alert.strStatusBar  = "Alert 2, cancels 1";
+    SignAndSave(alert, "test/alertTests");
+
+    alert.nExpiration += 60;
+    ++alert.nID;
+    SignAndSave(alert, "test/alertTests");
+
+    ++alert.nID;
+    alert.nMinVer = 11;
+    alert.nMaxVer = 22;
+    SignAndSave(alert, "test/alertTests");
+
+    ++alert.nID;
+    alert.strStatusBar  = "Alert 2 for Satoshi 0.1.0";
+    alert.setSubVer.insert(std::string("/Satoshi:0.1.0/"));
+    SignAndSave(alert, "test/alertTests");
+
+    ++alert.nID;
+    alert.nMinVer = 0;
+    alert.nMaxVer = 999999;
+    alert.strStatusBar  = "Evil Alert'; /bin/ls; echo '";
+    alert.setSubVer.clear();
+    SignAndSave(alert, "test/alertTests");
+}
+#endif
+
+struct ReadAlerts : public TestingSetup
+{
+    ReadAlerts()
+    {
+        std::vector<unsigned char> vch(alertTests, alertTests + sizeof(alertTests));
+        CDataStream stream(vch, SER_DISK, CLIENT_VERSION);
+        try {
+            while (!stream.eof())
+            {
+                CAlert alert;
+                stream >> alert;
+                alerts.push_back(alert);
+            }
+        }
+        catch (const std::exception&) { }
+    }
+    ~ReadAlerts() { }
+
+    static std::vector<std::string> read_lines(boost::filesystem::path filepath)
+    {
+        std::vector<std::string> result;
+
+        std::ifstream f(filepath.string().c_str());
+        std::string line;
+        while (std::getline(f,line))
+            result.push_back(line);
+
+        return result;
+    }
+
+    std::vector<CAlert> alerts;
+};
+
+BOOST_FIXTURE_TEST_SUITE(Alert_tests, ReadAlerts)
+
+
+BOOST_AUTO_TEST_CASE(AlertApplies)
+{
+    SetMockTime(11);
+    const std::vector<unsigned char>& alertKey = Params(CBaseChainParams::MAIN).AlertKey();
+
+    BOOST_FOREACH(const CAlert& alert, alerts)
+    {
+        BOOST_CHECK(alert.CheckSignature(alertKey));
+    }
+
+    BOOST_CHECK(alerts.size() >= 3);
+
+    // Matches:
+    BOOST_CHECK(alerts[0].AppliesTo(1, ""));
+    BOOST_CHECK(alerts[0].AppliesTo(999001, ""));
+    BOOST_CHECK(alerts[0].AppliesTo(1, "/Satoshi:11.11.11/"));
+
+    BOOST_CHECK(alerts[1].AppliesTo(1, "/Satoshi:0.1.0/"));
+    BOOST_CHECK(alerts[1].AppliesTo(999001, "/Satoshi:0.1.0/"));
+
+    BOOST_CHECK(alerts[2].AppliesTo(1, "/Satoshi:0.1.0/"));
+    BOOST_CHECK(alerts[2].AppliesTo(1, "/Satoshi:0.2.0/"));
+
+    // Don't match:
+    BOOST_CHECK(!alerts[0].AppliesTo(-1, ""));
+    BOOST_CHECK(!alerts[0].AppliesTo(999002, ""));
+
+    BOOST_CHECK(!alerts[1].AppliesTo(1, ""));
+    BOOST_CHECK(!alerts[1].AppliesTo(1, "Satoshi:0.1.0"));
+    BOOST_CHECK(!alerts[1].AppliesTo(1, "/Satoshi:0.1.0"));
+    BOOST_CHECK(!alerts[1].AppliesTo(1, "Satoshi:0.1.0/"));
+    BOOST_CHECK(!alerts[1].AppliesTo(-1, "/Satoshi:0.1.0/"));
+    BOOST_CHECK(!alerts[1].AppliesTo(999002, "/Satoshi:0.1.0/"));
+    BOOST_CHECK(!alerts[1].AppliesTo(1, "/Satoshi:0.2.0/"));
+
+    BOOST_CHECK(!alerts[2].AppliesTo(1, "/Satoshi:0.3.0/"));
+
+    SetMockTime(0);
+}
+
+
+BOOST_AUTO_TEST_CASE(AlertNotify)
+{
+    SetMockTime(11);
+    const std::vector<unsigned char>& alertKey = Params(CBaseChainParams::MAIN).AlertKey();
+
+    boost::filesystem::path temp = GetTempPath() /
+        boost::filesystem::unique_path("alertnotify-%%%%.txt");
+
+    mapArgs["-alertnotify"] = std::string("echo %s >> ") + temp.string();
+
+    BOOST_FOREACH(CAlert alert, alerts)
+        alert.ProcessAlert(alertKey, false);
+
+    std::vector<std::string> r = read_lines(temp);
+    BOOST_CHECK_EQUAL(r.size(), 4u);
+
+// Windows built-in echo semantics are different than posixy shells. Quotes and
+// whitespace are printed literally.
+
+#ifndef WIN32
+    BOOST_CHECK_EQUAL(r[0], "Alert 1");
+    BOOST_CHECK_EQUAL(r[1], "Alert 2, cancels 1");
+    BOOST_CHECK_EQUAL(r[2], "Alert 2, cancels 1");
+    BOOST_CHECK_EQUAL(r[3], "Evil Alert; /bin/ls; echo "); // single-quotes should be removed
+#else
+    BOOST_CHECK_EQUAL(r[0], "'Alert 1' ");
+    BOOST_CHECK_EQUAL(r[1], "'Alert 2, cancels 1' ");
+    BOOST_CHECK_EQUAL(r[2], "'Alert 2, cancels 1' ");
+    BOOST_CHECK_EQUAL(r[3], "'Evil Alert; /bin/ls; echo ' ");
+#endif
+    boost::filesystem::remove(temp);
+
+    SetMockTime(0);
+}
+
+static bool falseFunc() { return false; }
+
+BOOST_AUTO_TEST_SUITE_END()