Skip to content

syntax

Jump to bottom
Nestor Arias edited this page Aug 12, 2022 · 3 revisions

jWebAppTester

English

Syntax of the script files

Every line starting with #, is ignored. This program builds a tree the folder "scripts" and subfolders. The tree is composed of folders and actions in every txt file. If there is a file _start.txt, that file will be read and executed before proceeding to any other action in that folder. If there is a file _end.txt, that file will be read and executed after any other action in that folder.

Folder Tree Examples [scripts]

scripts/_start.txt

scripts/_end.txt

[scripts/management]

scripts/management/_start.txt

scripts/management/crearpregunta.txt

scripts/management/listarpreguntas.txt

If you request the execution of the command "scripts/management/listarpreguntas", the program will run these commands in order:

scripts/_start.txt

scripts/management/_start.txt

scripts/management/listarpreguntas.txt

scripts/_end.txt

The files _start.txt and _end.txt are not mandatory: they are justa a way to automate actions as authentication prior to work with a page or execute a logout after using a given page

Every action is a set of instructions to be executed by your web browser. each instruction has the format "action={command}"

[Supported actions]

go - Opens a web page.

Example:

go={https://duckduckgo.com/}

wait - Waits for a page to be completely loaded after a change in the location bar URL, or after clicking any element. The browser will wait until a given object (given its selector), appear or simply the page to be fully loaded

Params:

  • selector : The selector of the object to wait for. Could be a css or xpath selector
  • type (Optional): The type of the selector to be used: "css/xpath". If missing, css will be used

Examples:

wait={}

wait={
  "selector":"duckbar"
}

wait={
  "selector":"//*[@id="search_form_input_homepage"]",
  "type":"xpath"
}

write - Writes text in a page component given its css selector.

Params:

  • selector: the css selector of the component to write on, If selector=="", then the action is send to the whole page. e.g.: CTRL+P
  • text: the text to write
  • type (Optional): The type of the selector to be used: "css/xpath". If missing, css will be used

Examples:

write={
 "selector":"search_form_input_homepage",
 "text":"inicio"
}

write={
 "selector":"#search_form_input_homepage",
 "text":"inicio"
  "type":"css"
}

You can specify special commands (ALT, F1,ENTER, ESCAPE, etc) using this format:

[%Keys.CONTROL]

The full list of supported constants can be found in https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/Keys.html If you need to send command combinations, you can write using this format:

[%Keys.CONTROL,Keys.ALT]

You can also add non-commands characters, like this:

[%Keys.CONTROL,Keys.ALT]r

Examples:

write={
 "selector":"search_form_input_homepage",
 "text":"[%Keys.CONTROL,Keys.ALT]r"
}

write={
 "selector":"",
 "text":"[%Keys.CONTROL]p"
}

If you need to write the text "[%", instead write "[%%"

click - clicks a component of the page given a css selector

Params:

  • selector (optional): The selector of the object to click. Could be a css or xpath selector
  • type (optional): The type of the selector to be used: "css/xpath". If missing, css will be used If no selector provided, the click event is triggered wherever the mouse pointer is located.

Example:

click={ 
  "selector":"search_button_homepage"
}

double click - Double-clicks any element in the page, given its selector.

Params:

  • selector (optional): The selector of the object to double click. Could be a css or xpath selector
  • type (optional): The type of the selector to be used: "css/xpath". If missing, css will be used If no selector provided, the double click event is triggered wherever the mouse pointer is located.

Example:

double click={
    "selector": "body"
}

right click - Right clickks any element in the page, given its selector.

Params:

  • selector (optional): The selector of the object to right click. Could be a css or xpath selector
  • type (optional): The type of the selector to be used: "css/xpath". If missing, css will be used If no selector provided, the right click event is triggered wherever the mouse pointer is located.

Example:

right click={
    "selector": "Identificacion"
}

place mouse pointer - Place the mouse pointer in screen

Params:

  • offsetType (optional): One of these: FROM_UL_CORNER (default)- To place the mouse pointer relative to the upper left corner FROM_CUR_LOCATION - To place the mouse pointer from its current location FROM_CNTR_OBJECT - To place the mouse pointer from the center of a given object
  • x: the horizontal pixels to move the mouse pointer
  • y: the vertical pixels to move the mouse pointer -selector: the selector for the object (use only with FROM_CNTR_OBJECT) -type: Type of the selector for the object (default = css) Examples:
place mouse pointer={
    "offsetType":"FROM_UL_CORNER",
    "x":"150",
    "y":"350"
}

place mouse pointer={
    "offsetType":"FROM_CNTR_OBJECT",
    "x":"150",
    "y":"350",
    "selector":"img:nth-of-type(2)"
}

scroll - Scrolls the screen horizantally (x) or vertically (y) a given amount of pixels.

Params:

  • selector (optional): The selector of the object to scroll on. Could be a css or xpath selector. If missing, the whole page will be selected (body)
  • type (optional): The type of the selector to be used: "css/xpath". If missing, css will be used
  • x : pixels to scroll in horizontal axis (>0 right, <0 left)
  • y : pixels to scroll in vertical axis (>0 down, <0 up)

Examples:

scroll={
   "x":"0",
   "y":"100"
}

scroll={
   "x":"10",
   "y":"-100"
}

scroll={
   "x":"10",
   "y":"-100",
   "selector":"//*[@id='main-content-inner']",
   "type": "xpath"
}

pause - Waits a given time, before proceeding with the next instruction.

Params:

  • time: NUMBER UNITS, Where UNITS can be one of these values: S=milliseconds,s=seconds, m=minutes, h=hours, d=days

Example:

To wait three seconds

pause={"time":"3 s"}

To wait 10 minutes

pause={"time":"10 m"}

pick choice - Prompts user to pick a single choice among a list, stores selected

option in a variable. Params:

  • selector: Required. This selector must match to a collection of HTML elements
  • subselector: Secondary css path, to specify the element of every option to be shown to the user. By default, the text of every element gathered with the "selector" will be used as option.
  • type (optional): The type of the selector to be used: "css/xpath". If missing, css will be used
  • variable: Required. Name of the variable used to store user's selection.
  • title: Title for the promtpt window
  • message: Message to use in the prompt window.
  • sorted: Sort options alphabetically? (yes/no)

Example:

pick choice={
 "selector":"div.central-featured-lang",
 "subselector": "a",
 "sorted":"yes",
 "title":"Wikipedia",
 "message":"Select a language",
 "variable":"Language"
}

Set variable - A handy way to assign text to a name.

Params:

  • name : Name of the variable. Allowed characters in the name: numbers, letters and the signs _ -. e.g.: "MY_KEY","comment-02"
  • value : The text inside it

Example:

set={"name":"comment","value":"I like this"}

Set browser

Use to change between these browsers:

  • CHROME,
  • EDGE,
  • FIREFOX,
  • INTERNET_EXPLORER,
  • OPERA,
  • SAFARI

Example:

browser={SAFARI}

Note: When a new browser is set, the default page will be loaded and all authentication data will be lost

for

iterative cycle, intended to repeat a set of actions several times. It always must be finished with an "end={}" instruction. formats:

for={"var":"VAR_NAME","expr":"ELEMENTS_TO_ITERATE"}
...instructions
end={}

or

for={"var":"VAR_NAME","selector":"CSS_SELECTOR"}
...instructions
end={}

where

  • VAR_NAME - Name of the variable you want to be set with the proper value for each iteration
  • ELEMENTS_TO_ITERATE - This parameter has these forms:
    • "A B C D 1 2 three" This sets respectively the values "A", "B", "C", "D", "1", "2", "three" on the variable for each iteration
    • "{-50..50}" This format asks the iteration cycle to set the variable with the numbers -50, -49, -48,... 50 for each iteration.
    • "{-0001..50}" As before, but the padding zeroes makes the number to have always 4 digits: "-0001", "0000", "0001", ... "0050" for each iteration. -CSS_SELECTOR - Iterates on the elements collected with the css path "CSS_SELECTOR:nth-child(N)", for N being a number from 1 to the number of elements found. Only CSS selectors are allowed for this command. Three different ways to use:

Examples:

for={"var":"i","expr":"A1 B2 C3 D4 E5 F6"}
    write={"text":" [:i] ","selector":"#note-area"}
end={}

#writes 52 times
"for={"var":"i", "exp":"{-1..50}"}
         write={"text":" [:i] ","selector":"#note-area"}
end={}

#clicks every element under "selector":"ul.pagination > li.paginate_button" and waits 10 seconds
for={"var":"div", "selector":"ul.pagination > li.paginate_button"}
        run("    click={"selector":"[:div] > a"}
        run("    pause={"time":"10 s"}
end={}

Variables

Use existing variables inside your instructions writing the variable's name between square brackets like this: [:VARIABLE_NAME]

Example:

click={
 "selector":"[:Language] > a"
}

Passwords

If you want to store encripted passwords in your scripts, so that nobody else can read them (typically usernames & passwords to enter in secured sites), encrypt your word with the button "Crypt password" and write the password in your script file using this sintax:

[$YOUR_ENCRIPTED_PASSWORD]

If you need to write the text "[$", write "[$$" instead. Keep in mind: the hash used for each password is unique per computer

Example:

write={
 "selector":"input[type='search']",
  \#This encripted password won't be decrypted in your machine
  "text":"[$QTUgOMDYfXZ4gEjZ7BTYpw==]"
}
Notes About passwords:
  • You can't nest encripted text, variables and special characters in any order: [:[%MY_ENCRIPTED_TEXT]] and [%[:VARIABLE_WITH_ENCRIPTED_TEXT]], are invalid expressions.
  • The encripted blocks created on your machine can't be decrypted in other machines: every password algorithm is unique to each machine.
features with this version
  • Variables are not forgotten between different files
  • commands "set"
known Issues:
  • Selectors won't work inside an IFRAME element.
About CSS Selectors:

https://www.w3.org/wiki/CSS/Selectors https://www.w3schools.com/cssref/css_selectors.asp https://www.w3schools.com/xml/xpath_syntax.asp https://docs.scrapy.org/en/latest/topics/selectors.html

Running Binary version

You can download the last running version at https://github.com/omarazrat/jWebAppTester/releases

Debugging

This program writes all its output to the file WebTester.log

Upcoming

  • for_each loops
  • Mouse Over

Español

Sintaxis de los archivos de comandos

Cada lí­nea que comienza con #, no se tiene en cuenta y será tratada como comentario. El programa lee la carpeta "scripts" y con todas las carpetas en su interior arma un árbol. El árbol se compone de carpetas y de acciones representadas en cada uno de los archivos con extension .txt en cada carpeta Si se encuentra un archivo _start.txt en una carpeta, se ejecutará ese archivo antes de ejecutar cualquier otra acción en la carpeta. Si se encuentra un archivo _end.txt en una carpeta, se ejecutará ese archivo despuíés de ejecutar cualquier acción en la carpeta. Ejemplo de estructura

[scripts]

scripts/_start.txt

scripts/_end.txt

[scripts/administracion]

scripts/administracion/_start.txt

scripts/administracion/crearpregunta.txt

scripts/administracion/listarpreguntas.txt

Si desde el programa se solicita la ejecución del comando "scripts/administracion/listarpreguntas", el programa ejecutará los siguientes comandos en orden:

scripts/_start.txt

scripts/administracion/_start.txt

scripts/administracion/listarpreguntas.txt

scripts/_end.txt

Los archivos _start.txt y _end.txt no son obligatorios, son solo una forma de colocar acciones como autenticarse antes de entrar a una página en la cual se ejecutará un comando o cerrar sesión despuíés de salir de cierta página

Cada acción es un conjunto de instrucciones que serán ejecutadas por el navegador de internet. Cada instrucción tiene el formato "acción={comando}"

[Acciones soportadas]

ir - Abre una página internet.

Ejemplo:

ir={https://duckduckgo.com/}

esperar - Espera a que la página cargue completamente despues de un cambio de URL o despues de hacer clic en algun lado. esperará a que cierto objeto (dado su selector), aparezca o simplemente a que la página cargue completa Argumentos:

  • selector : El selector para el objeto a esperar. Puede ser un selector css o xpath
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css

Ejemplos:

esperar={}

esperar={
  "selector":"duckbar"  
}

esperar={
  "selector":"//*[@id="search_form_input_homepage"]",
  "tipo":"xpath"
}

escribir - Escribe texto en un componente de la pagina dado un selector css.

Argumentos:

  • selector : El selector para el objeto en el cual escribir. Puede ser un selector css o xpath
  • texto : Lo que se va a escribir en el componente
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css Ejemplo:
escribir={
 "selector":"search_form_input_homepage",
 "texto":"inicio"
}

escribir={
 "selector":"#search_form_input_homepage",
 "tipo" : "css";
 "texto":"inicio"
}

Puede enviar comandos especiales (ALT, F1,ENTER, ESCAPE, etc) escribiendolo de la siguiente forma:

[%Keys.CONTROL]

Utilice las constantes definidas en https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/Keys.html

Si requiere enviar combinaciones de comandos, puede escribirlo así­:

[%Keys.CONTROL,Keys.ALT]

Además puede agregar otras letras así­:

[%Keys.CONTROL,Keys.ALT]r

Ejemplos:

escribir={
 "selector":"search_form_input_homepage",
 "texto":"[%Keys.CONTROL,Keys.ALT]r"
}

escribir={
 "selector":"",
 "texto":"[%Keys.CONTROL]p"
}

Si necesita escribir el texto "[%", sin referirse a ningún comando, escrí­balo así­: "[%%"

clic - Hace clic en un componente de la pagina dado un selector css.

Argumentos:

  • selector : (Opcional) El selector para el objeto sobre el cual hacer clic. Puede ser un selector css o xpath
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css Si no se especifica un selector, se lanza el evento clic donde quiera que esté ubicado el cursor.

Ejemplo:

clic={ 
  "selector":"search_button_homepage"
}

doble clic - Hace doble clic en algun elemento de la pagina, dado su selector.

Argumentos:

  • selector : (Opcional) El selector para el objeto sobre el cual hacer doble clic. Puede ser un selector css o xpath
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css Si no se especifica un selector, se lanza el evento doble clic donde quiera que esté ubicado el cursor.

Ejemplo:

doble clic={
    "selector": "/html/body",
     "tipo": "xpath"
}

clic derecho - Hace clic derecho en cualquier elemento de la pagina, dado su selector.

Argumentos:

  • selector : (Opcional) El selector para el objeto sobre el cual hacer clic derecho. Puede ser un selector css o xpath
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css Si no se especifica un selector, se lanza el evento clic derecho donde quiera que esté ubicado el cursor.

Ejemplo:

clic derecho={
    "selector": "Identificacion"
}

ubicar puntero raton - Ubica el puntero del ratón en una posición específica

Parametros:

  • tipoMovimiento (opcional): Una de las siguientes opciones: FROM_UL_CORNER (por omisión)- Para ubicar el puntero en una posición relativa a la esquina superior izquierda. FROM_CUR_LOCATION - Para ubicar el puntero moviéndolo desde su ubicación actual. FROM_CNTR_OBJECT - Para ubicarlo desde el centro de un objeto específico.
  • x: el número de pixeles a desplazar horizontalmente(>0 a la derecha, <0 a la izquierda)
  • y: el número de pixeles a desplazar verticalmente(>0 abajo, <0 arriba)
  • selector (opcional): El selector para el objeto sobre el cual hacer el desplazamiento. Si no se especifica se toma la página activa (body). Sólo utilizar con FROM_CNTR_OBJECT
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css

Ejemplos:

ubicar puntero raton={
    "tipoMovimiento":"FROM_UL_CORNER",
    "x":"150",
    "y":"350"
}

ubicar puntero raton={
    "tipoMovimiento":"FROM_CNTR_OBJECT",
    "x":"150",
    "y":"350",
    "selector":"img:nth-of-type(2)"
}

desplazar - Realiza un desplazamiento por la pantalla horizontalmente (x) o verticalmente (Y)

una cierta cantidad de pixeles. Argumentos:

  • x: el número de pixeles a desplazar horizontalmente(>0 a la derecha, <0 a la izquierda)
  • y: el número de pixeles a desplazar verticalmente(>0 abajo, <0 arriba)
  • selector (opcional): El selector para el objeto sobre el cual hacer el desplazamiento. Si no se especifica se toma la página activa (body)
  • tipo (opcional): El tipo de selector que se está usando: "css/xpath". Si no se especifica, se usará css Ejemplos:
desplazar={
   "x":"0",
   "y":"100"
}

desplazar={
   "x":"10",
   "y":"-100"
}

desplazar={
   "x":"10",
   "y":"-100",
   "selector":"//*[@id='main-content-inner']",
   "tipo": "xpath"
}

pausa - Espera cierto tiempo, antes de continuar con la siguiente instrucción.

Argumentos:

  • tiempo: NUMERO UNIDADES, donde UNIDADES puede tener uno de los siguientes valores: S=milisegundos,s=segundos, m=minutos, h=horas, d=dias

Ejemplos:

Para esperar 3 segundos

pausa={"tiempo":"3 s"}

Para esperar 10 minutos

pausa={"tiempo":"10 m"}

seleccionar opcion - Pide al usuario seleccionar una opción de una lista y guarda el valor seleccionado

en una variable.

Argumentos:

  • selector: Obligatorio. El selector css que corresponde a los elementos HTML a mostrar
  • subselector: Opcional. Ruta complementaria, para determinar el valor de cada opciòn.
  • tipo (opcional): El tipo de selector que se está usando en selector y subselector: "css/xpath". Si no se especifica, se usará css que se mostrará al usuario. Por omisiòn se tomará el texto de cada elemento web asociado con la ruta en el parámetro "selector"
  • variable: Obligatorio. Nombre de la variable que se va a asignar con el elemento que el usuario seleccione
  • titulo: Opcional. Título que tendrá la caja de texto que se va a mostrar al usuario.
  • mensaje: Opcional. Mensaje a mostrar en la caja de texto que se va a mostrar al usuario.
  • orden alfabetico: Opcional. ordenar alfabèticamente las opciones a mostrar (si/no)

Ejemplo:

seleccionar opcion={
 "selector":"div.central-featured-lang",
 "subselector": "a",
 "orden alfabetico":"yes",
 "titulo":"Wikipedia",
 "mensaje":"Seleccione un lenguaje",
 "variable":"Lenguaje"
}

####Asignar variable - Es una forma de guardar texto asociado a un nombre. Argumentos: -nombre : Nombre que tendrá la variable. Caracteres permitidos en el nombre: números, letras y los signos _ -. Ejemplos:"MI_CLAVE","commentario-02" -valor : El texto a ingresar en esa variable

Ejemplo:

asignar={"nombre":"comentario","valor":"Me gusta esto"}

Cambiar de navegador:

Puede cambiar entre los siguientes navegadores:

  • CHROME,
  • EDGE,
  • FIREFOX,
  • INTERNET_EXPLORER,
  • OPERA,
  • SAFARI

Ejemplo:

navegador={SAFARI}

Nota: al abrirse el nuevo navegador, iniciará en la página predeterminada, perdiendo cualquier navegación o autenticación realizada previamente.

Variables

Utilice variables ya definidas como parte de sus instrucciones colocando el nombre de la variable entre los signos [:] así­: [:NOMBRE_VARIABLE] Ejemplo:

clic={
 "selector":"[:Lenguaje] > a"
}

Contraseñas

Si desea almacenar contraseñas u otra información en sus archivos, de tal forma que nadie más pueda leerla (normalmente usuarios y contraseñas para ingresar en sitios seguros), encripte lo que desee con el botón "Encriptar contraseña" y escriba el texto encrptado en su archivo de instrucciones de esta forma: [$SU_CONTRASEÑA_ENCRIPTADA] Se necesita escribir "[$", escriba "[$$".

Ejemplo:

escribir={ "selector":"input[type='search']",

#Esta contraseña no funcionará en otras máquinas.

"texto":"[$QTUgOMDYfXZ4gEjZ7BTYpw==]" }

Notas sobre las contraseñas:
  • No se pueden anidar contraseñas, variables y caracteres especiales en ningún orden: [:[$MI_TEXTO_ENCRIPTADO]] y [$[:VARIABLE_CON_TEXTO_ENCRIPTADO]], son expresiones inválidas.
  • Las contraseñas encriptadas que se creen en su máquina no pueden ser desencriptadas en otras máquinas: cada algoritmo de encripción es único para cada máquina.

#####Problemas conocidos:

  • Los selectores no funcionarán dentro de elementos IFRAME.
Referencias de Selectores:

https://w3.org/wiki/CSS_/_Selectores_CSS https://www.w3schools.com/cssref/css_selectors.asp https://www.w3schools.com/xml/xpath_syntax.asp https://docs.scrapy.org/en/latest/topics/selectors.html

Versión compilada

Si desea utilizar este programa sin compilar nada, use la últimaversión en https://github.com/omarazrat/jWebAppTester/releases

Depuración

El programa escribe todo lo que hace en el archivo WebTester.log

Próximamente

  • iteraciones al estilo for_each
  • Implementar el Mouse Over, esa acción de colocar el cursor sobre un objeto.

Clone this wiki locally