Testautomation Documentation
This webpage has been created to provide users with testautomation examples and guides, so that they can quickly get started writing automated tests. The test cases are built on the testframework package, which is built in-house by the Testbrains team and this page also includes api-references for this package.
Thanks for reading the docs! Please bear in mid, this is a work in progress and we’re happy if you’d provide us with feedback 👨🔬
Testcase Automation
- Getting started
- Creating your own automated test pipeline
- Important Update 📣: Breaking changes in release of testframework lib v2.0.0
Testframework API reference
- testframework.clients package
- Subpackages
- testframework.clients.brain package
TestClient- Subpackages
- testframework.clients.brain.tester package
TestClient- Submodules
- testframework.clients.brain.tester.car module
- testframework.clients.brain.tester.client_recorded module
- testframework.clients.brain.tester.grid module
- testframework.clients.brain.tester.houseload module
- testframework.clients.brain.tester.pvsystem module
- testframework.clients.brain.tester.solar module
- testframework.clients.brain.tester.wallbox module
- testframework.clients.brain.tester package
- Submodules
- testframework.clients.ops package
OpsClientOpsClient.assert_response_success()OpsClient.assert_sensor_value_matches()OpsClient.check_battery()OpsClient.check_errors()OpsClient.check_preconditions()OpsClient.check_properties_battery()OpsClient.check_properties_dongle()OpsClient.check_properties_inverter()OpsClient.check_value()OpsClient.ensure_default_params()OpsClient.get_manufacturer()OpsClient.run_validation_check()
- Subpackages
- testframework.clients.ops.tester package
OpsClientOpsClient.assert_response_success()OpsClient.assert_sensor_value_matches()OpsClient.check_battery()OpsClient.check_errors()OpsClient.check_preconditions()OpsClient.check_properties_battery()OpsClient.check_properties_dongle()OpsClient.check_properties_inverter()OpsClient.check_value()OpsClient.ensure_default_params()OpsClient.get_manufacturer()OpsClient.run_validation_check()
- Submodules
- testframework.clients.ops.tester package
- Submodules
- testframework.clients.ops.api_model module
ActionDeviceAttributeDeviceClassEnumDevicePropertiesDeviceProperties.attributesDeviceProperties.deviceClassDeviceProperties.deviceIdDeviceProperties.eTagDeviceProperties.identifiersDeviceProperties.manufacturerDeviceProperties.model_computed_fieldsDeviceProperties.model_configDeviceProperties.model_fieldsDeviceProperties.serialNumberDeviceProperties.timeStampUtcDeviceProperties.type
ElectroUnitEnumElectroUnitEnum.AElectroUnitEnum.AhElectroUnitEnum.CelciusElectroUnitEnum.HzElectroUnitEnum.KiloOhmElectroUnitEnum.MegaOhmElectroUnitEnum.MinutesElectroUnitEnum.None_ElectroUnitEnum.OhmElectroUnitEnum.PercentElectroUnitEnum.VElectroUnitEnum.VAElectroUnitEnum.WElectroUnitEnum.WhElectroUnitEnum.kVAElectroUnitEnum.kVARElectroUnitEnum.kWElectroUnitEnum.kWhElectroUnitEnum.mA
ErrorResponseGridControlResponseHeartbeatRequestLoadLimitRequestMeasurementUnitTypeMeasurementUnitType.AMeasurementUnitType.AhMeasurementUnitType.CelciusMeasurementUnitType.HzMeasurementUnitType.KiloOhmMeasurementUnitType.MegaOhmMeasurementUnitType.MinutesMeasurementUnitType.None_MeasurementUnitType.OhmMeasurementUnitType.PercentMeasurementUnitType.VMeasurementUnitType.VAMeasurementUnitType.WMeasurementUnitType.WhMeasurementUnitType.kVAMeasurementUnitType.kWMeasurementUnitType.kWhMeasurementUnitType.mA
NumberDataPointPowerLimitTypePvActionRequestSensorValue
- testframework.clients.ops.base_client module
OpsBaseClientOpsBaseClient.url_baseOpsBaseClient.loggerOpsBaseClient.default_timeoutOpsBaseClient.start_timeOpsBaseClient.get_all_global_sensor_name()OpsBaseClient.get_device_properties()OpsBaseClient.get_global_sensor_name()OpsBaseClient.get_pv_sensor_value()OpsBaseClient.post_device_defaults()OpsBaseClient.post_pv_action()OpsBaseClient.put_grid_control_lpc()OpsBaseClient.put_grid_control_lpp()OpsBaseClient.remove_grid_control_lpp()OpsBaseClient.wait_for_sensor_value()
- testframework.clients.ops.api_model module
- testframework.clients.brain package
- Submodules
- testframework.clients.brain_datamodel module
AcPowerMeasurementCollectionAcPowerMeasurementCollection.CurrentL1AcPowerMeasurementCollection.CurrentL2AcPowerMeasurementCollection.CurrentL3AcPowerMeasurementCollection.EnergyFeedInAcPowerMeasurementCollection.EnergyPurchasedAcPowerMeasurementCollection.FrequencyAcPowerMeasurementCollection.PowerL1AcPowerMeasurementCollection.PowerL2AcPowerMeasurementCollection.PowerL3AcPowerMeasurementCollection.PowerTotalAcPowerMeasurementCollection.VoltageL1AcPowerMeasurementCollection.VoltageL2AcPowerMeasurementCollection.VoltageL3AcPowerMeasurementCollection.model_computed_fieldsAcPowerMeasurementCollection.model_configAcPowerMeasurementCollection.model_fields
ContactorApiUrlContactorMetaDataContactorPointsContactorPoints.ACBOX_24VContactorPoints.AC_POWER_DCSOURCEContactorPoints.DC_LOADPATH_TB13ContactorPoints.DC_LOADPATH_TB14ContactorPoints.DC_LOADPATH_TB15ContactorPoints.DC_LOADPATH_TB26ContactorPoints.DUTContactorPoints.ENGPINContactorPoints.EQUIPMENTContactorPoints.EVCONNECTEDContactorPoints.EVERRORContactorPoints.EVREADYContactorPoints.EVREADYFANContactorPoints.GRIDContactorPoints.IOT_ENGPINContactorPoints.LOADALLContactorPoints.LOADL1ContactorPoints.LOADL2ContactorPoints.LOADL3ContactorPoints.SCHUKOContactorPoints.WBACBOXContactorPoints.WBLOADL1ContactorPoints.WBLOADL2ContactorPoints.WBLOADL3
ContactorStateContactorTypeDcPowerMeasurementCollectionDcSourceOpModeDcSourceParamDcSourceRemoteModeDcSourceStandbyModeDcSourceTagDcSourceVariableFrameworkApiUrlMeasurementMeasurementCollectionPowerVariablesPowerVariables.CURRENTL1PowerVariables.CURRENTL2PowerVariables.CURRENTL3PowerVariables.ENERGYFEEDINPowerVariables.ENERGYPURCHASEDPowerVariables.FREQUENCYPowerVariables.POWERL1PowerVariables.POWERL2PowerVariables.POWERL3PowerVariables.POWERTOTALPowerVariables.VOLTAGEL1PowerVariables.VOLTAGEL2PowerVariables.VOLTAGEL3
SamplingPointUnitType
- testframework.clients.ops_datamodel module
ComparatorsDatapointValueDatapointValuesHttpResponseDeviceClassDeviceManufacturerGlobalSensorNameGlobalSensorName.BATTERY_SOHGlobalSensorName.CODE_DEVICE_TYPEGlobalSensorName.CODE_INVERTER_COUNTRYGlobalSensorName.CODE_INVERTER_GRIDGlobalSensorName.COMMAND_EMS_MODEGlobalSensorName.COMMAND_START_STOPGlobalSensorName.CPU_LOADGlobalSensorName.CURRENT_BATTERYGlobalSensorName.CURRENT_STRING_1GlobalSensorName.CURRENT_STRING_2GlobalSensorName.CURRENT_WALLBOX_CONNECTOR_1_PHASE_AGlobalSensorName.CURRENT_WALLBOX_CONNECTOR_1_PHASE_BGlobalSensorName.CURRENT_WALLBOX_CONNECTOR_1_PHASE_CGlobalSensorName.DONGLE_BACKENDCONNECTIONGlobalSensorName.DONGLE_BATTERYCOUNTGlobalSensorName.DONGLE_BATTERY_NODE_1GlobalSensorName.DONGLE_BATTERY_NODE_2GlobalSensorName.DONGLE_CUSTOMERIDENTGlobalSensorName.DONGLE_LOCALACCESSGlobalSensorName.DONGLE_POWERMETER_NODEGlobalSensorName.ENERGY_BATTERY_CAPACITYGlobalSensorName.ENERGY_BATTERY_CHARGE_DAYGlobalSensorName.ENERGY_BATTERY_CHARGE_LEVELGlobalSensorName.ENERGY_BATTERY_CHARGE_LOADGlobalSensorName.ENERGY_BATTERY_DISCHARGE_DAYGlobalSensorName.ENERGY_CONSUMPTION_TOTAL_DAYGlobalSensorName.ENERGY_EXTERNAL_TOTAL_IN_DAYGlobalSensorName.ENERGY_EXTERNAL_TOTAL_OUT_DAYGlobalSensorName.ENERGY_GRID_EXPORT_DAYGlobalSensorName.ENERGY_GRID_IMPORT_DAYGlobalSensorName.ENERGY_PRODUCTION_TOTAL_DAYGlobalSensorName.ENERGY_STORAGE_LEVELGlobalSensorName.ENERGY_STORAGE_TOTAL_IN_DAYGlobalSensorName.ENERGY_STORAGE_TOTAL_OUT_DAYGlobalSensorName.ENERGY_WALLBOX_CONNECTOR_1_CHARGED_TOTALGlobalSensorName.FREQUENCY_GRIDGlobalSensorName.INVERTER_RUNNING_STATEGlobalSensorName.INVERTER_SYSTEM_STATEGlobalSensorName.LTE_PREDICTOR_RESULT_PASSEDGlobalSensorName.LTE_QUALITYGlobalSensorName.MEMORY_USAGEGlobalSensorName.MODE_FORCIBLE_CHARGE_DISCHARGEGlobalSensorName.PERCENT_STORAGE_LEVELGlobalSensorName.POWER_AC_PHASE_AGlobalSensorName.POWER_AC_PHASE_BGlobalSensorName.POWER_AC_PHASE_CGlobalSensorName.POWER_BATTERY_CHARGE_DISCHARGEGlobalSensorName.POWER_BATTERY_CHARGE_DISCHARGE_SETGlobalSensorName.POWER_CONSUMPTION_TOTALGlobalSensorName.POWER_DC_STRING_1GlobalSensorName.POWER_DC_STRING_2GlobalSensorName.POWER_DC_TOTALGlobalSensorName.POWER_EXTERNAL_TOTALGlobalSensorName.POWER_GRID_EXPORTGlobalSensorName.POWER_HOUSE_TOTALGlobalSensorName.POWER_OUTPUT_NOMINALGlobalSensorName.POWER_POWERMETER_ACTIVEGlobalSensorName.POWER_PRODUCTION_TOTALGlobalSensorName.POWER_STORAGE_TOTALGlobalSensorName.POWER_WALLBOX_CONNECTOR_0_CHARGING_REQUESTEDGlobalSensorName.POWER_WALLBOX_CONNECTOR_1_CHARGINGGlobalSensorName.POWER_WALLBOX_CONNECTOR_1_CHARGING_REQUESTEDGlobalSensorName.POWER_WALLBOX_CONNECTOR_1_OFFEREDGlobalSensorName.SOFTWARE_VERSION_SERVICE_1GlobalSensorName.SOFTWARE_VERSION_SERVICE_2GlobalSensorName.STATE_ALARMCODES_1GlobalSensorName.STATE_ALARMCODES_10GlobalSensorName.STATE_ALARMCODES_11GlobalSensorName.STATE_ALARMCODES_12GlobalSensorName.STATE_ALARMCODES_13GlobalSensorName.STATE_ALARMCODES_14GlobalSensorName.STATE_ALARMCODES_15GlobalSensorName.STATE_ALARMCODES_2GlobalSensorName.STATE_ALARMCODES_3GlobalSensorName.STATE_ALARMCODES_4GlobalSensorName.STATE_ALARMCODES_5GlobalSensorName.STATE_ALARMCODES_6GlobalSensorName.STATE_ALARMCODES_7GlobalSensorName.STATE_ALARMCODES_8GlobalSensorName.STATE_ALARMCODES_9GlobalSensorName.STATE_ERRORCODES_1GlobalSensorName.STATE_ERRORCODES_10GlobalSensorName.STATE_ERRORCODES_11GlobalSensorName.STATE_ERRORCODES_2GlobalSensorName.STATE_ERRORCODES_6GlobalSensorName.STATE_ERRORCODES_9GlobalSensorName.STATE_WALLBOX_CONNECTOR_1_CHARGEGlobalSensorName.STATUS_WALLBOX_CONNECTEDGlobalSensorName.TEMPERATURE_BATTERYGlobalSensorName.TEMPERATURE_HOUSING_INSIDEGlobalSensorName.VOLTAGE_BATTERYGlobalSensorName.VOLTAGE_PHASE_AGlobalSensorName.VOLTAGE_PHASE_BGlobalSensorName.VOLTAGE_PHASE_CGlobalSensorName.VOLTAGE_STRING_1GlobalSensorName.VOLTAGE_STRING_2GlobalSensorName.VOLTAGE_WALLBOX_CONNECTOR_1_PHASE_AGlobalSensorName.VOLTAGE_WALLBOX_CONNECTOR_1_PHASE_BGlobalSensorName.VOLTAGE_WALLBOX_CONNECTOR_1_PHASE_C
GlobalSensorNameInverterBatch1GlobalSensorNameInverterBatch1.ENERGY_EXTERNAL_TOTAL_IN_DAYGlobalSensorNameInverterBatch1.ENERGY_EXTERNAL_TOTAL_OUT_DAYGlobalSensorNameInverterBatch1.ENERGY_PRODUCTION_TOTAL_DAYGlobalSensorNameInverterBatch1.ENERGY_STORAGE_LEVELGlobalSensorNameInverterBatch1.ENERGY_STORAGE_TOTAL_IN_DAYGlobalSensorNameInverterBatch1.ENERGY_STORAGE_TOTAL_OUT_DAYGlobalSensorNameInverterBatch1.PERCENT_STORAGE_LEVELGlobalSensorNameInverterBatch1.POWER_EXTERNAL_TOTALGlobalSensorNameInverterBatch1.POWER_PRODUCTION_TOTALGlobalSensorNameInverterBatch1.POWER_STORAGE_TOTAL
GlobalSensorNameInverterBatch2GlobalSensorNameInverterBatch2.CURRENT_STRING_1GlobalSensorNameInverterBatch2.CURRENT_STRING_2GlobalSensorNameInverterBatch2.ENERGY_BATTERY_CHARGE_LOADGlobalSensorNameInverterBatch2.ENERGY_CONSUMPTION_TOTAL_DAYGlobalSensorNameInverterBatch2.MODE_FORCIBLE_CHARGE_DISCHARGEGlobalSensorNameInverterBatch2.POWER_BATTERY_CHARGE_DISCHARGEGlobalSensorNameInverterBatch2.POWER_BATTERY_CHARGE_DISCHARGE_SETGlobalSensorNameInverterBatch2.POWER_CONSUMPTION_TOTALGlobalSensorNameInverterBatch2.POWER_DC_TOTALGlobalSensorNameInverterBatch2.POWER_WALLBOX_CONNECTOR_0_CHARGING_REQUESTEDGlobalSensorNameInverterBatch2.VOLTAGE_PHASE_AGlobalSensorNameInverterBatch2.VOLTAGE_STRING_1GlobalSensorNameInverterBatch2.VOLTAGE_STRING_2
GlobalSensorNameInverterBatch3GlobalSensorNameInverterBatch3.ENERGY_GRID_EXPORT_DAYGlobalSensorNameInverterBatch3.ENERGY_GRID_IMPORT_DAYGlobalSensorNameInverterBatch3.FREQUENCY_GRIDGlobalSensorNameInverterBatch3.POWER_AC_PHASE_AGlobalSensorNameInverterBatch3.POWER_AC_PHASE_BGlobalSensorNameInverterBatch3.POWER_DC_STRING_1GlobalSensorNameInverterBatch3.POWER_DC_STRING_2GlobalSensorNameInverterBatch3.POWER_GRID_EXPORTGlobalSensorNameInverterBatch3.POWER_HOUSE_TOTALGlobalSensorNameInverterBatch3.POWER_POWERMETER_ACTIVEGlobalSensorNameInverterBatch3.VOLTAGE_PHASE_BGlobalSensorNameInverterBatch3.VOLTAGE_PHASE_C
GlobalSensorNameInverterBatch4GlobalSensorNameInverterBatch4.BATTERY_SOHGlobalSensorNameInverterBatch4.CURRENT_BATTERYGlobalSensorNameInverterBatch4.ENERGY_BATTERY_CAPACITYGlobalSensorNameInverterBatch4.ENERGY_BATTERY_CHARGE_DAYGlobalSensorNameInverterBatch4.ENERGY_BATTERY_CHARGE_LEVELGlobalSensorNameInverterBatch4.ENERGY_BATTERY_DISCHARGE_DAYGlobalSensorNameInverterBatch4.INVERTER_RUNNING_STATEGlobalSensorNameInverterBatch4.POWER_AC_PHASE_CGlobalSensorNameInverterBatch4.POWER_WALLBOX_CONNECTOR_1_CHARGING_REQUESTEDGlobalSensorNameInverterBatch4.STATUS_WALLBOX_CONNECTEDGlobalSensorNameInverterBatch4.TEMPERATURE_BATTERYGlobalSensorNameInverterBatch4.VOLTAGE_BATTERY
GlobalSensorNameWallboxBatch1GlobalSensorNameWallboxBatch2GlobalSensorNameWallboxBatch3GlobalSensorNameWallboxBatch3.POWER_WALLBOX_CONNECTOR_0_CHARGING_REQUESTEDGlobalSensorNameWallboxBatch3.POWER_WALLBOX_CONNECTOR_1_CHARGINGGlobalSensorNameWallboxBatch3.POWER_WALLBOX_CONNECTOR_1_CHARGING_REQUESTEDGlobalSensorNameWallboxBatch3.POWER_WALLBOX_CONNECTOR_1_OFFEREDGlobalSensorNameWallboxBatch3.STATE_WALLBOX_CONNECTOR_1_CHARGE
GlobalSensorNameWallboxBatch4MiscDataPointIdOpsApiUrlSensorValueTimeoutException
- testframework.clients.brain_datamodel module
- Subpackages
- testframework.datasinks package
- Submodules
- testframework.datasinks.influx_client module
InfluxDBClientInfluxDBClient.tokenInfluxDBClient.orgInfluxDBClient.urlInfluxDBClient.bucketInfluxDBClient.write()InfluxDBClient.query()InfluxDBClient.query()InfluxDBClient.query_data_frame()InfluxDBClient.write_contactor()InfluxDBClient.write_dcsource()InfluxDBClient.write_ops()InfluxDBClient.write_ops_setting_annotation()InfluxDBClient.write_power()InfluxDBClient.write_setcontactor_annotation()InfluxDBClient.write_sw_version()InfluxDBClient.write_testbench_metadata()
- testframework.datasinks.influx_measurement module
InfluxMeasurementInfluxMeasurement.INFLUXDB_MEASUREMENT_CONTACTORInfluxMeasurement.INFLUXDB_MEASUREMENT_CONTACTOR_ANNOInfluxMeasurement.INFLUXDB_MEASUREMENT_DCSOURCEInfluxMeasurement.INFLUXDB_MEASUREMENT_OPSInfluxMeasurement.INFLUXDB_MEASUREMENT_OPS_ANNOInfluxMeasurement.INFLUXDB_MEASUREMENT_POWERInfluxMeasurement.INFLUXDB_MEASUREMENT_TESTInfluxMeasurement.INFLUXDB_TESTBENCH_INVENTORYInfluxMeasurement.INFLUXDB_TESTFRAMEWORK_PARAM
- testframework.datasinks.mqtt_client module
- testframework.datasinks.influx_client module
- Submodules
- testframework.inventory package
BatteryDcBenchDcSourceDongleHeatPumpHeatPumpItemInventoryInventoryDataModelInventoryFilterInventoryMetaDataInverterIotLoadsManufacturerOptionsPvSimulationPvSimulationItemPvSystemPvSystemItemSlaveItemTestBenchTestBenchTypeTestBrainTestEquipmentsWallboxWallboxItem- Submodules
- testframework.inventory.datamodel module
- testframework.inventory.metadata module
- testframework.utils package
fetch()fetch_all()- Submodules
- testframework.utils.async_requests module
- testframework.utils.helper module
- testframework.utils.modbus_utils module
DataTypeDecodeErrorEncodeErrorModbusFunctionCodesEnumModbusFunctionCodesEnum.READ_COILSModbusFunctionCodesEnum.READ_DISCRETE_INPUTModbusFunctionCodesEnum.READ_HOLDING_REGISTERModbusFunctionCodesEnum.READ_INPUT_REGISTERModbusFunctionCodesEnum.UNDEFINEDModbusFunctionCodesEnum.WRITE_MULTIPLE_COILSModbusFunctionCodesEnum.WRITE_MULTIPLE_HOLDING_REGISTERSModbusFunctionCodesEnum.WRITE_SINGLE_COILModbusFunctionCodesEnum.WRITE_SINGLE_HOLDING_REGISTER
RegisterDefinitionSlaveFailureExceptionWriteExceptionconvert_string_to_registers()create_modbus_client()decode_modbus_response()get_decoding_function()get_result_from_client()int_to_modbus_registers()read_coils()read_discrete_inputs()read_holding_register_multiple_values()read_holding_register_value()read_input_registers()write_multiple_coils()write_multiple_holding_registers()write_single_coil()write_single_holding_register()
- testframework.utils.singleton module