[Internal review] Scripts for 3309 issue

test_scripts/API/VehicleData/VehicleDataVersioning/013_VD_parameter_from_HMI_in_API_DB_app_version_more_then_parameter_version.lua

@@ -0,0 +1,47 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is greater then parameter version,
+--  parameter is listed in DB and API
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 7.0
+-- 2. "shifted" parameter in "gps" structure has since = 6.0 in DB and API
+-- 3. App is subscribed on "gps" vehicle data
+-- 4. App sends GetVehicleData(gps) request
+-- 5. SDL transfers this request to HMI
+-- 6. HMI sends GetVehicleData response with "shifted" item
+-- SDL does:
+--  - send GetVehicleData response to mobile app with allowed parameter "shifted"
+-- 7. HMI sends OnVehicleData notification with "shifted" item in "gps" structure
+-- SDL does:
+--  - send OnVehicleData notification to app with "shifted" item in "gps" structure
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 7
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Local Variables ]]
+local parameter = "gps"
+local shiftedIsExpected = true
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { common.pTUpdateFunc })
+runner.Step("Activate App", common.activateApp)
+runner.Step("RPC " .. common.rpc.sub, common.processSubscriptionRPC, { common.rpc.sub, parameter })
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataGps, { shiftedIsExpected })
+runner.Step("OnVehicleData", common.onVehicleDataGps, { shiftedIsExpected })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/014_VD_parameter_from_HMI_in_API_DB_app_version_equal_parameter_version.lua

@@ -0,0 +1,47 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is equal to parameter version,
+--  parameter is listed in DB and API
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 6.0
+-- 2. "shifted" parameter in "gps" structure has since = 6.0 in DB and API
+-- 3. App is subscribed on "gps" vehicle data
+-- 4. App sends GetVehicleData(gps) request
+-- 5. SDL transfers this request to HMI
+-- 6. HMI sends GetVehicleData response with "shifted" item
+-- SDL does:
+--  - send GetVehicleData response to mobile app with allowed parameter "shifted"
+-- 7. HMI sends OnVehicleData notification with "shifted" item in "gps" structure
+-- SDL does:
+--  - send OnVehicleData notification to app with "shifted" item in "gps" structure
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 6
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Local Variables ]]
+local parameter = "gps"
+local shiftedIsExpected = true
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { common.pTUpdateFunc })
+runner.Step("Activate App", common.activateApp)
+runner.Step("RPC " .. common.rpc.sub, common.processSubscriptionRPC, { common.rpc.sub, parameter })
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataGps, { shiftedIsExpected })
+runner.Step("OnVehicleData", common.onVehicleDataGps, { shiftedIsExpected })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/015_VD_parameter_from_HMI_in_API_DB_app_version_less_then_parameter_version.lua.lua

@@ -0,0 +1,49 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL does not send the parameter from HMI to mobile app in case app version is less
+--  then parameter version, parameter is listed in DB and API
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 5.0
+-- 2. "shifted" parameter in "gps" structure has since = 6.0 in DB and API
+-- 3. App is subscribed on "gps" vehicle data
+-- 4. App sends GetVehicleData(gps) request
+-- 5. SDL transfers this request to HMI
+-- 6. HMI sends GetVehicleData response with "shifted" item
+-- SDL does:
+--  - cut off the "shifted" parameter from HMI response that allowed for apps starting from 6.0 version
+--  - send GetVehicleData response to mobile app without not allowed parameter "shifted"
+-- 7.  HMI sends OnVehicleData notification with "shifted" item in "gps" structure
+-- SDL does:
+--  - cut off the "shifted" parameter from HMI notification that allowed for apps starting from 6.0 version
+--  - send OnVehicleData notification to app without "shifted" item in "gps" structure
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 5
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Local Variables ]]
+local parameter = "gps"
+local shiftedIsNOTexpected = false
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { common.pTUpdateFunc })
+runner.Step("Activate App", common.activateApp)
+runner.Step("RPC " .. common.rpc.sub, common.processSubscriptionRPC, { common.rpc.sub, parameter })
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataGps, { shiftedIsNOTexpected })
+runner.Step("OnVehicleData", common.onVehicleDataGps, { shiftedIsNOTexpected})
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/016_VD_parameter_from_HMI_in_API_DB_different_values_app_version_less_more_then_parameter_version.lua

@@ -0,0 +1,70 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is greather then parameter version,
+--  parameter is listed in DB and API and parameter has different version in DB and API
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 6.5
+-- 2. "shifted" parameter in "gps" structure has since = 7.0 in DB and since = 6.0 in API
+-- 3. App is subscribed on "gps" vehicle data
+-- 4. App sends GetVehicleData(gps) request
+-- 5. SDL transfers this request to HMI
+-- 6. HMI sends GetVehicleData response with "shifted" item
+-- SDL does:
+--  - send GetVehicleData response to mobile app with allowed parameter "shifted"
+-- 7. HMI sends OnVehicleData notification with "shifted" item in "gps" structure
+-- SDL does:
+--  - send OnVehicleData notification to app with "shifted" item in "gps" structure
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 6
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 5
+
+--[[ Local Variables ]]
+local parameter = "gps"
+local shiftedIsExpected = true
+
+--[[ Local Functions ]]
+local function preloadedUpdFunc(pTbl)
+  for key, value in pairs (pTbl.policy_table.vehicle_data.schema_items) do
+    if value.name == parameter then
+      for subKey, subValue in pairs (value.params) do
+        if subValue.name == "shifted" then
+          -- shifted has since="6.0" in API
+          pTbl.policy_table.vehicle_data.schema_items[key].params[subKey].since = "7.0.0"
+        elseif key == #value.params then
+          common.cprint(35, "'shifted' was not found in preloaded file")
+        end
+      end
+    elseif key == #pTbl.policy_table.vehicle_data.schema_items then
+      common.cprint(35, parameter .. " was not found in preloaded file")
+    end
+  end
+end
+
+local function ptuFunc(pTbl)
+  pTbl.policy_table.app_policies[common.getConfigAppParams(1).fullAppID].groups = { "Base-4", "Location-1" }
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Update preloaded file since=7.0 for shifted", common.updatePreloadedFile, { preloadedUpdFunc })
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { ptuFunc })
+runner.Step("Activate App", common.activateApp)
+runner.Step("RPC " .. common.rpc.sub, common.processSubscriptionRPC, { common.rpc.sub, parameter })
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataGps, { shiftedIsExpected })
+runner.Step("OnVehicleData", common.onVehicleDataGps, { shiftedIsExpected })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/017_VD_parameter_from_HMI_in_API_DB_different_values_app_version_more_then_parameter_version.lua

@@ -0,0 +1,70 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is greather then parameter version,
+--  parameter is listed in DB and API and parameter has different version in DB and API
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 8.0
+-- 2. "shifted" parameter in "gps" structure has since = 7.0 in DB and since = 6.0 in API
+-- 3. App is subscribed on "gps" vehicle data
+-- 4. App sends GetVehicleData(gps) request
+-- 5. SDL transfers this request to HMI
+-- 6. HMI sends GetVehicleData response with "shifted" item
+-- SDL does:
+--  - send GetVehicleData response to mobile app with allowed parameter "shifted"
+-- 7. HMI sends OnVehicleData notification with "shifted" item in "gps" structure
+-- SDL does:
+--  - send OnVehicleData notification to app with "shifted" item in "gps" structure
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 8
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Local Variables ]]
+local parameter = "gps"
+local shiftedIsExpected = true
+
+--[[ Local Functions ]]
+local function preloadedUpdFunc(pTbl)
+  for key, value in pairs (pTbl.policy_table.vehicle_data.schema_items) do
+    if value.name == parameter then
+      for subKey, subValue in pairs (value.params) do
+        if subValue.name == "shifted" then
+          -- shifted has since="6.0" in API
+          pTbl.policy_table.vehicle_data.schema_items[key].params[subKey].since = "7.0.0"
+        elseif key == #value.params then
+          common.cprint(35, "'shifted' was not found in preloaded file")
+        end
+      end
+    elseif key == #pTbl.policy_table.vehicle_data.schema_items then
+      common.cprint(35, parameter .. " was not found in preloaded file")
+    end
+  end
+end
+
+local function ptuFunc(pTbl)
+  pTbl.policy_table.app_policies[common.getConfigAppParams(1).fullAppID].groups = { "Base-4", "Location-1" }
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Update preloaded file since=7.0 for shifted", common.updatePreloadedFile, { preloadedUpdFunc })
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { ptuFunc })
+runner.Step("Activate App", common.activateApp)
+runner.Step("RPC " .. common.rpc.sub, common.processSubscriptionRPC, { common.rpc.sub, parameter })
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataGps, { shiftedIsExpected })
+runner.Step("OnVehicleData", common.onVehicleDataGps, { shiftedIsExpected })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/018_VD_parameter_from_HMI_in_DB_app_version_more_then_parameter_version.lua

@@ -0,0 +1,50 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is greater then parameter version,
+--  parameter is listed in DB only
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 7.0
+-- 2. Custom sub-parameter has since = 6.0 in DB
+-- 3. App sends GetVehicleData(<custom parameter>) request
+-- SDL does:
+--  - transfer GetVehicleData request to HMI with sub-parameter
+-- 4. HMI sends GetVehicleData response with sub-parameter
+-- SDL does:
+--  - send GetVehicleData response to mobile app with sub-parameter
+-- 5. App sends SubscribeVehileData(<custom parameter>) request
+-- SDL does:
+--  - transfer SubscribeVehileData request to HMI with sub-parameter
+-- 6. HMI sends SubscribeVehileData response
+-- SDL does:
+--  - send SubscribeVehileData response to mobile app
+-- 7. HMI sends OnVehicleData notification with sub-parameter
+-- SDL does:
+--  - send OnVehicleData notification to app with sub-parameter
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.ValidateSchema = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 7
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { common.ptuFuncOEM })
+runner.Step("Activate App", common.activateApp)
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataOEM)
+runner.Step("SubscribeVehicleData", common.subscribeVehicleDataOEM)
+runner.Step("OnVehicleData", common.onVehicleDataOEM)
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)

test_scripts/API/VehicleData/VehicleDataVersioning/019_VD_parameter_from_HMI_in_DB_app_version_equal_parameter_version.lua

@@ -0,0 +1,50 @@
+---------------------------------------------------------------------------------------------------
+--Issue: https://github.com/smartdevicelink/sdl_core/issues/3309
+---------------------------------------------------------------------------------------------------
+-- Description: SDL resends the parameter from HMI to mobile app in case app version is equal to parameter version,
+--  parameter is listed in DB only
+
+-- In case:
+-- 1. App is registered with syncMsgVersion = 6.0
+-- 2. Custom sub parameter has since = 6.0 in DB
+-- 3. App sends GetVehicleData(<custom parameter>) request
+-- SDL does:
+--  - transfer GetVehicleData request to HMI with sub parameter
+-- 4. HMI sends GetVehicleData response with sub parameter
+-- SDL does:
+--  - send GetVehicleData response to mobile app with sub parameter
+-- 5. App sends SubscribeVehileData(<custom parameter>) request
+-- SDL does:
+--  - transfer SubscribeVehileData request to HMI with sub parameter
+-- 6. HMI sends SubscribeVehileData response
+-- SDL does:
+--  - send SubscribeVehileData response to mobile app
+-- 7. HMI sends OnVehicleData notification with sub parameter
+-- SDL does:
+--  - send OnVehicleData notification to app with sub parameter
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local common = require('test_scripts/API/VehicleData/VehicleDataVersioning/common')
+
+-- [[ Test Configuration ]]
+runner.testSettings.isSelfIncluded = false
+config.ValidateSchema = false
+config.application1.registerAppInterfaceParams.syncMsgVersion.majorVersion = 6
+config.application1.registerAppInterfaceParams.syncMsgVersion.minorVersion = 0
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", common.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", common.start)
+runner.Step("Register App", common.registerApp)
+runner.Step("PTU", common.policyTableUpdate, { common.ptuFuncOEM })
+runner.Step("Activate App", common.activateApp)
+
+runner.Title("Test")
+runner.Step("GetVehicleData", common.getVehicleDataOEM)
+runner.Step("SubscribeVehicleData", common.subscribeVehicleDataOEM)
+runner.Step("OnVehicleData", common.onVehicleDataOEM)
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", common.postconditions)