Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

# Authors: 

#   Jason Gerard DeRose <jderose@redhat.com> 

# 

# Copyright (C) 2008  Red Hat 

# see file 'COPYING' for use and warranty information 

# 

# 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, either version 3 of the License, or 

# (at your option) any later version. 

# 

# 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, see <http://www.gnu.org/licenses/>. 

 

""" 

Test the `ipalib.base` module. 

""" 

 

from tests.util import ClassChecker, raises 

from ipalib.constants import NAME_REGEX, NAME_ERROR 

from ipalib.constants import TYPE_ERROR, SET_ERROR, DEL_ERROR, OVERRIDE_ERROR 

from ipalib import base 

 

 

class test_ReadOnly(ClassChecker): 

    """ 

    Test the `ipalib.base.ReadOnly` class 

    """ 

    _cls = base.ReadOnly 

 

    def test_lock(self): 

        """ 

        Test the `ipalib.base.ReadOnly.__lock__` method. 

        """ 

        o = self.cls() 

        assert o._ReadOnly__locked is False 

        o.__lock__() 

        assert o._ReadOnly__locked is True 

        e = raises(AssertionError, o.__lock__) # Can only be locked once 

        assert str(e) == '__lock__() can only be called once' 

        assert o._ReadOnly__locked is True # This should still be True 

 

    def test_islocked(self): 

        """ 

        Test the `ipalib.base.ReadOnly.__islocked__` method. 

        """ 

        o = self.cls() 

        assert o.__islocked__() is False 

        o.__lock__() 

        assert o.__islocked__() is True 

 

    def test_setattr(self): 

        """ 

        Test the `ipalib.base.ReadOnly.__setattr__` method. 

        """ 

        o = self.cls() 

        o.attr1 = 'Hello, world!' 

        assert o.attr1 == 'Hello, world!' 

        o.__lock__() 

        for name in ('attr1', 'attr2'): 

            e = raises(AttributeError, setattr, o, name, 'whatever') 

            assert str(e) == SET_ERROR % ('ReadOnly', name, 'whatever') 

        assert o.attr1 == 'Hello, world!' 

 

    def test_delattr(self): 

        """ 

        Test the `ipalib.base.ReadOnly.__delattr__` method. 

        """ 

        o = self.cls() 

        o.attr1 = 'Hello, world!' 

        o.attr2 = 'How are you?' 

        assert o.attr1 == 'Hello, world!' 

        assert o.attr2 == 'How are you?' 

        del o.attr1 

        assert not hasattr(o, 'attr1') 

        o.__lock__() 

        e = raises(AttributeError, delattr, o, 'attr2') 

        assert str(e) == DEL_ERROR % ('ReadOnly', 'attr2') 

        assert o.attr2 == 'How are you?' 

 

 

def test_lock(): 

    """ 

    Test the `ipalib.base.lock` function 

    """ 

    f = base.lock 

 

    # Test with ReadOnly instance: 

    o = base.ReadOnly() 

    assert o.__islocked__() is False 

    assert f(o) is o 

    assert o.__islocked__() is True 

    e = raises(AssertionError, f, o) 

    assert str(e) == 'already locked: %r' % o 

 

    # Test with another class implemented locking protocol: 

    class Lockable(object): 

        __locked = False 

        def __lock__(self): 

            self.__locked = True 

        def __islocked__(self): 

            return self.__locked 

    o = Lockable() 

    assert o.__islocked__() is False 

    assert f(o) is o 

    assert o.__islocked__() is True 

    e = raises(AssertionError, f, o) 

    assert str(e) == 'already locked: %r' % o 

 

    # Test with a class incorrectly implementing the locking protocol: 

    class Broken(object): 

        def __lock__(self): 

            pass 

        def __islocked__(self): 

            return False 

    o = Broken() 

    e = raises(AssertionError, f, o) 

    assert str(e) == 'failed to lock: %r' % o 

 

 

def test_islocked(): 

    """ 

    Test the `ipalib.base.islocked` function. 

    """ 

    f = base.islocked 

 

    # Test with ReadOnly instance: 

    o = base.ReadOnly() 

    assert f(o) is False 

    o.__lock__() 

    assert f(o) is True 

 

    # Test with another class implemented locking protocol: 

    class Lockable(object): 

        __locked = False 

        def __lock__(self): 

            self.__locked = True 

        def __islocked__(self): 

            return self.__locked 

    o = Lockable() 

    assert f(o) is False 

    o.__lock__() 

    assert f(o) is True 

 

    # Test with a class incorrectly implementing the locking protocol: 

    class Broken(object): 

        __lock__ = False 

        def __islocked__(self): 

            return False 

    o = Broken() 

    e = raises(AssertionError, f, o) 

    assert str(e) == 'no __lock__() method: %r' % o 

 

 

def test_check_name(): 

    """ 

    Test the `ipalib.base.check_name` function. 

    """ 

    f = base.check_name 

    okay = [ 

        'user_add', 

        'stuff2junk', 

        'sixty9', 

    ] 

    nope = [ 

        '_user_add', 

        '__user_add', 

        'user_add_', 

        'user_add__', 

        '_user_add_', 

        '__user_add__', 

        '60nine', 

    ] 

    for name in okay: 

        assert name is f(name) 

        e = raises(TypeError, f, unicode(name)) 

        assert str(e) == TYPE_ERROR % ('name', str, unicode(name), unicode) 

    for name in nope: 

        e = raises(ValueError, f, name) 

        assert str(e) == NAME_ERROR % (NAME_REGEX, name) 

    for name in okay: 

        e = raises(ValueError, f, name.upper()) 

        assert str(e) == NAME_ERROR % (NAME_REGEX, name.upper()) 

 

 

def membername(i): 

    return 'member%03d' % i 

 

 

class DummyMember(object): 

    def __init__(self, i): 

        self.i = i 

        self.name = membername(i) 

 

 

def gen_members(*indexes): 

    return tuple(DummyMember(i) for i in indexes) 

 

 

class test_NameSpace(ClassChecker): 

    """ 

    Test the `ipalib.base.NameSpace` class. 

    """ 

    _cls = base.NameSpace 

 

    def new(self, count, sort=True): 

        members = tuple(DummyMember(i) for i in xrange(count, 0, -1)) 

        assert len(members) == count 

        o = self.cls(members, sort=sort) 

        return (o, members) 

 

    def test_init(self): 

        """ 

        Test the `ipalib.base.NameSpace.__init__` method. 

        """ 

        o = self.cls([]) 

        assert len(o) == 0 

        assert list(o) == [] 

        assert list(o()) == [] 

 

        # Test members as attribute and item: 

        for cnt in (3, 42): 

            for sort in (True, False): 

                (o, members) = self.new(cnt, sort=sort) 

                assert len(members) == cnt 

                for m in members: 

                    assert getattr(o, m.name) is m 

                    assert o[m.name] is m 

 

        # Test that TypeError is raised if sort is not a bool: 

        e = raises(TypeError, self.cls, [], sort=None) 

        assert str(e) == TYPE_ERROR % ('sort', bool, None, type(None)) 

 

        # Test that AttributeError is raised with duplicate member name: 

        members = gen_members(0, 1, 2, 1, 3) 

        e = raises(AttributeError, self.cls, members) 

        assert str(e) == OVERRIDE_ERROR % ( 

            'NameSpace', membername(1), members[1], members[3] 

        ) 

 

    def test_len(self): 

        """ 

        Test the `ipalib.base.NameSpace.__len__` method. 

        """ 

        for count in (5, 18, 127): 

            (o, members) = self.new(count) 

            assert len(o) == count 

            (o, members) = self.new(count, sort=False) 

            assert len(o) == count 

 

    def test_iter(self): 

        """ 

        Test the `ipalib.base.NameSpace.__iter__` method. 

        """ 

        (o, members) = self.new(25) 

        assert list(o) == sorted(m.name for m in members) 

        (o, members) = self.new(25, sort=False) 

        assert list(o) == list(m.name for m in members) 

 

    def test_call(self): 

        """ 

        Test the `ipalib.base.NameSpace.__call__` method. 

        """ 

        (o, members) = self.new(25) 

        assert list(o()) == sorted(members, key=lambda m: m.name) 

        (o, members) = self.new(25, sort=False) 

        assert tuple(o()) == members 

 

    def test_contains(self): 

        """ 

        Test the `ipalib.base.NameSpace.__contains__` method. 

        """ 

        yes = (99, 3, 777) 

        no = (9, 333, 77) 

        for sort in (True, False): 

            members = gen_members(*yes) 

            o = self.cls(members, sort=sort) 

            for i in yes: 

                assert membername(i) in o 

                assert membername(i).upper() not in o 

            for i in no: 

                assert membername(i) not in o 

 

    def test_getitem(self): 

        """ 

        Test the `ipalib.base.NameSpace.__getitem__` method. 

        """ 

        cnt = 17 

        for sort in (True, False): 

            (o, members) = self.new(cnt, sort=sort) 

            assert len(members) == cnt 

            if sort is True: 

                members = tuple(sorted(members, key=lambda m: m.name)) 

 

            # Test str keys: 

            for m in members: 

                assert o[m.name] is m 

            e = raises(KeyError, o.__getitem__, 'nope') 

 

            # Test int indexes: 

            for i in xrange(cnt): 

                assert o[i] is members[i] 

            e = raises(IndexError, o.__getitem__, cnt) 

 

            # Test negative int indexes: 

            for i in xrange(1, cnt + 1): 

                assert o[-i] is members[-i] 

            e = raises(IndexError, o.__getitem__, -(cnt + 1)) 

 

            # Test slicing: 

            assert o[3:] == members[3:] 

            assert o[:10] == members[:10] 

            assert o[3:10] == members[3:10] 

            assert o[-9:] == members[-9:] 

            assert o[:-4] == members[:-4] 

            assert o[-9:-4] == members[-9:-4] 

 

            # Test that TypeError is raised with wrong type 

            e = raises(TypeError, o.__getitem__, 3.0) 

            assert str(e) == TYPE_ERROR % ('key', (str, int, slice), 3.0, float) 

 

    def test_repr(self): 

        """ 

        Test the `ipalib.base.NameSpace.__repr__` method. 

        """ 

        for cnt in (0, 1, 2): 

            for sort in (True, False): 

                (o, members) = self.new(cnt, sort=sort) 

                if cnt == 1: 

                    assert repr(o) == \ 

                        'NameSpace(<%d member>, sort=%r)' % (cnt, sort) 

                else: 

                    assert repr(o) == \ 

                        'NameSpace(<%d members>, sort=%r)' % (cnt, sort) 

 

    def test_todict(self): 

        """ 

        Test the `ipalib.base.NameSpace.__todict__` method. 

        """ 

        for cnt in (3, 101): 

            for sort in (True, False): 

                (o, members) = self.new(cnt, sort=sort) 

                d = o.__todict__() 

                assert d == dict((m.name, m) for m in members) 

 

                # Test that a copy is returned: 

                assert o.__todict__() is not d