:py:mod:`vspyx.AUTOSAR.AcceptanceTest` ====================================== .. py:module:: vspyx.AUTOSAR.AcceptanceTest Package Contents ---------------- Classes ~~~~~~~ .. autoapisummary:: vspyx.AUTOSAR.AcceptanceTest.UpperTester .. py:class:: UpperTester Bases: :py:obj:`vspyx.Core.Object` .. autoapi-inheritance-diagram:: vspyx.AUTOSAR.AcceptanceTest.UpperTester :parts: 1 :private-bases: UpperTester .. py:class:: ARPOperationRequest ARPOperationRequest .. py:attribute:: ifName :annotation: :str .. py:attribute:: ip :annotation: :str .. py:attribute:: mac :annotation: :str .. py:attribute:: operation :annotation: :int .. py:class:: ARPOperationResponse ARPOperationResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ActivateTestModeRequest ActivateTestModeRequest .. py:attribute:: ifName :annotation: :str .. py:attribute:: testMode :annotation: :int .. py:class:: ActivateTestModeResponse ActivateTestModeResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: CloseSocketRequest CloseSocketRequest .. py:attribute:: abort :annotation: :bool .. py:attribute:: socketId :annotation: :int .. py:class:: CloseSocketResponse CloseSocketResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ConfigureSocketRequest ConfigureSocketRequest .. py:attribute:: paramId :annotation: :int .. py:attribute:: paramVal :annotation: :List[int] .. py:attribute:: socketId :annotation: :int .. py:class:: ConfigureSocketResponse ConfigureSocketResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ConnectRequest ConnectRequest .. py:attribute:: destAddr :annotation: :str .. py:attribute:: destPort :annotation: :int .. py:attribute:: socketId :annotation: :int .. py:class:: ConnectResponse ConnectResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: CreateAndBindRequest CreateAndBindRequest .. py:attribute:: doBind :annotation: :bool .. py:attribute:: localAddr :annotation: :str .. py:attribute:: localPort :annotation: :int .. py:class:: CreateAndBindResponse CreateAndBindResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:attribute:: socketId :annotation: :int .. py:class:: EchoRequestRequest EchoRequestRequest .. py:attribute:: data :annotation: :List[int] .. py:attribute:: destAddr :annotation: :str .. py:attribute:: ifName :annotation: :Any .. py:class:: EchoRequestResponse EchoRequestResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: EndTestRequest EndTestRequest .. py:attribute:: tcId :annotation: :int .. py:attribute:: tsName :annotation: :str .. py:class:: EndTestResponse EndTestResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: GIDs Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.AUTOSAR.AcceptanceTest.UpperTester.GIDs :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: ARP :annotation: = 9 .. py:attribute:: DHCP :annotation: = 7 .. py:attribute:: DHCPv6 :annotation: = 8 .. py:attribute:: ETH :annotation: = 11 .. py:attribute:: GENERAL :annotation: = 0 .. py:attribute:: ICMP :annotation: = 3 .. py:attribute:: ICMPv6 :annotation: = 4 .. py:attribute:: IP :annotation: = 5 .. py:attribute:: IPv6 :annotation: = 6 .. py:attribute:: NDP :annotation: = 10 .. py:attribute:: PHY :annotation: = 12 .. py:attribute:: TCP :annotation: = 2 .. py:attribute:: UDP :annotation: = 1 .. py:class:: GetVersionResponse GetVersionResponse .. py:attribute:: majorVer :annotation: :int .. py:attribute:: minorVer :annotation: :int .. py:attribute:: patchVer :annotation: :int .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: InitDHCPClientRequest InitDHCPClientRequest .. py:attribute:: ifName :annotation: :str .. py:class:: InitDHCPClientResponse InitDHCPClientResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: InterfaceDownRequest InterfaceDownRequest .. py:attribute:: ifName :annotation: :str .. py:class:: InterfaceDownResponse InterfaceDownResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: InterfaceUpRequest InterfaceUpRequest .. py:attribute:: ifName :annotation: :str .. py:class:: InterfaceUpResponse InterfaceUpResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ListenAndAcceptEvent ListenAndAcceptEvent .. py:attribute:: address :annotation: :str .. py:attribute:: listenSocketId :annotation: :int .. py:attribute:: newSocketId :annotation: :int .. py:attribute:: port :annotation: :int .. py:class:: ListenAndAcceptRequest ListenAndAcceptRequest .. py:attribute:: listenSocketId :annotation: :int .. py:attribute:: maxCon :annotation: :int .. py:class:: ListenAndAcceptResponse ListenAndAcceptResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: PIDs Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.AUTOSAR.AcceptanceTest.UpperTester.PIDs :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: ACTIVATE_TEST_MODE :annotation: = 2 .. py:attribute:: CLOSE_SOCKET :annotation: = 0 .. py:attribute:: CONFIGURE_SOCKET :annotation: = 6 .. py:attribute:: CONNECT :annotation: = 5 .. py:attribute:: CREATE_AND_BIND :annotation: = 1 .. py:attribute:: ECHO_REQUEST :annotation: = 0 .. py:attribute:: END_TEST :annotation: = 3 .. py:attribute:: GET_VERSION :annotation: = 1 .. py:attribute:: INIT_DHCP_CLIENT :annotation: = 0 .. py:attribute:: INTERFACE_DOWN :annotation: = 1 .. py:attribute:: INTERFACE_UP :annotation: = 0 .. py:attribute:: LISTEN_AND_ACCEPT :annotation: = 4 .. py:attribute:: READ_DIAG_RESULT :annotation: = 1 .. py:attribute:: READ_SIGNAL_QUALITY :annotation: = 0 .. py:attribute:: RECEIEVE_AND_FORWARD :annotation: = 3 .. py:attribute:: SEND_DATA :annotation: = 2 .. py:attribute:: SET_DHCP_OPTION :annotation: = 2 .. py:attribute:: SET_PHY_TX_MODE :annotation: = 3 .. py:attribute:: SHUTDOWN :annotation: = 7 .. py:attribute:: START_VERSION :annotation: = 2 .. py:attribute:: STATIC_ADDRESS :annotation: = 0 .. py:attribute:: STATIC_ROUTE :annotation: = 1 .. py:attribute:: STOP_DHCP_CLIENT :annotation: = 1 .. py:class:: ReadDiagResultRequest ReadDiagResultRequest .. py:attribute:: ifName :annotation: :str .. py:class:: ReadDiagResultResponse ReadDiagResultResponse .. py:attribute:: diagResult :annotation: :int .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ReadSignalQualityRequest ReadSignalQualityRequest .. py:attribute:: ifName :annotation: :str .. py:class:: ReadSignalQualityResponse ReadSignalQualityResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:attribute:: sigQuality :annotation: :int .. py:class:: ReceiveAndForwardEvent ReceiveAndForwardEvent .. py:attribute:: fullLen :annotation: :int .. py:attribute:: payload :annotation: :List[int] .. py:attribute:: srcAddr :annotation: :str .. py:attribute:: srcPort :annotation: :int .. py:class:: ReceiveAndForwardRequest ReceiveAndForwardRequest .. py:attribute:: maxFwd :annotation: :int .. py:attribute:: maxLen :annotation: :int .. py:attribute:: socketId :annotation: :int .. py:class:: ReceiveAndForwardResponse ReceiveAndForwardResponse .. py:attribute:: dropCnt :annotation: :int .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: Results Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.AUTOSAR.AcceptanceTest.UpperTester.Results :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: E_IIF :annotation: = 236 .. py:attribute:: E_INV :annotation: = 252 .. py:attribute:: E_ISB :annotation: = 253 .. py:attribute:: E_ISD :annotation: = 239 .. py:attribute:: E_NOK :annotation: = 1 .. py:attribute:: E_NTF :annotation: = 255 .. py:attribute:: E_OK :annotation: = 0 .. py:attribute:: E_PEN :annotation: = 254 .. py:attribute:: E_TCP_CAE :annotation: = 231 .. py:attribute:: E_TCP_CAT :annotation: = 227 .. py:attribute:: E_TCP_CNE :annotation: = 229 .. py:attribute:: E_TCP_COC :annotation: = 230 .. py:attribute:: E_TCP_COR :annotation: = 226 .. py:attribute:: E_TCP_CRE :annotation: = 228 .. py:attribute:: E_TCP_FSU :annotation: = 234 .. py:attribute:: E_TCP_ILP :annotation: = 233 .. py:attribute:: E_TCP_INR :annotation: = 232 .. py:attribute:: E_TCP_PNA :annotation: = 235 .. py:attribute:: E_UBS :annotation: = 237 .. py:attribute:: E_UCS :annotation: = 238 .. py:class:: SendDataRequest SendDataRequest .. py:attribute:: data :annotation: :List[int] .. py:attribute:: destAddr :annotation: :str .. py:attribute:: destPort :annotation: :int .. py:attribute:: flags :annotation: :int .. py:attribute:: socketId :annotation: :int .. py:attribute:: totalLen :annotation: :int .. py:class:: SendDataResponse SendDataResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: SetDHCPOptionRequest SetDHCPOptionRequest .. py:attribute:: code :annotation: :int .. py:attribute:: ifName :annotation: :str .. py:attribute:: value :annotation: :List[int] .. py:class:: SetDHCPOptionResponse SetDHCPOptionResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: SetPhyTxModeRequest SetPhyTxModeRequest .. py:attribute:: ifName :annotation: :str .. py:attribute:: txMode :annotation: :int .. py:class:: SetPhyTxModeResponse SetPhyTxModeResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: ShutdownRequest ShutdownRequest .. py:attribute:: socketId :annotation: :int .. py:attribute:: typeId :annotation: :int .. py:class:: ShutdownResponse ShutdownResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: StartTestResponse StartTestResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: StaticAddressRequest StaticAddressRequest .. py:attribute:: addr :annotation: :str .. py:attribute:: ifName :annotation: :str .. py:attribute:: netMask :annotation: :int .. py:class:: StaticAddressResponse StaticAddressResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: StaticRouteRequest StaticRouteRequest .. py:attribute:: gateway :annotation: :str .. py:attribute:: ifName :annotation: :str .. py:attribute:: netMask :annotation: :int .. py:attribute:: subNet :annotation: :str .. py:class:: StaticRouteResponse StaticRouteResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:class:: StopDHCPClientRequest StopDHCPClientRequest .. py:attribute:: ifName :annotation: :str .. py:class:: StopDHCPClientResponse StopDHCPClientResponse .. py:attribute:: result :annotation: :UpperTester.Results .. py:method:: ARPOperation(self, gid: UpperTester.GIDs, request: UpperTester.ARPOperationRequest) -> UpperTester.ARPOperationResponse .. py:method:: ActivateTestMode(self, gid: UpperTester.GIDs, request: UpperTester.ActivateTestModeRequest) -> UpperTester.ActivateTestModeResponse Activates a given PHY test mode. .. py:method:: CloseSocket(self, gid: UpperTester.GIDs, request: UpperTester.CloseSocketRequest) -> UpperTester.CloseSocketResponse Closes a socket. .. py:method:: ConfigureSocket(self, gid: UpperTester.GIDs, request: UpperTester.ConfigureSocketRequest) -> UpperTester.ConfigureSocketResponse This SP is used to select and set parameters that can be configured on a socket basis. More parameters may be supported in following versions of this document or by non-standard extensions (Parameter IDs starting with 0xFFFF, 0xFFFE... and so forth). .. py:method:: Connect(self, gid: UpperTester.GIDs, request: UpperTester.ConnectRequest) -> UpperTester.ConnectResponse Triggers a TCP connection to a remote destination. .. py:method:: CreateAndBind(self, gid: UpperTester.GIDs, request: UpperTester.CreateAndBindRequest) -> UpperTester.CreateAndBindResponse Creates a socket and optionally binds this socket to a port and a local IP address. Note: Some TCP/IP-Stacks may need to know at socket creation time whether it is a client or a server socket. For those kind of implementations the SP may create and return a higher-level ID that maps to the corresponding data needed to create the socket later and the real socket ID once created. .. py:method:: EchoRequest(self, gid: UpperTester.GIDs, request: UpperTester.EchoRequestRequest) -> UpperTester.EchoRequestResponse .. py:method:: EndTest(self, gid: UpperTester.GIDs, request: UpperTester.EndTestRequest) -> UpperTester.EndTestResponse The purpose of this SP is to reset the Upper Tester. All sockets of the test channel will be closed, counters are set to the default value, buffers are cleared and active service primitives will be terminated. Another purpose of this SP is to have a defined entry tag in trace at the point in time the test case was stopped. The parameters may be ignored by the testability module. .. py:method:: GetVersion(self, gid: UpperTester.GIDs) -> UpperTester.GetVersionResponse This SP will return the testability protocol version of the used protocol and service primitive implementation. The testability protocol version is bound to the TC release version the protocol is based on. The current version is TC1.2.0. .. py:method:: InitDHCPClient(self, gid: UpperTester.GIDs, request: UpperTester.InitDHCPClientRequest) -> UpperTester.InitDHCPClientResponse Initialize the DHCP Client by use of network interface and port. .. py:method:: InterfaceDown(self, gid: UpperTester.GIDs, request: UpperTester.InterfaceDownRequest) -> UpperTester.InterfaceDownResponse Disables an Ethernet interface or virtual interface. This SP is not affecting the persistent configuration. .. py:method:: InterfaceUp(self, gid: UpperTester.GIDs, request: UpperTester.InterfaceUpRequest) -> UpperTester.InterfaceUpResponse Enables an Ethernet interface or virtual interface. This SP is not affecting the persistent configuration. .. py:method:: ListenAndAccept(self, gid: UpperTester.GIDs, request: UpperTester.ListenAndAcceptRequest, handler: vspyx.Core.Function_1db682930d) -> UpperTester.ListenAndAcceptResponse Marks a socket as listen socket that will be used to accept incoming connections. Whenever a new connection was established this SP provides the socket ID of the new connection together with the listen socket, client port, and address in an event. .. py:method:: NewInternal(iface: vspyx.TCPIP.Interface) -> UpperTester :staticmethod: .. py:method:: ReadDiagResult(self, gid: UpperTester.GIDs, request: UpperTester.ReadDiagResultRequest) -> UpperTester.ReadDiagResultResponse Returns the result of the cable diagnostics. .. py:method:: ReadSignalQuality(self, gid: UpperTester.GIDs, request: UpperTester.ReadSignalQualityRequest) -> UpperTester.ReadSignalQualityResponse Returns the current signal quality in percent by reading the value from the related Ethernet transceiver .. py:method:: ReceiveAndForward(self, gid: UpperTester.GIDs, request: UpperTester.ReceiveAndForwardRequest, handler: vspyx.Core.Function_5b8b9c0ffc) -> UpperTester.ReceiveAndForwardResponse Data that will be received after the call of this SP will be forwarded to the test system. The amount of forwarded data per received datagram (UDP) or bulk of stream data (TCP) can be limited using maxFwd. The original length of this data unit can be obtained by fullLen. The process will repeat itself (active phase) until the maximum amount of data defined by maxLen was received or END_TEST was called (inactive phase). UDP: No further requirements. (see 6.12.2 UDP Receive and Count) TCP: In the inactive phase (e.g. prior the first call) all data received will be discarded or ignored. When called all data that was received on the specified socked prior the call of this SP will be consumed2 in order to open the TCP receive window. All data that is received during the active phase of this SP will be consumed up to the maximum amount of data defined by maxLen. (see 6.12.4 TCP Client Receive and Forward) .. py:method:: SendData(self, gid: UpperTester.GIDs, request: UpperTester.SendDataRequest) -> UpperTester.SendDataResponse Sends data to a target. Please note: because of the non-blocking behavior of Service Primitives a positive response does NOT signal the success of the transmission, but the success of issuing the transmission. .. py:method:: SetDHCPOption(self, gid: UpperTester.GIDs, request: UpperTester.SetDHCPOptionRequest) -> UpperTester.SetDHCPOptionResponse Sets DHCP Client options .. py:method:: SetPhyTxMode(self, gid: UpperTester.GIDs, request: UpperTester.SetPhyTxModeRequest) -> UpperTester.SetPhyTxModeResponse Activates a given transmission mode. .. py:method:: Shutdown(self, gid: UpperTester.GIDs, request: UpperTester.ShutdownRequest) -> UpperTester.ShutdownResponse Shuts down a socket. .. py:method:: StartTest(self, gid: UpperTester.GIDs) -> UpperTester.StartTestResponse The purpose of this SP is to have a defined entry tag in trace at the point in time the test case was started. This SP does not have any request parameters. .. py:method:: StaticAddress(self, gid: UpperTester.GIDs, request: UpperTester.StaticAddressRequest) -> UpperTester.StaticAddressResponse Assigns a static IP address and Netmask to the given network interface. .. py:method:: StaticRoute(self, gid: UpperTester.GIDs, request: UpperTester.StaticRouteRequest) -> UpperTester.StaticRouteResponse Adds a static route for the network. This SP is not affecting the persistent configuration. .. py:method:: StopDHCPClient(self, gid: UpperTester.GIDs, request: UpperTester.StopDHCPClientRequest) -> UpperTester.StopDHCPClientResponse Shutdown the DHCP Client by use of network interface and port.