xref: /freebsd/contrib/atf/atf-c++/detail/test_helpers.cpp (revision e477abf734cc777a55286bfbd6b80a6760c96acf)
1 //
2 // Automated Testing Framework (atf)
3 //
4 // Copyright (c) 2009 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 extern "C" {
31 #include <regex.h>
32 }
33 
34 #include <fstream>
35 #include <iostream>
36 #include <string>
37 #include <vector>
38 
39 #include "../check.hpp"
40 #include "../config.hpp"
41 #include "../macros.hpp"
42 
43 #include "fs.hpp"
44 #include "process.hpp"
45 #include "test_helpers.hpp"
46 
47 void
48 build_check_cxx_o_aux(const atf::fs::path& sfile, const char* failmsg,
49                       const bool expect_pass)
50 {
51     std::vector< std::string > optargs;
52     optargs.push_back("-I" + atf::config::get("atf_includedir"));
53     optargs.push_back("-Wall");
54     optargs.push_back("-Werror");
55 
56     const bool result = atf::check::build_cxx_o(
57         sfile.str(), "test.o", atf::process::argv_array(optargs));
58     if ((expect_pass && !result) || (!expect_pass && result))
59         ATF_FAIL(failmsg);
60 }
61 
62 void
63 build_check_cxx_o(const atf::tests::tc& tc, const char* sfile,
64                   const char* failmsg, const bool expect_pass)
65 {
66     const atf::fs::path sfilepath =
67         atf::fs::path(tc.get_config_var("srcdir")) / sfile;
68     build_check_cxx_o_aux(sfilepath, failmsg, expect_pass);
69 }
70 
71 void
72 header_check(const char *hdrname)
73 {
74     std::ofstream srcfile("test.c");
75     ATF_REQUIRE(srcfile);
76     srcfile << "#include <" << hdrname << ">\n";
77     srcfile.close();
78 
79     const std::string failmsg = std::string("Header check failed; ") +
80         hdrname + " is not self-contained";
81     build_check_cxx_o_aux(atf::fs::path("test.c"), failmsg.c_str(), true);
82 }
83 
84 atf::fs::path
85 get_process_helpers_path(const atf::tests::tc& tc)
86 {
87     return atf::fs::path(tc.get_config_var("srcdir")) /
88            ".." / "atf-c" / "detail" / "process_helpers";
89 }
90 
91 bool
92 grep_file(const char* name, const char* regex)
93 {
94     std::ifstream is(name);
95     ATF_REQUIRE(is);
96 
97     bool found = false;
98 
99     std::string line;
100     std::getline(is, line);
101     while (!found && is.good()) {
102         if (grep_string(line, regex))
103             found = true;
104         else
105             std::getline(is, line);
106     }
107 
108     return found;
109 }
110 
111 bool
112 grep_string(const std::string& str, const char* regex)
113 {
114     int res;
115     regex_t preg;
116 
117     std::cout << "Looking for '" << regex << "' in '" << str << "'\n";
118     ATF_REQUIRE(::regcomp(&preg, regex, REG_EXTENDED) == 0);
119 
120     res = ::regexec(&preg, str.c_str(), 0, NULL, 0);
121     ATF_REQUIRE(res == 0 || res == REG_NOMATCH);
122 
123     ::regfree(&preg);
124 
125     return res == 0;
126 }
127 
128 void
129 test_helpers_detail::check_equal(const char* expected[],
130                                  const string_vector& actual)
131 {
132     const char** expected_iter = expected;
133     string_vector::const_iterator actual_iter = actual.begin();
134 
135     bool equals = true;
136     while (equals && *expected_iter != NULL && actual_iter != actual.end()) {
137         if (*expected_iter != *actual_iter) {
138             equals = false;
139         } else {
140             expected_iter++;
141             actual_iter++;
142         }
143     }
144     if (equals && ((*expected_iter == NULL && actual_iter != actual.end()) ||
145                    (*expected_iter != NULL && actual_iter == actual.end())))
146         equals = false;
147 
148     if (!equals) {
149         std::cerr << "EXPECTED:\n";
150         for (expected_iter = expected; *expected_iter != NULL; expected_iter++)
151             std::cerr << *expected_iter << "\n";
152 
153         std::cerr << "ACTUAL:\n";
154         for (actual_iter = actual.begin(); actual_iter != actual.end();
155              actual_iter++)
156             std::cerr << *actual_iter << "\n";
157 
158         ATF_FAIL("Expected results differ to actual values");
159     }
160 }
161