aboutsummaryrefslogtreecommitdiffstats
path: root/bootstrap/plain_helpers.cpp
blob: 7de629a99d4df035ae3ef9112e4e97cc1acc84e6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
// Copyright 2010 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.

#include <cstdlib>
#include <cstring>
#include <iostream>

#include "utils/defs.hpp"
#include "utils/test_utils.ipp"


namespace {


/// Prints a fake but valid test case list and then aborts.
///
/// \param argv The original arguments of the program.
///
/// \return Nothing because this dies before returning.
static int
helper_abort_test_cases_list(int /* argc */, char** argv)
{
    for (const char* const* arg = argv; *arg != NULL; arg++) {
        if (std::strcmp(*arg, "-l") == 0) {
            std::cout << "Content-Type: application/X-atf-tp; "
                "version=\"1\"\n\n";
            std::cout << "ident: foo\n";
        }
    }
    utils::abort_without_coredump();
}


/// Just returns without printing anything as the test case list.
///
/// \return Always 0, as required for test programs.
static int
helper_empty_test_cases_list(int /* argc */, char** /* argv */)
{
    return EXIT_SUCCESS;
}


/// Prints a correctly-formatted test case list but empty.
///
/// \param argv The original arguments of the program.
///
/// \return Always 0, as required for test programs.
static int
helper_zero_test_cases(int /* argc */, char** argv)
{
    for (const char* const* arg = argv; *arg != NULL; arg++) {
        if (std::strcmp(*arg, "-l") == 0)
            std::cout << "Content-Type: application/X-atf-tp; "
                "version=\"1\"\n\n";
    }
    return EXIT_SUCCESS;
}


/// Mapping of the name of a helper to its implementation.
struct helper {
    /// The name of the helper, as will be provided by the user on the CLI.
    const char* name;

    /// A pointer to the function implementing the helper.
    int (*hook)(int, char**);
};


/// NULL-terminated table mapping helper names to their implementations.
static const helper helpers[] = {
    { "abort_test_cases_list", helper_abort_test_cases_list, },
    { "empty_test_cases_list", helper_empty_test_cases_list, },
    { "zero_test_cases", helper_zero_test_cases, },
    { NULL, NULL, },
};


}  // anonymous namespace


/// Entry point to the ATF-less helpers.
///
/// The caller must select a helper to execute by defining the HELPER
/// environment variable to the name of the desired helper.  Think of this main
/// method as a subprogram dispatcher, to avoid having many individual helper
/// binaries.
///
/// \todo Maybe we should really have individual helper binaries.  It would
/// avoid a significant amount of complexity here and in the tests, at the
/// expense of some extra files and extra build logic.
///
/// \param argc The user argument count; delegated to the helper.
/// \param argv The user arguments; delegated to the helper.
///
/// \return The exit code of the helper, which depends on the requested helper.
int
main(int argc, char** argv)
{
    const char* command = std::getenv("HELPER");
    if (command == NULL) {
        std::cerr << "Usage error: HELPER must be set to a helper name\n";
        std::exit(EXIT_FAILURE);
    }

    const struct helper* iter = helpers;
    for (; iter->name != NULL && std::strcmp(iter->name, command) != 0; iter++)
        ;
    if (iter->name == NULL) {
        std::cerr << "Usage error: unknown command " << command << "\n";
        std::exit(EXIT_FAILURE);
    }

    return iter->hook(argc, argv);
}