1471641 - [mozinstall] Add support for Python 3

Status: RESOLVED FIXED

(Testing :: Mozbase, enhancement, P3)

Description

[Dave Hunt [:davehunt] [he/him] ⌚BST]

+++ This bug was initially created as a clone of Bug #1427062 +++

We need to add support for Python3 without losing legacy Python support. Whilst some aspects were taken care of in bug 1388018 we are now able to run the unit tests against Python 3, and many of these are failing.

To work on this bug you will need to install and configure Mercurial, which will enable you to download the Firefox source code. It will also be used to commit your changes locally and prepare a patch for review. See the installation guide at https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/installing.html for help getting Mercurial on your system. Once installed, there are some extensions we recommend installing, details of these can be found here: https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/extensions.html

To clone the Firefox source code we recommend using the unified repository. Details of this and how to create a bookmark for your work can be found here: https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/unifiedrepo.html

As this bug relates to Python 3, you will need to have this installed on your system. Our continuous integration is currently using Python 3.5, so for best results we recommend using the same version locally. There are a number of ways to install Python, and they vary depending on your environment. We suggest reading over the guides at http://docs.python-guide.org/en/latest/starting/installation/#python-3-installation-guides to find the best method for you. Note that we also need to maintain support for Python 2, so you'll also need to have Python 2.7 installed.

Whilst we're moving towards adding support for Python 3, we've disabled any tests that fail against this version. This means that in order to work on this bug you will need to enable the tests. This can be done by removing "skip-if = python == 3" from the manifest file in `testing/mozbase/mozinstall/tests/manifest.ini`

To run the tests against Python 3, execute the following command:

```
mach python-test --python=3.5 testing/mozbase/mozinstall
```

Work through the test failures, and update the tests and source code for the package to simultaneously support Python 2.7 and Python 3.5. You can always check that your changes have not inadvertently broken support for Python 2 by using `--python=2.7` on the command line. 

If you're new to Python 3, the guide at https://docs.python.org/3/howto/pyporting.html may help you to get started with understanding the differences. To assist with supporting both Python 2 and 3, we have vendored the "six" package. You can read more about this and how to use it at https://pythonhosted.org/six/

Note that this package depends on others that may not yet support Python 3. If these dependencies are preventing tests from passing, then we can block this bug on getting support in those packages. If there are circular dependencies then we may need to coordinate landing a sequence of patches between bugs,

Once the package supports Python 3 and the tests pass, we will also need to prepare for a new release. Bump the version number in `testing/mozbase/mozinstall/setup.py` to "2.0.0", and update the classifiers so they reflect the versions of Python that we now support.

Finally, to prepare a universal distribution, create a `testing/mozbase/mozinstall/setup.cfg` file with the following contents:

```
[bdist_wheel]
universal=1
```

When your patch(es) are ready, you will need to push them for review. We are use MozReview for this, and instructions for how to prepare your machine and how to structure your commit messages can be found in our guide: https://mozilla-version-control-tools.readthedocs.io/en/latest/mozreview-user.html

There may be some review issues to address, but once your contribution has been approved and subsequently landed, we will release the new version of the package!

Comment 1

[Preeti[:preeti]]

Hello! I'd like to fix this bug , in case no one is working on this .
I did setup the build environment for Firefox, and any further mentoring would be great!

Comment 2

[William Lachance (:wlach)]

I'm going to take this one.

Comment 3

[William Lachance (:wlach)]

Attachment: Bug 1471641 - Use subprocess check_call and check_output in mozinstall r=davehunt

We were using more primitive methods before to support python 2.4, but
that's obviously no longer required.

Comment 4

[William Lachance (:wlach)]

Attachment: Bug 1471641 - Python 3 compatibility fixes in mozinstall r=davehunt

Depends on D15539

Comment 5

[William Lachance (:wlach)]

Attachment: Bug 1471641 - Enable and fix mozinstall tests on python 3 r=davehunt

Depends on D15540

Comment 6

[William Lachance (:wlach)]

Attachment: Bug 1471641 - Changes to support a mozinstall 2.0 release r=davehunt

Comment 7

[William Lachance (:wlach)]

try run: https://treeherder.mozilla.org/#/jobs?repo=try&revision=4a8fad1a3fc24be8e3b8851c480dc9d60232ff07

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/4ceb73d7896f
Use subprocess check_call and check_output in mozinstall r=davehunt
https://hg.mozilla.org/integration/autoland/rev/17049f612abe
Python 3 compatibility fixes in mozinstall r=davehunt
https://hg.mozilla.org/integration/autoland/rev/11580728adf0
Enable and fix mozinstall tests on python 3 r=davehunt

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d36e920d3acd
Changes to support a mozinstall 2.0 release r=davehunt

Comment 10

[Bogdan Tara[:bogdan_tara | bogdant]]

https://hg.mozilla.org/mozilla-central/rev/4ceb73d7896f
https://hg.mozilla.org/mozilla-central/rev/17049f612abe
https://hg.mozilla.org/mozilla-central/rev/11580728adf0
https://hg.mozilla.org/mozilla-central/rev/d36e920d3acd