From 4d72fc225a49a876bce82761a60bc088c67b3752 Mon Sep 17 00:00:00 2001
From: Edward Hennis <ed@ripple.com>
Date: Tue, 19 Jan 2016 19:48:22 -0500
Subject: [PATCH] Unit test of RPC ledger_request

---
 Builds/VisualStudio2015/RippleD.vcxproj       |   4 +
 .../VisualStudio2015/RippleD.vcxproj.filters  |   3 +
 .../rpc/tests/LedgerRequestRPC.test.cpp       | 159 ++++++++++++++++++
 src/ripple/unity/rpcx.cpp                     |   1 +
 4 files changed, 167 insertions(+)
 create mode 100644 src/ripple/rpc/tests/LedgerRequestRPC.test.cpp

diff --git a/Builds/VisualStudio2015/RippleD.vcxproj b/Builds/VisualStudio2015/RippleD.vcxproj
index b2e4077002..f83e0351ad 100644
--- a/Builds/VisualStudio2015/RippleD.vcxproj
+++ b/Builds/VisualStudio2015/RippleD.vcxproj
@@ -3279,6 +3279,10 @@
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='debug|x64'">True</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='release|x64'">True</ExcludedFromBuild>
     </ClCompile>
+    <ClCompile Include="..\..\src\ripple\rpc\tests\LedgerRequestRPC.test.cpp">
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='debug|x64'">True</ExcludedFromBuild>
+      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='release|x64'">True</ExcludedFromBuild>
+    </ClCompile>
     <ClCompile Include="..\..\src\ripple\rpc\tests\Status.test.cpp">
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='debug|x64'">True</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='release|x64'">True</ExcludedFromBuild>
diff --git a/Builds/VisualStudio2015/RippleD.vcxproj.filters b/Builds/VisualStudio2015/RippleD.vcxproj.filters
index 8822874aa8..a93564270b 100644
--- a/Builds/VisualStudio2015/RippleD.vcxproj.filters
+++ b/Builds/VisualStudio2015/RippleD.vcxproj.filters
@@ -3768,6 +3768,9 @@
     <ClCompile Include="..\..\src\ripple\rpc\tests\KeyGeneration.test.cpp">
       <Filter>ripple\rpc\tests</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\src\ripple\rpc\tests\LedgerRequestRPC.test.cpp">
+      <Filter>ripple\rpc\tests</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\src\ripple\rpc\tests\Status.test.cpp">
       <Filter>ripple\rpc\tests</Filter>
     </ClCompile>
diff --git a/src/ripple/rpc/tests/LedgerRequestRPC.test.cpp b/src/ripple/rpc/tests/LedgerRequestRPC.test.cpp
new file mode 100644
index 0000000000..90a923b0ec
--- /dev/null
+++ b/src/ripple/rpc/tests/LedgerRequestRPC.test.cpp
@@ -0,0 +1,159 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of rippled: https://github.com/ripple/rippled
+    Copyright (c) 2012-2016 Ripple Labs Inc.
+
+    Permission to use, copy, modify, and/or distribute this software for any
+    purpose  with  or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include <BeastConfig.h>
+#include <ripple/protocol/ErrorCodes.h>
+#include <ripple/protocol/JsonFields.h>
+#include <ripple/test/jtx.h>
+#include <beast/unit_test/suite.h>
+
+namespace ripple {
+
+namespace RPC {
+
+class LedgerRequestRPC_test : public beast::unit_test::suite
+{
+public:
+    void testLedgerRequest()
+    {
+        using namespace test::jtx;
+
+        Env env(*this);
+
+        env.close();
+        env.close();
+        expect(env.current()->info().seq == 5);
+
+        {
+            // arbitrary text is converted to 0.
+            auto const result = env.rpc("ledger_request", "arbitrary_text");
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                "Ledger index too small");
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "-1");
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                "Ledger index too small");
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "0");
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                    "Ledger index too small");
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "1");
+            expect(!RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::ledger_index] == 1 &&
+                    result[jss::result].isMember(jss::ledger));
+            expect(result[jss::result][jss::ledger].
+                isMember(jss::ledger_hash) &&
+                    result[jss::result][jss::ledger]
+                        [jss::ledger_hash].isString());
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "2");
+            expect(!RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::ledger_index] == 2 &&
+                    result[jss::result].isMember(jss::ledger));
+            expect(result[jss::result][jss::ledger].
+                isMember(jss::ledger_hash) &&
+                    result[jss::result][jss::ledger]
+                        [jss::ledger_hash].isString());
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "3");
+            expect(!RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::ledger_index] == 3 &&
+                    result[jss::result].isMember(jss::ledger));
+            expect(result[jss::result][jss::ledger].
+                isMember(jss::ledger_hash) &&
+                    result[jss::result][jss::ledger]
+                        [jss::ledger_hash].isString());
+
+            auto const ledgerHash = result[jss::result]
+                [jss::ledger][jss::ledger_hash].asString();
+
+            {
+                // Intentionally shadow `result` here to avoid reuing it.
+                auto const result = env.rpc("ledger_request", ledgerHash);
+                expect(!RPC::contains_error(result[jss::result]) &&
+                    result[jss::result][jss::ledger_index] == 3 &&
+                        result[jss::result].isMember(jss::ledger));
+                expect(result[jss::result][jss::ledger].
+                    isMember(jss::ledger_hash) &&
+                        result[jss::result][jss::ledger]
+                            [jss::ledger_hash] == ledgerHash);
+            }
+        }
+
+        {
+            std::string ledgerHash(64, 'q');
+
+            auto const result = env.rpc("ledger_request", ledgerHash);
+
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                    "Invalid field 'ledger_hash'.");
+        }
+
+        {
+            std::string ledgerHash(64, '1');
+
+            auto const result = env.rpc("ledger_request", ledgerHash);
+
+            log << result;
+            expect(!RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::have_header] == false);
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "4");
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                    "Ledger index too large");
+        }
+
+        {
+            auto const result = env.rpc("ledger_request", "5");
+            expect(RPC::contains_error(result[jss::result]) &&
+                result[jss::result][jss::error_message] ==
+                    "Ledger index too large");
+        }
+
+    }
+
+    void run ()
+    {
+        testLedgerRequest ();
+    }
+};
+
+BEAST_DEFINE_TESTSUITE(LedgerRequestRPC,app,ripple);
+
+} // RPC
+} // ripple
+
diff --git a/src/ripple/unity/rpcx.cpp b/src/ripple/unity/rpcx.cpp
index 24c7def4f3..8ff4ecc429 100644
--- a/src/ripple/unity/rpcx.cpp
+++ b/src/ripple/unity/rpcx.cpp
@@ -100,5 +100,6 @@
 #include <ripple/rpc/impl/RPCVersion.cpp>
 
 #include <ripple/rpc/tests/JSONRPC.test.cpp>
+#include <ripple/rpc/tests/LedgerRequestRPC.test.cpp>
 #include <ripple/rpc/tests/KeyGeneration.test.cpp>
 #include <ripple/rpc/tests/Status.test.cpp>