From 2c75fbac93cb0c06a9eb9597544c495a8ce19673 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Fri, 15 Nov 2013 16:46:27 -0300 Subject: Add bundle qa guidelines. --- docs/client/bundle-testing.md | 89 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 docs/client/bundle-testing.md diff --git a/docs/client/bundle-testing.md b/docs/client/bundle-testing.md new file mode 100644 index 0000000..fa7e096 --- /dev/null +++ b/docs/client/bundle-testing.md @@ -0,0 +1,89 @@ +@nav_title = "Bundle QA" +@title = "Guidelines for bundle QA" + +Bundle functionality test +========================= + +Recommended setup +----------------- + +VirtualBox (or similar) with virtual machines installed for supported OSs +For each system that you are going to test, you should do: +- Install the VM +- Restart the VM and check that the process is finished. +- Turn it off and make a snapshot named 'fresh install' or similar. + +NOTE: The OS should be installed with the default settings and no extra packages. You can choose your language, username, timezone, etc + + +Test process +------------ + +- roll back the virtual machine to its 'fresh install' state, to make sure that you're testing against a reproducible environment. +- download the bundle, verify signature (if apply), extract and run the app +- tests to do: + - check if the version number is the same as the current bundle version. + - 'Help->About Bitmask' + - `./bitmask --version` + - correct installation of files to 'better protect privacy' + - `/etc/leap/resolv-update` + - `/usr/share/polkit-1/actions/net.openvpn.gui.leap.policy` + + NOTE: you should check that they get copied when the user says 'yes' and they don't get copied if the user says 'no'. + - installation of tun/tap in Windows and MAC (explain more here) + - account creation + recommended username template: test_bundleversion_os_arch, that way you avoid conflicts between test iterations. + e.g.: 'test_036_debian7_64', 'test_036_win7_32', etc + + NOTE: If you need to create extra users in order to test a bug or whatever, you can use 'test_036_ubuntu1204_32a', 'test_036_ubuntu1204_32b', etc + + NOTE: In case of being a lot of users testing a version you may want to use your username instead of test, e.g.: 'johndoe_036_ubuntu1204_32'. + - eip connection + + you can check if the vpn is working entering to the site: http://wtfismyip.com + or using the console: + `shell> wget -qO- wtfismyip.com/json` + - soledad key generation + - thunderbird configuration manually and using add-on + - send and receive mail + + You need to test communication between inside and outside users, e.g.: someuser@bitmask.net and otheruser@gmail.com + + A good thing to do is to subscribe to a mailing list that have a lot of activity. + + - check if the account data is correctly synced. + + After the account creation, have everything working and the app closed: + - remove the configuration files created by the app (`~/.config/leap` in linux) + - log in with your recently created credentials and check that everything is working and your mails are there too. + + +Problems report +--------------- + +You should to create an issue with the followinw information: +- OS, version, architecture, desktop environment (if relevant). +- bitmask.log file located in the root folder of the uncompressed bundle +- steps to reproduce + +NOTE: if you find a problem, try to reproduce and take note of the steps needed to get the same error. +Also, in some cases, a failure appears but if you run again is not there anymore (e.g.: some initialization issue), please report that too. + + +Utils +----- + +Download, extract and run helper script for linux: + + shell> ./download-extract-run-bitmask.sh + +Script contents: + + #!/bin/bash + HOST="https://downloads.leap.se/client/linux/" + VERSION="0.3.7" + # FOLDER="Bitmask-linux32-${VERSION}" + FOLDER="Bitmask-linux64-${VERSION}" + FILE="${FOLDER}.tar.bz2" + + wget ${HOST}${FILE} && tar xjf ${FILE} && cd ${FOLDER} && ./bitmask -- cgit v1.2.3 From 9ff5d2802456f510ceadef1a54c15d2a8e3d0b80 Mon Sep 17 00:00:00 2001 From: Ivan Alejandro Date: Fri, 6 Dec 2013 15:20:24 -0300 Subject: Add supported OSs. --- docs/client/en.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/client/en.md b/docs/client/en.md index 3bfe3f1..1603b15 100644 --- a/docs/client/en.md +++ b/docs/client/en.md @@ -19,7 +19,7 @@ User Guide ---------- * [Installing Bitmask](client/user-install) * [Running Bitmask](client/user-running) - + Tester Guide ------------ @@ -27,7 +27,7 @@ This part of the documentation details how to fetch the last development version and how to report bugs. * [Howto for testers](client/testers-howto) - + Hackers Guide ------------- @@ -35,9 +35,21 @@ If you want to contribute to the project, we wrote this for you. * [Setting up a development environment](client/dev-environment) - + + + +Supported OSs +------------- + +Currently supported OSs (32 and 64 bits) are: +- Debian 7 (32bits lxde and 64 bits gnome3) +- Ubuntu 12.04 (LTS, unity) +- Ubuntu 13.10 (latest, unity) +- Mac OSX >= 10.8 +- Windows 7 (32 bits only) +- Windows 8 (planned) -- cgit v1.2.3