summaryrefslogtreecommitdiffstats
path: root/selftest/target/__init__.py
blob: 4c95c74895cb884d0faf9e4b797b6128301a5c96 (plain)
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# target.py -- Targets
# Copyright (C) 2012 Jelmer Vernooij <jelmer@samba.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; version 3
# of the License or (at your option) any later version of
# the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA  02110-1301, USA.

"""Selftest target management."""

__all__ = ['Target', 'Environment', 'EnvironmentManager']


class EnvironmentDown(Exception):
    """Indicates an environment has gone down."""

    def __init__(self, msg):
        super(EnvironmentDown, self).__init__("environment went down: %s" % msg)


class UnsupportedEnvironment(Exception):
    """Indicates a particular environment is not supported."""

    def __init__(self, target, envname):
        super(UnsupportedEnvironment, self).__init__(
            "Target %s does not support environment %s" % (target, envname))


class Target(object):
    """A target for Samba tests."""

    def setup_env(self, name, prefix):
        """Setup an environment.

        :param name: name of the environment
        :param prefix: directory to create it in
        """
        raise NotImplementedError(self.setup_env)


class Environment(object):
    """An environment for Samba tests.

    Tests often need to run against a server with particular things set up,
    a "environment". This environment is provided by the test target.
    """

    def check(self):
        """Check if this environment is still up and running.

        :return: Boolean indicating whether environment is still running
        """
        raise NotImplementedError(self.check)

    def get_log(self):
        """Retrieve the last log for this environment.

        :return: String with log
        """
        raise NotImplementedError(self.get_log)

    def teardown(self):
        """Tear down an environment.

        """
        raise NotImplementedError(self.teardown)

    def get_vars(self):
        """Retrieve the environment variables for this environment.

        :return: Dictionary with string -> string values
        """
        raise NotImplementedError(self.get_vars)


class NoneEnvironment(Environment):
    """Empty environment.
    """

    def check(self):
        return True

    def get_log(self):
        return ""

    def teardown(self):
        return

    def get_vars(self):
        return {}


class NoneTarget(Target):
    """Target that can only provide the 'none' environment."""

    name = "none"

    def setup_env(self, envname, prefix):
        raise UnsupportedEnvironment(self.name, envname)


class EnvironmentManager(object):
    """Manager of environments."""

    def __init__(self, target):
        self.target = target
        self.running_envs = {}

    def get_running_env(self, name):
        envname = name.split(":")[0]
        if envname == "none":
            return NoneEnvironment()
        return self.running_envs.get(envname)

    def getlog_env(self, envname):
        env = self.get_running_env(envname)
        return env.get_log()

    def check_env(self, envname):
        """Check if an environment is still up.

        :param envname: Environment to check
        """
        env = self.get_running_env(envname)
        return env.check()

    def teardown_env(self, envname):
        """Tear down an environment.

        :param envname: Name of the environment
        """
        env = self.get_running_env(envname)
        env.teardown()
        del self.running_envs[envname]

    def teardown_all(self):
        """Teardown all environments."""
        for env in self.running_envs.iterkeys():
            self.teardown_env(env)

    def setup_env(self, envname, prefix):
        running_env = self.get_running_env(envname)
        if running_env is not None:
            if not running_env.check():
                raise EnvironmentDown(running_env.get_log())
            return running_env

        env = self.target.setup_env(envname, prefix)
        if env is None:
            return None

        self.running_envs[envname] = env

        return env