Autopilot

Merge lp:~veebers/autopilot/adding-run-instructions-readme into lp:autopilot

adding-run-instructions-readme
Merge into trunk

Proposed by Christopher Lee on 2015-01-21

Status:	Merged
Approved by:	Christopher Lee on 2015-01-22
Approved revision:	534
Merged at revision:	534
Proposed branch:	lp:~veebers/autopilot/adding-run-instructions-readme
Merge into:	lp:autopilot
Diff against target:	110 lines (+38/-9) 2 files modified README (+29/-0) docs/tutorial/running_ap.rst (+9/-9)
To merge this branch:	bzr merge lp:~veebers/autopilot/adding-run-instructions-readme
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Approve on 2015-01-22
Nicholas Skaggs (community)			Needs Fixing on 2015-01-22
Thomi Richards (community)		2015-01-21	Approve on 2015-01-21
Review via email: mp+247088@code.launchpad.net

Commit Message

Adding details to README re: running/listing autopilot tests.

Description of the Change

Adding details to README re: running/listing autopilot tests.

Thomi Richards (thomir) wrote on 2015-01-21:

please remove spurious whitespace changes, and fix one comment on awkward english.

review: Needs Fixing

Thomi Richards (thomir) on 2015-01-21:

review: Approve

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/980/rebuild

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-01-21:

review: Needs Fixing (continuous-integration)

Nicholas Skaggs (nskaggs) wrote on 2015-01-22:

See comments. So nice to have this info though!

review: Needs Fixing

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

FAILED: Continuous integration, rev:533
http://jenkins.qa.ubuntu.com/job/autopilot-ci/996/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-ci/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-ci/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-ci/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/77/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/502/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/996/rebuild

review: Needs Fixing (continuous-integration)

PS Jenkins bot (ps-jenkins) on 2015-01-22:

review: Approve (continuous-integration)

PS Jenkins bot (ps-jenkins) wrote on 2015-01-22:

review: Needs Fixing (continuous-integration)

PS Jenkins bot (ps-jenkins) on 2015-01-22:

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Autopilot Hackers

Chris Gagnon

Christopher Lee

 === modified file 'README'
 --- README	2015-01-20 03:33:54 +0000
 +++ README	2015-01-22 18:01:22 +0000
@@ -44,6 +44,35 @@
  	$ xdg-open build/sphinx/html/index.html
++
++Running and Listing tests
++=========================
++
++Normally running autopilot tests is as easy as::
++
++    $ autopilot3 run <test id>
++
++There are some complexities when attempting to run the autopilot tests from
++within a development branch (this related to how autopilot modules are loaded
++and then used to attempt to collect the required tests).
++
++For that reason when running autopilot's tests while hacking on it it is
++advised to run autopilot in this manner::
++
++    $ python3 -m autopilot.run run autopilot.tests.unit
++
++Listing is similar::
++
++    $ python3 -m autopilot.run list autopilot.tests.unit
++
++For a more complete explanation for running or listing tests please see the
++full documentation found here:
++https://developer.ubuntu.com/api/devel/ubuntu-14.10/python/autopilot/tutorial/running_ap.html
++
++If you are in the root of the autopilot source tree this will run/list the tests from
++within that local module. Otherwise autopilot will look in the system python path.
++
++
  Release Manual Tests
  ====================
 === modified file 'docs/tutorial/running_ap.rst'
 --- docs/tutorial/running_ap.rst	2015-01-22 03:29:46 +0000
 +++ docs/tutorial/running_ap.rst	2015-01-22 18:01:22 +0000
@@ -8,11 +8,11 @@
  Autopilot can list all tests found within a particular module::
--    $ autopilot list <modulename>
++    $ autopilot3 list <modulename>
  where *<modulename>* is the base name of the module you want to look at. The module must either be in the current working directory, or be importable by python. For example, to list the tests inside autopilot itself, you can run::
--     $ autopilot list autopilot
++     $ autopilot3 list autopilot
          autopilot.tests.test_ap_apps.GtkTests.test_can_launch_qt_app
          autopilot.tests.test_ap_apps.QtTests.test_can_launch_qt_app
          autopilot.tests.test_application_mixin.ApplicationSupportTests.test_can_create
@@ -39,7 +39,7 @@
  Running autopilot tests is very similar to listing tests::
--    $ autopilot run <modulename>
++    $ autopilot3 run <modulename>
  However, the run command has many more options to customize the run behavior:
@@ -70,19 +70,19 @@
 . **Run autopilot and save the test log**::
--    $ autopilot run -o . <modulename>
++    $ autopilot3 run -o . <modulename>
    Autopilot will create a text log file named <hostname>_<dd.mm.yyy_HHMMSS>.log with the contents of the test log.
 . **Run autopilot and record failing tests**::
--    $ autopilot run -r --rd . <modulename>
++    $ autopilot3 run -r --rd . <modulename>
    Videos are recorded as *ogg-vorbis* files, with an .ogv extension. They will be named with the test id that failed. All videos will be placed in the directory specified by the ``-rd`` option - in this case the currect directory. If this option is omitted, videos will be placed in ``/tmp/autopilot/``.
 . **Save the test log as jUnitXml format**::
--    $ autopilot run -o results.xml -f xml <modulename>
++    $ autopilot3 run -o results.xml -f xml <modulename>
    The file 'results.xml' will be created when all the tests have completed, and will be in the jUnitXml file format. This is useful when running the autopilot tests within a jenkins environment.
@@ -94,18 +94,18 @@
  In order to be able to introspect an application, it must first be launched with introspection enabled. Autopilot provides the **launch** command to enable this: ::
      $ autopilot3 launch <application> <app_parameters>
--
++
  The *<application>* parameter could be the full path to the application, or the name of an application located somewhere on ``$PATH``. *<app_parameter>* is passed on to the application being launched.
  A simple Gtk example to launch gedit::
      $ autopilot3 launch gedit
--A Qt example which passes on parameters to the application being launched::
++A Qt example which passes on parameters to the application being launched::
      $ autopilot3 launch qmlscene my_app.qml
--Autopilot launch attempts to detect if you are launching either a Gtk or Qt application so that it can enable the correct libraries. If it is unable to determine this you will need to specify the type of application it is by using the -i argument. This allows "Gtk" or "Qt" frameworks to be specified when launching the application. The default value ("Auto") will try to detect which interface to load automatically.
++Autopilot launch attempts to detect if you are launching either a Gtk or Qt application so that it can enable the correct libraries. If it is unable to determine this you will need to specify the type of application it is by using the -i argument. This allows "Gtk" or "Qt" frameworks to be specified when launching the application. The default value ("Auto") will try to detect which interface to load automatically.
  A typical error in this situation will be "Error: Could not determine introspection type to use for application". In which case the -i option should be specified with the correct application framework type to fix the problem::