File: testenv.py

package info (click to toggle)
trac-accountmanager 0.6.1%2Bsvn18669-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,552 kB
  • sloc: python: 6,863; javascript: 175; makefile: 4
file content (234 lines) | stat: -rw-r--r-- 7,015 bytes parent folder | download | duplicates (2)
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# -*- coding: utf-8 -*-
#
# Copyright (C) 2008 Matthew Good <trac@matt-good.net>
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.
#
# Author: Pedro Algarvio <ufs@ufsoft.org>

import os
import sys
import time
import socket
import subprocess

from trac.env import Environment
from trac.util.compat import close_fds
try:
    from trac.test import rmtree
except ImportError:
    from shutil import rmtree

from ...compat import unicode
from .smtpd import SMTPThreadedServer


TOX_ENV_DIR = os.environ.get('TOX_ENV_DIR')


if hasattr(subprocess.Popen, '__enter__'):
    Popen = subprocess.Popen
else:
    class Popen(subprocess.Popen):

        def __enter__(self):
            return self

        def __exit__(self, *args):
            try:
                if self.stdin:
                    self.stdin.close()
            finally:
                self.wait()
            for f in (self.stdout, self.stderr):
                if f:
                    f.close()


def get_topdir():
    path = os.path.dirname(os.path.abspath(__file__))
    suffix = '/acct_mgr/tests/functional'.replace('/', os.sep)
    if not path.endswith(suffix):
        raise RuntimeError("%r doesn't end with %r" % (path, suffix))
    return path[:-len(suffix)]


def get_testdir():
    dir_ = TOX_ENV_DIR
    if dir_ and os.path.isdir(dir_):
        dir_ = os.path.join(dir_, 'tmp')
    else:
        dir_ = get_topdir()
    if not os.path.isabs(dir_):
        raise RuntimeError('Non absolute directory: %s' % repr(dir_))
    return os.path.join(dir_, 'testenv')


def get_ephemeral_port():
    s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    try:
        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        s.bind(('127.0.0.1', 0))
        s.listen(1)
        return s.getsockname()[1]
    finally:
        s.close()


def to_b(value):
    if isinstance(value, unicode):
        return value.encode('utf-8')
    if isinstance(value, bytes):
        return value
    raise ValueError(type(value))


class TestEnvironment(object):

    _testdir = get_testdir()
    _plugins_dir = os.path.join(_testdir, 'plugins') if not TOX_ENV_DIR else ''
    _devnull = None
    _log = None
    port = None
    smtp_port = None
    tracdir = None
    url = None
    smtpd = None
    _env = None
    _tracd = None

    def __init__(self):
        if os.path.isdir(self._testdir):
            rmtree(self._testdir)
        os.mkdir(self._testdir)
        if self._plugins_dir:
            os.mkdir(self._plugins_dir)

    _inherit_template = """\
[inherit]
plugins_dir = %(plugins_dir)s
[logging]
log_type = file
log_level = INFO
[trac]
base_url = %(url)s
use_chunked_encoding = disabled
[project]
url = %(url)s
admin = testenv%(port)d@localhost
[notification]
smtp_enabled = enabled
smtp_from = testenv%(port)d@localhost
smtp_port = %(smtp_port)d
smtp_server = localhost
"""

    @property
    def inherit_file(self):
        return self._inherit_template % \
               {'plugins_dir': self._plugins_dir, 'url': self.url,
                'port': self.port, 'smtp_port': self.smtp_port}

    def init(self):
        self._devnull = os.open(os.devnull, os.O_RDWR)
        self._log = os.open(os.path.join(self._testdir, 'tracd.log'),
                            os.O_WRONLY | os.O_CREAT | os.O_APPEND)
        self.port = get_ephemeral_port()
        self.smtp_port = get_ephemeral_port()
        if self._plugins_dir:
            self.check_call([sys.executable, 'setup.py', 'develop', '-mxd',
                             self._plugins_dir])
        self.tracdir = os.path.join(self._testdir, 'trac')
        self.url = 'http://127.0.0.1:%d/%s' % \
                   (self.port, os.path.basename(self.tracdir))
        inherit = os.path.join(self._testdir, 'inherit.ini')
        with open(inherit, 'w') as f:
            f.write(self.inherit_file)
        args = [sys.executable, '-m', 'trac.admin.console', self.tracdir]
        with self.popen(args, stdin=subprocess.PIPE) as proc:
            proc.stdin.write(
                b'initenv --inherit=%s testenv%d sqlite:db/trac.db\n'
                b'config set components acct_mgr.* enabled\n'
                b'config set components trac.web.auth.loginmodule disabled\n'
                % (to_b(inherit), self.port))
        self.smtpd = SMTPThreadedServer(self.smtp_port)
        self.smtpd.start()
        self.start()

    def cleanup(self):
        self.stop()
        if self.smtpd:
            self.smtpd.stop()
            self.smtpd = None
        if self._env:
            self._env.shutdown()
            self._env = None
        if self._devnull is not None:
            os.close(self._devnull)
            self._devnull = None
        if self._log is not None:
            os.close(self._log)
            self._log = None

    def start(self):
        if self._tracd and self._tracd.returncode is None:
            raise RuntimeError('tracd is running')
        args = [
            sys.executable, '-m', 'trac.web.standalone',
            '--port=%d' % self.port, '--hostname=localhost', self.tracdir,
        ]
        self._tracd = self.popen(args, stdout=self._log, stderr=self._log)
        start = time.time()
        while time.time() - start < 10:
            s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
            try:
                s.connect(('127.0.0.1', self.port))
            except socket.error:
                time.sleep(0.125)
            else:
                break
            finally:
                s.close()
        else:
            raise RuntimeError('Timed out waiting for tracd to start')

    def stop(self):
        if self._tracd:
            try:
                self._tracd.terminate()
            except EnvironmentError:
                pass
            self._tracd.wait()
            self._tracd = None

    def restart(self):
        self.stop()
        self.start()

    def popen(self, *args, **kwargs):
        kwargs.setdefault('stdin', self._devnull)
        kwargs.setdefault('stdout', self._devnull)
        kwargs.setdefault('stderr', self._devnull)
        kwargs.setdefault('close_fds', close_fds)
        return Popen(*args, **kwargs)

    def check_call(self, *args, **kwargs):
        kwargs.setdefault('stdin', self._devnull)
        kwargs.setdefault('stdout', subprocess.PIPE)
        kwargs.setdefault('stderr', subprocess.PIPE)
        with self.popen(*args, **kwargs) as proc:
            stdout, stderr = proc.communicate()
            if proc.returncode != 0:
                raise RuntimeError('Exited with %d (stdout %r, stderr %r)' %
                                   (proc.returncode, stdout, stderr))

    def get_trac_environment(self):
        if not self._env:
            self._env = Environment(self.tracdir)
        return self._env

    def _tracadmin(self, *args):
        self.check_call((sys.executable, '-m', 'trac.admin.console',
                         self.tracdir) + args)