misc fixes (spacing, capitalization)
[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.files import mkdir_p, check_and_fix_urw_only
32
33
34 class BaseLeapTest(unittest.TestCase):
35     """
36     Base Leap TestCase
37     """
38     __name__ = "leap_test"
39     _system = platform.system()
40
41     @classmethod
42     def setUpClass(cls):
43         """
44         Sets up common facilities for testing this TestCase:
45         - custom PATH and HOME environmental variables
46         - creates a temporal folder to which those point.
47         It saves the old path and home vars so they can be restored later.
48         """
49         cls.old_path = os.environ['PATH']
50         cls.old_home = os.environ['HOME']
51         cls.tempdir = tempfile.mkdtemp(prefix="leap_tests-")
52         cls.home = cls.tempdir
53         bin_tdir = os.path.join(
54             cls.tempdir,
55             'bin')
56         os.environ["PATH"] = bin_tdir
57         os.environ["HOME"] = cls.tempdir
58
59     @classmethod
60     def tearDownClass(cls):
61         """
62         Cleanup common facilities used for testing this TestCase:
63         - restores the default PATH and HOME variables
64         - removes the temporal folder
65         """
66         os.environ["PATH"] = cls.old_path
67         os.environ["HOME"] = cls.old_home
68         # safety check! please do not wipe my home...
69         # XXX needs to adapt to non-linuces
70         leap_assert(
71             cls.tempdir.startswith('/tmp/leap_tests-'),
72             "beware! tried to remove a dir which does not "
73             "live in temporal folder!")
74         shutil.rmtree(cls.tempdir)
75
76     # you have to override these methods
77     # this way we ensure we did not put anything
78     # here that you can forget to call.
79
80     def setUp(self):
81         """not implemented"""
82         raise NotImplementedError("abstract base class")
83
84     def tearDown(self):
85         """not implemented"""
86         raise NotImplementedError("abstract base class")
87
88     #
89     # helper methods
90     #
91
92     def _missing_test_for_plat(self, do_raise=False):
93         """
94         Raises NotImplementedError for this platform
95         if do_raise is True
96
97         @param do_raise: flag to actually raise exception
98         @type do_raise: bool
99         """
100         if do_raise:
101             raise NotImplementedError(
102                 "This test is not implemented "
103                 "for the running platform: %s" %
104                 self._system)
105
106     def get_tempfile(self, filename):
107         """
108         Returns the path of a given filename
109         prepending the temporal dir associated with this
110         TestCase
111
112         @param filename: the filename
113         @type filename: str
114         """
115         return os.path.join(self.tempdir, filename)
116
117     def touch(self, filepath):
118         """
119         Touches a filepath, creating folders along
120         the way if needed.
121
122         @param filepath: path to be touched
123         @type filepath: str
124         """
125         folder, filename = os.path.split(filepath)
126         if not os.path.isdir(folder):
127             mkdir_p(folder)
128         self.assertTrue(os.path.isdir(folder))
129         with open(filepath, 'w') as fp:
130             fp.write(' ')
131         self.assertTrue(os.path.isfile(filepath))
132
133     def chmod600(self, filepath):
134         """
135         Chmods 600 a file
136
137         @param filepath: filepath to be chmodded
138         @type filepath: str
139         """
140         check_and_fix_urw_only(filepath)