Welcome to your guide to becoming the best Quality Assurance engineer ever and helping to contribute to the most exciting, world changing network we will ever see. Don’t be intimidated! This stuff is easy!
. . .
ATTENTION this is a work in progress. Order of events are going to change as I learn. Please be patient and bear with me. I am hoping to have something you can work with soon. Thanks. Also if you see any errors or have suggestions please feel free to edit the wiki or just leave a comment below.
. . .
There are a few different approaches you can take to start testing. One way is to just dive in! There are plenty of forum members that are willing to help should you get stuck. Check out the Resources for a condensed list of links available.
If you have experience using Command Prompt or Terminal there is a great guide already set up on Github. You shouldn’t have too many problems following that, the guide goes over many items including how to highlight issues and make feature requests, the team’s development process, their commit process and so on, it even has links on how to use Github, a great resource so check it out!
This guide is mainly intended for beginner users, ones that want to help out but understandably can’t get past all that lingo. That being said, we do suggest having a look at the previously mentioned guide to see what you are getting yourself into, give you an idea of some of the teams expectations and processes, and to, a little bit, get familiar with some keywords. Our goal here is to get you involved, have some fun, and help the team out. Once you get through this guide we feel confident you will be able to move over to the official guide, start making pull requests and if you are lucky enough contribute to a commit. Even if you don’t make it that far everyone can help in some way and at times it is the most inexperienced that have a lot of value to add! Stick with us and data will be flowing from your fingers and minds in no time! .
Mobile Browser Downloads
Currently you can test using Android and iOS. This is really simple and really easy.
Just download and install. Two barriers, on Android you need to authorise apps from unknown sources and on iOS you need to register with Azure.
On Github you have multiple options available.
You have three choices to download from, the AppCenter, Github, or if you can just scan the QR code.
If you choose AppCenter, easy, just press on the blue download button. Note; you may receive a notification “This type of file can harm your device…”. Just tap “OK” and the file will download.
If you choose Github scroll down until you see Assets (you may need to tap on the little black arrow to make the downloads appear) and press the .apk package, confirm the download and downloading should start.
Authorising "Unknown Sources"
Depending on your Android version you will receive a different type of prompt when trying to install.
Versions below Android 8.0 apply a global setting for all app installations (you will only need to do this once for all app installs). If you have not changed this you may receive a notification “Install Blocked”, tap on “Settings” which will bring you to the “Security” page, enable the switch next to “Unknown Sources”. You will receive an extra warning, tap “OK”. Find the package you downloaded using your file manager and resume the installation.
Versions Android 8.0 and above apply an individual app install setting (meaning you will need to approve install for each individual app). You will be prompted to allow the permission when you try to install any app. Tap “Settings” on the prompt, then on the next screen enable the switch next to “Allow from this source”. From there tap your back button. You can then resume the installation.
. . .
Mobile Authenticator Downloads
. . .
. . .
iOS Authenticator. . .
Mobile Use Cases
. . .
VM's (Virtual Machines)
You may want to set yourself up a separate secure environment if you have sensitive data on your machine. Although doing this testing will not access your data for some separating the two is a necessary step. Another reason to setup VM’s is to be able to test on other operating systems (OS’s) different than the one currently installed. Playing around with other OS’s can be fun and can be an introduction to perhaps a setup you may end up preferring. Keep in mind, to use a VM you will need an ISO image, a disk image of an optical disk, of the OS you want to install.
There are a few ways to create VM’s. One preferred way is virtualbox. Some don’t like the limitations of this program such as window size and mouse issues. There are others available such as Windows Sandbox. . . Here is a great post that covers some of the stuff we are going to go over and provides a good link to obtain ISO images. Have a search online and find the VM that best suits you.
Concerning Virtualbox there are various configurations you can make, create a windows machine, a linux machine . . .
Choose your operation system and download. When downloaded, just click next, next, next and so on till you get till install. Install. (This will take several minutes). Allow the program access that it needs. Once installation has finished launch the application.
To create a linux environment on an already linux machine please see this post
For those on Windows:
Now you want to create a work environment. Click on “New” (That funny blue star to left of the green plus “add”). On the next window:
- Choose any “Name” you wish, I chose SAFE;
- Choose a “Machine Folder” or just leave the default as I did.
- For “Type” choose the operating system you wish to set up (currently for this guide I am choosing Windows)
- Choose the Version (I chose “Windows 10 (32-bit)” 64-bit is not available for me but depending on your virtualbox version it may be available for you. Choose as you wish.
You will now see a choice for memory usage; Just leave it at default and click “Next”.
You will now see a choice on creation of Hard Disk. Virtualbox’s recommended size is 50GB. But for testing 4GB should be enough. If you are unsure about how much disk space you have free do the following:
Right click on the windows icon, depending on your setup this is by default on the bottom left of your screen, if you customised it like I did, it is on the top left…
I am not able to get a screenshot but after right-clicking a bunch of options will show up in a drop down menu. Select “Disk Management”
Windows 10 will ask you (at least it does me) if I want to authorise the app to make changes, just click “yes”.
You will now see a screen which shows you how much space is available on your hard disk.
If you are happy with giving up 4GB to create your virtual disk go back to the “Oracle VM VirtualBox Manager” which should still be open as a “tab” in your “taskbar” (the bar with all the icons generally at the bottom of your screen). And click “Create”.
You will now see a window asking for the Hard Disk File Type, reading the directions, just click “Next”. You are creating a “VDI”, a “VirtualBox Disk Image”.
- You will now see a choice on how much space this virtual machine will eventually take up on your hard drive. Even though we just allocated 4GB for the initial install you can now choose if you want to allow additional space on top of the 4GB if the Virtual Machine eventually needs it. I am choosing “fixed size” as I think for this exercise it should be enough and it is faster to use. If you want to be 100% sure you will have enough space choose Dynamic Make your selection and click “Next”.
The next screen you see may seem repetitive, it is just confirming everything you previously setup is correct to your liking and allowing you the option to change if you wish. Just click “Create”.
Your application will now create a Virtual Hard Disk, depending on your computer resources this may take some time. Mine says it will take “7 minutes”. This may take longer or less, from my experience computers aren’t very good at estimating time. You may also notice a lag in other affairs in your computer as it is working hard! Just let it do its work and be patient.
Desktop Browser Downloads
. . .
. . .
. . .
. . .
Desktop Authenticator Downloads. . .
. . .
. . .
. . .
**Desktop Use Cases**
. . .
CLI is an acronym for Command Line Interface commonly known as the Command Prompt on Windows and Terminal on OSX. These Terminal Emulator’s are GUI’s (Graphical User Interface’s) that allow a user to interact with The shell. The Shell is a command-line interface program that takes commands from the user as an input, processes the command, and prints out the output to the display.
Linux users regularly use Terminal Emulators to install/uninstall programs and run various commands although over the years Linux’s various operating system’s GUI’s have gotten much better removing this necessity.
Using the CLI can seem very intimidating and very geeky especially to new users. But, it actually is quite simple and can be fun to work with.
Maidsafe already has a great guide on how to install their CLI on github that I cannot improve on much. For Windows users I can run you through the install process visually. And then later in this guide we can run through some tests together.
. . .
Reporting Bugs / Crashes / User Experiences
. . .
. . .