src/test/alert_tests.cpp

   1 // Copyright (c) 2013 The Bitcoin Core developers
   2 // Distributed under the MIT/X11 software license, see the accompanying
   3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4
   5 //
   6 // Unit tests for alert system
   7 //
   8
   9 #include "alert.h"
  10 #include "data/alertTests.raw.h"
  11
  12 #include "serialize.h"
  13 #include "util.h"
  14 #include "version.h"
  15
  16 #include <fstream>
  17
  18 #include <boost/filesystem/operations.hpp>
  19 #include <boost/foreach.hpp>
  20 #include <boost/test/unit_test.hpp>
  21
  22 #if 0
  23 //
  24 // alertTests contains 7 alerts, generated with this code:
  25 // (SignAndSave code not shown, alert signing key is secret)
  26 //
  27 {
  28     CAlert alert;
  29     alert.nRelayUntil   = 60;
  30     alert.nExpiration   = 24 * 60 * 60;
  31     alert.nID           = 1;
  32     alert.nCancel       = 0;   // cancels previous messages up to this ID number
  33     alert.nMinVer       = 0;  // These versions are protocol versions
  34     alert.nMaxVer       = 999001;
  35     alert.nPriority     = 1;
  36     alert.strComment    = "Alert comment";
  37     alert.strStatusBar  = "Alert 1";
  38
  39     SignAndSave(alert, "test/alertTests");
  40
  41     alert.setSubVer.insert(std::string("/Satoshi:0.1.0/"));
  42     alert.strStatusBar  = "Alert 1 for Satoshi 0.1.0";
  43     SignAndSave(alert, "test/alertTests");
  44
  45     alert.setSubVer.insert(std::string("/Satoshi:0.2.0/"));
  46     alert.strStatusBar  = "Alert 1 for Satoshi 0.1.0, 0.2.0";
  47     SignAndSave(alert, "test/alertTests");
  48
  49     alert.setSubVer.clear();
  50     ++alert.nID;
  51     alert.nCancel = 1;
  52     alert.nPriority = 100;
  53     alert.strStatusBar  = "Alert 2, cancels 1";
  54     SignAndSave(alert, "test/alertTests");
  55
  56     alert.nExpiration += 60;
  57     ++alert.nID;
  58     SignAndSave(alert, "test/alertTests");
  59
  60     ++alert.nID;
  61     alert.nMinVer = 11;
  62     alert.nMaxVer = 22;
  63     SignAndSave(alert, "test/alertTests");
  64
  65     ++alert.nID;
  66     alert.strStatusBar  = "Alert 2 for Satoshi 0.1.0";
  67     alert.setSubVer.insert(std::string("/Satoshi:0.1.0/"));
  68     SignAndSave(alert, "test/alertTests");
  69
  70     ++alert.nID;
  71     alert.nMinVer = 0;
  72     alert.nMaxVer = 999999;
  73     alert.strStatusBar  = "Evil Alert'; /bin/ls; echo '";
  74     alert.setSubVer.clear();
  75     SignAndSave(alert, "test/alertTests");
  76 }
  77 #endif
  78
  79 struct ReadAlerts
  80 {
  81     ReadAlerts()
  82     {
  83         std::vector<unsigned char> vch(alert_tests::alertTests, alert_tests::alertTests + sizeof(alert_tests::alertTests));
  84         CDataStream stream(vch, SER_DISK, CLIENT_VERSION);
  85         try {
  86             while (stream.good())
  87             {
  88                 CAlert alert;
  89                 stream >> alert;
  90                 alerts.push_back(alert);
  91             }
  92         }
  93         catch (std::exception) { }
  94     }
  95     ~ReadAlerts() { }
  96
  97     static std::vector<std::string> read_lines(boost::filesystem::path filepath)
  98     {
  99         std::vector<std::string> result;
 100
 101         std::ifstream f(filepath.string().c_str());
 102         std::string line;
 103         while (std::getline(f,line))
 104             result.push_back(line);
 105
 106         return result;
 107     }
 108
 109     std::vector<CAlert> alerts;
 110 };
 111
 112 BOOST_FIXTURE_TEST_SUITE(Alert_tests, ReadAlerts)
 113
 114
 115 BOOST_AUTO_TEST_CASE(AlertApplies)
 116 {
 117     SetMockTime(11);
 118
 119     BOOST_FOREACH(const CAlert& alert, alerts)
 120     {
 121         BOOST_CHECK(alert.CheckSignature());
 122     }
 123
 124     BOOST_CHECK(alerts.size() >= 3);
 125
 126     // Matches:
 127     BOOST_CHECK(alerts[0].AppliesTo(1, ""));
 128     BOOST_CHECK(alerts[0].AppliesTo(999001, ""));
 129     BOOST_CHECK(alerts[0].AppliesTo(1, "/Satoshi:11.11.11/"));
 130
 131     BOOST_CHECK(alerts[1].AppliesTo(1, "/Satoshi:0.1.0/"));
 132     BOOST_CHECK(alerts[1].AppliesTo(999001, "/Satoshi:0.1.0/"));
 133
 134     BOOST_CHECK(alerts[2].AppliesTo(1, "/Satoshi:0.1.0/"));
 135     BOOST_CHECK(alerts[2].AppliesTo(1, "/Satoshi:0.2.0/"));
 136
 137     // Don't match:
 138     BOOST_CHECK(!alerts[0].AppliesTo(-1, ""));
 139     BOOST_CHECK(!alerts[0].AppliesTo(999002, ""));
 140
 141     BOOST_CHECK(!alerts[1].AppliesTo(1, ""));
 142     BOOST_CHECK(!alerts[1].AppliesTo(1, "Satoshi:0.1.0"));
 143     BOOST_CHECK(!alerts[1].AppliesTo(1, "/Satoshi:0.1.0"));
 144     BOOST_CHECK(!alerts[1].AppliesTo(1, "Satoshi:0.1.0/"));
 145     BOOST_CHECK(!alerts[1].AppliesTo(-1, "/Satoshi:0.1.0/"));
 146     BOOST_CHECK(!alerts[1].AppliesTo(999002, "/Satoshi:0.1.0/"));
 147     BOOST_CHECK(!alerts[1].AppliesTo(1, "/Satoshi:0.2.0/"));
 148
 149     BOOST_CHECK(!alerts[2].AppliesTo(1, "/Satoshi:0.3.0/"));
 150
 151     SetMockTime(0);
 152 }
 153
 154
 155 // This uses sh 'echo' to test the -alertnotify function, writing to a
 156 // /tmp file. So skip it on Windows:
 157 #ifndef WIN32
 158 BOOST_AUTO_TEST_CASE(AlertNotify)
 159 {
 160     SetMockTime(11);
 161
 162     boost::filesystem::path temp = GetTempPath() / "alertnotify.txt";
 163     boost::filesystem::remove(temp);
 164
 165     mapArgs["-alertnotify"] = std::string("echo %s >> ") + temp.string();
 166
 167     BOOST_FOREACH(CAlert alert, alerts)
 168         alert.ProcessAlert(false);
 169
 170     std::vector<std::string> r = read_lines(temp);
 171     BOOST_CHECK_EQUAL(r.size(), 4u);
 172     BOOST_CHECK_EQUAL(r[0], "Alert 1");
 173     BOOST_CHECK_EQUAL(r[1], "Alert 2, cancels 1");
 174     BOOST_CHECK_EQUAL(r[2], "Alert 2, cancels 1");
 175     BOOST_CHECK_EQUAL(r[3], "Evil Alert; /bin/ls; echo "); // single-quotes should be removed
 176
 177     boost::filesystem::remove(temp);
 178
 179     SetMockTime(0);
 180 }
 181 #endif
 182
 183 BOOST_AUTO_TEST_SUITE_END()