Home

Welcome to the guide-automator-mobile wiki!

GuideAutomator was proposed by professor Rodrigo Souza and originally implemented by Allan Oliveira as part of his Bachelor's thesis. The project is being developed in the context of aSide, a research group at the Federal University of Bahia specialized in software design and evolution.

Related publications:

• GuideAutomator: Continuous Delivery of End User Documentation -- paper accepted at ICSE 2017, NIER Track (New Ideas and Emerging Results)
• GuideAutomator: Automated User Manual Generation with Markdown -- Allan Oliveira's bachelor thesis
• GuideAutomator: Automated User Manual Generation with Markdown -- paper presented at CBSoft 2016 (Tools Track)

Instalation

• Python
• • https://www.python.org/downloads/source/
• Python Libraries
• • pytest, IPython.
• Appium Desktop
• • https://github.com/appium/appium-desktop/releases
• Jupyter notebook
• • https://jupyter.org/install
• ADB
• • https://developer.android.com/studio/command-line/

Getting Started

Description: GuideAutomatorMobile use the code blocks from jupyter notebook to process and generate manual form the app to be documents. You need to connect with your phone using appium in order do generate the document. Exemple:

Appium selector: You need to take the selectors from Appium to use then in you script.

Jupyter notebook with the selectors from Appium.

In the part number one you can see the markdown part created, in the number 2 is a function from GuideAutomatorMobile using the selectors from Appium and the number 3 is the output image process by the GuideAutomator Mobile.

Commands

That is a list with all the commands implemented in the GuideAutomator Mobile.

`

• init() - Initializes a new session on the target smartphone using Appium. `

\begin{longtable}{| p{.40\textwidth} | p{.50\textwidth} |} \caption{Comandos de básicos GuideAutomator Mobile} \ \hline \textbf{Comando} & \textbf{Descrição} \ \hline & Inicializa uma nova sessão no smartfone destino usando o Appium. \ \hline clickById(id) & Clica em um elemento na tela do através do seletor id''. \\ \hline clickByAccessibilityId (accessibilityId) & Clica em um elemento na tela do através do seletor accessibilityId''. \ \hline clickByXPath(xpath) & Clica em um elemento na tela do através do seletor xpath''. \\ \hline sendKeysById(id, text) & Encontra um campo de texto através do seletor id'' e o preenche através com o valor da parâmetro text''. \\ \hline sendKeysByAccessibilityId (accessibilityId, text) & Encontra um campo de texto através do seletor accessibilityId'' e o preenche através com o valor da parâmetro text''. \\ \hline getTextById(id) & Recupera o texto de um label através do seu atributo id''. \ \hline getTextByAccessibilityId (accessibilityId) & Recupera o texto de um label através do seu atributo accessibilityId''. \\ \hline getTextByXpath(xpath) & Recupera o texto de um label através do seu atributo xpath''. \ \hline scrolltoElementById(id) & Desliza a tela até o elemento desejado através do seu atributo id''. \\ \hline scrolltoElementByAccessibilityId (accessibilityId) & Desliza a tela até o elemento desejado através do seu atributo accessibilityId''. \ \hline scrolltoElementByXpath(xpath) & Desliza a tela até o elemento desejado através do seu atributo ``xpath''. \ \hline quit() & Finaliza a sessão do GuideAutomator com o Appium. \ \hline \end{longtable}