HardenedBSD/contrib/kyua/store/read_transaction.hpp
Brooks Davis b0d29bc47d Import the kyua test framework.
Having kyua in the base system will simplify automated testing in CI and
eliminates bootstrapping issues on new platforms.

The build of kyua is controlled by WITH(OUT)_TESTS_SUPPORT.

Reviewed by:	emaste
Obtained from:	CheriBSD
Sponsored by:	DARPA
Differential Revision:	https://reviews.freebsd.org/D24103
2020-03-23 19:01:23 +00:00

121 lines
3.7 KiB
C++

// Copyright 2011 The Kyua Authors.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Google Inc. nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/// \file store/read_transaction.hpp
/// Implementation of read-only transactions on the backend.
#if !defined(STORE_READ_TRANSACTION_HPP)
#define STORE_READ_TRANSACTION_HPP
#include "store/read_transaction_fwd.hpp"
extern "C" {
#include <stdint.h>
}
#include <memory>
#include <string>
#include "model/context_fwd.hpp"
#include "model/test_program_fwd.hpp"
#include "model/test_result_fwd.hpp"
#include "store/read_backend_fwd.hpp"
#include "store/read_transaction_fwd.hpp"
#include "utils/datetime_fwd.hpp"
namespace store {
namespace detail {
model::test_program_ptr get_test_program(read_backend&, const int64_t);
} // namespace detail
/// Iterator for the set of test case results that are part of an action.
///
/// \todo Note that this is not a "standard" C++ iterator. I have chosen to
/// implement a different interface because it makes things easier to represent
/// an SQL statement state. Rewrite as a proper C++ iterator, inheriting from
/// std::iterator.
class results_iterator {
struct impl;
/// Pointer to the shared internal implementation.
std::shared_ptr< impl > _pimpl;
friend class read_transaction;
results_iterator(std::shared_ptr< impl >);
public:
~results_iterator(void);
results_iterator& operator++(void);
operator bool(void) const;
const model::test_program_ptr test_program(void) const;
std::string test_case_name(void) const;
model::test_result result(void) const;
utils::datetime::timestamp start_time(void) const;
utils::datetime::timestamp end_time(void) const;
std::string stdout_contents(void) const;
std::string stderr_contents(void) const;
};
/// Representation of a read-only transaction.
///
/// Transactions are the entry place for high-level calls that access the
/// database.
class read_transaction {
struct impl;
/// Pointer to the shared internal implementation.
std::shared_ptr< impl > _pimpl;
friend class read_backend;
read_transaction(read_backend&);
public:
~read_transaction(void);
void finish(void);
model::context get_context(void);
results_iterator get_results(void);
};
} // namespace store
#endif // !defined(STORE_READ_TRANSACTION_HPP)