2017-03-28 12:30:28 +00:00
|
|
|
- Testing global log functions
|
|
|
|
|
01:02:03 tst <origin>: from log.log()
|
|
|
|
|
01:02:03 tst <origin>: DBG: from log.dbg()
|
|
|
|
|
01:02:03 tst <origin>: ERR: from log.err()
|
|
|
|
|
- Testing log.Origin functions
|
|
|
|
|
01:02:03 tst some-name(some='detail'): hello log
|
|
|
|
|
01:02:03 tst some-name(some='detail'): ERR: hello err
|
|
|
|
|
01:02:03 tst some-name(some='detail'): message {int=3, none=None, str='str\n', tuple=('foo', 42)}
|
|
|
|
|
01:02:03 tst some-name(some='detail'): DBG: hello dbg
|
|
|
|
|
- Testing log.style()
|
|
|
|
|
01:02:03: only time
|
|
|
|
|
tst: only category
|
|
|
|
|
DBG: only level
|
2017-05-05 17:51:40 +00:00
|
|
|
some-name(some='detail'): only origin
|
2017-06-12 22:08:35 +00:00
|
|
|
only src [log_test.py:69]
|
2017-03-28 12:30:28 +00:00
|
|
|
- Testing log.style_change()
|
|
|
|
|
no log format
|
|
|
|
|
01:02:03: add time
|
|
|
|
|
but no time format
|
|
|
|
|
01:02:03: DBG: add level
|
|
|
|
|
01:02:03 tst: DBG: add category
|
2017-06-12 22:08:35 +00:00
|
|
|
01:02:03 tst: DBG: add src [log_test.py:84]
|
|
|
|
|
01:02:03 tst some-name(some='detail'): DBG: add origin [log_test.py:86]
|
2017-03-28 12:30:28 +00:00
|
|
|
- Testing origin_width
|
2017-06-12 22:08:35 +00:00
|
|
|
01:02:03 tst shortname: origin str set to 23 chars [log_test.py:91]
|
|
|
|
|
01:02:03 tst very long name(and_some=(3, 'things', 'in a tuple'), some='details'): long origin str [log_test.py:93]
|
|
|
|
|
01:02:03 tst very long name(and_some=(3, 'things', 'in a tuple'), some='details'): DBG: long origin str dbg [log_test.py:94]
|
|
|
|
|
01:02:03 tst very long name(and_some=(3, 'things', 'in a tuple'), some='details'): ERR: long origin str err [log_test.py:95]
|
2017-03-28 12:30:28 +00:00
|
|
|
- Testing log.Origin with omitted info
|
2017-06-12 22:08:35 +00:00
|
|
|
01:02:03 tst LogTest: hello log, name implicit from class name [log_test.py:99]
|
|
|
|
|
01:02:03 --- explicit_name: hello log, no category set [log_test.py:103]
|
|
|
|
|
01:02:03 --- LogTest: hello log, no category nor name set [log_test.py:107]
|
|
|
|
|
01:02:03 --- LogTest: DBG: debug message, no category nor name set [log_test.py:110]
|
2017-03-28 12:30:28 +00:00
|
|
|
- Testing logging of Exceptions, tracing origins
|
|
|
|
|
nested print just prints
|
2017-06-12 22:08:35 +00:00
|
|
|
01:02:03 tst level3: nested log() [level1↪level2↪level3] [log_test.py:132]
|
|
|
|
|
01:02:03 tst level2: nested l2 log() from within l3 scope [level1↪level2] [log_test.py:133]
|
|
|
|
|
01:02:03 tst level3: ERR: ValueError: bork [level1↪level2↪level3] [log_test.py:134: raise ValueError('bork')]
|
fix and refactor logging: drop 'with', simplify
With the recent fix of the junit report related issues, another issue arose:
the 'with log.Origin' was changed to disallow __enter__ing an object twice to
fix problems, now still code would fail because it tries to do 'with' on the
same object twice. The only reason is to ensure that logging is associated with
a given object. Instead of complicating even more, implement differently.
Refactor logging to simplify use: drop the 'with Origin' style completely, and
instead use the python stack to determine which objects are created by which,
and which object to associate a log statement with.
The new way: we rely on the convention that each class instance has a local
'self' referencing the object instance. If we need to find an origin as a new
object's parent, or to associate a log message with, we traverse each stack
frame, fetching the first local 'self' object that is a log.Origin class
instance.
How to use:
Simply call log.log() anywhere, and it finds an Origin object to log for, from
the stack. Alternatively call self.log() for any Origin() object to skip the
lookup.
Create classes as child class of log.Origin and make sure to call
super().__init__(category, name). This constructor will magically find a parent
Origin on the stack.
When an exception happens, we first escalate the exception up through call
scopes to where ever it is handled by log.log_exn(). This then finds an Origin
object in the traceback's stack frames, no need to nest in 'with' scopes.
Hence the 'with log.Origin' now "happens implicitly", we can write pure natural
python code, no more hassles with scope ordering.
Furthermore, any frame can place additional logging information in a frame by
calling log.ctx(). This is automatically inserted in the ancestry associated
with a log statement / exception.
Change-Id: I5f9b53150f2bb6fa9d63ce27f0806f0ca6a45e90
2017-06-09 23:18:27 +00:00
|
|
|
- Disallow origin loops
|
refactor: fix error handling; fix log.Origin; only one trial
A bit of refactoring to fix logging and error reporting, and simplify the code.
This transmogrifies some of the things committed in
0ffb41440661631fa1d520c152be4cf8ebd4c46b "Add JUnit XML reports; refactor test
reporting", which did not fully match the code structuring ideas used in
osmo-gsm-tester. Also solve some problems present from the start of the code
base.
Though this is a bit of a code bomb, it would take a lot of time to separate
this into smaller bits: these changes are closely related and resulted
incrementally from testing error handling and logging details. I hope it's ok.
Things changed / problems fixed:
Allow only a single trial to be run per cmdline invocation: unbloat trial and
suite invocation in osmo-gsm-tester.py.
There is a SuiteDefinition, intended to be immutable, and a mutable SuiteRun.
SuiteDefinition had a list of tests, which was modified by the SuiteRun to
record test results. Instead, have only the test basenames in the
SuiteDefinition and create a new set of Test() instances for each SuiteRun, to
ensure that no state leaks between separate suite runs.
State leaking across runs can be seen in
http://jenkins.osmocom.org/jenkins/view/osmo-gsm-tester/job/osmo-gsm-tester_run/453/
where an earlier sms test for sysmo succeeds, but its state gets overwritten by
the later sms test for trx that fails. The end result is that both tests
failed, although the first run was successful.
Fix a problem with Origin: log.Origin allowed to be __enter__ed more than once,
skipping the second entry. The problem there is that we'd still __exit__ twice
or more, popping the Origin off the stack even though it should still remain.
We could count __enter__ recurrences, but instead, completely disallow entering
a second time.
A code path should have one 'with' statement per object, at pivotal points like
run_suites or run_tests. Individual utility functions should not do 'with' on a
central object. The structure needed is, in pseudo code:
try:
with trial:
try:
with suite_run:
try:
with test:
test_actions()
The 'with' needs to be inside the 'try', so that the exception can be handled
in __exit__ before it reaches the exception logging.
To clarify this, like test exceptions caught in Test.run(), also move suite
exception handling from Trial into SuiteRun.run_tests(). There are 'with self'
in Test.run() and SuiteRun.run_tests(), which are well placed, because these
are pivotal points in the main code path.
Log output: clearly separate logging of distinct suites and test scripts, by
adding more large_separator() calls at the start of each test. Place these
separator calls in more logical places. Add separator size and spacing args.
Log output: print tracebacks only once, for the test script where they happen.
Have less state that duplicates other state: drop SuiteRun.test_failed_ctr and
suite.test_skipped_ctr, instead add SuiteRun.count_test_results().
For test failure reporting, store the traceback text in a separate member var.
In the text report, apply above changes and unclutter to achieve a brief and
easy to read result overview: print less filler characters, drop the starting
times, drop the tracebacks. This can be found in the individual test logs.
Because the tracebacks are no longer in the text report, the suite_test.py can
just print the reports and expect that output instead of asserting individual
contents.
In the text report, print duration in precision of .1 seconds.
Add origin information and a traceback text to the junit XML result to give
more context when browsing the result XML. For 'AssertionError', add the source
line of where the assertion hit.
Drop the explicit Failure exception. We don't need one specific exception to
mark a failure, instead any arbitrary exception is treated as a failure. Use
the exception's class name as fail_type.
Though my original idea was to use raising exceptions as the only way to cause
a test failure, I'm keeping the set_fail() function as an alternative way,
because it allows test specific cleanup and may come in handy later. To have
both ways integrate seamlessly, shift some result setting into 'finally'
clauses and make sure higher levels (suite, trial) count the contained items'
stati.
Minor tweak: write the 'pass' and 'skip' reports in lower case so that the
'FAIL' stands out.
Minor tweak: pass the return code that the program exit should return further
outward, so that the exit(1) call does not cause a SystemExit exception to be
logged.
The aims of this patch are:
- Logs are readable so that it is clear which logging belongs to which test and
suite.
- The logging origins are correct (vs. parents gone missing as previously)
- A single test error does not cause following tests or suites to be skipped.
- An exception "above" Exception, i.e. SystemExit and the like, *does*
immediately abort all tests and suites, and the results for tests that were
not run are reported as "unknown" (rather than skipped on purpose):
- Raising a SystemExit aborts all.
- Hitting ctrl-c aborts all.
- The resulting summary in the log is brief and readable.
Change-Id: Ibf0846d457cab26f54c25e6906a8bb304724e2d8
2017-06-06 17:41:17 +00:00
|
|
|
disallowed successfully
|
