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              : 
      39              : #include <vector>
      40              : #include <memory>
      41              : 
      42              : #include <MockEvent.hpp>
      43              : #include <common.hpp>
      44              : #include <keys.hpp>
      45              : 
      46              : 
      47              : namespace h2agent
      48              : {
      49              : namespace model
      50              : {
      51              : 
      52              : class MockEventsHistory
      53              : {
      54              :     std::vector<std::shared_ptr<MockEvent>> events_{};
      55              :     mutable mutex_t rw_mutex_{};
      56              : 
      57              : protected:
      58              :     DataKey data_key_;
      59              : 
      60              : public:
      61              : 
      62              :     /**
      63              :     * Constructor
      64              :     *
      65              :     * @param dataKey Events key ([client enpoint id,] method & uri).
      66              :     */
      67          202 :     MockEventsHistory(const DataKey &dataKey) : data_key_(dataKey) {;}
      68              : 
      69              :     // setters:
      70              : 
      71              :     /**
      72              :     * Loads event into history
      73              :     *
      74              :     * @param event Event to load
      75              :     * @param historyEnabled Events complete history storage
      76              :     *
      77              :     * Memory must be reserved by the user
      78              :     */
      79              :     void loadEvent(std::shared_ptr<MockEvent> event, bool historyEnabled);
      80              : 
      81              :     /**
      82              :      * Removes vector item for a given position
      83              :      * We could also access from the tail (reverse chronological order)
      84              : 
      85              :      * @param eventNumber Event history number (1..N) to filter selection.
      86              :      * @param reverse Reverse the order to get the event from the tail instead the head.
      87              :      *
      88              :      * @return Boolean about if something was deleted
      89              :      */
      90              :     bool removeEvent(std::uint64_t eventNumber, bool reverse);
      91              : 
      92              :     // getters:
      93              : 
      94              :     /**
      95              :      * Gets the mock key event in specific position (last by default)
      96              :      *
      97              :      * @param eventNumber Event history number (1..N) to filter selection.
      98              :      * Value '0' is not accepted, and null will be returned in this case.
      99              :      * @param reverse Reverse the order to get the event from the tail instead the head.
     100              :      *
     101              :      * @return mock request pointer
     102              :      * @see size()
     103              :      */
     104              :     std::shared_ptr<MockEvent> getEvent(std::uint64_t eventNumber, bool reverse) const;
     105              : 
     106              :     /**
     107              :      * Builds json document for class information
     108              :      *
     109              :      * @return Json object
     110              :      */
     111              :     nlohmann::json getJson() const;
     112              : 
     113              :     /**
     114              :      * Gets the mock events data key
     115              :      *
     116              :      * @return Mock event data key
     117              :      */
     118           11 :     const DataKey &getKey() const {
     119           11 :         return data_key_;
     120              :     }
     121              : 
     122              :     /** Number of events
     123              :     *
     124              :     * @return Events list size
     125              :     */
     126           16 :     size_t size() const {
     127           16 :         return events_.size();
     128              :     }
     129              : 
     130              :     /** Last registered request state
     131              :     *
     132              :     * @return Last registered request state
     133              :     */
     134              :     const std::string &getLastRegisteredRequestState() const;
     135              : };
     136              : 
     137              : }
     138              : }
     139              :