Merge lp:~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix into lp:ubuntu-system-settings

[Bartosz Kosiorek]

Updated README file with information about building and running (LP: #1350687)

Updated README file with information about building and running (LP: #1350687)

[Jonas G. Drange (jonas-drange)]

Looks good, thanks! I added some comments inline.

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1545
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/2438/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/4693
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-amd64-ci/213
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/622
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/3786
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4690
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4690/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24316

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/2438/rebuild

review: Needs Fixing (continuous-integration)

[lp:~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix]

1546. By Bartosz Kosiorek on 2015-10-19

Updates after review

[Bartosz Kosiorek (gang65)]

Thanks Jonas for review.
I would like to fix some issues in system-settings, and I thought that creating README will be nice starting point :-)

I have a few question for you:
How do you build system-settings?
How do you run test ?
How do you updates translations?

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1546
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/2439/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/4696
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-amd64-ci/214
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/623
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/3789
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4693
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4693/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24319

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/2439/rebuild

review: Needs Fixing (continuous-integration)

[Jonas G. Drange (jonas-drange)]

On 19 October 2015 at 05:02, Bartosz Kosiorek <email address hidden> wrote:

> I would like to fix some issues in system-settings, and I thought that
> creating README will be nice starting point :-)
>
>
​Great! It is :)​

> I have a few question for you:
> How do you build system-settings?
>

​Similarly to what you have proposed, but without ninja and eight
concurrent jobs.​ ;)

> How do you run test ?
>

​Now, that's a good question. We have unit tests, python formatting tests
as well as autopilot tests. Running the unit tests is done using “make
test”, but there's no definitive way of running the autopilot tests. I
usually cd to test/autopilot and run “autopilot3 run -v
ubuntu_system_settings.tests”, but it should be trivial to add this to the
makefile.
​

> How do you updates translations?
>

​IIRC it is done by the infrastructure, but maybe others can chime in on
this.​

[Sebastien Bacher (seb128)]

> How do you updates translations?

There is a "pot" make target that updates the template (po/ubuntu-system-settings.pot), that's done automatically during the package build [1].

We enabled the auto import from the package to launchpad and are using ubuntu translations, the currently used serie for the phone image is ubuntu-rtm/15.04 and translations can be done on
https://translations.launchpad.net/ubuntu-rtm/15.04/+source/ubuntu-system-settings
(the url might change when we rebase on another serie)

The translations are then exported from launchpad to language-packs which are included on the system images

[1] http://bazaar.launchpad.net/~system-settings-touch/ubuntu-system-settings/trunk/view/head:/debian/rules#L17

[lp:~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix]

1547. By Bartosz Kosiorek on 2015-10-20

Further updating README file

1548. By Bartosz Kosiorek on 2015-10-20

Small fix

[Bartosz Kosiorek (gang65)]

I tried to run autopilot tests, from directory: tests/autopilot, with command:
   $ autopilot3 run ubuntu_system_settings

Unfortunately I have following error (I think I miss maliit server):

ERROR: unittest.loader.ModuleImportFailure.ubuntu_system_settings.tests.test_notifications
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/autopilot/run.py", line 438, in _filter_tests
    test.debug()
  File "/usr/lib/python3.4/unittest/case.py", line 630, in debug
    getattr(self, self._testMethodName)()
  File "/usr/lib/python3.4/unittest/loader.py", line 32, in testFailure
    raise exception
ImportError: Failed to import test module: ubuntu_system_settings.tests.test_notifications
Traceback (most recent call last):
  File "/usr/lib/python3.4/unittest/loader.py", line 312, in _find_tests
    module = self._get_module_from_name(name)
  File "/usr/lib/python3.4/unittest/loader.py", line 290, in _get_module_from_name
    __import__(name)
  File "/home/kosiorek/dev/core/ubuntu-system-settings-readme-fix/tests/autopilot/ubuntu_system_settings/__init__.py", line 21, in <module>
    from ubuntu_system_settings.utils.i18n import ugettext as _
  File "/home/kosiorek/dev/core/ubuntu-system-settings-readme-fix/tests/autopilot/ubuntu_system_settings/utils/__init__.py", line 1, in <module>
    from ubuntuuitoolkit._custom_proxy_objects._common \
ImportError: cannot import name 'is_maliit_process_running'

How I could install maliit server?

review: Needs Information

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1548
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/2443/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/4733
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-amd64-ci/218
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/627
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/3820
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4730
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4730/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24402

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/2443/rebuild

review: Needs Fixing (continuous-integration)

[Jonas G. Drange (jonas-drange)]

On 20 October 2015 at 22:58, Bartosz Kosiorek <email address hidden> wrote:

> Review: Needs Information
>
> I tried to run autopilot tests, from directory: tests/autopilot, with
> command:
> $ autopilot3 run ubuntu_system_settings
>
> Unfortunately I have following error (I think I miss maliit server):
>

​Maybe you're missing a package listed in $ apt-cache show
ubuntu-system-settings-autopilot | grep Depends​

[lp:~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix]

1549. By Bartosz Kosiorek on 2015-10-28

Fix autopilot test, when system-settings is installed in /usr/local/bin/system-settings

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1549
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/2452/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/4872
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-amd64-ci/227
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/636
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/3919
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4869
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4869/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24628

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/2452/rebuild

review: Needs Fixing (continuous-integration)

[Bartosz Kosiorek (gang65)]

Unfortunately I don't know why it is failing.

On my othe MR, the problem is the same:
https://code.launchpad.net/~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix/+merge/274811

Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/ubuntu_system_settings/tests/test_system_updates.py", line 91, in test_no_updates_state
    updates.state.wait_for("NOUPDATES")
  File "/usr/lib/python3/dist-packages/autopilot/introspection/types.py", line 180, in wait_for
    failure_msg))
AssertionError: After 10.0 seconds test on SystemUpdatesPage.state failed: 'NOUPDATES' != dbus.String('SEARCHING', variant_level=1)

review: Needs Information

[Bartosz Kosiorek (gang65)]

I mean following MR:
https://code.launchpad.net/~gang65/ubuntu-system-settings/ubuntu-system-settings-remove-retry-button/+merge/275572

review: Needs Information

[lp:~gang65/ubuntu-system-settings/ubuntu-system-settings-readme-fix]

1550. By Bartosz Kosiorek on 2015-11-01

Further updating README file

1551. By Bartosz Kosiorek on 2015-11-01

Merge with trunk.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1551
http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-ci/2461/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/4962
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-amd64-ci/236
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-system-settings-vivid-i386-ci/645
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/3985
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4959
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/4959/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24776

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-system-settings-ci/2461/rebuild

review: Needs Fixing (continuous-integration)

[Bartosz Kosiorek (gang65)]

Is it possible to merge these changes into trunk?
What needs to be fixed?

review: Needs Information

Unmerged revisions

1551. By Bartosz Kosiorek on 2015-11-01

Merge with trunk.

1550. By Bartosz Kosiorek on 2015-11-01

Further updating README file

1549. By Bartosz Kosiorek on 2015-10-28

Fix autopilot test, when system-settings is installed in /usr/local/bin/system-settings

1548. By Bartosz Kosiorek on 2015-10-20

Small fix

1547. By Bartosz Kosiorek on 2015-10-20

Further updating README file

1546. By Bartosz Kosiorek on 2015-10-19

Updates after review

1545. By Bartosz Kosiorek on 2015-10-17

[ Bartosz Kosiorek ]
Updated README file with information about building and running (LP: #1350687)

=== modified file 'README'
--- README	2014-09-24 14:49:06 +0000
+++ README	2015-11-01 12:05:20 +0000
@@ -4,3 +4,95 @@
 https://launchpad.net/ubuntu-system-settings
 https://wiki.ubuntu.com/SystemSettings
 
+
+= Preparing environment =
+
+You need to download source code with using command:
+
+   $ bzr branch lp:ubuntu-system-settings branch-name
+   $ cd branch-name
+
+You need to install all necessary packages needed for build.
+The easiest way to install dependend packages is to run command:
+
+   $ sudo apt-get build-dep ubuntu-system-settings
+
+Unfortunately some packages still could be missing (because we are working on trunk branch). 
+The list of all requried packages is available at file: debian/control
+You could install missing packages by using apt-get command. For example:
+
+   $ sudo apt-get install libubuntu-download-manager-client-dev libubuntuoneauth-2.0-dev \
+     libtrust-store-dev libupower-glib-dev libaccountsservice-dev libtimezonemap1-dev
+
+
+= Building =
+
+The build system uses CMake. To compile, create "builddir" directory 
+(to separate build artefacts from source code). Then invoke cmake generation 
+process and start build :
+
+   $ mkdir builddir && cd builddir
+   $ cmake .. && cmake --build . -- -j 5
+
+To speed up generation and compilation, you could use Ninja generator instead of Make:
+
+   $ mkdir builddir && cd builddir
+   $ cmake .. -G Ninja && cmake --build .
+
+
+= Running application =
+
+To run application you need to type command:
+
+For Make generator:
+
+   $ sudo make install
+
+For Ninja generator:
+
+   $ sudo ninja install
+
+Then from builddir run command:
+
+   $ ./src/system-settings
+
+
+= Running Unit Tests =
+
+Unit Tests help with testing the internal working of components while
+autopilot tests help with testing the UI workflow as experience by the user.
+Running unit tests is quite simple and very fast.
+
+If you want to run all tests, then run the following command from the builddir,
+
+   $ ctest --output-on-failure
+   
+If you want more verbose output, then run,
+
+   $ ctest -VV
+
+You could filter individual tests by using "-R <regex>" or "--tests-regex <regex>" parameter.
+For example to run only tests which contains "bluetooth" word you could specify:
+
+   $ ctest --tests-regex bluetooth
+
+
+= Running autopilot tests
+
+Autopilot tests are functional tests, which emulate using application by touch.
+Remember to setup language to US before running autopilot tests,
+to pass tests successfully.
+
+To run autopilot tests, you need following packages:
+
+   $ sudo apt-get install ubuntu-ui-toolkit-autopilot python3-autopilot
+
+To run all tests type commands:
+
+   $ cd tests/autopilot
+   $ autopilot3 run ubuntu_system_settings -v
+
+To see what test cases a test suite has, and selectively run only some of them, use:
+   $ autopilot3 list ubuntu_system_settings
+   
+

=== modified file 'debian/changelog'
--- debian/changelog	2015-10-29 15:48:09 +0000
+++ debian/changelog	2015-11-01 12:05:20 +0000
@@ -41,7 +41,11 @@
   * [phone] encode numbers before passing them to url-dispatcher (LP:
     #1496845)
 
- -- Ken VanDine <[e-mail]>  Fri, 02 Oct 2015 17:52:49 +0000
+  [ Bartosz Kosiorek ]
+  * Updated README file with information about building and running (LP: #1350687)
+ 
+ -- Bartosz Kosiorek <[e-mail]>  Sun, 18 Oct 2015 00:10:12 +0200
+
 
 ubuntu-system-settings (0.3+15.10.20150930-0ubuntu1) wily; urgency=medium
 

=== modified file 'tests/autopilot/ubuntu_system_settings/tests/__init__.py'
--- tests/autopilot/ubuntu_system_settings/tests/__init__.py	2015-10-06 15:56:48 +0000
+++ tests/autopilot/ubuntu_system_settings/tests/__init__.py	2015-11-01 12:05:20 +0000
@@ -79,7 +79,7 @@
 
     """Base class for Ubuntu System Settings."""
 
-    APP_PATH = '/usr/bin/system-settings'
+    APP_FILENAME = 'system-settings'
     DESKTOP_FILE = '/usr/share/applications/ubuntu-system-settings.desktop'
 
     def setUp(self, panel=None):
@@ -107,7 +107,7 @@
         :returns: A proxy object that represents the application. Introspection
         data is retrievable via this object.
         """
-        params = [self.APP_PATH]
+        params = [self.APP_FILENAME]
         if platform.model() != 'Desktop':
             params.append('--desktop_file_hint={}'.format(self.DESKTOP_FILE))