external/bsd/atf/dist/tools/test-program.hpp

   1 //
   2 // Automated Testing Framework (atf)
   3 //
   4 // Copyright (c) 2010 The NetBSD Foundation, Inc.
   5 // All rights reserved.
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 // 1. Redistributions of source code must retain the above copyright
  11 //    notice, this list of conditions and the following disclaimer.
  12 // 2. Redistributions in binary form must reproduce the above copyright
  13 //    notice, this list of conditions and the following disclaimer in the
  14 //    documentation and/or other materials provided with the distribution.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
  17 // CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 // IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
  21 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  23 // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25 // IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  27 // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 //
  29
  30 #if !defined(TOOLS_TEST_PROGRAM_HPP)
  31 #define TOOLS_TEST_PROGRAM_HPP
  32
  33 #include <map>
  34 #include <string>
  35
  36 #include "fs.hpp"
  37 #include "process.hpp"
  38
  39 namespace tools {
  40 namespace test_program {
  41
  42 struct test_case_result {
  43     std::string m_state;
  44     int m_value;
  45     std::string m_reason;
  46
  47 public:
  48     test_case_result(void) :
  49         m_state("UNINITIALIZED"),
  50         m_value(-1),
  51         m_reason("")
  52     {
  53     }
  54
  55     test_case_result(const std::string& p_state, const int p_value,
  56                      const std::string& p_reason) :
  57         m_state(p_state),
  58         m_value(p_value),
  59         m_reason(p_reason)
  60     {
  61     }
  62
  63     const std::string&
  64     state(void) const
  65     {
  66         return m_state;
  67     }
  68
  69     int
  70     value(void) const
  71     {
  72         return m_value;
  73     }
  74
  75     const std::string&
  76     reason(void) const
  77     {
  78         return m_reason;
  79     }
  80 };
  81
  82 namespace detail {
  83
  84 class atf_tp_reader {
  85     std::istream& m_is;
  86
  87     void validate_and_insert(const std::string&, const std::string&,
  88                              const size_t,
  89                              std::map< std::string, std::string >&);
  90
  91 protected:
  92     virtual void got_tc(const std::string&,
  93                         const std::map< std::string, std::string >&);
  94     virtual void got_eof(void);
  95
  96 public:
  97     atf_tp_reader(std::istream&);
  98     virtual ~atf_tp_reader(void);
  99
 100     void read(void);
 101 };
 102
 103 test_case_result parse_test_case_result(const std::string&);
 104
 105 } // namespace detail
 106
 107 class atf_tps_writer {
 108     std::ostream& m_os;
 109
 110     std::string m_tpname, m_tcname;
 111
 112 public:
 113     atf_tps_writer(std::ostream&);
 114
 115     void info(const std::string&, const std::string&);
 116     void ntps(size_t);
 117
 118     void start_tp(const std::string&, size_t);
 119     void end_tp(const std::string&);
 120
 121     void start_tc(const std::string&);
 122     void stdout_tc(const std::string&);
 123     void stderr_tc(const std::string&);
 124     void end_tc(const std::string&, const std::string&);
 125 };
 126
 127 typedef std::map< std::string, std::map< std::string, std::string > >
 128     test_cases_map;
 129
 130 struct metadata {
 131     test_cases_map test_cases;
 132
 133     metadata(void)
 134     {
 135     }
 136
 137     metadata(const test_cases_map& p_test_cases) :
 138         test_cases(p_test_cases)
 139     {
 140     }
 141 };
 142
 143 class atf_tps_writer;
 144
 145 metadata get_metadata(const tools::fs::path&,
 146                       const std::map< std::string, std::string >&);
 147 test_case_result read_test_case_result(const tools::fs::path&);
 148 std::pair< std::string, tools::process::status > run_test_case(
 149     const tools::fs::path&, const std::string&, const std::string&,
 150     const std::map< std::string, std::string >&,
 151     const std::map< std::string, std::string >&,
 152     const tools::fs::path&, const tools::fs::path&, atf_tps_writer&);
 153
 154 } // namespace test_program
 155 } // namespace tools
 156
 157 #endif // !defined(TOOLS_TEST_PROGRAM_HPP)