3d3cee06796caea9990bf4f719a5ea37ccff7286
[leap_pycommon.git] / src / leap / common / testing / basetest.py
1 # -*- coding: utf-8 -*-
2 # basetest.py
3 # Copyright (C) 2013 LEAP
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 """
18 Common testing facilities
19 """
20 import os
21 import platform
22 import shutil
23 import tempfile
24
25 try:
26     import unittest2 as unittest
27 except ImportError:
28     import unittest
29
30 from leap.common.check import leap_assert
31 from leap.common.events import server as events_server
32 from leap.common.events import client as events_client
33 from leap.common.events import flags, set_events_enabled
34 from leap.common.files import mkdir_p, check_and_fix_urw_only
35
36 set_events_enabled(False)
37
38
39 class BaseLeapTest(unittest.TestCase):
40     """
41     Base Leap TestCase
42     """
43     __name__ = "leap_test"
44     _system = platform.system()
45
46     @classmethod
47     def setUpClass(cls):
48         cls.setUpEnv()
49
50     @classmethod
51     def tearDownClass(cls):
52         cls.tearDownEnv()
53
54     @classmethod
55     def setUpEnv(cls):
56         """
57         Sets up common facilities for testing this TestCase:
58         - custom PATH and HOME environmental variables
59         - creates a temporal folder to which those point.
60         It saves the old path and home vars so they can be restored later.
61         """
62         cls.old_path = os.environ['PATH']
63         cls.old_home = os.environ['HOME']
64         cls.old_xdg_config = None
65         if "XDG_CONFIG_HOME" in os.environ:
66             cls.old_xdg_config = os.environ["XDG_CONFIG_HOME"]
67         cls.tempdir = tempfile.mkdtemp(prefix="leap_tests-")
68         cls.home = cls.tempdir
69         bin_tdir = os.path.join(
70             cls.tempdir,
71             'bin')
72         os.environ["PATH"] = bin_tdir
73         os.environ["HOME"] = cls.tempdir
74         os.environ["XDG_CONFIG_HOME"] = os.path.join(cls.tempdir, ".config")
75         cls._init_events()
76
77     @classmethod
78     def _init_events(cls):
79         if flags.EVENTS_ENABLED:
80             cls._server = events_server.ensure_server(
81                 emit_addr="tcp://127.0.0.1:0",
82                 reg_addr="tcp://127.0.0.1:0")
83             events_client.configure_client(
84                 emit_addr="tcp://127.0.0.1:%d" % cls._server.pull_port,
85                 reg_addr="tcp://127.0.0.1:%d" % cls._server.pub_port)
86
87     @classmethod
88     def tearDownEnv(cls):
89         """
90         Cleanup common facilities used for testing this TestCase:
91         - restores the default PATH and HOME variables
92         - removes the temporal folder
93         """
94         if flags.EVENTS_ENABLED:
95             events_client.shutdown()
96             cls._server.shutdown()
97
98         os.environ["PATH"] = cls.old_path
99         os.environ["HOME"] = cls.old_home
100         if cls.old_xdg_config is not None:
101             os.environ["XDG_CONFIG_HOME"] = cls.old_xdg_config
102         # safety check! please do not wipe my home...
103         # XXX needs to adapt to non-linuces
104         leap_assert(
105             cls.tempdir.startswith('/tmp/leap_tests-') or
106             (cls.tempdir.startswith('/tmp/') and
107              cls.tempdir.startswith(tempfile.gettempdir()) and
108              'leap_tests-' in cls.tempdir) or
109             cls.tempdir.startswith('/var/folder'),
110             "beware! tried to remove a dir which does not "
111             "live in temporal folder!")
112         shutil.rmtree(cls.tempdir)
113
114     # you have to override these methods
115     # this way we ensure we did not put anything
116     # here that you can forget to call.
117
118     def setUp(self):
119         """not implemented"""
120         raise NotImplementedError("abstract base class")
121
122     def tearDown(self):
123         """not implemented"""
124         raise NotImplementedError("abstract base class")
125
126     #
127     # helper methods
128     #
129
130     def _missing_test_for_plat(self, do_raise=False):
131         """
132         Raises NotImplementedError for this platform
133         if do_raise is True
134
135         :param do_raise: flag to actually raise exception
136         :type do_raise: bool
137         """
138         if do_raise:
139             raise NotImplementedError(
140                 "This test is not implemented "
141                 "for the running platform: %s" %
142                 self._system)
143
144     def get_tempfile(self, filename):
145         """
146         Returns the path of a given filename
147         prepending the temporal dir associated with this
148         TestCase
149
150         :param filename: the filename
151         :type filename: str
152         """
153         return os.path.join(self.tempdir, filename)
154
155     def touch(self, filepath):
156         """
157         Touches a filepath, creating folders along
158         the way if needed.
159
160         :param filepath: path to be touched
161         :type filepath: str
162         """
163         folder, filename = os.path.split(filepath)
164         if not os.path.isdir(folder):
165             mkdir_p(folder)
166         self.assertTrue(os.path.isdir(folder))
167         with open(filepath, 'w') as fp:
168             fp.write(' ')
169         self.assertTrue(os.path.isfile(filepath))
170
171     def chmod600(self, filepath):
172         """
173         Chmods 600 a file
174
175         :param filepath: filepath to be chmodded
176         :type filepath: str
177         """
178         check_and_fix_urw_only(filepath)