[WIP] Restructuring OnResetTimeout (Part 2)

test_scripts/API/Restructuring_OnResetTimeout/001_BC_OnResetTimeout_Success_flow.lua

@@ -0,0 +1,50 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(resetPeriod = 15000) to SDL
+-- 4) HMI sends response in 11 seconds after receiving request
+-- SDL does:
+-- 1) Respond with SUCCESS resultCode to mobile app
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+local commonRC = require('test_scripts/RC/commonRC')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+local paramsForRespFunction = {
+	respTime = 11000,
+	notificationTime = 0,
+	resetPeriod = 15000
+}
+
+local RespParams = { success = true, resultCode = "SUCCESS" }
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App_1 registration", common.registerAppWOPTU)
+runner.Step("App_2 registration", common.registerAppWOPTU, { 2 })
+runner.Step("App_1 activation", common.activateApp)
+runner.Step("Set RA mode: ASK_DRIVER", commonRC.defineRAMode, { true, "ASK_DRIVER" })
+runner.Step("Create InteractionChoiceSet", common.createInteractionChoiceSet)
+
+runner.Title("Test")
+for _, rpc in pairs(common.rpcsArray) do
+  runner.Step("Send " .. rpc , common.rpcs[rpc],
+	{ 12000, 11000, common.responseWithOnResetTimeout, paramsForRespFunction, RespParams})
+end
+runner.Step("App_2 activation", common.activateApp, { 2 })
+runner.Step("Send SetInteriorVehicleData with consent" , common.rpcs.rpcAllowedWithConsent,
+  { 12000, 11000, common.responseWithOnResetTimeout, paramsForRespFunction, RespParams})
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/Restructuring_OnResetTimeout/002_BC_OnResetTimeout_Success_flow_without_resetPeriod.lua

@@ -0,0 +1,50 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(without resetPeriod) to SDL
+-- 4) HMI sends response in 11 seconds after receiving request
+-- SDL does:
+-- 1) Receive response and successful process it
+-- 2) Respond with SUCCESS resultCode to mobile app
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+local commonRC = require('test_scripts/RC/commonRC')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+local paramsForRespFunction = {
+	respTime = 11000,
+	notificationTime = 5000
+}
+
+local RespParams = { success = true, resultCode = "SUCCESS" }
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App_1 registration", common.registerAppWOPTU)
+runner.Step("App_2 registration", common.registerAppWOPTU, { 2 })
+runner.Step("App_1 activation", common.activateApp)
+runner.Step("Set RA mode: ASK_DRIVER", commonRC.defineRAMode, { true, "ASK_DRIVER" })
+runner.Step("Create InteractionChoiceSet", common.createInteractionChoiceSet)
+
+runner.Title("Test")
+for _, rpc in pairs(common.rpcsArray) do
+  runner.Step("Send " .. rpc , common.rpcs[rpc],
+    { 12000, 6000, common.responseWithOnResetTimeout, paramsForRespFunction, RespParams })
+end
+runner.Step("App_2 activation", common.activateApp, { 2 })
+runner.Step("Send SetInteriorVehicleData with consent" , common.rpcs.rpcAllowedWithConsent,
+  { 12000, 6000, common.responseWithOnResetTimeout, paramsForRespFunction })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/Restructuring_OnResetTimeout/003_BC_OnResetTimeout_GENERIC_ERROR_in_case_HMI_did_not_respond.lua

@@ -0,0 +1,49 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(resetPeriod = 6000) to SDL
+-- 4) HMI does not send response
+-- SDL does:
+-- 1) Respond with GENERIC_ERROR resultCode to mobile app after 13 seconds
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+local commonRC = require('test_scripts/RC/commonRC')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+local paramsForRespFunction = {
+	notificationTime = 6000,
+	resetPeriod = 6000
+}
+
+local rpcResponse = { success = false, resultCode = "GENERIC_ERROR" }
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App_1 registration", common.registerAppWOPTU)
+runner.Step("App_2 registration", common.registerAppWOPTU, { 2 })
+runner.Step("App_1 activation", common.activateApp)
+runner.Step("Set RA mode: ASK_DRIVER", commonRC.defineRAMode, { true, "ASK_DRIVER" })
+runner.Step("Create InteractionChoiceSet", common.createInteractionChoiceSet)
+
+runner.Title("Test")
+for _, rpc in pairs(common.rpcsArray) do
+  runner.Step("Send " .. rpc , common.rpcs[rpc],
+  { 13000, 6000, common.withoutResponseWithOnResetTimeout, paramsForRespFunction, rpcResponse })
+end
+runner.Step("App_2 activation", common.activateApp, { 2 })
+runner.Step("Send SetInteriorVehicleData with consent" , common.rpcs.rpcAllowedWithConsent,
+  { 13000, 6000, common.withoutResponseWithOnResetTimeout, paramsForRespFunction, rpcResponse })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/Restructuring_OnResetTimeout/004_BC_OnResetTimeout_HMI_did_not_respond_notification_without_resetPeriod.lua

@@ -0,0 +1,48 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(without resetPeriod) to SDL in 2 seconds after HMI request receiving
+-- 4) HMI does not send response
+-- SDL does:
+-- 1) Respond with GENERIC_ERROR resultCode to mobile app in 12 seconds after mobile request receiving
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+local commonRC = require('test_scripts/RC/commonRC')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+local paramsForRespFunction = {
+	notificationTime = 2000
+}
+
+local rpcResponse = { success = false, resultCode = "GENERIC_ERROR" }
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App_1 registration", common.registerAppWOPTU)
+runner.Step("App_2 registration", common.registerAppWOPTU, { 2 })
+runner.Step("App_1 activation", common.activateApp)
+runner.Step("Set RA mode: ASK_DRIVER", commonRC.defineRAMode, { true, "ASK_DRIVER" })
+runner.Step("Create InteractionChoiceSet", common.createInteractionChoiceSet)
+
+runner.Title("Test")
+for _, rpc in pairs(common.rpcsArray) do
+  runner.Step("Send " .. rpc , common.rpcs[rpc],
+	{ 13000, 10000, common.withoutResponseWithOnResetTimeout, paramsForRespFunction, rpcResponse })
+end
+runner.Step("App_2 activation", common.activateApp, { 2 })
+runner.Step("Send SetInteriorVehicleData with consent" , common.rpcs.rpcAllowedWithConsent,
+  { 13000, 10000, common.withoutResponseWithOnResetTimeout, paramsForRespFunction, rpcResponse })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/Restructuring_OnResetTimeout/005_BC_OnResetTimeout_sends_twice_notification.lua

@@ -0,0 +1,62 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(resetPeriod = 11000) to SDL after receiving HMI request
+-- 4) HMI sends BC.OnResetTimeout(resetPeriod = 7000) to SDL in 6 sec after receiving HMI request
+-- 5) HMI does not send response in 13 seconds after receiving request
+-- SDL does:
+-- 1) Respond with GENERIC_ERROR resultCode to mobile app after 13 seconds are expired
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+local paramsForRespFunctionFirstNot = {
+  notificationTime = 0,
+  resetPeriod = 11000
+}
+
+local paramsForRespFunctionSecondNot = {
+  notificationTime = 6000,
+  resetPeriod = 7000
+}
+
+--[[ Local Functions ]]
+local function diagnosticMessageError()
+  local requestParams = { targetID = 1, messageLength = 1, messageData = { 1 } }
+  local cid = common.getMobileSession():SendRPC("DiagnosticMessage", requestParams)
+
+  EXPECT_HMICALL("VehicleInfo.DiagnosticMessage", requestParams)
+  :Do(function(_, data)
+    common.withoutResponseWithOnResetTimeout(data, paramsForRespFunctionFirstNot)
+    common.withoutResponseWithOnResetTimeout(data, paramsForRespFunctionSecondNot)
+  end)
+
+  common.getMobileSession():ExpectResponse(cid, { success = false, resultCode = "GENERIC_ERROR" })
+  :Timeout(14000)
+  :ValidIf(function()
+    local checkResult, resultMessage = common.responseTimeCalculation(7000)
+    return checkResult, resultMessage
+  end)
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App registration", common.registerAppWOPTU)
+runner.Step("App activation", common.activateApp)
+
+runner.Title("Test")
+runner.Step("Send DiagnosticMessage", diagnosticMessageError)
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/Restructuring_OnResetTimeout/006_BC_OnResetTimeout_with_wrong_methodName_and_HMI_did_not_respond.lua

@@ -0,0 +1,69 @@
+---------------------------------------------------------------------------------------------------
+-- Proposal: https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals/0189-Restructuring-OnResetTimeout.md
+--
+-- Description:
+-- In case:
+-- 1) RPC is requested
+-- 2) Some time after receiving RPC request on HMI is passed
+-- 3) HMI sends BC.OnResetTimeout(resetPeriod = 6000) with wrong methodName to SDL in 6 sec after HMI request
+-- 4) HMI does not send response in 10 seconds after receiving request
+-- SDL does:
+-- 1) Respond in 10 seconds with GENERIC_ERROR resultCode to mobile app
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/Restructuring_OnResetTimeout/common_OnResetTimeout')
+local commonRC = require('test_scripts/RC/commonRC')
+
+--[[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+
+--[[ Local Variables ]]
+
+-- Slider is removed from array, because specific timeout must be applicable for it(default timeout + timeout from request)
+for key, value in pairs(common.rpcsArray) do
+  if value == "Slider"then
+    table.remove(common.rpcsArray, key)
+  end
+end
+
+local wrongMethodName = "Wrong_methodName"
+
+local paramsForRespFunction = {
+	notificationTime = 6000,
+	resetPeriod = 6000
+}
+
+local rpcResponse = { success = false, resultCode = "GENERIC_ERROR" }
+
+--[[ Local Functions ]]
+local function invalidParamOnResetTimeout(pData, pOnRTParams)
+  local function sendOnResetTimeout()
+    common.onResetTimeoutNotification(pData.id, wrongMethodName, pOnRTParams.resetPeriod)
+  end
+  RUN_AFTER(sendOnResetTimeout, pOnRTParams.notificationTime)
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("App_1 registration", common.registerAppWOPTU)
+runner.Step("App_2 registration", common.registerAppWOPTU, { 2 })
+runner.Step("App_1 activation", common.activateApp)
+runner.Step("Set RA mode: ASK_DRIVER", commonRC.defineRAMode, { true, "ASK_DRIVER" })
+runner.Step("Create InteractionChoiceSet", common.createInteractionChoiceSet)
+
+runner.Title("Test")
+for _, rpc in pairs(common.rpcsArray) do
+  runner.Step("Send " .. rpc , common.rpcs[rpc],
+    { 11000, 4000, invalidParamOnResetTimeout, paramsForRespFunction, rpcResponse })
+end
+runner.Step("Send Slider" , common.rpcs.Slider,
+  { 12000, 5000, invalidParamOnResetTimeout, paramsForRespFunction, rpcResponse })
+runner.Step("App_2 activation", common.activateApp, { 2 })
+runner.Step("Send SetInteriorVehicleData with consent" , common.rpcs.rpcAllowedWithConsent,
+  { 11000, 4000, invalidParamOnResetTimeout, paramsForRespFunction, rpcResponse })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)