WindowsTesting

Revision 17 as of 2011-07-01 20:39:35

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 support Windows 7 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.

Once the installation finished, be sure to have your python.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

setuptools

To make the rest of the dependency installation easier, please install setuptools from here. 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.

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. There 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.

VisualStudio 2008

Some of the python packages that are required (pykeyring is one of them) required your system to have VS2008 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 VS2008, you can use the express C++ version from here (look at the far right tab). Direct link to Visual C++ 2008 is this.

Important note

After installing VS2008 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. 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.

At the time of this writing, there is a bug in the pywin32 package where the non-utf8 functions GetFileSecurity and SetFileSecurity are used. This bug has been reported to upstream. If this bug is not fixed in upstream by the time you read this, you will need to patch pywin32, otherwise the operations that are performed on utf-8 paths will raise the winerror "23".

You can patch your installation by either downloading this zip and overwriting the contents of the win32 folder (inside site-packages from your Python installation), or applying the patch located at the bottom of this wiki page and recompile pywin32.

Twisted

Download the .msi from here and install.

qt4reactor

Download the compressed tarball from here, decompress and drop the resulting directory into your python's site-packages renaming it to qtreactor.

python-distutils-extra

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

ubuntuone-dev-tools

Install the following dependencies (TODO, add download links):
- coverage (for ubuntuone-dev-tools)
- pylint (for ubuntuone-dev-tools)
- pep8 (for ubuntuone-dev-tools)
Branch lp:ubuntuone-dev-tool and run "python setup.py install" inside it.

xdg

Branch lp:~mandel/+junk/xdg and run "python setup.py install" inside it.

Ubuntu SSO Client

Install the following dependencies:
- pycrypto
- py2exe
- PyQt4
- Using C:\python27\scripts\easy_install
  - lazr.restfulclient
  - python-mocker
  - pyOpenSSL
  - keyring
  - simplejson
  - PIL
Branch lp:ubuntu-sso-client, and run "python setup.py build" inside it. 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 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 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.

Ubuntu One Storage Protocol

Install protobuf: download from here and install.
Branch lp:ubuntuone-storage-protocol and run "python setup.py install" inside it.

Ubuntuone Client

Install configglue: branch lp:configglue and run "python setup.py install" inside it.
Branch lp:ubuntuone-client and enter that directory.
Download this file and save it as logging.conf inside the data/ directory.
Download this file and save it as clientdefs.py inside the ubuntuone/ directory.

Run the ubuntuone-syncdaemon service

Run the ubuntu-sso-client service by 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

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

Patch for pywin32

   1 diff -r 7dce71d174a9 win32/src/win32security.i
   2 --- a/win32/src/win32security.i Sat Jun 18 10:16:06 2011 -0400
   3 +++ b/win32/src/win32security.i Mon Jun 20 14:15:27 2011 +0200
   4 @@ -2108,7 +2108,7 @@
   5   if (!PyWinObject_AsTCHAR(obFname, &fname))
   6    goto done;
   7 
   8 -       if (GetFileSecurity(fname, info, psd, dwSize, &dwSize)) {
   9 +       if (GetFileSecurityW(fname, info, psd, dwSize, &dwSize)) {
  10    PyErr_SetString(PyExc_RuntimeError, "Can't query for SECURITY_DESCRIPTOR size info?");
  11    goto done;
  12   }
  13 @@ -2117,7 +2117,7 @@
  14    PyErr_SetString(PyExc_MemoryError, "allocating SECURITY_DESCRIPTOR");
  15    goto done;
  16   }
  17 - if (!GetFileSecurity(fname, info, psd, dwSize, &dwSize)) {
  18 + if (!GetFileSecurityW(fname, info, psd, dwSize, &dwSize)) {
  19    PyWin_SetAPIError("GetFileSecurity");
  20    goto done;
  21   }
  22 @@ -2153,7 +2153,7 @@
  23   PSECURITY_DESCRIPTOR psd;
  24   if (!PyWinObject_AsSECURITY_DESCRIPTOR(obsd, &psd))
  25    goto done;
  26 -       if (!SetFileSecurity(fname, info, psd)) {
  27 +       if (!SetFileSecurityW(fname, info, psd)) {
  28    PyWin_SetAPIError("SetFileSecurity");
  29    goto done;
  30   }

Ubuntu Wiki