Merge lp:~allanlesage/ueqa-code-proposals/indicator-datetime into lp:ueqa-code-proposals

[Allan LeSage]

Adapt to style review.

Some style revisions per jfunk/thomi.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:14
http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-ci/12/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-amd64-ci/12
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-armhf-ci/12
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-i386-ci/12

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ueqa-code-proposals-ci/12/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Needs TOC otherwise looks good

review: Needs Fixing

[lp:~allanlesage/ueqa-code-proposals/indicator-datetime]

15. By Allan LeSage on 2014-11-26

Add TOC.

16. By Allan LeSage on 2014-11-26

Merge trunk, resolving conflict.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:15
http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-ci/14/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-amd64-ci/14/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-armhf-ci/14/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ueqa-code-proposals-vivid-i386-ci/14/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ueqa-code-proposals-ci/14/rebuild

review: Needs Fixing (continuous-integration)

[Christopher Lee (veebers)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'index.rst'
--- index.rst	2014-11-26 20:54:14 +0000
+++ index.rst	2014-11-26 23:01:42 +0000
@@ -12,6 +12,7 @@
    :maxdepth: 1
    :glob:
 
+   proposals/indicator-datetime/index
    proposals/indicator-messages/index
    proposals/*
 

=== added directory 'proposals/indicator-datetime'
=== renamed file 'proposals/indicator_datetime_clock_helper.py' => 'proposals/indicator-datetime/clock_helper.py'
=== renamed file 'proposals/indicator-datetime.rst' => 'proposals/indicator-datetime/index.rst'
--- proposals/indicator-datetime.rst	2014-11-24 22:31:40 +0000
+++ proposals/indicator-datetime/index.rst	2014-11-26 23:01:42 +0000
@@ -1,10 +1,14 @@
 Indicator Datetime
 ==================
 
+.. contents::
+
 Here UEQA offers specification of some needed "helpers" pursuant to an end-to-end test of indicator-datetime.
 
-End-To-End Test
----------------
+.. note:: All the code paths of the test helpers must also be tested on their respective projects.
+
+Target Functional/Integration Test
+----------------------------------
 
 * Open the clock app
 * Set an alarm:
@@ -32,38 +36,22 @@
 * Swipe open indicator-datetime
 * No alarm item must appear in the menu
 
-Component Helpers
------------------
+Deliverables
+------------
+.. note:: Unless otherwise specified, all python code is to written in Python 3.
 
-Real Time Clock Helper
-~~~~~~~~~~~~~~~~~~~~~~
+Unity APIs: Real Time Clock Helper
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 We need a mock real time clock so that we can manipulate the system time during end-to-end autopilot tests.  A sample interface is offered below; this adds only the set_time function as shown in the `systemd timedated interface <http://www.freedesktop.org/wiki/Software/systemd/timedated/>`_.
 
-.. literalinclude:: indicator_datetime_clock_helper.py
-
-UI Elements
-~~~~~~~~~~~
-As described in the `Ubuntu developer documentation <http://developer.ubuntu.com/apps/platform/guides/acceptance-testing-using-the-page-object-model>`_, adopt the page-object model and provide UI helpers for elements necessary to the test.  See below for a snippet with required helper stubs.
-
-.. literalinclude:: indicator_datetime_ui_helpers.py
-
-Technology Requirements
-~~~~~~~~~~~~~~~~~~~~~~~
-* Written in Python3
-
-* Helpers need automated tests
-
-Packaging
----------
-
-Component Helpers
-~~~~~~~~~~~~~~~~~
-It is suggested dthat the component helper code (i.e. the RTC helper) be packaged as indicator-datetime-autopilot.
-
-End-to-End Test
-~~~~~~~~~~~~~~~
-The test itself should reside in the existing Unity8 autopilot test suite (i.e. autopilot/unity8/indicators).
-
-Clock App Autopilot Packaging
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. literalinclude:: clock_helper.py
+
+Community: Clock App Autopilot Packaging
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The ubuntu-clock-app supplies useful helpers, e.g. to `add an alarm <http://bazaar.launchpad.net/~ubuntu-clock-dev/ubuntu-clock-app/utopic-3.0/view/head:/tests/autopilot/ubuntu_clock_app/emulators.py#L184>`_.  These belong in a new ``ubuntu-clock-app-autopilot`` package.
+
+Shell: Test Helpers for Datetime Indicator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+For the datetime indicator, As described in the `Ubuntu developer documentation <http://developer.ubuntu.com/apps/platform/guides/acceptance-testing-using-the-page-object-model>`_, adopt the page-object model and provide UI helpers for elements necessary to the test.  See below for a snippet with required helper stubs.
+
+.. literalinclude:: unity_ui.py

=== renamed file 'proposals/indicator_datetime_ui_helpers.py' => 'proposals/indicator-datetime/unity_ui.py'