Autopilot

Merge lp:~canonical-platform-qa/autopilot/launch-cmd-doc into lp:autopilot

launch-cmd-doc
Merge into trunk

Proposed by Richard Huddie on 2015-01-15

Status:	Superseded
Proposed branch:	lp:~canonical-platform-qa/autopilot/launch-cmd-doc
Merge into:	lp:autopilot
Diff against target:	43 lines (+28/-1) 1 file modified docs/tutorial/running_ap.rst (+28/-1)
To merge this branch:	bzr merge lp:~canonical-platform-qa/autopilot/launch-cmd-doc
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Needs Fixing on 2015-01-19
Christopher Lee (community)			Needs Fixing on 2015-01-19
Nicholas Skaggs (community)			Needs Fixing on 2015-01-16
Allan LeSage (community)		2015-01-15	Needs Fixing on 2015-01-15
Review via email: mp+246601@code.launchpad.net

Commit Message

Add a new section that includes how to use autopilot launch command. Also update references of autopilot to autopilot3 in existing material.

Description of the Change

Add a new section that includes how to use autopilot launch command. Also update references of autopilot to autopilot3 in existing material.

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

Left comments about ordering and expansion.

review: Needs Fixing

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

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

review: Needs Fixing (continuous-integration)

Allan LeSage (allanlesage) wrote on 2015-01-15:

Agree with Nick's suggestion concerning placement of launch doc on page, else looks fine.

review: Needs Fixing

lp:~canonical-platform-qa/autopilot/launch-cmd-doc updated on 2015-01-16

522. By Richard Huddie on 2015-01-16: Fix review comments, move launch before vis, add -i option and also remove the 3s as this will be done in another mp
523. By Richard Huddie on 2015-01-16: remove last autopilot3 reference

Richard Huddie (rhuddie) wrote on 2015-01-16:

Thanks. I have made updates accordingly. I have also removed the changes to use autopilot3, so this will be easier to merge with other updates.

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

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

review: Needs Fixing (continuous-integration)

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

Thanks for removing the autopilot3 refs; should be easier to merge multiple mp's now. Some more nit picky stuff, but I think we're close. Thanks Richard!

review: Needs Fixing

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

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

review: Needs Fixing (continuous-integration)

Christopher Lee (veebers) wrote on 2015-01-19:

There is currently text in the faq covering this (titled: 'Autopilot Qt & Gtk Support'). Perhaps we need to amalgamate these sections so we're not repeating ourselves. (Perhaps in the faq section was a silly place to put this initially :-)).

review: Needs Fixing

lp:~canonical-platform-qa/autopilot/launch-cmd-doc updated on 2015-01-19

524. By Richard Huddie on 2015-01-19: Address latest review comments. Add app parameters, include framework error, use some info from faq page

Richard Huddie (rhuddie) wrote on 2015-01-19:

Thanks Nicholas, Chris, I have made updates to fix those issues.

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

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

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/autopilot/launch-cmd-doc updated on 2015-01-20

525. By Thomi Richards on 2015-01-20: Various cleanups.

Unmerged revisions

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

Canonical Platform QA Team

Chris Gagnon

 === modified file 'docs/tutorial/running_ap.rst'
 --- docs/tutorial/running_ap.rst	2013-06-24 04:02:17 +0000
 +++ docs/tutorial/running_ap.rst	2015-01-20 02:51:37 +0000
@@ -86,12 +86,39 @@
    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.
++.. _launching_application_to_introspect:
++
++Launching an Application to Introspect
++--------------------------------------
++
++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::
++
++    $ 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.
++
++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::
++
++    $ autopilot3 launch -i Qt address-book-app
++
++Once an application has launched with introspection enabled, it will be possible to launch autopilot vis and view the introspection tree, see: :ref:`visualise_introspection_tree`.
++
  .. _visualise_introspection_tree:
  Visualise Introspection Tree
  ----------------------------
--A very common thing to want to do while writing autopilot tests is see the structure of the application being tested. To support this, autopilot includes a simple application to help visualize the introspection tree. To start it, make sure the application you wish to test is running, and then run::
++A very common thing to want to do while writing autopilot tests is see the structure of the application being tested. To support this, autopilot includes a simple application to help visualize the introspection tree. To start it, make sure the application you wish to test is running (see: :ref:`launching_application_to_introspect`), and then run::
      $ autopilot vis