AutoQA resultsdb API: Difference between revisions

Revision as of 13:25, 12 April 2010

Draft
This page is only draft, and will change in time.

Syntax Description

method_name (arg1, [arg2, arg3 = "Foo"]) -> return_value

method_name ~ name of the respective method (see #Methods)
arg1 ~ required argument
arg2 ~ optional argument, default value is set to None
arg3 ~ optional argument, default value is set to "Foo"
-> return_value ~ method gives back the return_value

Methods

start_job

start_job ([testplan_url]) -> job_id

end_job

end_job (job_id)

start_testrun

start_testrun (test_url, [job_id]) -> testrun_id

end_testrun

end_testrun (testrun_id, result, [keyval_pairs, summary, highlights])

start_phase

start_phase (testrun_id, name)

end_phase

end_phase (testrun_id, result)

store_keyval

store_keyval (testrun_id, keyval_pairs)

Workflows

Simple

testrun_id = start_testrun ("http://fedoraproject.org/wiki/QA:Some_test_page")
end_testrun (testrun_id, "PASSED")

Phases - simple

testrun_id = start_testrun ("http://fedoraproject.org/wiki/QA:Some_test_page")
  start_phase (testrun_id, "First phase")
  end_phase (testrun_id, "PASSED")
  start_phase (testrun_id, "Second phase")
  end_phase (testrun_id, "PASSED")
end_testrun (testrun_id, "PASSED")

Phases - nested

testrun_id = start_testrun ("http://fedoraproject.org/wiki/QA:Some_test_page")
  start_phase (testrun_id, "First phase")
    start_phase (testrun_id, "Second phase")
    end_phase (testrun_id, "PASSED")
  end_phase (testrun_id, "PASSED")
end_testrun (testrun_id, "PASSED")

Using Job

job_id = start_job ()
  testrun_id = start_testrun ("http://fedoraproject.org/wiki/QA:Some_test_page")
    start_phase (testrun_id, "First phase")
    end_phase (testrun_id, "PASSED")
  end_testrun (testrun_id, "PASSED")

  testrun_id = start_testrun ("http://fedoraproject.org/wiki/QA:Some_other_test_page")
    start_phase (testrun_id, "First phase")
    end_phase (testrun_id, "PASSED")
  end_testrun (testrun_id, "PASSED")

@@ Line 13: / Line 13: @@
 == Methods ==
-=== start_job ([testplan_url]) -> job_id ===
+=== start_job===
-=== end_job (job_id) ===
-=== start_testrun (test_url, [job_id]) -> testrun_id ===
+<code>start_job ([testplan_url]) -> job_id </code>
-=== end_testrun (testrun_id, result, [keyval_pairs, summary, highlights]) ===
-=== start_phase (testrun_id, name) -> phase_id ===
+=== end_job===
-=== end_phase (testrun_id, result) ===
-=== store_keyval (testrun_id, keyval_pairs) ===
+<code>end_job (job_id) </code>
+=== start_testrun ===
+<code>start_testrun (test_url, [job_id]) -> testrun_id</code>
+=== end_testrun ===
+<code>end_testrun (testrun_id, result, [keyval_pairs, summary, highlights])</code>
+=== start_phase ===
+<code>start_phase (testrun_id, name)</code>
+=== end_phase ===
+<code>end_phase (testrun_id, result)</code>
+=== store_keyval ===
+<code>store_keyval (testrun_id, keyval_pairs)</code>
 == Workflows ==

Search