Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml,v
diff -u -N -r1.13 -r1.14
--- openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml 27 Oct 2014 16:39:31 -0000 1.13
+++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial-debug.xml 7 Aug 2017 23:47:54 -0000 1.14
@@ -31,7 +31,7 @@
Hint: "Parse error near *" usually means that an xql file
- wasn't recognized, because the tcl file is choking on the *SQL*
+ wasn't recognized, because the Tcl file is choking on the *SQL*
placeholder that it falls back on.Watching the server log
@@ -85,7 +85,7 @@
Proc should return 0 for success.
- Other things to test: try to delete someone else's
+ Other things to test: try to delete someone else's
note. Try to delete your own note. Edit your own note.
Search for a note.
@@ -98,7 +98,7 @@
Automated tests
- It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.
+ It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.Create the directory that will contain the test
script and edit the script file. The directory location and file name are standards which are recognized by the automated testing package:[$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
@@ -111,25 +111,25 @@
To create a test case you call
aa_register_case test_case_name..
-Once you've created the test case you start writing the needed logic.
-We'll use the tutorial package, "myfirstpackage," as an example.
-Let's say you just wrote an API for adding and deleting notes in the
-notes packages and wanted to test that. You'd probably want to write a
+Once you've created the test case you start writing the needed logic.
+We'll use the tutorial package, "myfirstpackage," as an example.
+Let's say you just wrote an API for adding and deleting notes in the
+notes packages and wanted to test that. You'd probably want to write a
test that first creates a note, then verifies that it was inserted,
then perhaps deletes it again, and finally verifies that it is
gone.
-Naturally this means you'll be adding a lot of bogus data to the
-database, which you're not really interested in having there. To avoid
+Naturally this means you'll be adding a lot of bogus data to the
+database, which you're not really interested in having there. To avoid
this I usually do two things. I always put all my test code inside a
call to aa_run_with_teardown which basically means that all the
inserts, deletes, and updates will be rolled back once the test has
been executed. A very useful feature. Instead of inserting bogus data
-like: set name "Simon", I tend to generate a random script in order avoid inserting a value that's already in the database:
+like: set name "Simon", I tend to generate a random script in order avoid inserting a value that's already in the database:
set name [ad_generate_random_string]
-Here's how the test case looks so far:
+Here's how the test case looks so far:aa_register_case mfp_basic_test {
My test
@@ -141,17 +141,17 @@
}
}
-Now let's look at the actual test code. That's the code that
+Now let's look at the actual test code. That's the code that
goes inside -test_code {}. We want to implement test case API-001, "Given an object id from API-001, invoke mfp::note::get. Proc should return the specific word in the title."
set name [ad_generate_random_string]
set new_id [mfp::note::add -title $name]
- aa_true "Note add succeeded" ([info exists new_id] && $new_id ne "")
- To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.) To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage". Since we'll be changing it frequently, select "watch this file" on the next page. This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing. We can also add some aa_register_case flags to make it easier to run the test. The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all. The -cats flag, setting categories, makes it easier to control which tests to run. The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")
+ aa_true "Note add succeeded" ([info exists new_id] && $new_id ne "")
+ To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.) To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage". Since we'll be changing it frequently, select "watch this file" on the next page. This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing. We can also add some aa_register_case flags to make it easier to run the test. The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all. The -cats flag, setting categories, makes it easier to control which tests to run. The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")Once the file is loaded, go to ACS Automated Testing and click on myfirstpackage. You should see your test case. Run it and examine the results.TCLWebtest tests
- API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs. For this, we can use TCLwebtest. TCLwebtest must be installed for this test to work. This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms. TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.
+ API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs. For this, we can use TCLwebtest. TCLwebtest must be installed for this test to work. This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms. TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.Example