tests/modules.at

   1 # Hand crafted tests for GNU M4.                               -*- Autotest -*-
   2 # Copyright (C) 2001, 2006, 2007, 2008 Free Software Foundation, Inc.
   3
   4 # This file is part of GNU M4.
   5 #
   6 # GNU M4 is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # GNU M4 is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 AT_BANNER([Module support.])
  21
  22
  23 ## --------- ##
  24 ## modfreeze ##
  25 ## --------- ##
  26
  27 AT_SETUP([Freezing modules])
  28 AT_KEYWORDS([frozen])
  29 AT_CHECK_DYNAMIC_MODULE
  30
  31 AT_DATA([[frozen.m4]],
  32 [[divert(1)dnl
  33 define(`test', `local::`test'')dnl
  34 define(`test1', defn(`test'))dnl
  35 ->test
  36 load(`modtest')
  37 define(`test2', defn(`test'))dnl
  38 ->test
  39 load(`shadow')
  40 define(`test3', defn(`test'))dnl
  41 ->test
  42 ]])
  43
  44 AT_DATA([[unfrozen.m4]],
  45 [[undivert(1)dnl
  46 test1
  47 test2
  48 test3
  49 ]])
  50
  51 # First generate the `expout' ouput by running over the sources before
  52 # freezing.
  53 AT_CHECK_M4([-M "$abs_builddir" -m load frozen.m4 unfrozen.m4],
  54             [0], [stdout], [stderr])
  55
  56 mv stdout expout
  57 mv stderr experr
  58
  59 # Now freeze the first source file.
  60 AT_CHECK_M4([-M "$abs_builddir" -m load -F frozen.m4f frozen.m4],
  61             [0], [], [ignore])
  62
  63 # Now rerun the original sequence, but using the frozen file.
  64 AT_CHECK_M4([-M "$abs_builddir" -R frozen.m4f unfrozen.m4],
  65             [0], [expout], [experr])
  66
  67 AT_CLEANUP([frozen.m4f])
  68
  69
  70 ## ------------------ ##
  71 ## module test macros ##
  72 ## ------------------ ##
  73
  74 AT_SETUP([module test macros])
  75 AT_CHECK_DYNAMIC_MODULE
  76 AT_CHECK_GMP
  77
  78 AT_DATA([in], [[load(`mpeval')
  79 -__load__-__mpeval__-
  80 unload(`mpeval')
  81 -__load__-__mpeval__-
  82 unload(`load')
  83 -__load__-__mpeval__-
  84 ]])
  85
  86 AT_CHECK_M4([-m load in], [0], [[
  87 ---
  88
  89 --__mpeval__-
  90
  91 -__load__-__mpeval__-
  92 ]])
  93
  94 AT_CLEANUP
  95
  96
  97 ## ---------------------------- ##
  98 ## Exercising the test module.  ##
  99 ## ---------------------------- ##
 100
 101 # AT_CHECK_M4_MODTEST(TITLE, ENV-VARS, M4-OPTIONS)
 102 # ------------------------------------------------
 103 # Add a test named TITLE, running m4 with either ENV-VARS in the environment
 104 # or M4-OPTIONS set to pick up test modules.
 105 m4_define([AT_CHECK_M4_MODTEST],
 106 [AT_SETUP([$1])
 107 AT_CHECK_DYNAMIC_MODULE
 108
 109 AT_DATA([input.m4],
 110 [[load(`modtest')
 111 test
 112 Dumpdef: dumpdef(`test').
 113 unload(`modtest')
 114 test
 115 Dumpdef: dumpdef(`test').
 116 ]])
 117
 118 dnl Fortunately, all tests within AT_SETUP are in the same subshell, so
 119 dnl setting the environment now will impact the AT_CHECK_M4, but not
 120 dnl carry over to the next AT_SETUP.
 121 m4_ifval([$2], [$2
 122 export m4_substr([$2], [0], m4_index([$2], [=]))])
 123
 124 AT_CHECK_M4([-m load $3 input.m4], [0],
 125 [[
 126 Test module called.
 127 Dumpdef: .
 128
 129 test
 130 Dumpdef: .
 131 ]],
 132 [[Test module loaded.
 133 test:   <test>
 134 Test module unloaded.
 135 m4:input.m4:6: Warning: dumpdef: undefined macro `test'
 136 ]])
 137
 138 AT_CLEANUP
 139 ])
 140
 141
 142
 143 AT_CHECK_M4_MODTEST([--module-directory: absolute path],
 144                     [], [-M "$abs_builddir"])
 145
 146 AT_CHECK_M4_MODTEST([--module-directory: relative path],
 147                     [], [-M "$top_build_prefix/tests"])
 148
 149 AT_CHECK_M4_MODTEST([M4MODPATH: absolute path],
 150                     [M4MODPATH="$abs_builddir"], [])
 151
 152 AT_CHECK_M4_MODTEST([M4MODPATH: relative path],
 153                     [M4MODPATH="$top_build_prefix/tests"], [])
 154
 155 AT_CHECK_M4_MODTEST([LTDL_LIBRARY_PATH: absolute path],
 156                     [LTDL_LIBRARY_PATH="$abs_builddir"], [])
 157
 158 AT_CHECK_M4_MODTEST([LTDL_LIBRARY_PATH: relative path],
 159                     [LTDL_LIBRARY_PATH="$top_build_prefix/tests"], [])
 160
 161
 162
 163
 164 ## ------ ##
 165 ## shadow ##
 166 ## ------ ##
 167
 168 AT_SETUP([modules: shadow])
 169 AT_CHECK_DYNAMIC_MODULE
 170
 171 AT_DATA([[input.m4]],
 172 [[# no modules loaded yet
 173 test
 174 shadow
 175
 176 # define our own macros for `test' and `shadow'
 177 define(`test', `local::`test'')
 178 define(`shadow', `local::`shadow'')
 179 test
 180 shadow
 181
 182 # module Shadow defines `shadow' and `test' macros
 183 load(`shadow')
 184 dumpdef(`test')
 185 dumpdef(`shadow')
 186 test
 187 shadow
 188
 189 # save the definition of `test' from the Shadow module
 190 define(`Shadow::test', defn(`test'))
 191
 192 # module Modtest also defines a `test' macro
 193 load(`modtest')
 194 dumpdef(`test')
 195 dumpdef(`shadow')
 196 test
 197 shadow
 198
 199 # Reloading Shadow shouldn't affect anything
 200 load(`shadow')
 201 dumpdef(`test')
 202 dumpdef(`shadow')
 203 test
 204 shadow
 205
 206 # Unloading Modtest will unshadow the test definition in Shadow
 207 unload(`modtest')
 208 dumpdef(`test')
 209 dumpdef(`shadow')
 210 test
 211 shadow
 212
 213 # Unloading Shadow once has no effect (we loaded it twice)
 214 unload(`shadow')
 215 dumpdef(`test')
 216 dumpdef(`shadow')
 217 test
 218 shadow
 219
 220 # Unloading Shadow again will revert to copying `test' and the local
 221 # `shadow' macro.
 222 unload(`shadow')
 223 test
 224 shadow
 225 ]])
 226
 227 AT_DATA([[expout]],
 228 [[# no modules loaded yet
 229 test
 230 shadow
 231
 232 # define our own macros for `test' and `shadow'
 233
 234
 235 local::test
 236 local::shadow
 237
 238 # module Shadow defines `shadow' and `test' macros
 239 Shadow module loaded.
 240
 241
 242 Shadow::test called.
 243 Shadow::shadow called.
 244
 245 # save the definition of `test' from the Shadow module
 246
 247
 248 # module Modtest also defines a `test' macro
 249
 250
 251
 252 Test module called.
 253 Shadow::shadow called.
 254
 255 # Reloading Shadow shouldn't affect anything
 256
 257
 258
 259 Test module called.
 260 Shadow::shadow called.
 261
 262 # Unloading Modtest will unshadow the test definition in Shadow
 263
 264
 265
 266 Shadow::test called.
 267 Shadow::shadow called.
 268
 269 # Unloading Shadow once has no effect (we loaded it twice)
 270
 271
 272
 273 Shadow::test called.
 274 Shadow::shadow called.
 275
 276 # Unloading Shadow again will revert to copying `test' and the local
 277 # `shadow' macro.
 278
 279 local::test
 280 local::shadow
 281 ]])
 282
 283 AT_DATA([[experr]],
 284 [[test: <test>
 285 shadow: <shadow>
 286 Test module loaded.
 287 test:   <test>
 288 shadow: <shadow>
 289 test:   <test>
 290 shadow: <shadow>
 291 Test module unloaded.
 292 test:   <test>
 293 shadow: <shadow>
 294 test:   <test>
 295 shadow: <shadow>
 296 ]])
 297
 298 AT_CHECK_M4([-M "$abs_builddir" -m load input.m4], [0],
 299             [expout], [experr])
 300
 301 AT_CLEANUP
 302
 303
 304
 305 ## ------ ##
 306 ## unload ##
 307 ## ------ ##
 308
 309 AT_SETUP([modules: unload])
 310 AT_CHECK_DYNAMIC_MODULE
 311
 312 AT_DATA([[input.m4]],
 313 [[test
 314 __test__
 315 load(`modtest')
 316 test
 317 __test__
 318 load(`shadow')
 319 test
 320 __test__
 321 unload(`modtest')
 322 test
 323 __test__
 324 load(`modtest')
 325 test
 326 __test__
 327 unload(`modtest')
 328 test
 329 __test__
 330 unload(`shadow')
 331 test
 332 __test__
 333 ]])
 334
 335 AT_DATA([[expout]],
 336 [[test
 337 __test__
 338
 339 Test module called.
 340 modtest
 341 Shadow module loaded.
 342 Shadow::test called.
 343 shadow
 344
 345 Shadow::test called.
 346 shadow
 347
 348 Test module called.
 349 modtest
 350
 351 Shadow::test called.
 352 shadow
 353
 354 test
 355 __test__
 356 ]])
 357
 358 AT_DATA([[experr]],
 359 [[Test module loaded.
 360 Test module unloaded.
 361 Test module loaded.
 362 Test module unloaded.
 363 ]])
 364
 365
 366 AT_CHECK_M4([-M "$abs_builddir" -m load input.m4],
 367             [0], [expout], [experr])
 368
 369 AT_CLEANUP
 370
 371
 372
 373 ## ----------------------- ##
 374 ## module symbol importing ##
 375 ## ----------------------- ##
 376
 377 # Importing a symbol from a not yet loaded module
 378
 379 # This test is ugly, because we need to canonicalize strerror strings
 380 # to match our test.  So we save STDERR to a file, and run another check
 381 # which edits that file and compares it to the canonical STDERR output
 382 # from the first command:
 383
 384 AT_SETUP([modules: importing])
 385 AT_CHECK_DYNAMIC_MODULE
 386
 387 AT_DATA([[input.m4]],
 388 [[import
 389 load(`import')
 390 import
 391 unload(`modtest')
 392 import
 393 symbol_fail
 394 module_fail
 395 ]])
 396
 397 AT_DATA([[expout]],
 398 [[import
 399
 400 import::import called.
 401
 402 import::import called.
 403 import::symbol_fail called.
 404 ]])
 405
 406 AT_DATA([[experr]],
 407 [[Test module loaded.
 408
 409 TRUE
 410 Test module unloaded.
 411 Test module loaded.
 412
 413 TRUE
 414 m4:input.m4:6: cannot load symbol `no_such' from module `modtest'
 415 m4:input.m4:7: cannot open module `no_such'
 416 ]])
 417
 418 AT_CHECK_M4([-M "$abs_builddir" -m load input.m4],
 419             [1], [expout], [experr])
 420
 421 AT_CLEANUP
 422
 423
 424
 425 ## ------------------- ##
 426 ## text module symbols ##
 427 ## ------------------- ##
 428
 429 # Support text macros with requested numbers of parameters.
 430
 431 AT_SETUP([modules: text])
 432 AT_CHECK_DYNAMIC_MODULE
 433
 434 AT_DATA([input.m4],
 435 [[__test__
 436 __test__(1)
 437 __test__(1,2)
 438 onearg
 439 onearg(1)
 440 onearg(1,2)
 441 manyargs
 442 manyargs(1)
 443 manyargs(1,2)
 444 ]])
 445
 446 AT_CHECK_M4([-M "$abs_builddir" -m modtest input.m4], [0],
 447 [[modtest
 448 modtest
 449 modtest
 450
 451 1
 452 1
 453
 454 1
 455 1,2
 456 ]], [[Test module loaded.
 457 m4:input.m4:2: Warning: __test__: extra arguments ignored: 1 > 0
 458 m4:input.m4:3: Warning: __test__: extra arguments ignored: 2 > 0
 459 m4:input.m4:4: Warning: onearg: too few arguments: 0 < 1
 460 m4:input.m4:6: Warning: onearg: extra arguments ignored: 2 > 1
 461 Test module unloaded.
 462 ]])
 463
 464 AT_CLEANUP
 465
 466
 467 ## -------------------- ##
 468 ## trace module symbols ##
 469 ## -------------------- ##
 470
 471 # The trace bit should not be lost if a builtin is unloaded from
 472 # memory and then redefined by a subsequent load.
 473
 474 AT_SETUP([modules: trace])
 475 AT_CHECK_DYNAMIC_MODULE
 476
 477 AT_DATA([[input.m4]],
 478 [[test
 479 load(`shadow')
 480 test
 481 unload(`shadow')
 482 test
 483 load(`shadow')
 484 test
 485 ]])
 486
 487 AT_DATA([[expout]],
 488 [[test
 489 Shadow module loaded.
 490 Shadow::test called.
 491
 492 test
 493 Shadow module loaded.
 494 Shadow::test called.
 495 ]])
 496
 497 AT_DATA([[experr]],
 498 [[m4trace: -1- test -> `Shadow::`test' called.'
 499 m4trace: -1- test -> `Shadow::`test' called.'
 500 ]])
 501
 502
 503 AT_CHECK_M4([-M "$abs_builddir" -m load -t test input.m4],
 504             [0], [expout], [experr])
 505
 506 AT_CLEANUP
 507
 508
 509 ## ----------------- ##
 510 ## unload gnu module ##
 511 ## ----------------- ##
 512
 513 AT_SETUP([unload gnu module])
 514 AT_CHECK_DYNAMIC_MODULE
 515
 516 dnl Ensure that the gnu module does not leak memory.  I don't know how
 517 dnl to portably artificially limit the heap to cause an out-of-memory
 518 dnl condition in the case of a leak, but examining the run of this test
 519 dnl in a debugger can show whether it is leaking.
 520 AT_DATA([input.m4], [[divert(-1)
 521 define(`forloop',
 522   `pushdef(`$1', `$2')_forloop(`$1', `$2', `$3', `$4')popdef(`$1')')
 523 define(`_forloop',
 524   `$4`'ifelse($1, `$3', `',
 525     `define(`$1', incr($1))_forloop(`$1', `$2', `$3', `$4')')')
 526 forloop(`i', `1', `5000', `unload(`gnu')load(`gnu')regexp(`123', `\(4\)?2')')
 527 ]])
 528
 529 AT_CHECK_M4([-m load input.m4], [0])
 530
 531 AT_CLEANUP
 532
 533
 534 ## ------------------ ##
 535 ## unload load module ##
 536 ## ------------------ ##
 537
 538 AT_SETUP([unload load module])
 539 AT_CHECK_DYNAMIC_MODULE
 540
 541 dnl Ensure that the load module can be unloaded and reloaded (obviously,
 542 dnl it can't reload itself; the reload occurs on the command line).  Since
 543 dnl the module must be resident (after all, the `unload' builtin had better
 544 dnl not unmap the memory for the code it is currently executing), make sure
 545 dnl that resident modules are handled gracefully.
 546 AT_DATA([in1.m4], [[__load__ 1
 547 unload(`load') 2
 548 __load__ 3
 549 ]])
 550
 551 AT_DATA([in2.m4], [[__load__ 4
 552 load(`load') 5
 553 __load__ 6
 554 unload(`load') 7
 555 __load__ 8
 556 unload(`load') 9
 557 __load__ 10
 558 ]])
 559
 560 AT_CHECK_M4([-m load in1.m4 -m load in2.m4], [0],
 561 [[ 1
 562  2
 563 __load__ 3
 564  4
 565  5
 566  6
 567  7
 568  8
 569  9
 570 __load__ 10
 571 ]])
 572
 573 AT_CLEANUP