Skip to content
Snippets Groups Projects
Commit 9864bb84 authored by Kevin Abel's avatar Kevin Abel
Browse files

Update README with test and expection information.

parent 8b778852
No related branches found
No related tags found
No related merge requests found
...@@ -5,19 +5,16 @@ Proxies UNL Alerts issued from external vendor applications so they can be distr ...@@ -5,19 +5,16 @@ Proxies UNL Alerts issued from external vendor applications so they can be distr
SETUP SETUP
----- -----
1. Copy configsample.inc.php to config.inc.php 1. Copy configsample.inc.php to config.inc.php
2. 2. Configure CRON to run the `scripts/exportCAPAlert.php` every minute
Expections Expectations
----- -----
TODO: document how the application is expected to work and communicate with the UNLedu framework and other systems This application is designed to proxy an alert feed (such as an RSS feed) from a vendor alerting service and output that message in the Common Alerting Protocol (CAP). This is an XML format. It has been translated to JSON for easier integration with the UNLedu web framework.
Automated Testing The scripts that proxy the alert from the vendor are expected to be run at a regular basis, such as via the CRON utility. CRON does have a limitation being able to run something no more frequent than every minute. It may be desired to build some simple daemon script that fetches the content more frequently.
-----
Run automated tests via this command `TODO: fill in once suite has been created`
Manual Testing The UNLedu Framework is expected to regularly request the JavaScript file `www/json/unlcap.js` and display the alert if one exists.
Automated Testing
----- -----
TODO: Describe process to set up a test server with a test alert and how to test it with the UNLedu framework. Run automated tests via this command `pyrus run-phpt tests`
* Ensure that polling is working \ No newline at end of file
* Ensure that the alert does not re-open
*
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment