[asterisk-dev] [Code Review] Generic AMI Module for Events

[Mark Michelson]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2013/
-----------------------------------------------------------

(Updated July 10, 2012, 9:16 a.m.)


Review request for Asterisk Developers and Matt Jordan.


Changes
-------

Addresed Matt's review. Most changes are pretty self-explanatory.

With regards to the sample yaml file, I created a directory called "sample-yaml" and placed the sample in there.

With regards to the "load-from-test" comment, I did not just revert the option to its original method of being set. Prior to my changes, "load-from-test" was read per-module in the test configuration. This doesn't make a lot of sense to me because this property is not intrinsic to the module but rather to the test itself. I have modified the option to be read in the test-object configuration section now.


Summary
-------

This is a new pluggable module for the Asterisk test suite intended to be used to verify AMI events.

There are two ways that this may be used.

* "headermatch": This is the simpler of the two methods. When user-specified conditions are met, then headers in an AMI event are checked for expected values. If the check fails, then the test fails as well.
* "callback": For cases where more complicated checks are required than just AMI headers, then a user-defined callback may be called instead. This allows for the user to maintain their own test state to determine if the test has passed or failed.

There are some changes made outside the AMI module as well.

* TestCase has been updated to have a set_passed() method. Instead of directly modifying the 'passed' field of a test object, this method should be called. This way, if one module fails, other modules cannot override the failed state of the test. The CDR and ForkCDR modules have been updated accordingly
* TestRunner has been modified to get rid of the "load-from-test" option. Instead, when module configuration is loaded, it automatically loads the test path into its loader's supported paths. This was done to get around a situation where I wanted the test path added to the supported paths but did not want the TestRunner to actually load the module in that path.

I have also included a sample YAML file that details the options available for the AMI module.


Diffs (updated)
-----

  /asterisk/team/mmichelson/bridge-tests/lib/python/asterisk/asterisk.py 3290 
  /asterisk/team/mmichelson/bridge-tests/lib/python/asterisk/TestCase.py 3290 
  /asterisk/team/mmichelson/bridge-tests/lib/python/asterisk/TestRunner.py 3290 
  /asterisk/team/mmichelson/bridge-tests/lib/python/asterisk/ami.py 3290 
  /asterisk/team/mmichelson/bridge-tests/lib/python/asterisk/cdr.py 3290 
  /asterisk/team/mmichelson/bridge-tests/sample-yaml/ami-config.yaml.sample PRE-CREATION 
  /asterisk/team/mmichelson/bridge-tests/tests/cdr/ForkCdrModule.py 3290 
  /asterisk/team/mmichelson/bridge-tests/tests/predial/configs/ast1/extensions.conf PRE-CREATION 
  /asterisk/team/mmichelson/bridge-tests/tests/predial/configs/ast1/followme.conf PRE-CREATION 
  /asterisk/team/mmichelson/bridge-tests/tests/predial/run-test PRE-CREATION 
  /asterisk/team/mmichelson/bridge-tests/tests/predial/test-config.yaml PRE-CREATION 
  /asterisk/team/mmichelson/bridge-tests/tests/tests.yaml 3290 

Diff: https://reviewboard.asterisk.org/r/2013/diff


Testing
-------

I tested this by tweaking the cdr_userfield test with different values. The only option that is not thoroughly tested is the 'id' field since SimpleTestCase only uses a single Asterisk instance. The intention, once this gets committed, is to use this in a battery of Bridging tests that will be written in the near future.


Thanks,

Mark

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20120710/6dc432a7/attachment.htm>