Line data Source code
1 : /*
2 : ___________________________________________
3 : | _ ___ _ |
4 : | | | |__ \ | | |
5 : | | |__ ) |__ _ __ _ ___ _ __ | |_ |
6 : | | '_ \ / // _` |/ _` |/ _ \ '_ \| __| | HTTP/2 AGENT FOR MOCK TESTING
7 : | | | | |/ /| (_| | (_| | __/ | | | |_ | Version 0.0.z
8 : | |_| |_|____\__,_|\__, |\___|_| |_|\__| | https://github.com/testillano/h2agent
9 : | __/ | |
10 : | |___/ |
11 : |___________________________________________|
12 :
13 : Licensed under the MIT License <http://opensource.org/licenses/MIT>.
14 : SPDX-License-Identifier: MIT
15 : Copyright (c) 2021 Eduardo Ramos
16 :
17 : Permission is hereby granted, free of charge, to any person obtaining a copy
18 : of this software and associated documentation files (the "Software"), to deal
19 : in the Software without restriction, including without limitation the rights
20 : to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
21 : copies of the Software, and to permit persons to whom the Software is
22 : furnished to do so, subject to the following conditions:
23 :
24 : The above copyright notice and this permission notice shall be included in all
25 : copies or substantial portions of the Software.
26 :
27 : THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 : IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 : FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30 : AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31 : LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32 : OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 : SOFTWARE.
34 : */
35 :
36 : #pragma once
37 :
38 : #include <vector>
39 : #include <cstdint>
40 :
41 : #include <nlohmann/json.hpp>
42 :
43 : #include <Map.hpp>
44 : #include <MockEventsHistory.hpp>
45 : #include <MockEvent.hpp>
46 :
47 :
48 : namespace h2agent
49 : {
50 : namespace model
51 : {
52 :
53 :
54 : /**
55 : * This class stores the mock events.
56 : *
57 : * This is useful to post-verify the internal data (content and schema validation) on testing system.
58 : * Also, the last request for an specific key, is used to know the state which is used to get the
59 : * corresponding provision information.
60 : */
61 : class MockData : public Map<mock_events_key_t, std::shared_ptr<MockEventsHistory>>
62 : {
63 : protected:
64 : mutable mutex_t rw_mutex_{};
65 :
66 : // Get the events list for data key provided, and pass by reference a boolean to know if the list must be inaugurated
67 : // Set write guard for rw_mutex_ before calling this
68 : std::shared_ptr<MockEventsHistory> getEvents(const DataKey &dataKey, bool &maiden);
69 :
70 : public:
71 245 : MockData() {};
72 245 : ~MockData() = default;
73 :
74 : /** Clears internal data
75 : *
76 : * @param somethingDeleted boolean to know if something was deleted, by reference
77 : * @param ekey Event key given by data key and event history number (1..N) to filter selection
78 : * Empty event key will remove the whole history for data key provided.
79 : * Event number '-1' will select the latest event in events history.
80 : *
81 : * @return Boolean about success of operation (not related to the number of events removed)
82 : */
83 : bool clear(bool &somethingDeleted, const EventKey &ekey);
84 :
85 : /**
86 : * Json string representation for class information filtered (json array)
87 : *
88 : * @param elkey Event location key given by data key, event history number (1..N) and event path to filter selection
89 : * Event history number (1..N) is optional, but cannot be provided alone (needs data key).
90 : * If empty, whole history is selected for data key provided.
91 : * If provided '-1' (unsigned long long max), the latest event is selected.
92 : * Event Path within the event selected is optional, but cannot be provided alone (needs data key and event number).
93 : * @param validQuery Boolean result passed by reference.
94 : *
95 : * @return Json string representation ('[]' for empty array).
96 : * @warning This method may throw exception due to dump() when unexpected data is stored on json wrap: execute under try/catch block.
97 :
98 : */
99 : std::string asJsonString(const EventLocationKey &elkey, bool &validQuery) const;
100 :
101 : /**
102 : * Json string representation for class summary (total number of events and first/last/random keys).
103 : *
104 : * @param maxKeys Maximum number of keys to be displayed in the summary (protection for huge server data size). No limit by default.
105 : *
106 : * @return Json string representation.
107 : */
108 : std::string summary(const std::string &maxKeys = "") const;
109 :
110 : /**
111 : * Gets the mock server key event in specific position
112 : *
113 : * @param ekey Event key given by data key and event history number (1..N) to filter selection
114 : * Value '-1' (unsigned long long max) selects the latest event.
115 : * Value '0' is not accepted, and null will be returned in this case.
116 : *
117 : * All the parameters are mandatory to select the single request event.
118 : * If any is missing, nullptr is returned.
119 : *
120 : * @return mock request pointer
121 : * @see size()
122 : */
123 : std::shared_ptr<MockEvent> getEvent(const EventKey &ekey) const;
124 :
125 : /**
126 : * Builds json document for class information
127 : *
128 : * @return Json object
129 : */
130 : nlohmann::json getJson() const;
131 :
132 : /**
133 : * Finds most recent mock context entry state.
134 : *
135 : * @param key Data key triggered.
136 : * @param state Request current state filled by reference.
137 : * If nothing found or no state (unprovisioned events), 'initial' will be set.
138 : *
139 : * @return Boolean about if the request is found or not
140 : */
141 : bool findLastRegisteredRequestState(const DataKey &key, std::string &state) const;
142 : };
143 :
144 : }
145 : }
146 :
|
