Uso del contexto de IDT - FreeRTOS
Esquema de contextoAcceso a los datos del contexto

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Uso del contexto de IDT

Cuando IDT ejecuta un conjunto de pruebas, este puede acceder a un conjunto de datos que se puede utilizar para determinar cómo se ejecuta cada prueba. Estos datos se denominan contexto de IDT. Por ejemplo, la configuración de los datos de usuario proporcionada por los ejecutores de pruebas en un archivo userdata.json se pone a disposición de los conjuntos de pruebas en el contexto de IDT.

El contexto de IDT puede considerarse un documento JSON de solo lectura. Los conjuntos de pruebas pueden recuperar datos del contexto y escribirlos en él mediante tipos de datos JSON estándar, como objetos, matrices, números, etc.

Esquema de contexto

El contexto de IDT utiliza el siguiente formato:

{
    "config": {
        <config-json-content>
        "timeoutMultiplier": timeout-multiplier,
        "idtRootPath": <path/to/IDT/root>
    },
    "device": {
        <device-json-device-element>
    },
    "devicePool": {
        <device-json-pool-element>
    },
    "resource": {
        "devices": [
            {
                <resource-json-device-element>
                "name": "<resource-name>"
            }
        ]
    },
    "testData": {
        "awsCredentials": {
            "awsAccessKeyId": "<access-key-id>",
            "awsSecretAccessKey": "<secret-access-key>",
            "awsSessionToken": "<session-token>"
        },
        "logFilePath": "/path/to/log/file"
    },
    "userData": {
        <userdata-json-content>
    }
}
config

Información del archivo config.json. El campo config también contiene los siguientes campos adicionales:

config.timeoutMultiplier

El multiplicador para cualquier valor de tiempo de espera utilizado por el conjunto de pruebas. El ejecutor de pruebas especifica este valor desde la CLI de IDT. El valor predeterminado es 1.

config.idRootPath

Este valor es un marcador de posición para el valor de ruta absoluto de IDT al configurar el archivo userdata.json. Se utiliza en los comandos build y flash.

device

Información sobre el dispositivo seleccionado para la ejecución de la prueba. Esta información equivale al elemento de matriz devices del archivo device.json del dispositivo seleccionado.

devicePool

Información sobre el grupo de dispositivos seleccionado para la ejecución de la prueba. Esta información equivale al elemento de matriz del grupo de dispositivos en el nivel superior definido en el archivo device.json para el grupo de dispositivos seleccionado.

resource

Información sobre los dispositivos de recursos del archivo resource.json.

resource.devices

Esta información equivale a la matriz devices definida en el archivo resource.json. Cada elemento devices incluye el siguiente campo adicional:

resource.device.name

El nombre del dispositivo de recursos. Este valor se establece en el valor requiredResource.name en el archivo test.json.

testData.awsCredentials

Las AWS credenciales utilizadas por la prueba para conectarse a la AWS nube. Esta información se obtiene del archivo config.json.

testData.logFilePath

La ruta al archivo de registro en el que el caso de prueba escribe los mensajes de registro. El conjunto de pruebas crea este archivo si no existe.

userData

Información proporcionada por el ejecutor de la prueba en el archivo userdata.json.

Acceso a los datos del contexto

Puede consultar el contexto mediante la JSONPath notación de los archivos de configuración y del ejecutable de texto con la tecla GetContextValue y GetContextString APIs. La sintaxis de JSONPath las cadenas para acceder al contexto IDT varía de la siguiente manera:

  • En suite.json y test.json, se usa {{query}} Es decir, no utilice el elemento raíz $. para iniciar la expresión.

  • En statemachine.json, se usa {{$.query}}.

  • En los comandos de la API, se utiliza query o {{$.query}}, según el comando. Para obtener más información, consulte la documentación en línea en. SDKs

En la siguiente tabla se describen los operadores de una expresión de foobar JSONPath típica:

Operador Descripción
$ El elemento raíz. Como el valor de contexto de nivel superior de IDT es un objeto, se suele utilizar $. para iniciar las consultas.
.childName Accede al elemento secundario con el nombre childName desde un objeto. Si se aplica a una matriz, genera una nueva matriz con este operador aplicado a cada elemento. El nombre del elemento distingue entre mayúsculas y minúsculas. Por ejemplo, la consulta para acceder al valor awsRegion del objeto config es $.config.awsRegion.
[start:end] Filtra los elementos de una matriz y los recupera desde el índice start hasta el índice end, ambos incluidos.
[index1, index2, ... , indexN] Filtra los elementos de una matriz y los recupera únicamente de los índices especificados.
[?(expr)] Filtra los elementos de una matriz con la expresión expr. Esta expresión debe evaluarse en un valor booleano.

Para crear expresiones de filtro, utilice la siguiente sintaxis:

<jsonpath> | <value> operator <jsonpath> | <value>

En esta sintaxis:

Puede utilizar JSONPath consultas con el formato {{query}} como cadenas de marcadores de posición dentro de los environmentVariables campos args y de los test.json archivos y dentro de los environmentVariables campos de los suite.json archivos. IDT realiza una búsqueda contextual y rellena los campos con el valor evaluado de la consulta. Por ejemplo, en el archivo suite.json, puede utilizar cadenas de marcadores de posición para especificar los valores de las variables de entorno que cambian con cada caso de prueba e IDT rellenará las variables de entorno con el valor correcto para cada caso de prueba. Sin embargo, cuando se utilizan cadenas de marcadores de posición en los archivos test.json y suite.json, las consultas tienen en cuenta las siguientes consideraciones:

  • Debe escribir en minúsculas cada vez que aparezca la clave devicePool en la consulta. Es decir, utilizar devicepool en su lugar.

  • Para las matrices, solo puede usar matrices de cadenas. Además, las matrices utilizan un formato item1, item2,...,itemN no estándar. Si la matriz contiene solo un elemento, se serializa como item, lo que la hace que no se pueda distinguir de un campo de cadena.

  • No puede utilizar marcadores de posición para recuperar objetos del contexto.

Debido a estas consideraciones, le recomendamos que, siempre que sea posible, utilice la API para acceder al contexto en su lógica de prueba en lugar de cadenas de marcadores de posición en los archivos test.json y suite.json. Sin embargo, en algunos casos puede ser más conveniente utilizar JSONPath marcadores de posición para recuperar cadenas individuales y configurarlas como variables de entorno.