summaryrefslogtreecommitdiff
path: root/docs/testing/index.rst
blob: 8d72e9acaba8cb750bd8916cb360084ea10b74d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
:LastChangedDate: $LastChangedDate$
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

.. _qa:

Testing & QA
============ 

`Latest bundles`_ for the next release cycle are automatically built by our
Gitlab CI for every commit in master.

Beginning with 0.9.5, we have ported again the VPN service into the Bitmask
client. Choose the following testing providers (beware that no guarantee about
continuity of the accounts is made at this point): 

* For Encrypted Email, test against ``https://cdev.bitmask.net``
* For VPN, test against ``https://demo.bitmask.net``

.. _`Latest bundles`: https://0xacab.org/leap/bitmask-dev/builds/artifacts/master/download?job=bitmask_latest_bundle

Reporting bugs
--------------

* Bug reports go into our `Issue Tracker`_. 
* `Here`_ is some very good read about what constitutes a `good bug report`_.
* Have also a look at the :ref:`Known Issues <issues>` page.

.. _`Issue Tracker`: https://0xacab.org/leap/bitmask-dev/issues/
.. _`Here`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
.. _`good bug report`: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html

Tips for QA
--------------------------------

If you want to give a hand testing the unreleased bundles, please follow the
following tips:

* Focus all your efforts, if possible, on whatever is *the* golden distro at
  the time of the release.  This currently is: Ubuntu 17.04.x (zesty), 64bits, with
  Unity as the default desktop environment.
  It's very important to have a reference environment as bug-free as possible,
  before trying to solve issues that are present in other distributions or window
  managers.
* Identify all issues that need help in the QA phase. You can do that going to
  the bug tracker, and filtering all the issues for a given release that are in
  the QA state.
* If the issue is solved in your tests for this alpha release, please add a
  comment to the issue stating the results of your tests, and the platform and
  desktop environment in which your tests took place.  But please do not change
  the QA status on the issue. We generally leave this role to the author of the
  original issue, or to the person playing the role of the release QA master.
* Always test with a newly created account (specially relevant when testing
  email candidates)
* Always test with the reference Mail User Agent (currently, Thunderbird, in
  whatever version is present in the reference distribution).
* Remove also any thunderbird configuration, start a freshly configured account.
* If you find a new bug, please make sure that it hasn't already been reported
  in the issue tracker. If you are absolutely certain that you have found a new
  bug, please attach a log of a new bitmask session, which should contain
  *only* the behaviour needed to reproduce the bug you are reporting.

Xenial live image testing
-------------------------

Pasting the following lines in a terminal will help you testing the latest
bundle from inside a virtual machine running a **live image for xenial** (note
that this is **not** an installation method!)::

  curl https://0xacab.org/leap/bitmask-dev/raw/master/docs/testing/latest-bundle-xenial | bash

Testing against providers with invalid certificates
---------------------------------------------------

If you need to test against a provider without a valid certificate, you can use
the following flag::

  SKIP_TWISTED_SSL_CHECK=1 bitmask

Thunderbird integration
-----------------------

You can configure Thunderbird manually with the info that is shown in the
"Configure a Mail Client" section, within the Mail pane in Bitmask. However,
there is a Thunderbird extension that automates this configuration. Before
configuring a Bitmask account in Thunderbird, make sure that you have Bitmask
running and that you are logged in with an account that supports the mail
service (mail.bitmask.net).

These are the steps:

1. Run Bitmask, login with an account that suports encrypted email.
2. From within Thunderbird, install the `Bitmask Thunderbird Extension`_.
3. Enable the menu bar: Right Click in the top bar > Menu Bar
4. Create a Bitmask Account in Thunderbird: From the menubar, click on File > New > Bitmask Account
5. Fill in your name. This can be anything.
6. Fill in your username, in the form "username@provider"

.. _`Bitmask Thunderbird Extension`: https://addons.mozilla.org/en-us/thunderbird/addon/bitmask/