aboutsummaryrefslogtreecommitdiff
path: root/engine/filters.hpp
blob: 91a667c3b46b29a2d6af35253d6608649ca5e026 (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
// 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 engine/filters.hpp
/// Representation and manipulation of filters for test cases.
///
/// All the filter classes in this module are supposed to be purely functional:
/// they are mere filters that decide whether they match or not the input data
/// fed to them.  User-interface filter manipulation must go somewhere else.

#if !defined(ENGINE_FILTERS_HPP)
#define ENGINE_FILTERS_HPP

#include "engine/filters_fwd.hpp"

#include <ostream>
#include <string>
#include <set>
#include <utility>

#include "utils/fs/path.hpp"
#include "utils/optional.ipp"


namespace engine {


/// Filter for test cases.
///
/// A filter is one of: the name of a directory containing test cases, the name
/// of a test program, or the name of a test program plus the name of a test
/// case.
class test_filter {
public:
    /// The name of the test program or subdirectory to match.
    utils::fs::path test_program;

    /// The name of the test case to match; if empty, represents any test case.
    std::string test_case;

    test_filter(const utils::fs::path&, const std::string&);
    static test_filter parse(const std::string&);

    std::string str(void) const;

    bool contains(const test_filter&) const;
    bool matches_test_program(const utils::fs::path&) const;
    bool matches_test_case(const utils::fs::path&, const std::string&) const;

    bool operator<(const test_filter&) const;
    bool operator==(const test_filter&) const;
    bool operator!=(const test_filter&) const;
};


std::ostream& operator<<(std::ostream&, const test_filter&);


/// Collection of user-provided filters to select test cases.
///
/// An empty collection of filters is considered to match any test case.
///
/// In general, the filters maintained by this class should be disjoint.  If
/// they are not, some filters may never have a chance to do a match, which is
/// most likely the fault of the user.  To check for non-disjoint filters before
/// constructing this object, use check_disjoint_filters.
class test_filters {
    /// The user-provided filters.
    std::set< test_filter > _filters;

public:
    explicit test_filters(const std::set< test_filter >&);

    /// Return type of match_test_case.  Indicates whether the filters have
    /// matched a particular test case and, if they have, which filter did the
    /// match (if any).
    typedef std::pair< bool, utils::optional< test_filter > > match;

    bool match_test_program(const utils::fs::path&) const;
    match match_test_case(const utils::fs::path&, const std::string&) const;

    std::set< test_filter > difference(const std::set< test_filter >&) const;
};


void check_disjoint_filters(const std::set< test_filter >&);


/// Tracks state of the filters that have matched tests during execution.
class filters_state {
    /// The user-provided filters.
    test_filters _filters;

    /// Collection of filters that have matched test cases so far.
    std::set< test_filter > _used_filters;

public:
    explicit filters_state(const std::set< test_filter >&);

    bool match_test_program(const utils::fs::path&) const;
    bool match_test_case(const utils::fs::path&, const std::string&);

    std::set< test_filter > unused(void) const;
};


}  // namespace engine

#endif  // !defined(ENGINE_FILTERS_HPP)