Autopilot

Merge lp:~canonical-platform-qa/autopilot/custom-assert-doc into lp:autopilot

custom-assert-doc
Merge into trunk

Proposed by Thomi Richards on 2015-01-20

Status:	Merged
Approved by:	Leo Arias on 2015-01-20
Approved revision:	526
Merged at revision:	525
Proposed branch:	lp:~canonical-platform-qa/autopilot/custom-assert-doc
Merge into:	lp:autopilot
Diff against target:	79 lines (+55/-1) 2 files modified docs/tutorial/advanced_autopilot.rst (+53/-1) docs/tutorial/good_tests.rst (+2/-0)
To merge this branch:	bzr merge lp:~canonical-platform-qa/autopilot/custom-assert-doc
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration	2015-01-20	Approve on 2015-01-20
Thomi Richards (community)			Approve on 2015-01-20
Leo Arias		2015-01-20	Pending
Christopher Lee		2015-01-20	Pending
Allan LeSage		2015-01-20	Pending
Review via email: mp+246963@code.launchpad.net

Commit Message

Add missing documentation for custom assert methods in advanced autopilot tutorial.

Description of the Change

Add missing documentation for custom assert methods in advanced autopilot tutorial.

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

Resubmitted to take into account fixes now in trunk.

review: Approve

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

FAILED: Autolanding.
No commit message was specified in the merge proposal. Hit 'Add commit message' on the merge proposal web page or follow the link below. You can approve the merge proposal yourself to rerun.
https://code.launchpad.net/~canonical-platform-qa/autopilot/custom-assert-doc/+merge/246963/+edit-commit-message

review: Needs Fixing (continuous-integration)

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

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

review: Approve (continuous-integration)

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

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/autopilot-autolanding/290/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-amd64-autolanding/7/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-armhf-autolanding/7/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-vivid-i386-autolanding/7/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-vivid-autopilot/46/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-amd64/457/console

review: Needs Fixing (continuous-integration)

lp:~canonical-platform-qa/autopilot/custom-assert-doc updated on 2015-01-20

526. By Richard Huddie on 2015-01-20: merge trunk

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

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

review: Needs Fixing (continuous-integration)

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

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

review: Approve (continuous-integration)

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

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

Canonical Platform QA Team

Chris Gagnon

 === modified file 'docs/tutorial/advanced_autopilot.rst'
 --- docs/tutorial/advanced_autopilot.rst	2015-01-20 08:40:37 +0000
 +++ docs/tutorial/advanced_autopilot.rst	2015-01-20 10:51:37 +0000
@@ -159,10 +159,62 @@
  The :class:`fixtures.EnvironmentVariable` fixture will revert the value of the environment variable to it's initial value, or will delete it altogether if the environment variable did not exist when :class:`fixtures.EnvironmentVariable` was instantiated. This happens in the cleanup phase of the test execution.
++.. _custom_assertions:
++
  Custom Assertions
  =================
--.. Document the custom assertion methods present in AutopilotTestCase
++Autopilot provides additional custom assertion methods within the :class:`~autopilot.testcase.AutopilotTestCase` base class. These assertion methods can be used for validating the visible window stack and also properties on objects whose attributes do not have the ``wait_for`` method, such as :class:`~autopilot.process.Window` objects (See :ref:`wait_for` for more information about ``wait_for``).
++
++:py:mod:`autopilot.testcase.AutopilotTestCase.assertVisibleWindowStack`
++
++This assertion allows the test to check the start of the visible window stack by passing an iterable item of :class:`~autopilot.process.Window` instances. Minimised windows will be ignored::
++
++    from autopilot.process import ProcessManager
++    from autopilot.testcase import AutopilotTestCase
++
++
++    class WindowTests(AutopilotTestCase):
++
++        def test_window_stack(self):
++            self.launch_some_test_apps()
++            pm = ProcessManager.create()
++            test_app_windows = []
++            for window in pm.get_open_windows():
++                if self.is_test_app(window.name):
++                    test_app_windows.append(window)
++            self.assertVisibleWindowStack(test_app_windows)
++
++.. note:: The process manager is only available on environments that use bamf, i.e. desktop running Unity 7. There is currently no process manager for any other platform.
++
++.. _custom_assertions_assertProperty:
++
++:py:mod:`autopilot.testcase.AutopilotTestCase.assertProperty`
++
++This assertion allows the test to check properties of an object that does not have a **wait_for** method (i.e.- objects that do not come from the autopilot DBus interface). For example the :py:mod:`~autopilot.process.Window` object::
++
++    from autopilot.process import ProcessManager
++    from autopilot.testcase import AutopilotTestCase
++
++
++    class WindowTests(AutopilotTestCase):
++
++        def test_window_stack(self):
++            self.launch_some_test_apps()
++            pm = ProcessManager.create()
++            for window in pm.get_open_windows():
++                if self.is_test_app(window.name):
++                    self.assertProperty(window, is_maximized=True)
++
++.. note:: :py:mod:`~autopilot.testcase.AutopilotTestCase.assertProperties` is a synonym for this method.
++
++.. note:: The process manager is only available on environments that use bamf, i.e. desktop running Unity 7. There is currently no process manager for any other platform.
++
++:py:mod:`autopilot.testcase.AutopilotTestCase.assertProperties`
++
++See :ref:`autopilot.testcase.AutopilotTestCase.assertProperty <custom_assertions_assertProperty>`.
++
++.. note:: :py:mod:`~autopilot.testcase.AutopilotTestCase.assertProperty` is a synonym for this method.
  .. _platform_selection:
 === modified file 'docs/tutorial/good_tests.rst'
 --- docs/tutorial/good_tests.rst	2014-05-16 02:09:23 +0000
 +++ docs/tutorial/good_tests.rst	2015-01-20 10:51:37 +0000
@@ -339,6 +339,8 @@
  Note that you can pass any object that follows the testtools matcher protocol (so you can write your own matchers, if you like).
++.. _wait_for:
++
  In Proxy Classes
  ----------------