rippled
STAccount_test.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2015 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/protocol/STAccount.h>
21 #include <ripple/beast/unit_test.h>
22 
23 namespace ripple {
24 
25 struct STAccount_test : public beast::unit_test::suite
26 {
27  void
29  {
30  {
31  // Test default constructor.
32  STAccount const defaultAcct;
33  BEAST_EXPECT(defaultAcct.getSType() == STI_ACCOUNT);
34  BEAST_EXPECT(defaultAcct.getText() == "");
35  BEAST_EXPECT(defaultAcct.isDefault() == true);
36  BEAST_EXPECT(defaultAcct.value() == AccountID {});
37  {
38 #ifdef NDEBUG // Qualified because the serialization asserts in a debug build.
39  Serializer s;
40  defaultAcct.add (s); // Asserts in debug build
41  BEAST_EXPECT(s.size() == 1);
42  BEAST_EXPECT(s.getHex() == "00");
43  SerialIter sit (s.slice ());
44  STAccount const deserializedDefault (sit, sfAccount);
45  BEAST_EXPECT(deserializedDefault.isEquivalent (defaultAcct));
46 #endif // NDEBUG
47  }
48  {
49  // Construct a deserialized default STAccount.
50  Serializer s;
51  s.addVL (nullptr, 0);
52  SerialIter sit (s.slice ());
53  STAccount const deserializedDefault (sit, sfAccount);
54  BEAST_EXPECT(deserializedDefault.isEquivalent (defaultAcct));
55  }
56 
57  // Test constructor from SField.
58  STAccount const sfAcct {sfAccount};
59  BEAST_EXPECT(sfAcct.getSType() == STI_ACCOUNT);
60  BEAST_EXPECT(sfAcct.getText() == "");
61  BEAST_EXPECT(sfAcct.isDefault());
62  BEAST_EXPECT(sfAcct.value() == AccountID {});
63  BEAST_EXPECT(sfAcct.isEquivalent (defaultAcct));
64  {
65  Serializer s;
66  sfAcct.add (s);
67  BEAST_EXPECT(s.size() == 1);
68  BEAST_EXPECT(s.getHex() == "00");
69  SerialIter sit (s.slice ());
70  STAccount const deserializedSf (sit, sfAccount);
71  BEAST_EXPECT(deserializedSf.isEquivalent(sfAcct));
72  }
73 
74  // Test constructor from SField and AccountID.
75  STAccount const zeroAcct {sfAccount, AccountID{}};
76  BEAST_EXPECT(zeroAcct.getText() == "rrrrrrrrrrrrrrrrrrrrrhoLvTp");
77  BEAST_EXPECT(! zeroAcct.isDefault());
78  BEAST_EXPECT(zeroAcct.value() == AccountID {0});
79  BEAST_EXPECT(! zeroAcct.isEquivalent (defaultAcct));
80  BEAST_EXPECT(! zeroAcct.isEquivalent (sfAcct));
81  {
82  Serializer s;
83  zeroAcct.add (s);
84  BEAST_EXPECT(s.size() == 21);
85  BEAST_EXPECT(s.getHex() ==
86  "140000000000000000000000000000000000000000");
87  SerialIter sit (s.slice ());
88  STAccount const deserializedZero (sit, sfAccount);
89  BEAST_EXPECT(deserializedZero.isEquivalent (zeroAcct));
90  }
91  {
92  // Construct from a VL that is not exactly 160 bits.
93  Serializer s;
94  const std::uint8_t bits128[] {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0};
95  s.addVL (bits128, sizeof (bits128));
96  SerialIter sit (s.slice ());
97  try
98  {
99  // Constructing an STAccount with a bad size should throw.
100  STAccount const deserializedBadSize (sit, sfAccount);
101  }
102  catch (std::runtime_error const& ex)
103  {
104  BEAST_EXPECT(ex.what() == std::string("Invalid STAccount size"));
105  }
106 
107  }
108 
109  // Interestingly, equal values but different types are equivalent!
110  STAccount const regKey {sfRegularKey, AccountID{}};
111  BEAST_EXPECT(regKey.isEquivalent (zeroAcct));
112 
113  // Test assignment.
114  STAccount assignAcct;
115  BEAST_EXPECT(assignAcct.isEquivalent (defaultAcct));
116  BEAST_EXPECT(assignAcct.isDefault());
117  assignAcct = AccountID{};
118  BEAST_EXPECT(! assignAcct.isEquivalent (defaultAcct));
119  BEAST_EXPECT(assignAcct.isEquivalent (zeroAcct));
120  BEAST_EXPECT(! assignAcct.isDefault());
121  }
122  }
123 
124  void
125  run() override
126  {
127  testSTAccount();
128  }
129 };
130 
131 BEAST_DEFINE_TESTSUITE(STAccount,protocol,ripple);
132 
133 }
ripple::STAccount_test
Definition: STAccount_test.cpp:25
ripple::sfRegularKey
const SF_Account sfRegularKey(access, STI_ACCOUNT, 8, "RegularKey")
Definition: SField.h:467
std::string
STL class.
ripple::BEAST_DEFINE_TESTSUITE
BEAST_DEFINE_TESTSUITE(AccountTxPaging, app, ripple)
ripple::STAccount::getSType
SerializedTypeID getSType() const override
Definition: STAccount.h:61
ripple::Serializer::getHex
std::string getHex() const
Definition: Serializer.h:264
ripple::sfAccount
const SF_Account sfAccount(access, STI_ACCOUNT, 1, "Account")
Definition: SField.h:460
ripple::STI_ACCOUNT
@ STI_ACCOUNT
Definition: SField.h:67
ripple::STAccount::isDefault
bool isDefault() const override
Definition: STAccount.h:89
ripple::STAccount::isEquivalent
bool isEquivalent(const STBase &t) const override
Definition: STAccount.h:82
ripple::base_uint< 160, detail::AccountIDTag >
ripple::STAccount_test::testSTAccount
void testSTAccount()
Definition: STAccount_test.cpp:28
ripple::Serializer::slice
Slice slice() const noexcept
Definition: Serializer.h:67
std::runtime_error
STL class.
ripple::SerialIter
Definition: Serializer.h:311
std::uint8_t
ripple::STAccount::add
void add(Serializer &s) const override
Definition: STAccount.h:69
ripple::STAccount::value
AccountID value() const noexcept
Definition: STAccount.h:102
ripple::Serializer
Definition: Serializer.h:43
ripple::STAccount
Definition: STAccount.h:29
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::Serializer::size
std::size_t size() const noexcept
Definition: Serializer.h:73
ripple::STAccount::getText
std::string getText() const override
Definition: STAccount.cpp:70
ripple::Serializer::addVL
int addVL(Blob const &vector)
Definition: Serializer.cpp:208
std::runtime_error::what
T what(T... args)
ripple::STAccount_test::run
void run() override
Definition: STAccount_test.cpp:125