Prepare 1.15.0 release

bdelbosc · bdelbosc · commit 87eab975a267 · 2011-03-11T09:42:28.000+01:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -17,22 +17,32 @@ FunkLoad GIT master
 
 :git: https://github.com/nuxeo/FunkLoad
 
-:Target: 1.15.0
+:Target: 1.16.0
+
+
+FunkLoad 1.15.0
+------------------
+
+:Package: http://pypi.python.org/packages/source/f/funkload/funkload-1.15.0.tar.gz
+
+:github: https://github.com/nuxeo/FunkLoad/tree/1.15.0
+
+:Released date: 2011-03-11
 
 
 New features
 ~~~~~~~~~~~~~
 
-* Now supporting emacs org-mode_ text format as report output. This
-  enable to edit a report as plain text and produce professional PDF
-  reports througth the org-mode_ LaTeX export.
+* Now supporting emacs Org-mode_ text format as report output. This
+  enable to edit a report as plain text and to produce professional
+  PDF reports througth the Org-mode_ LaTeX export.
 
-  Here is an example of a `PDF
+  Here is an example of a `PDF 
   <http://funkload.nuxeo.org/report-example/test_seam_java6.pdf>`_ and
-  an `org-mode report
+  an `Org-mode report 
   <http://funkload.nuxeo.org/report-example/test_seam_java6.org>`_.
 
-  The org file requires to build the html report first::
+  You need to build the HTML report first::
   
     fl-build-report --html funkload.xml
     Creating html report: ...done: 
@@ -41,23 +51,27 @@ New features
     fl-build-report --org funkload.xml > /tmp/test_foo-20110304T160328/index.org
     emacs /tmp/test_foo-20110304T160328/index.org
     # then export as PDF C-c C-e d 
-    # refer to the org-mode site for 
+    # refer to the org-mode site for latex exports requirements
 
-* New ``--trend`` option to the ``fl-build-report`` command. It creates a 
-  trend report to display evolution of the page statistics over time.
-  Here is an example of a trend report:
-  http://funkload.nuxeo.org/report-example/trend-report/
+* New `trend report
+  <http://funkload.nuxeo.org/report-example/trend-report/>`_ to
+  display evolution of performances over time. Just use the
+  ``--trend`` option of the ``fl-build-report`` command.
 
-* Credential server can serve a sequence, using ``xmlrpc_get_seq`` tests
-  can share a sequence::
+* The credential server can serve a sequence. Using ``xmlrpc_get_seq``
+  threads can share a sequence::
 
     from funkload.utils import xmlrpc_get_seq
     ...
     seq = xmlrpc_get_seq()
 
-* Source migrated to git in gigthub https://github.com/nuxeo/FunkLoad
+* Source migrated from svn to git, hosted in gigthub
+  https://github.com/nuxeo/FunkLoad
+
+* But tracker moving to github:
+  https://github.com/nuxeo/FunkLoad/issues
 
-* Documentation migrated to sphinx http://funkload.nuxeo.org/
+* New site and documentation using sphinx: http://funkload.nuxeo.org/
 
 * CPSTestCase and ZopeTestCase have been moved to the demo folder.
 
@@ -71,8 +85,8 @@ Bug fixes
 * Fix #3: FunkLoad Failures Fail on Python 2.7
   https://github.com/nuxeo/FunkLoad/issues#issue/3
 
-* Do not block on read content when content-length is null, patch submited by Bertrand
-  Yvain.
+* Do not block on read content when content-length is null, patch
+  submited by Bertrand Yvain.
 
 * Fix monitoring network monitoring charts.
 
@@ -121,7 +135,7 @@ New features
   A typical usage is to add metadata during setUpBench or
   tearDownBench hooks.
 
-* Handling FunkLoad todo list with an org-mode_ file TODO_, replacing 
+* Handling FunkLoad todo list with an Org-mode_ file TODO_, replacing 
   the old trac.
 
 * Mark CPSTestCase as deprecated will be removed in 1.15.
@@ -917,7 +931,7 @@ More information on the FunkLoad_ site.
 .. _TCPWatch: http://hathawaymix.org/Software/TCPWatch/
 .. _API: api/index.html
 .. _TODO: https://github.com/nuxeo/FunkLoad/blob/master/TODO.txt
-.. _org-mode: http://orgmode.org/
+.. _Org-mode: http://orgmode.org/
 .. _epydoc: http://epydoc.sourceforge.net/
 .. _cheesecake: http://tracos.org/cheesecake/
 .. _933: http://svn.nuxeo.org/trac/pub/ticket/933
@@ -952,7 +966,6 @@ More information on the FunkLoad_ site.
 .. _1837: http://svn.nuxeo.org/trac/pub/ticket/1837
 .. _1838: http://svn.nuxeo.org/trac/pub/ticket/1837
 .. _Plone: http://plone.org/
-.. _org-mode: http://orgmode.org/
 
 .. Local Variables:
 .. mode: rst
diff --git a/README.txt b/README.txt
@@ -16,20 +16,19 @@ main use cases are:
 * Stress testing tool to overwhelm the web application resources and test
   the application recoverability.
 
-* Writing web agents by scripting any web repetitive task, like checking if
-  a site is alive.
+* Writing web agents by scripting any web repetitive task.
 
 Features
 ---------
 
 Main FunkLoad_ features are:
 
-* Functional test are pure Python scripts using the pyUnit_ framework like
-  normal unit test. Python enable complex scenarios to handle real world
-  applications.
+* Functional test are pure Python scripts using the pyUnit_ framework
+  like normal unit test. Python enable complex scenarios to handle
+  real world applications.
 
-* Truly emulates a web browser (single-threaded) using an enhanced Richard
-  Jones' webunit_:
+* Truly emulates a web browser (single-threaded) using an enhanced
+  Richard Jones' webunit_:
 
   - get/post/put/delete support
   - post any kind of content type like ``application/xml``
@@ -53,30 +52,35 @@ Main FunkLoad_ features are:
   - green/red color mode
   - select or exclude tests cases using a regex
   - support normal pyUnit_ test
-  - support doctest_ from a plain text file or embedded in python docstring
+  - support doctest_ from a plain text file or embedded in python
+    docstring
 
 * Turn a functional test into a load test: just by invoking the bench
   runner you can identify scalability and performance problems. If
   needed the bench can distributed over a group of worker machines.
 
-* Detailed bench reports in ReST or HTML (and PDF via ps2pdf)
-  containing:
+* Detailed bench reports in ReST, HTML, Org-mode_, PDF (using
+  LaTeX/PDF Org-mode export) containing:
 
   - the bench configuration
-  - tests, pages, requests stats and charts.
-  - the requets that took the most time.
-  - monitoring one or many servers cpu usage, load average, memory/swap
-    usage and network traffic charts.
+  - tests, pages, requests stats and charts
+  - the requets that took the most time
+  - monitoring one or many servers cpu usage, load average,
+    memory/swap usage and network traffic charts
   - an http error summary list
 
-* Differential reports to compare 2 bench reports giving a quick overview of
-  scalability and velocity changes.
+* Differential reports to compare 2 bench reports giving a quick
+  overview of scalability and velocity changes.
 
-* Easy test customization using a configuration file or command line options.
+* Trend reports to view the performance evolution with multiple
+  reports.
 
-* Easy test creation using embeded TCPWatch_ as proxy recorder, so you can
-  use your web browser and produce a FunkLoad_ test automatically, including
-  file upload or any ajax call.
+* Easy test customization using a configuration file or command line
+  options.
+
+* Easy test creation using embeded TCPWatch_ as proxy recorder, so you
+  can use your web browser and produce a FunkLoad_ test automatically,
+  including file upload or any ajax call.
 
 * Provides web assertion helpers to check expected results in responses.
 
@@ -113,14 +117,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 
 
 .. _FunkLoad: http://funkload.nuxeo.org/
+.. _Org-mode: http://orgmode.org/
 .. _TCPWatch: http://hathawaymix.org/Software/TCPWatch/
 .. _webunit: http://mechanicalcat.net/tech/webunit/
 .. _pyUnit: http://pyunit.sourceforge.net/
 .. _API: api/index.html
 .. _Nuxeo: http://www.nuxeo.com/
 .. _`python cheese shop`: http://www.python.org/pypi/funkload/
 .. _EasyInstall: http://peak.telecommunity.com/DevCenter/EasyInstall
-.. _`GNU GPL`: http://www.gnu.org/licenses/licenses.html
+.. _`GNU GPL`: http://www.gnu.org/licenses/licenses.html#GPL
 .. _doctest: http://docs.python.org/lib/module-doctest.html
 .. _demo: https://github.com/nuxeo/FunkLoad/tree/master/src/funkload/demo/
 
diff --git a/TODO.txt b/TODO.txt
@@ -8,7 +8,6 @@ missing, See the [[http://funkload.nuxeo.org/reporting.html][reporting section]]
 Current target release is 1.15.0
 
 * Features
-** TODO Release 1.15
 ** TODO Merge monitoring refactoring in 1.16			 :@next:CORE:
    test with munin-plugins-extra, nagios-plugins
 *** TODO Fix tb when running fl-build-report on old result file
@@ -35,7 +34,15 @@ Creating html report: ...Traceback (most recent call last):
 KeyError: u'localhost'
 #+end_ascii
 ** TODO Matplotlib integration				       :@next:REPORT:
-** TODO Finish funkload.metadata impl				   :@next:
+** TODO Add a param to join to next request action		 :@next:CORE:
+   Joining distinct requests into a single page/action:
+   
+   self.get(url, description="foo", join_with_next_req=True)
+   self.get(url2)
+
+   url2 is reported as being on the same page as url, there is no
+   thinktime pause between the 2 requests.
+** TODO Finish funkload.metadata impl				      :@next:
    fl-buil-report should render the funkload.metadata file if present
 ** TODO Produce gplot script with commented extended options   :@next:REPORT:
    - explain how to have small label on trend reports
@@ -51,25 +58,6 @@ KeyError: u'localhost'
    - extractToken(buffer, start, stop, maxlen=-1)
    - getRandomLineInFile()
    - assertAndDump() dump getBody on failure
-** TODO Add a param to join to next request action		 :@next:CORE:
-   Joining distinct requests into a single page/action:
-   
-   self.get(url, description="foo", join_with_next_req=True)
-   self.get(url2)
-
-   url2 is reported as being on the same page as url, there is no
-   thinktime pause between the 2 requests.
-** TODO Generate a shinx documentation PDF			  :@next:DOC:
-   Fix the sphinx documentation PDF export: make latex + pdflatex
-   generate a PDF with errors on the toc.
-** TODO Remove CPSTestCase from FunkLoad sources		 :@next:CORE:
-   Added: [2010-12-27 lun. 18:28]
-   - [X] Mark it as deprecated on 1.14
-   - [ ] remove on 1.15
-   - [ ] Keep it as a demo, add link to migrated script on the CPS repo.
-** TODO Remove GDchart support					 :@next:CORE:
-   - [X] Mark it as deprecated on 1.14
-   - [ ] remove on 1.15
 ** TODO Improve report failure section			       :@next:REPORT:
    Add an error section with:
    - http failure:
@@ -87,7 +75,6 @@ KeyError: u'localhost'
    Added: [2010-11-18 jeu. 14:23
 ** TODO Produce valid xml test result			       :@next:REPORT:
    the root element is missing
-
 * org-mode configuration
 
 
diff --git a/doc/source/reporting.rst b/doc/source/reporting.rst
@@ -5,7 +5,7 @@ If you want to report a bug or if you think that something is missing,
 either send me an email bdelbosc _at_ nuxeo.com or use the `github
 issue tracker <https://github.com/nuxeo/FunkLoad/issues>`_.
 
-The list of open tasks and bugs are sceduled in the `TODO 
+The list of open tasks and bugs are scheduled in the `TODO 
 <https://github.com/nuxeo/FunkLoad/tree/master/src/funkload/TODO.txt>`_
 file.
 
