Updates SUMMARY.md

Auto commit by GitBook Editor

Author: Shauvik Roy Choudhary

README.md

@@ -1,3 +1,68 @@
-# My Awesome Book
+Android Hardware Documentation
+==============================
+
+# Docker Setup
+
+## Downloading the Docker
+ 
+Pull the image from dockerhub
+sudo docker pull moquality/atest:0.32
+
+## Setup the Docker
+
+### Running tests
+Ensure that you have killed adb server on the host machine. Use adb kill-server.
+
+Run the run.sh bash script inside the docker with:
+```
+docker run -i -t --privileged -v /dev/bus/usb:/dev/bus/usb -v /home/archermind/.android:/root/.android moquality/atest:0.32
+python /app/run.py
+```
+
+### Configuration
+
+All tests can be configured through the config.yml file (See Appendix A). An example config file is:
+```
+device_1: device_id
+testlink_url: "http://tl.moquality.com/lib/api/xmlrpc/v1/xmlrpc.php"
+testlink_key: "api_key"
+testlink_tester: "bot1"
+project_name: "Video Playback Testing"
+testplan_name: "Videoplan" 
+build_name: "NexusM".
+```
+It should be saved in the /app folder.
+
+If you want to edit the config.yml, edit it on the host machine and put it on the docker using:
+```
+docker cp config.yml <container-id> /app/config.yml
+```
+You can find the current docker’s container-id with docker ps.
+
+# Working with Testlink
+
+A current version of testlink is hosted at http://tl.moquality.com (username: archertest, password: testlink). Test cases are pre-loaded and can be viewed in Test Specification tab. 
+
+![Testlink Build/Release Page](testlink.png)
+
+- Create a Build using Build/Releases tab on the right. The build name has to be mentioned in the config file as well. 
+- After creating a Build, an administrator must assign the test cases to a user. Assigning test cases is done using Assign Test Case Execution. 
+- Test cases are executed automatically by our program. It checks periodically if there are any new tests assigned. 
+- In the report, a user can see the details of the substeps for each test case. If all the test cases are executed correctly, the test case is passed.
+
+## Example Output from a Test Case
+
+![Testlink Output](output.png)
+
+# Appendix A
+
+## config.yml configuration
+
+- Config.yml resides in the main directory project android_tests
+- First field is device_1. This field represent the device id and is unique to every phone. A user must enter the valid device id. The device id is obtained using the command  “adb devices” inside the docker machine.
+- Next few fields are “testlink_url”,  “testlink_key”, “testlink_tester” (default is bot 1). These details are filled beforehand and need not to be changed.
+- Next field is “project_name”. Default name is “Video Playback Testing”. It can be changed, but a project with the same name must be created in the Testlink.
+- Next field is “Testplan_name”. Default name is “Videoplan”.
+- Next field is “Build name”. Administrator must create a build on the Testlink (instructions given below) and enter the name of the build here. The test results will be updated for a build. 
+
 
-This file file serves as your book's preface, a great place to describe your book's content and ideas.

SUMMARY.md

@@ -1,3 +1,2 @@
 # Summary
 
-* [First Chapter](chapter1.md)