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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
|
# (C) Copyright 2005-2025 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" Tests naming operations on PyFS contexts. """
# Standard library imports.
import os
import shutil
import unittest
# Enthought library imports.
from apptools.io import File
from apptools.naming.api import (
DirContext,
InvalidNameError,
NameAlreadyBoundError,
NameNotFoundError,
NotContextError,
PyFSContext,
)
class PyFSContextTestCase(unittest.TestCase):
""" Tests naming operations on PyFS contexts. """
###########################################################################
# 'TestCase' interface.
###########################################################################
def setUp(self):
""" Prepares the test fixture before each test method is called. """
if os.path.exists("data"):
shutil.rmtree("data", ignore_errors=True)
if os.path.exists("other"):
shutil.rmtree("other", ignore_errors=True)
os.mkdir("data")
os.mkdir("other")
self.context = PyFSContext(path="data")
self.context.create_subcontext("sub")
self.context.bind("x", 123)
self.context.bind("y", 321)
def tearDown(self):
""" Called immediately after each test method has been called. """
self.context = None
shutil.rmtree("data")
shutil.rmtree("other")
###########################################################################
# Tests.
###########################################################################
def test_initialization(self):
""" initialization of an existing context """
context = PyFSContext(path="data")
self.assertEqual(len(context.list_bindings("")), 3)
def test_initialization_with_empty_environment(self):
""" initialization with empty environmentt """
context = PyFSContext(path="other", environment={})
self.assertEqual(len(context.list_names("")), 0)
def test_bind(self):
""" pyfs context bind """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.bind, "", 1)
# Bind a local file object.
f = File(os.path.join(sub.path, "foo.py"))
# f.create_file('print("foo!")\n')
context.bind("sub/foo.py", f)
self.assertEqual(len(sub.list_bindings("")), 1)
# Bind a reference to a non-local file.
f = File("/tmp")
context.bind("sub/tmp", f)
self.assertEqual(len(sub.list_bindings("")), 2)
self.assertEqual(context.lookup("sub/tmp").path, f.path)
# Bind a reference to a non-local context.
f = PyFSContext(path="other")
context.bind("sub/other", f)
self.assertEqual(len(sub.list_bindings("")), 3)
self.assertIn(f.path, context.lookup("sub/other").path)
# Bind a Python object.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 4)
# Try to bind it again.
self.assertRaises(NameAlreadyBoundError, context.bind, "sub/a", 1)
def test_rebind(self):
""" pyfs context rebind """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.rebind, "", 1)
# Bind a name.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
# Rebind it.
context.rebind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
def test_unbind(self):
""" pyfs context unbind """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.unbind, "")
# Bind a name.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
# Unbind it.
context.unbind("sub/a")
self.assertEqual(len(sub.list_bindings("")), 0)
# Try to unbind a non-existent name.
self.assertRaises(NameNotFoundError, context.unbind, "sub/b")
def test_rename(self):
""" multi-context rename """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.rename, "", "x")
self.assertRaises(InvalidNameError, context.rename, "x", "")
# Bind a name.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
# Rename it.
context.rename("sub/a", "sub/b")
self.assertEqual(len(sub.list_bindings("")), 1)
# Lookup using the new name.
self.assertEqual(context.lookup("sub/b"), 1)
# Lookup using the old name.
self.assertRaises(NameNotFoundError, context.lookup, "sub/a")
def test_lookup(self):
""" pyfs context lookup """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Bind a file object.
f = File(os.path.join(sub.path, "foo.py"))
# f.create_file('print("foo!")\n')
context.bind("sub/foo.py", f)
self.assertEqual(len(sub.list_bindings("")), 1)
# Look it up.
self.assertEqual(context.lookup("sub/foo.py").path, f.path)
# Bind a Python object.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 2)
# Look it up.
self.assertEqual(context.lookup("sub/a"), 1)
# Looking up the Empty name returns the context itself.
self.assertEqual(context.lookup(""), context)
# Non-existent name.
self.assertRaises(NameNotFoundError, context.lookup, "sub/b")
def test_create_subcontext(self):
""" pyfs context create sub-context """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.create_subcontext, "")
# Create a sub-context.
context.create_subcontext("sub/a")
self.assertEqual(len(sub.list_bindings("")), 1)
self.assertTrue(os.path.isdir(os.path.join(sub.path, "a")))
# Try to bind it again.
self.assertRaises(
NameAlreadyBoundError, context.create_subcontext, "sub/a"
)
def test_destroy_subcontext(self):
""" single context destroy sub-context """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
# Make sure that the sub-context is empty.
self.assertEqual(len(sub.list_bindings("")), 0)
# Empty name.
self.assertRaises(InvalidNameError, context.destroy_subcontext, "")
# Create a sub-context.
context.create_subcontext("sub/a")
self.assertEqual(len(sub.list_bindings("")), 1)
# Destroy it.
context.destroy_subcontext("sub/a")
self.assertEqual(len(sub.list_bindings("")), 0)
self.assertTrue(not os.path.isdir(os.path.join(sub.path, "a")))
# Bind a name.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
# Try to destroy it.
self.assertRaises(NotContextError, context.destroy_subcontext, "sub/a")
# Try to destroy a non-existent name.
self.assertRaises(
NameNotFoundError, context.destroy_subcontext, "sub/b"
)
def test_get_attributes(self):
""" get attributes """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
self.assertIsInstance(sub, DirContext)
#### Generic name resolution tests ####
# Non-existent name.
self.assertRaises(NameNotFoundError, context.get_attributes, "xx")
# Attempt to resolve via a non-existent context.
self.assertRaises(NameNotFoundError, context.get_attributes, "xx/a")
# Attempt to resolve via an existing name that is not a context.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
self.assertRaises(NotContextError, context.get_attributes, "sub/a/x")
#### Operation specific tests ####
# Attributes of the root context.
attributes = context.get_attributes("")
self.assertEqual(len(attributes), 0)
# Attributes of a sub-context.
attributes = context.get_attributes("sub")
self.assertEqual(len(attributes), 0)
def test_set_get_attributes(self):
""" get and set attributes """
defaults = {"colour": "blue"}
# Convenience.
context = self.context
sub = self.context.lookup("sub")
self.assertIsInstance(sub, DirContext)
#### Generic name resolution tests ####
# Non-existent name.
self.assertRaises(
NameNotFoundError, context.set_attributes, "xx", defaults
)
# Attempt to resolve via a non-existent context.
self.assertRaises(
NameNotFoundError, context.set_attributes, "xx/a", defaults
)
# Attempt to resolve via an existing name that is not a context.
context.bind("sub/a", 1)
self.assertEqual(len(sub.list_bindings("")), 1)
self.assertRaises(
NotContextError, context.set_attributes, "sub/a/xx", defaults
)
#### Operation specific tests ####
# Attributes of the root context.
attributes = self.context.get_attributes("")
self.assertEqual(len(attributes), 0)
# Set the attributes.
context.set_attributes("", defaults)
attributes = context.get_attributes("")
self.assertEqual(len(attributes), 1)
self.assertEqual(attributes["colour"], "blue")
# Attributes of a sub-context.
attributes = context.get_attributes("sub")
self.assertEqual(len(attributes), 0)
# Set the attributes.
context.set_attributes("sub", defaults)
attributes = context.get_attributes("sub")
self.assertEqual(len(attributes), 1)
self.assertEqual(attributes["colour"], "blue")
def test_namespace_name(self):
""" get the name of a context within its namespace. """
# Convenience.
context = self.context
sub = self.context.lookup("sub")
self.assertIsInstance(sub, DirContext)
self.assertEqual(context.namespace_name, "data")
self.assertEqual(sub.namespace_name, "data/sub")
|