Home Explore Help
Register Sign In
Shenzhen_SD
/
openpbs
3
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: eee0307f42
Branches Tags
openpbs
/
test
/
fw
/
doc
/
intro.rst

intro.rst 2.2 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 
  1. Introduction of PbsTestLab
    2. 

  2. ==========================
    3. 

  3. 

  4. Command line tools
    5. 

  5. ------------------
    6. 

  6. 

  7. - :ref:`pbs_benchpress <pbs_benchpress>` used to run unit tests
    8. 

  8. - :ref:`pbs_loganalyzer <pbs_loganalyzer>` used to analyze PBS logs
    9. 

  9. - :ref:`pbs_stat <pbs_stat>` used to filter PBS objects based on select properties
    10. 

  10. - :ref:`pbs_config <pbs_config>` used to configure services, e.g., create vnodes
    11. 

  11. - :ref:`pbs_py_spawn <pbs_py_spawn>` used to invoke a pbs_py_spawn action associated to a job running on a MoM
    12. 

  12. 

  13. Library
    14. 

  14. -------
    15. 

  15. 

  16. - Provides PBS IFL operations through either SWIG-wrappers or PBS CLI e.g. qstat, qsub etc.
    17. 

  17. - Encapsulated PBS entities: :py:class:`~ptl.lib.pbs_testlib.Server`, :py:class:`~ptl.lib.pbs_testlib.Scheduler`,
    18. 

  18.   :py:class:`~ptl.lib.pbs_testlib.MoM`, :py:class:`~ptl.lib.pbs_testlib.Comm`, :py:class:`~ptl.lib.pbs_testlib.Queue`,
    19. 

  19.   :py:class:`~ptl.lib.pbs_testlib.Job`, :py:class:`~ptl.lib.pbs_testlib.Reservation`, :py:class:`~ptl.lib.pbs_testlib.Hook`,
    20. 

  20.   :py:class:`~ptl.lib.pbs_testlib.Resource`
    21. 

  21. - Utility class to convert batch status and attributes to Python lists, strings and dictionaries
    22. 

  22. - High-level PBS operations to operate on PBS entities including nodes, queues, jobs, reservations, resources, and server
    23. 

  23. 

  24. Utilities
    25. 

  25. ---------
    26. 

  26. 

  27. - Logging to parse and report metrics from :py:class:`Server <ptl.utils.pbs_logutils.PBSServerLog>`, :py:class:`Scheduler <ptl.utils.pbs_logutils.PBSSchedulerLog>`,
    28. 

  28.   :py:class:`MoM <ptl.utils.pbs_logutils.PBSMoMLog>` and :py:class:`Accounting <ptl.utils.pbs_logutils.PBSAccountingLog>` logs.
    29. 

  29. - Distributed tools to transparently run commands locally or remotely, including file copying.
    30. 

  30. 

  31. Plugins
    32. 

  32. -------
    33. 

  33. 

  34. - Provides utilities to load, run and get info of test cases in form of `Nose framework`_ plugins
    35. 

  35. 

  36. Documentation
    37. 

  37. -------------
    38. 

  38. 

  39. - API documentation describing the capabilities of the framework and utilities
    40. 

  40. - For the command-line tools use the -h option for help
    41. 

  41. 

  42. Directory structure
    43. 

  43. -------------------
    44. 

  44. 

  45. ::
    46. 

  46. 

  47.     fw
    48. 

  48.     |- bin -- Command line tools
    49. 

  49.     |- doc -- Documentation
    50. 

  50.     `- ptl -- PTL package
    51. 

  51.        |- lib -- Library
    52. 

  52.        `- utils -- Utilities
    53. 

  53.           `- plugins -- plugins of PTL for Nose framework
    54. 

  54. 

  55. .. _Nose framework: http://readthedocs.org/docs/nose/
    56.