Welcome to xayah’s documentation!

Xayah is a testing tool with test report functionality.

Xayah allows to execute single or several test classes (test suites) separately. After executing tests, test report is generated and be parsed to HTML or passed to telegram bot message.

Example of simple test:

   from xayah import TestSuite, TestResult

   def add(a, b):
      return a + b

   @TestSuite.init
   class TestAdd:
      def test_add(self):
         assert add(2, 3) == 5

   # generating a test report
   TestAdd.run_test_cases()
   report = TestResult().create_test_result()

Modules:

• Test Suite
  • Init
  • Title
  • Before all
  • After all
  • Parametrization
• Test Case
  • Title
  • Description
  • Link
  • Severity
  • Skip
  • Additional params
• Test Result
  • Attributes:
  • Create test result
  • Test result schema
• Steps
  • Step
  • Check
• Shared Data