User Tools

Site Tools


es:en:text_files_adaptor

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

es:en:text_files_adaptor [2019/11/07 11:00]
montse
es:en:text_files_adaptor [2025/03/31 13:34] (current)
ale
Line 1: Line 1:
-====== Adaptador Archivos de Texto ======+Text Files Adaptor 
 +Introduction 
 +Through the Text Files Adaptor, TAST can manage plain text files and use them in testing. It’s possible to perform single tests with this adaptor or End to end tests connecting with other adaptors either.
  
 +Initialization Parameters
 +FilePath: the complete path, including the name of the file, of the file represented by the adapter in the diagram.
 +CharSet: the charset used to create the file. For example, if you are using files for Webservice testing, charset must be UTF-8. If you are using files from Windows to one FTP/SFTP server charset must be CP1252.
 +It is really important to select properly the charset of the file, the return carriage character is handled in a different way depending on it. It can impact in all the predefine functions managing the file in H-TEST.
 +To select the proper charset you, it is possible to identify it using the text editor in the following way:
  
  
-===== Parámetros de Inicialización ===== 
  
-  * **FilePath:​** La ruta completa, incluido el nombre del archivo representado por el adaptador en el diagrama. +Charset.png
-  * **CharSet:​** El conjunto de caracteres usados en el archivo a tratar. Por ejemplo, si usas ficheros para probar ficheros Webservices,​ el charset suele ser UTF-8. Si usas ficheros de Windows descargados a través de FTP/SFTP el charset suele ser CP1252.\\ \\ **IMPORTANTE**:​ Es muy importante seleccionar correctamente el charset del fichero, porque el retorno de carro se interpreta de forma diferente según el charset seleccionado y esto puede impactar en todas las funciones predefinidas que gestionan el fichero de texto en TAST.\\ \\ Para seleccionar el charset correcto del fichero puedes identificarlo en el editor de texto de la siguiente forma:+
  
 +Create/​Overwrite:​ when the checkbox is marked, H-TEST will create a new file or overwrite it if the file already exists.
 +Functions
 +closeFile():​ closes the file and release the associated resources. Returns true if the file could be closed correctly or false otherwise. Input parameters are not required.
 +containsText(SearchString):​ returns true if the text string entered in the searchString parameter exists in the file, false otherwise.
 +countFileLine():​ returns the number of lines in the file. Input parameters are not required.
 +countTextFile():​ this function counts the number of times a string appears in a file. The input parameter searchString allow the user to search and execute the comparison.
 +deleteFtpFile():​ this function deletes a file from the FTP server. Returns if the operation was successful or it was not. The parameters that function needs are:
 +The Host parameter represents the address of the remote machine where the file resides.
 +The User parameter represents the user of connection to the remote system.
 +The Password parameter represents the user's password on the remote system.
 +The RemotePath parameter represents the path of the file on the remote system.
 +The Port parameter represents the port number of the server.
 +deleteSftpFile():​ this function deletes a file from the SFTP server. Returns if the operation was successful or it was not. The parameters that function needs are:
 +The Host parameter represents the address of the remote machine where the file resides.
 +The User parameter represents the user of connection to the remote system.
 +The Password parameter represents the user's password on the remote system.
 +The RemotePath parameter represents the path of the file on the remote system.
 +The Port parameter represents the port number of the server.
 +generateFileAsEvidence():​ the function generates a copy of the file in it's current state to add as evidence.
 +getFileText():​ reads the content of the file and it returns as a TastDataString variable. It does not require input parameters.
 +getFtpFile(Host,​ User, Password, RemotePath, LocalPath): allows transferring a file via the FTP protocol of a remote system to the local system in which the diagram is executed.
 +Returns true if the operation is successful, false otherwise.
 +The Host parameter represents the address of the remote machine where the file resides.
 +The User parameter represents the user of connection to the remote system.
 +The Password parameter represents the user's password on the remote system.
 +The RemotePath parameter represents the path on the remote system to the file that we want to transfer.
 +The LocalPath parameter represents the path, in the local file system, where we want to transfer the file.
 +getLineLength(lineNum):​ returns the length of the file line indicated by the lineNum parameter.
 +getNumColumns():​ returns the number of columns contained in the TastTableData that was generated by the execution of the loadCsvFile function.
 +It requires the execution of the loadCsvFile function in previous steps of the diagram.
  
-{{:​en:​charset_example.png?​700|}} +getOwner(): return file 's owner in the filesystemInput parameters are not required
- +getReadLine(lineNum): returns ​a variable ​of type String ​to the executor with the content of the number of line indicated by the lineNum parameter
- +getSftpFile(Host, Port, User, Password, ​RemotePathLocalPath): allows transferring ​file via the SFTP protocol of a remote system to the local system in which the diagram is executed
-  * **Create/​Overwrite:​** Cuando el check está seleccionado,​ TAST creará un Nuevo fichero o lo sobrescribirá si ya existe.  +Returns true if the operation is successfulfalse otherwise
- +The Host parameter represents the address of the remote machine where the file resides
- +The Port parameter represents the port number on which the SFTP server listens for incoming connectionsThe Sftp takes port 22 by default
- +The User parameter represents the user of connection to the remote system
-===== Funciones ===== +The Password ​parameter represents the user's password on the remote system. 
- +The RemotePath ​parameter represents the path on the remote system to the file that we want to transfer
-  * **closeFile():** Cierra el archivo y libere los recursos asociadosDevuelve true si el archivo puede cerrarse correctamente o falso de lo contrario+The LocalPath parameter represents the pathin the local file systemwhere we want to transfer the file
- +getSize(): ​returns the file size in KiloBytes. Input parameters are not required
-  * **containsText(searchString):** Devuelve verdadero si el valor de la cadena de texto del parámetro searchString existe en el archivo, de lo contrario es falso. +getTableValue(RowNum,​ ColNum): ​returns the contained value of the cell indicated by the RowNum ​and ColNum ​parameters.  
- +It requires the execution of the loadCsvFile ​function in previous steps of the diagram.
-  * **countFileLine():​** Devuelve el número de líneas del fichero. +
- +
-  * **getFtpFile(Host,​ User, Password, remotePath, localPath):​** Permite transferir un archivo ​través del protocolo Ftp de un sistema remoto al sistema local en el que se ejecuta el diagrama.  +
-        * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso.  +
-        * El parámetro Host indica la dirección de la máquina remota donde reside el archivo.  +
-        * El parámetro User indica el usuario de la conexión al sistema remoto.  +
-        * El parámetro Password indica la contraseña del usuario en el sistema remoto.  +
-        * El parámetro remotePath indica la ruta en el sistema remoto del archivo que queremos transferir. +
-        * El parámetro localPath representa la ruta donde queremos transferir el archivo. +
- +
-  * **getLineLength(numLine):​** Devuelve la longitud de la línea de archivo indicada por el parámetro numLine. +
- +
-  * **getNumColumns():​** Devuelve el número de columnas contenidas en TastTableData que fue generado mediante la ejecución de la función dBGetQueryData. **Requiere la ejecución de la función dBGetQueryData en los pasos anteriores del diagrama**. +
- +
-  * **getOwner():​** Devuelve el propietario del fichero en el sistema de archivos. +
- +
-  * **getReadLine(numLine):​** Devuelve una variable ​de tipo String ​al ejecutor con el contenido del número de línea indicado por el parámetro numLine+
- +
-  * **getSFtpFile(Host, Port, User, Password, ​remotePathlocalPath):** Permite transferir un archivo ​través del protocolo SFtp de un sistema remoto al sistema ​local en el que se ejecuta el diagrama+
-      * Devuelve verdadero si la operación finaliza con éxito, de lo contrariofalso+
-      * El parámetro ​Host representa la dirección del equipo remoto donde reside el archivo+
-      * El parámetro ​Port representa el número de puerto en el que el servidor ​SFTP escucha las conexiones entrantesEl SFTP toma el puerto ​22 por defecto+
-      * El parámetro ​User representa el usuario de la conexión al sistema remoto+
-      * El parámetro ​Password ​representa la contraseña del usuario en el sistema remoto +
-      * El parámetro ​RemotePath ​representa la ruta en el sistema remoto al archivo que queremos transferir+
-      * El parámetro localPath representa la rutaen el sistema de archivos ​local, ​donde queremos transferir el archivo+
- +
-  * **getSize():** Devuelve el tamaño del fichero en KiloBytes. +
- +
-  * **getTableValue(RowNum,​ ColNum):** Devuelve el valor contenido de la celda indicada por los parámetros ​RowNum ​ColNum. **Requiere la ejecución de la función dBGetQueryData en los pasos anteriores del diagrama**+
- +
-  * **lineContainsText(numLine,​ searchString):​** Devuelve verdadero si la cadena de texto introducida en el parámetro searchString existe en la línea del archivo indicada por el parámetro numLine, y falso en caso contrario. +
- +
-  * **loadCsvFile(separator):​** Lee el contenido de un archivo de tipo csv y lo transforma en una variable TastTableData con la que podamos operar sobre los datos en los siguientes pasos del diagramaEl parámetro separator indica el carácter separador de los campos en el archivo. +
- +
-  * **newFile(FilePath):​** Crea o anula un archivo, con la ruta y el nombre indicados por el parámetro "​filePath"​. Si el archivo no existe, TAST lo creará como un archivo vacío. Si el archivo existe, TAST borrará el archivo actual y creará un nuevo archivo. +
- +
-  * **openFile():​** Comprueba la existencia del archivo en el sistema de ficheros y los permisos de lectura/​escritura del mismo. Devuelve verdadero si al archivo se puede acceder correctamente o falso en caso contrario. +
- +
-  * **openNewFile():​** Restablece el contenido del archivo configurado a vacío. Este archivo debe existir. +
- +
-  * **putFtpFile(Host,​ User, Pasword, LocalFileName,​ RemoteFileName,​ hostDirectory):​** Permite transferir un archivo, mediante el protocolo Ftp, del sistema local en el que se ejecuta el diagrama al sistema remoto. ​         +
-        * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso. +
-        * El parámetro Host representa la dirección del equipo remoto donde reside el archivo. +
-        * El parámetro User indica el usuario de la conexión al sistema remoto. +
-        * El parámetro Password indica la contraseña del usuario en el sistema remoto. +
-        * El parámetro LocalFileName representa la ruta completa al archivo en el sistema local. +
-        * El parámetro RemoteFileName representa el nombre del archivo en el sistema remoto. +
-        * El parámetro HostDirectory representa el directorio, en el sistema de archivos remoto, donde queremos transferir el archivo. +
- +
-  * **putSFtpFile(Host,​ Port, User, Password, LocalPath, remotePathFormed):​** Permite transferir un archivo, mediante el protocolo SFtp, del sistema local en el que se ejecuta el diagrama al sistema remoto. +
-      * Devuelve verdadero si la operación finaliza con éxito, de lo contrario, falso. +
-      * El parámetro Host indica la dirección de la máquina remota donde reside el archivo. +
-      * El parámetro Port representa el número de puerto en el que el servidor SFTP escucha las conexiones entrantes. +
-      * El parámetro User indica el usuario de la conexión al sistema remoto. +
-      * El parámetro Password indica la contraseña del usuario en el sistema remoto. +
-      * El parámetro localPath representa la ruta completa y el nombre del archivo en el sistema local. +
-      * El parámetro remotePathFormed representa la ruta completa y el nombre del archivo en el sistema remoto. +
- +
-  * **replaceText(From_Str,​ To_Str):** Permite sustituir todas las ocurrencias de la cadena "​From_Str"​ por la cadena "​To_Str",​ y guardará el archivo de nuevo. +
- +
-  * **writeEnter:​** La función añade un retorno de carro al fichero. +
- +
-  * **writeTo(writeString):​** Escriba la cadena de texto en el archivo, al final del mismo.  +
-      * Devuelve verdadero si la operación de escritura fue exitosa, de lo contrario, falsa. +
  
 +getTextFileData():​ keeps all the content of the file in an array and another file for futures operations. It does not require input parameters.
 +lineContainsText(lineNum,​ StringToSearch):​ returns true if the text string entered in the StringToSearch parameter exists in the line of the file indicated by the lineNum parameter, and false otherwise.
 +loadCsvFile(Separator):​ reads the contents of a csv-type file, and transforms it into a TastTableData variable that is returned to the executor so that we can operate on the data in the next steps of the diagram. The separator parameter indicates the separator character of fields in the file.
 +newFile(FilePath):​ creates or overrides a file, with the path and the name indicated by the parameter “filePath”.
 +If the file doesn´t exist, TAST will create it, as an empty file.
 +If the file exist, TAST will delete the current file, and it will create a new empty one.
 +openFile(): checks the existence of the file in the file system, and the reads / writes permissions on it. Returns true if the file could be accessed correctly or false otherwise. Input parameters are not required.
 +openNewFile():​ resets the content of the configured file to empty. This file must exist. Input parameters are not required.
 +putFtpFile(Host,​ User, Pasword, LocalFileName,​ RemoteFileName,​ HostDirectory):​ allows to transfer a file, by the Ftp protocol, of the local system in which the diagram is executed to the remote system.
 +Returns true if the operation is successful, false otherwise.
 +The Host parameter represents the address of the remote machine where the file resides.
 +The User parameter represents the user of connection to the remote system.
 +The Password parameter represents the user's password on the remote system.
 +The LocalFileName parameter represents the full path to the file on the local system.
 +The RemoteFileName parameter represents the name of the file on the remote system.
 +The HostDirectory parameter represents the directory, in the remote file system, where we want to transfer the file.
 +putSftpFile(Host,​ Port, User, Password, LocalPath, RemotePathFormed):​ allows to transfer a file, by the Sftp protocol, of the local system in which the diagram is executed to the remote system.
 +Returns true if the operation is successful, false otherwise.
 +The Host parameter represents the address of the remote machine where the file resides.
 +The Port parameter represents the port number on which the file server waits for incoming connections.The SFTP takes port 22 by default.
 +The User parameter represents the user of connection to the remote system.
 +The Password parameter represents the user's password on the remote system.
 +The LocalPath parameter represents the complete path and the name of the file in the local system.
 +The RemotePathFormed parameter represents the full path and the name of the file on the remote system.
 +replaceText(From_Str,​ To_Str): allows to replace all the occurrences of the string “From_Str” by the string “To_Str”,​ and will save the file again.
 +writeEnter: the function append a carriage return to the file. Input parameters are not required.
 +writeTo(StringToWrite):​ writes the text string in the file, in append mode.
 +Returns true if the write operation was successful, false otherwise. The input parameters are StringToWrite to receive the text string and addBreakLine to skip the line (this parameter is a Boolean).
es/en/text_files_adaptor.1573124440.txt.gz · Last modified: 2019/11/07 11:00 by montse