WindowsTesting

Differences between revisions 1 and 58 (spanning 57 versions)
⇤ ← Revision 1 as of 2010-07-23 14:05:12 →
Size: 13221
Editor: 223
Comment: Added documentation of how to start the windows installer testing.
← Revision 58 as of 2011-12-12 20:54:32 → ⇥
Size: 13310
Editor: 105-12-17-190
Comment: fixing pykeyring misspell
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= UbuntuOne Windows Testing =

The following details what's needed to test the window UbuntuOne installer and builds under windows.

== Dependencies ==

 * A Windows machine or VM
 * Download and install VS Express 2008 C# from http://www.microsoft.com/express/Downloads/#2008-Visual-CS
 * The Ubuntu One Windows Installer code from [[https://edge.launchpad.net/ubuntuone-windows-installer|Launchpad]]

== Building ==

In order to simplify the build process of the project and automate it as much as possible Nant has been used to create the build script. The fact that Nant is used adds a number of features that make the automation easier:

=== Tasks ===

Tasks in Nant can be seen as ''operations'' that can be performed with Nant using the projects contents. Each tasks performs an operation on the source code and can depend on other tasks that have been defined in the build script.

The following is a list of the different tasks that are currently defined in the project and a small description.

 * '''bootstrapper''': Creates a bootstrapper that will allow to install in the users machine the Ubuntu One solution plus a number of useful applications (Tomboy + !GtkSharp)
 * '''build''': Compiles the different projects that are part of the solution. This task depends on '''clean''' and '''build_protos'''.
 * '''clean''': Removes the different results from the last compilation/task .
 * '''generate_protos''': Generates part of the C# code of the solution that depends on the protobuffer definitions found in the proto dir.
 * '''installer''': Compiles the application using the '''build''' task, runs the unit tests usint the '''tests''' task and creates a msi installer that can be used to install Ubuntu One in the users machine (do not confuse with the bootstrapper, it only installes Ubuntu One)
 * '''tests''': Compiles the solution using the '''build''' task and runs the different unit tests. The output of the tests can be found in the test-results dir.

Nant provides a way to list all the available tasks in a project by executing the following:		 ## page was renamed from UbuntuOne/WindowsTesting
## page was renamed from UbuntuOne/Tutorials/WindowsTesting
The following details what's needed to test the Ubuntu One file sync client under windows.

= Dependencies =

A Windows machine or VM is needed. For now, we officially support Windows 7, and we try to support Vista and XP.

== Python ==

At the moment, the Windows port is targeting Python 2.7. You can find the correct version of python for your system in the python [[http://python.org/download/|download page]].

We suggest you download [[http://www.python.org/ftp/python/2.7.2/python-2.7.2.msi | this msi]].

=== setuptools ===

To make the rest of the dependency installation easier, please install setuptools from [[http://pypi.python.org/pypi/setuptools|here]].
Direct link to py2.7 version is [[http://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe#md5=57e1e64f6b7c7f1d2eddfc9746bbaf20 | this one]].

While ''easy_install'' will be able to install most of the needed packages, some of them won't and an explanation of how to install them will be provided.
'''PLEASE READ:''' always use ''easy_install -Z'' (use -Z so eggs are uncompressed)

=== Setting PATH properly ===

Once both installations finished, be sure to have your python.exe and easy_install.exe in your PATH environment variable. To do so, open the Windows Control Panel, and go to System And Security -> System -> Advanced System Settings -> Environment Variables -> System Variables -> Edit "Path" env var to be something like:
Line 31: Line 28:
tools\Nant\bin\nant.exe -projecthelp

NAnt 0.90 (Build 0.90.3780.0; release; 08/05/2010)
Copyright (C) 2001-2010 Gerry Shaw
http://nant.sourceforge.net


Default Target:

installer Compiles the solution and create a merge installer that allows to install the solution and other related apps.

Main Targets:

bootstrapper Creates a bootstrapper that will allow to install Ubuntu One, Tomboy and Gtk Sharp in the users machine.
build Compiles all the different projects that form part of the solution.
clean Removes all the different results of the last comilation if
they exist
generate_protos Generates the code that is used to talk with the python process using protobuffer.
installer Compiles the solution and create a merge installer that allows to install the solution and other related apps.
tests Runs the unit tests of the project.		 <original Path value>;C:\Python27;C:\Python27\Scripts
Line 53: Line 31:

=== Parameters ===

Nant allows to pass enviroment variables that can be used to configure the different tasks, the normal way to pass a property is the following:		 To confirm the setup was correct, open a command line (cmd.exe) and type:

 * python <enter> (you should get a python interpreter)
 * easy_install --help <enter> (you should get easy_install help/usage message)

=== 32 or 64 bits? ===

At the moment there is no preference between using python for x86 or x64 machines since tests should pass on both runtimes. Nevertheless some of the dependencies that the project has have to be installed using an msi that has been generated in a x86 machine. If you are using the x64 version of python you might find that a number of msi state that the installation of python could not be found. The reason for this is that because the installer was compiled in a x32 machine and your os is a x64 version the msi will be looking for the python data in the WoW64 (Windows 32-bit On Windows 64-bit) subsystem which has its information stored in the '''HKEY_LOCAL_MACHINE\Software\Wow6432Node''' in the path which is the equivalent to '''HKEY_LOCAL_MACHINE\Software''' in a x86 machine. In order to work around this issue you simple have to copy the exact same information that python added to your registry to the WoW64 registry path so that when the msi looks for it it will find it.

== Visual C++ 2008 ==

Some of the python packages that are required (pykeyring is one of them) required your system to have Visual C++ 2008 installed. It is very important that you install this specific version of VS and no later since the setup.py of the packages will be looking for that version and no other.

There is no need to install the payed version of Visual Studio, you can use the express C++ version from [[http://www.microsoft.com/express/Downloads/#2008-Visual-CS|here]] (look at the far right tab).

Direct link to Visual C++ 2008 is [[http://go.microsoft.com/?linkid=7729279 | this]]. Please note that when installing, you will get messages about "Visual Studio 2009", but you should confirm you're getting Visual C++ 2008 installed.

=== Important note ===

After installing Visual C++ 2008 Express, to make sure that all environment variables are set, either reboot or use the command prompt found here: "Start Menu\Programs\Microsoft Visual C++ 2008 Express Edition\Visual Studio Tools\Visual Studio 2008 Command Prompt" as your regular command prompt.

== Bazaar ==

Download and install bazaar from [[http://wiki.bazaar.canonical.com/WindowsDownloads | here]]. Choose the "standalone" installer.
This is the [[http://launchpad.net/bzr/2.3/2.3.1/+download/bzr-2.3.1-1-setup.exe | direct link]].

=== SSH key (not needed if only branching stuff) ===

If you need to setup your ssh key (only if you need to submit branches from this platform), there is a nice wiki page from launchpad that explains how to set up bzr on windows as well as the ssh keys in order to easily work with launchdpad. The wiki can be found [[https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair|here]].

=== Bazaar UIs ===

Tortoisebzr can be used so that the different status icons are shown in the you code files during development but there is an important fact to know. Those icons, known as IconOverlays, are limited on Windows. That is, only 15 different icons can be installed in your system. If you have any other tortoise software you might have reached that limit which means that those icons wont be shown. To know which IconOverlays have been installed in your system you can open regedit and look at '''HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers''' which contains a list of the overlays already installed in you system.

== pywin32 ==

Download from [[http://sourceforge.net/projects/pywin32/files/pywin32/Build216/pywin32-216.win32-py2.7.exe/download | here]]. Be sure to always choose python 2.7.

== Twisted ==

Download from [[http://twistedmatrix.com/trac/wiki/Downloads|here]] and install. Direct link to py2.7 version is [[http://twistedmatrix.com/Releases/Twisted/11.0/Twisted-11.0.0.winxp32-py2.7.msi | this]].

== qt4reactor ==

Download the compressed tarball from [[https://github.com/ghtdak/qtreactor/tarball/master|here]], decompress (see the next paragraph for a decompressing program suggestion) and drop the resulting directory (a folder named similar to ''ghtdak-qtreactor-057ce1f'') into your python's Lib/site-packages renaming it to ''qtreactor''.

If you need a program to untar and ungzip stuff, you can dowload [[http://downloads.sourceforge.net/sevenzip/7z920.msi | 7zip]].

== python-distutils-extra ==

Branch lp:python-distutils-extra and run "python setup.py install" inside it.

== Ubuntu SSO Client ==

 * Install the following dependencies:
   * [[ http://www.voidspace.org.uk/downloads/pycrypto-2.3.win32-py2.7.zip | pycrypto ]]
   * [[ http://sourceforge.net/projects/py2exe/files/py2exe/0.6.9/py2exe-0.6.9.win32-py2.7.exe/download | py2exe ]]
   * [[ http://www.riverbankcomputing.co.uk/static/Downloads/PyQt4/PyQt-Py2.7-x86-gpl-4.8.6-1.exe | PyQt4 ]]
   * [[ https://bitbucket.org/mandel/pykeyring-delete-password | our patched version of pykeyring ]]
   * Using ''easy_install -Z'':
     * lazr.restfulclient
     * pyOpenSSL
     * PIL
 * Branch lp:ubuntu-sso-client, and run "python setup.py build" inside it.
 * Install some keys to the registry: go to the ubuntu-sso-client branch, cd into "ubuntu_sso\main\tests" and execute "ubuntuone.reg"
 * To test if the project works properly, let's get you some Ubuntu One credentials into the system. To do so, perform the following steps.

=== Run the ubuntu-sso-client service ===

 * open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Then, run:
   * set PYTHONPATH=.
   * set DEBUG=True
   * python bin\windows-ubuntu-sso-login

=== Run the test suite ===

 * be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
 * open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Point PYTHONPATH to current location (set PYTHONPATH=.) and then, run "run-tests.bat"

=== Run the UI testing script ===

 * open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Then, run:
   * set PYTHONPATH=.
   * set DEBUG=True
   * python ubuntu_sso\qt\tests\show_gui.py

You should get a QT UI where you're asked to either sign in or register. Login with your SSO username and password. If you're eventually presented with a message of "Success", then you're good to go to further steps. If not, please seek assistance.

==== Important notes ====

 * If you get a "ImportError: PIL", you need to go to the python's Lib/site-packages folder and rename the 'pil' folder to PIL, or if you don't have a folder but an egg (something like pil<version>.egg), you should change it to be PIL.egg.

 * If you get a SSLHandshakeError failure when the Sign in dialog appears, you're running a httplib2 version that has some issues with https. Please use httplib2 version lower than 0.7.0 doing something like this:
Line 59: Line 126:

tools\Nant\bin\nant.exe -D:enviroment="debug"
 easy_install -Z http://httplib2.googlecode.com/files/httplib2-0.6.0.tar.gz
Line 64: Line 129:
Currently the build script supports the following configuration parameters:

 * '''enviroment''': The environment use for the compilation, the available values are:
   * debug
   * release

=== Building and Testing: ===

These are the commands to run to build and run the tests.

 * {{{tools\Nant\bin\nant.exe clean}}}
 * {{{tools\Nant\bin\nant.exe build}}}
 * {{{tools\Nant\bin\nant.exe tests}}}

This error happens if you run the tests from a network drive (e.g: Virtualbox share):
{{{
   [mkdir] Creating directory 'Z:\mandel\fix_tomboy_installer\test-results'.
     [echo] Executing Canonical.UbuntuOne.Common.Tests
     [exec] Z:\mandel\fix_tomboy_installer\main.build(147,4): Attribute 'userunt
imeengine' for <exec ... /> is deprecated. Use the managed attribute and Manage
d property instead.
     [exec]
     [exec] Unhandled Exception: System.TypeInitializationException: The type in
itializer for 'NUnit.ConsoleRunner.Runner' threw an exception. ---> System.Secur
ity.SecurityException: That assembly does not allow partially trusted callers.
     [exec] at NUnit.ConsoleRunner.Runner..cctor()
     [exec] The action that failed was:
     [exec] LinkDemand
     [exec] The assembly or AppDomain that failed was:
     [exec] nunit-console-runner, Version=2.5.5.10112, Culture=neutral, PublicKe
yToken=96d09a1eb7f44a77
     [exec] The method that caused the failure was:
     [exec] NUnit.Core.Logger GetLogger(System.Type)
     [exec] The Zone of the assembly that failed was:
     [exec] Internet
     [exec] The Url of the assembly that failed was:
     [exec] file:///Z:/mandel/fix_tomboy_installer/tools/NUnit/lib/nunit-console
-runner.DLL
     [exec] --- End of inner exception stack trace ---
     [exec] at NUnit.ConsoleRunner.Runner.Main(String[] args)
     [exec] at NUnit.ConsoleRunner.Class1.Main(String[] args)

BUILD FAILED - 0 non-fatal error(s), 22 warning(s)

Z:\mandel\fix_tomboy_installer\main.build(147,4):
External Program Failed: Z:\mandel\fix_tomboy_installer\tools\NUnit\nunit-consol
e.exe (return code was -532459699)

Total time: 152.4 seconds.
}}}

Fix is to move the code to a local drive.

=== Build the msi ===

{{{ tools\Nant\bin\nant.exe installer}}}

If you get this:

{{{
     [get] Retrieving 'http://download.gnome.org/binaries/win32/tomboy/1.2/Tomb
oy-1.2.2.msi' to 'C:\Documents and Settings\Stuart Colville\Desktop\fix_tomboy_i
nstaller\tomboy.msi'.
     [exec] C:\Documents and Settings\Stuart Colville\Desktop\fix_tomboy_install
er\main.build(121,5): Attribute 'useruntimeengine' for <exec ... /> is deprecate
d. Use the managed attribute and Managed property instead.

BUILD FAILED - 0 non-fatal error(s), 6 warning(s)

C:\Documents and Settings\Stuart Colville\Desktop\fix_tomboy_installer\main.buil
d(121,5):
'C:\Program Files\Windows Installer XML v3\bin\dark.exe' failed to start.
    The system cannot find the path specified

Total time: 24.5 seconds.}}}

Wix is present in the src tree under the tools directory, this means that the build script will be able to create an .msi without the need of having Wix installed in the VM.

Re-run the installer command and you should find !UbuntuOne.msi in the install directory.

=== Build the bootstrapper ===

Due to the nature of the windows installer only a single msi can be executed at a time. The project contains a boostrapper generation that will create a setup.exe program that will concatenate the installation of the following:

 * Ubuntu One on Windows
 * Gtk-Sharp
 * Tomboy

In order to create the bootstrapper the following command has to be executed:

{{{ tools\Nant\bin\nant.exe bootstrapper }}}

The output should be similar to the following:

{{{
Target framework: Microsoft .NET Framework 3.5
Target(s) specified: bootstrapper


bootstrapper:

     [exec] InstallerLinker: dotNetInstaller Packager (1.9.5931.0)
     [exec]

BUILD SUCCEEDED

Total time: 1 seconds.

}}}

Once this command has been ran you should find setup.exe in the install directory.

== Installing ==

The windows installer solution has different components that are installed by the msi. In certain cases it is interesting to install the different components independently to simplfy the testing.

=== Installing the windows service ===

!InstallUtil is the command line that can be used to install and uninstall a windows service. In order to install a windows service we first have to add '''C:\Windows\Microsoft.NET\Framework\v2.0.50727''' in your shell path (edit environment variables). Once !InstallUtil is in you path you can execute in the command line:

{{{
InstallUtil Canonical.UbuntuOne.ProcessDispatcher.exe
}}}

If the installation is successful a message similar to the following will be given:
{{{

Affected parameters are:
   logtoconsole =
   assemblypath = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_servi
ce_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.exe
   logfile = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_service_wi
x\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.InstallLog
Installing service UbuntuOne SyncDaemon...
Service UbuntuOne SyncDaemon has been successfully installed.
Creating EventLog source UbuntuOne SyncDaemon in log Application...

The Install phase completed successfully, and the Commit phase is beginning.
See the contents of the log file for the C:\Users\Mandel\Documents\Projects\Ubun
tuOne\net\install_service_wix\install\build_results\Daemon\Canonical.UbuntuOne.P
rocessDispatcher.exe assembly's progress.
The file is located at C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_
service_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.I
nstallLog.
Committing assembly 'C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_se
rvice_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.exe
'.
Affected parameters are:
   logtoconsole =
   assemblypath = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_servi
ce_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.exe
   logfile = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_service_wi
x\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.InstallLog

The Commit phase completed successfully.

The transacted install has completed.
}}}

If there are any errors the installation will be rolled back and a message like the following will be given:
{{{
Installing service UbuntuOne SyncDaemon...
Creating EventLog source UbuntuOne SyncDaemon in log Application...

An exception occurred during the Install phase.
System.ComponentModel.Win32Exception: The specified service has been marked for
deletion

The Rollback phase of the installation is beginning.
See the contents of the log file for the C:\Users\Mandel\Documents\Projects\Ubun
tuOne\net\install_service_wix\install\build_results\Daemon\Canonical.UbuntuOne.P
rocessDispatcher.exe assembly's progress.
The file is located at C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_
service_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.I
nstallLog.
Rolling back assembly 'C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_
service_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.e
xe'.
Affected parameters are:
   logtoconsole =
   assemblypath = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_servi
ce_wix\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.exe
   logfile = C:\Users\Mandel\Documents\Projects\UbuntuOne\net\install_service_wi
x\install\build_results\Daemon\Canonical.UbuntuOne.ProcessDispatcher.InstallLog
Restoring event log to previous state for source UbuntuOne SyncDaemon.

The Rollback phase completed successfully.

The transacted install has completed.
The installation failed, and the rollback has been performed.
}}}

Once the service has been installed you can manage it with mmc.exe. Once you have finished the different tests the service can be uninstalled with:

{{{
InstallUtil /u Canonical.UbuntuOne.ProcessDispatcher.exe
}}}

== Testing ==

There are a number of different ways/path to test the solution.

=== Unit Testing ===

Unit testing is executed in an automated manner by the build script everytime a new deploymnet package (msi) is build. The results of the unit testing can be found in the test-results dir. A tool like [[http://nunit2report.sourceforge.net/|Nunit2report]] can be used to view the results in a more human readable manner.

=== Test the msi ===

Testing the full result of an msi installation is a hard task due to the huge amount of possible actions that a msi can perform (install features, add short-cuts, add registry values...). Nevertheless there is a certain part of the msi testing that can be automated which is msi custom actions.

Custom actions are wix extensions that have been added in the project to perform special operations that wix is not able to do. The tool to be used to test this custom actions is [[http://wix.sourceforge.net/manual-wix3/lux.htm|Lux]].


To be able to execute the Lux test the following command should be executed when installing the msi:

{{{

msiexec /l lux.log /i install\UbuntuOne.msi

}}}

Once the installation has been completed search the log for '''!WixRunImmediateUnitTests''' to see test results. If issues exist with the installer please provide the output of '''lux.log''' (from the above command) to the bug report.

==== UI testing ====

A UI testing tool can be used to test the msi and add extra logic to ensure that the different operations to place. Read the UI testing for more information.

=== UI testing ===

'''TODO: Complete when ever a tool has been decided.'''		 == Ubuntu One Storage Protocol ==

 * Download the "protoc.exe" binary from [[http://protobuf.googlecode.com/files/protoc-2.4.1-win32.zip | here]] and copy that to a location in your PATH. Suggested location is C:\Python27\Scripts.
 * Download the sources of google.protobuf module from [[http://code.google.com/p/protobuf/downloads/list | here]]. Direct link is [[http://protobuf.googlecode.com/files/protobuf-2.4.1.tar.gz | this one]]. Decompress, and open a command line. Go to the folder just decompressed (something like protobuf-<version>), and enter the "python" directory. There, run "python setup.py install_lib".
 * Branch lp:ubuntuone-storage-protocol and run "python setup.py install" inside it.

== Ubuntu One Client ==

 * Install configglue: branch lp:configglue and run "python setup.py install" inside it.
 * Branch lp:ubuntuone-client and enter that directory.
 * Copy windows\logging.conf to {{{logging.conf}}} inside the {{{data/}}} directory.
 * Copy windows\clientdefs.py to {{{clientdefs.py}}} inside the {{{ubuntuone/}}} directory.

=== Run the ubuntuone-syncdaemon service ===

 * Run the ubuntu-sso-client service as per the instructions above under "Run the ubuntu-sso-client service".
 * open a command line (cmd.exe) and navigate to the ubuntuone-client branch. Then, run:
   * set PYTHONPATH=..\ubuntu-sso-client;.
   * python bin\ubuntuone-syncdaemon --debug

=== Run the test suite ===

 * be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
 * open a command line (cmd.exe) and navigate to the ubuntuone-client branch. Then, run "run-tests.bat"
 * to run individual tests or test suite, you should run a command like this:
   * python C:\Python27\Scripts\u1trial --reactor=twisted -c tests -p tests\platform\linux -t <insert test pattern here>

== Ubuntu One Control Panel ==

 * Branch lp:ubuntuone-control-panel and enter that directory.

=== Run the ubuntuone-control-panel-qt application ===

 * Run the ubuntuone-syncdaemon service as per the instructions above under "Run the ubuntuone-syncdaemon service".
 * Since the ubuntu-sso-client service finishes executing automatically, you need to re-run it for the control panel if it stopped running.
 * open a command line (cmd.exe) and navigate to the ubuntuone-control-panel branch. Then, run:
   * python setup.py build (for now ignore the error about intltool-update not being available)
   * set PYTHONPATH=..\ubuntu-sso-client;..\ubuntuone-client;.
   * set DEBUG=True
   * python bin\ubuntuone-control-panel-qt

=== Run the test suite ===

 * be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
 * open a command line (cmd.exe) and navigate to the ubuntuone-control-panel branch. Then, run "run-tests.bat"

== Ubuntu One Installer (Wizard) ==

 * Branch lp:ubuntuone-windows-installer and enter that directory.

=== Run the ubuntuone-installer-qt application ===

 * Run the ubuntuone-syncdaemon service as per the instructions above under "Run the ubuntuone-syncdaemon service".
 * Since the ubuntu-sso-client service finishes executing automatically, you need to re-run it for the installer if it stopped running.
 * open a command line (cmd.exe) and navigate to the ubuntuone-windows-installer branch. Then, run:
   * python setup.py build (for now ignore the error about intltool-update not being available)
   * set PYTHONPATH=..\ubuntu-sso-client;..\ubuntuone-client;..\ubuntuone-control-panel;.
   * set DEBUG=True
   * python bin\ubuntuone-installer-qt

=== Run the test suite ===

 * be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
 * open a command line (cmd.exe) and navigate to the ubuntuone-windows-installer branch. Then, run "run-tests.bat"

== ubuntuone-dev-tools (only needed to run tests and style checks) ==

 * Install the following dependencies using ''easy_install'':
   * mocker
   * coverage
   * pylint
   * pep8
 * Branch lp:ubuntuone-dev-tools and run "python setup.py install" inside it.

== Misc information ==

=== Editors/IDEs ===

You can use your preferred windows editor, but make sure that the new lines used by it are the Unix ones, no crazy new lines from windows allowed in the code. If you do not have an editor of choice you can use one of the following:

 * Notepad++
 * KomodoEdit
 * JEdit

The following details what's needed to test the Ubuntu One file sync client under windows.

Dependencies

A Windows machine or VM is needed. For now, we officially support Windows 7, and we try to support Vista and XP.

Python

At the moment, the Windows port is targeting Python 2.7. You can find the correct version of python for your system in the python download page.

We suggest you download this msi.

setuptools

To make the rest of the dependency installation easier, please install setuptools from here. Direct link to py2.7 version is this one.

While easy_install will be able to install most of the needed packages, some of them won't and an explanation of how to install them will be provided. PLEASE READ: always use easy_install -Z (use -Z so eggs are uncompressed)

Setting PATH properly

Once both installations finished, be sure to have your python.exe and easy_install.exe in your PATH environment variable. To do so, open the Windows Control Panel, and go to System And Security -> System -> Advanced System Settings -> Environment Variables -> System Variables -> Edit "Path" env var to be something like: 

<original Path value>;C:\Python27;C:\Python27\Scripts

To confirm the setup was correct, open a command line (cmd.exe) and type:

  • python <enter> (you should get a python interpreter)

  • easy_install --help <enter> (you should get easy_install help/usage message)

32 or 64 bits?

At the moment there is no preference between using python for x86 or x64 machines since tests should pass on both runtimes. Nevertheless some of the dependencies that the project has have to be installed using an msi that has been generated in a x86 machine. If you are using the x64 version of python you might find that a number of msi state that the installation of python could not be found. The reason for this is that because the installer was compiled in a x32 machine and your os is a x64 version the msi will be looking for the python data in the WoW64 (Windows 32-bit On Windows 64-bit) subsystem which has its information stored in the HKEY_LOCAL_MACHINE\Software\Wow6432Node in the path which is the equivalent to HKEY_LOCAL_MACHINE\Software in a x86 machine. In order to work around this issue you simple have to copy the exact same information that python added to your registry to the WoW64 registry path so that when the msi looks for it it will find it.

Visual C++ 2008

Some of the python packages that are required (pykeyring is one of them) required your system to have Visual C++ 2008 installed. It is very important that you install this specific version of VS and no later since the setup.py of the packages will be looking for that version and no other.

There is no need to install the payed version of Visual Studio, you can use the express C++ version from here (look at the far right tab).

Direct link to Visual C++ 2008 is this. Please note that when installing, you will get messages about "Visual Studio 2009", but you should confirm you're getting Visual C++ 2008 installed.

Important note

After installing Visual C++ 2008 Express, to make sure that all environment variables are set, either reboot or use the command prompt found here: "Start Menu\Programs\Microsoft Visual C++ 2008 Express Edition\Visual Studio Tools\Visual Studio 2008 Command Prompt" as your regular command prompt.

Bazaar

Download and install bazaar from here. Choose the "standalone" installer. This is the direct link.

SSH key (not needed if only branching stuff)

If you need to setup your ssh key (only if you need to submit branches from this platform), there is a nice wiki page from launchpad that explains how to set up bzr on windows as well as the ssh keys in order to easily work with launchdpad. The wiki can be found here.

Bazaar UIs

Tortoisebzr can be used so that the different status icons are shown in the you code files during development but there is an important fact to know. Those icons, known as IconOverlays, are limited on Windows. That is, only 15 different icons can be installed in your system. If you have any other tortoise software you might have reached that limit which means that those icons wont be shown. To know which IconOverlays have been installed in your system you can open regedit and look at HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers which contains a list of the overlays already installed in you system.

pywin32

Download from here. Be sure to always choose python 2.7.

Twisted

Download from here and install. Direct link to py2.7 version is this.

qt4reactor

Download the compressed tarball from here, decompress (see the next paragraph for a decompressing program suggestion) and drop the resulting directory (a folder named similar to ghtdak-qtreactor-057ce1f) into your python's Lib/site-packages renaming it to qtreactor.

If you need a program to untar and ungzip stuff, you can dowload 7zip.

python-distutils-extra

Branch lp:python-distutils-extra and run "python setup.py install" inside it.

Ubuntu SSO Client

  • Install the following dependencies:
  • Branch lp:ubuntu-sso-client, and run "python setup.py build" inside it.
  • Install some keys to the registry: go to the ubuntu-sso-client branch, cd into "ubuntu_sso\main\tests" and execute "ubuntuone.reg"
  • To test if the project works properly, let's get you some Ubuntu One credentials into the system. To do so, perform the following steps.

Run the ubuntu-sso-client service

  • open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Then, run:
    • set PYTHONPATH=.
    • set DEBUG=True
    • python bin\windows-ubuntu-sso-login

Run the test suite

  • be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
  • open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Point PYTHONPATH to current location (set PYTHONPATH=.) and then, run "run-tests.bat"

Run the UI testing script

  • open a command line (cmd.exe) and navigate to the ubuntu-sso-client branch. Then, run:
    • set PYTHONPATH=.
    • set DEBUG=True
    • python ubuntu_sso\qt\tests\show_gui.py

You should get a QT UI where you're asked to either sign in or register. Login with your SSO username and password. If you're eventually presented with a message of "Success", then you're good to go to further steps. If not, please seek assistance.

Important notes

  • If you get a "ImportError: PIL", you need to go to the python's Lib/site-packages folder and rename the 'pil' folder to PIL, or if you don't have a folder but an egg (something like pil<version>.egg), you should change it to be PIL.egg.

  • If you get a SSLHandshakeError failure when the Sign in dialog appears, you're running a httplib2 version that has some issues with https. Please use httplib2 version lower than 0.7.0 doing something like this: 

easy_install -Z http://httplib2.googlecode.com/files/httplib2-0.6.0.tar.gz

Ubuntu One Storage Protocol

  • Download the "protoc.exe" binary from here and copy that to a location in your PATH. Suggested location is C:\Python27\Scripts.

  • Download the sources of google.protobuf module from here. Direct link is this one. Decompress, and open a command line. Go to the folder just decompressed (something like protobuf-<version>), and enter the "python" directory. There, run "python setup.py install_lib".

  • Branch lp:ubuntuone-storage-protocol and run "python setup.py install" inside it.

Ubuntu One Client

  • Install configglue: branch lp:configglue and run "python setup.py install" inside it.
  • Branch lp:ubuntuone-client and enter that directory.

  • Copy windows\logging.conf to logging.conf inside the data/ directory.

  • Copy windows\clientdefs.py to clientdefs.py inside the ubuntuone/ directory.

Run the ubuntuone-syncdaemon service

  • Run the ubuntu-sso-client service as per the instructions above under "Run the ubuntu-sso-client service".
  • open a command line (cmd.exe) and navigate to the ubuntuone-client branch. Then, run:
    • set PYTHONPATH=..\ubuntu-sso-client;.
    • python bin\ubuntuone-syncdaemon --debug

Run the test suite

  • be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
  • open a command line (cmd.exe) and navigate to the ubuntuone-client branch. Then, run "run-tests.bat"
  • to run individual tests or test suite, you should run a command like this:

    • python C:\Python27\Scripts\u1trial --reactor=twisted -c tests -p tests\platform\linux -t <insert test pattern here>

Ubuntu One Control Panel

  • Branch lp:ubuntuone-control-panel and enter that directory.

Run the ubuntuone-control-panel-qt application

  • Run the ubuntuone-syncdaemon service as per the instructions above under "Run the ubuntuone-syncdaemon service".
  • Since the ubuntu-sso-client service finishes executing automatically, you need to re-run it for the control panel if it stopped running.
  • open a command line (cmd.exe) and navigate to the ubuntuone-control-panel branch. Then, run:
    • python setup.py build (for now ignore the error about intltool-update not being available)
    • set PYTHONPATH=..\ubuntu-sso-client;..\ubuntuone-client;.
    • set DEBUG=True
    • python bin\ubuntuone-control-panel-qt

Run the test suite

  • be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
  • open a command line (cmd.exe) and navigate to the ubuntuone-control-panel branch. Then, run "run-tests.bat"

Ubuntu One Installer (Wizard)

  • Branch lp:ubuntuone-windows-installer and enter that directory.

Run the ubuntuone-installer-qt application

  • Run the ubuntuone-syncdaemon service as per the instructions above under "Run the ubuntuone-syncdaemon service".
  • Since the ubuntu-sso-client service finishes executing automatically, you need to re-run it for the installer if it stopped running.
  • open a command line (cmd.exe) and navigate to the ubuntuone-windows-installer branch. Then, run:
    • python setup.py build (for now ignore the error about intltool-update not being available)
    • set PYTHONPATH=..\ubuntu-sso-client;..\ubuntuone-client;..\ubuntuone-control-panel;.
    • set DEBUG=True
    • python bin\ubuntuone-installer-qt

Run the test suite

  • be sure to have ubuntuone-dev-tools installed and setup (see the corresponding section near the bottom of this page).
  • open a command line (cmd.exe) and navigate to the ubuntuone-windows-installer branch. Then, run "run-tests.bat"

ubuntuone-dev-tools (only needed to run tests and style checks)

  • Install the following dependencies using easy_install:

    • mocker
    • coverage
    • pylint
    • pep8
  • Branch lp:ubuntuone-dev-tools and run "python setup.py install" inside it.

Misc information

Editors/IDEs

You can use your preferred windows editor, but make sure that the new lines used by it are the Unix ones, no crazy new lines from windows allowed in the code. If you do not have an editor of choice you can use one of the following:

UbuntuOne/Contribute/WindowsTesting (last edited 2012-01-20 19:37:27 by 30-36-17-190)