Scripts for feature "Send Location updates"

test_scripts/API/Navigation/SendLocation/001_SendLocation_success.lua

@@ -0,0 +1,111 @@
+---------------------------------------------------------------------------------------------------
+-- User story: https://github.com/smartdevicelink/sdl_requirements/issues/24
+-- Use case: https://github.com/smartdevicelink/sdl_requirements/blob/master/detailed_docs/TRS/embedded_navi/SendLocation_TRS.md
+-- Item: Use Case 1: Main Flow
+--
+-- Requirement summary:
+-- SendLocation with address, longitudeDegrees, latitudeDegrees, deliveryMode and other parameters
+--
+-- Description:
+-- App sends SendLocation with all available parameters.
+
+-- Pre-conditions:
+-- a. HMI and SDL are started
+-- b. appID is registered on SDL
+
+-- Steps:
+-- appID requests SendLocation with address, longitudeDegrees, latitudeDegrees, deliveryMode and other parameters
+
+-- Expected:
+
+-- SDL validates parameters of the request
+-- SDL checks if Navi interface is available on HMI
+-- SDL checks if SendLocation is allowed by Policies
+-- SDL checks if deliveryMode is allowed by Policies
+-- SDL transfers the request with allowed parameters to HMI
+-- SDL receives response from HMI
+-- SDL transfers response to mobile app
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local commonSendLocation = require('test_scripts/API/Navigation/commonSendLocation')
+
+--[[ Local Variables ]]
+local requestParams = {
+    longitudeDegrees = 1.1,
+    latitudeDegrees = 1.1,
+    addressLines =
+    {
+        "line1",
+        "line2",
+    },
+    address = {
+        countryName = "countryName",
+        countryCode = "countryName",
+        postalCode = "postalCode",
+        administrativeArea = "administrativeArea",
+        subAdministrativeArea = "subAdministrativeArea",
+        locality = "locality",
+        subLocality = "subLocality",
+        thoroughfare = "thoroughfare",
+        subThoroughfare = "subThoroughfare"
+    },
+    timeStamp = {
+        millisecond = 0,
+        second = 40,
+        minute = 30,
+        hour = 14,
+        day = 25,
+        month = 5,
+        year = 2017,
+        tz_hour = 5,
+        tz_minute = 30
+    },
+    locationName = "location Name",
+    locationDescription = "location Description",
+    phoneNumber = "phone Number",
+    deliveryMode = "PROMPT",
+    locationImage =
+    {
+        value = "icon.png",
+        imageType = "DYNAMIC",
+    }
+}
+
+--[[ Local Functions ]]
+local function sendLocation(params, self)
+    local cid = self.mobileSession1:SendRPC("SendLocation", params)
+
+    params.appID = commonSendLocation.getHMIAppId()
+    local deviceID = commonSendLocation.getDeviceMAC()
+    params.locationImage.value = commonSendLocation.getPathToSDL() .. "storage/"
+        .. commonSendLocation.getMobileAppId(1) .. "_" .. deviceID .. "/icon.png"
+
+    EXPECT_HMICALL("Navigation.SendLocation", params)
+    :Do(function(_,data)
+        self.hmiConnection:SendResponse(data.id, data.method, "SUCCESS", {})
+    end)
+
+    self.mobileSession1:ExpectResponse(cid, { success = true, resultCode = "SUCCESS" })
+    :ValidIf (function(_,data)
+        if data.payload.info then
+            return false, "SDL sent redundant info parameter to mobile App "
+        else
+            return true
+        end
+    end)
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", commonSendLocation.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", commonSendLocation.start)
+runner.Step("RAI, PTU", commonSendLocation.registerApplicationWithPTU)
+runner.Step("Activate App", commonSendLocation.activateApp)
+runner.Step("Upload file", commonSendLocation.putFile, {"icon.png"})
+
+runner.Title("Test")
+runner.Step("SendLocation - all params", sendLocation, {requestParams})
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", commonSendLocation.postconditions)

test_scripts/API/Navigation/SendLocation/002_SendLocation_disallowed_by_policies.lua

@@ -0,0 +1,55 @@
+---------------------------------------------------------------------------------------------
+-- Requirements: https://github.com/smartdevicelink/sdl_requirements/blob/master/detailed_docs/TRS/embedded_navi/SendLocation_TRS.md
+--
+-- Requirement summary:
+-- 1. Request is valid, SendLocation RPC is not allowed by policies
+-- 2. SDL responds DISALLOWED, success:false to request
+--
+-- Description:
+-- App requests SendLocation in different HMI levels
+--
+-- Steps:
+-- SDL receives SendLocation request in NONE, BACKGROUND, FULL, LIMITED
+--
+-- Expected:
+-- SDL responds DISALLOWED, success:false in NONE level, SUCCESS, success:true in BACKGROUND, FULL, LIMITED levels
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local commonSendLocation = require('test_scripts/API/Navigation/commonSendLocation')
+
+--[[ Local Variables ]]
+local requestParams = {
+    longitudeDegrees = 1.1,
+    latitudeDegrees = 1.1
+}
+
+--[[ Local Functions ]]
+local function ptuUpdateFuncDissalowedRPC(tbl)
+	local SendLocstionRpcs = tbl.policy_table.functional_groupings["SendLocation"].rpcs
+	if SendLocstionRpcs["SendLocation"] then SendLocstionRpcs["SendLocation"] = nil end
+end
+
+--[[ Local Functions ]]
+local function sendLocationDisallowed(params, self)
+    local cid = self.mobileSession1:SendRPC("SendLocation", params)
+
+    EXPECT_HMICALL("Navigation.SendLocation")
+    :Times(0)
+
+    self.mobileSession1:ExpectResponse(cid, { success = false, resultCode = "DISALLOWED" })
+    commonSendLocation.delayedExp()
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", commonSendLocation.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", commonSendLocation.start)
+runner.Step("RAI, PTU", commonSendLocation.registerApplicationWithPTU, { "1", ptuUpdateFuncDissalowedRPC })
+runner.Step("Activate App", commonSendLocation.activateApp)
+
+runner.Title("Test")
+runner.Step("SendLocation_rpc_disallowed", sendLocationDisallowed, { requestParams })
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", commonSendLocation.postconditions)

test_scripts/API/Navigation/SendLocation/003_SendLocation_without_address.lua

@@ -0,0 +1,96 @@
+---------------------------------------------------------------------------------------------------
+-- User story: https://github.com/smartdevicelink/sdl_requirements/issues/24
+-- Use case: https://github.com/smartdevicelink/sdl_requirements/blob/master/detailed_docs/TRS/embedded_navi/SendLocation_TRS.md
+-- Item: Use Case 1: Main Flow (Alternative flow 2)
+--
+-- Requirement summary:
+-- App requests SendLocation without address and with longitudeDegrees, latitudeDegrees, deliveryMode
+-- and other valid and allowed parameters
+--
+-- Description:
+-- SDL transfers the SendLocation requests without address to HMI
+
+-- Pre-conditions:
+-- a. HMI and SDL are started
+-- b. appID is registered on SDL
+
+-- Steps:
+-- appID requests SendLocation with address, longitudeDegrees, latitudeDegrees, deliveryMode and other parameters
+
+-- Expected:
+
+-- SDL validates parameters of the request
+-- SDL checks if Navi interface is available on HMI
+-- SDL checks if SendLocation is allowed by Policies
+-- SDL checks if deliveryMode is allowed by Policies
+-- SDL transfers the request with allowed parameters to HMI
+-- SDL receives response from HMI
+-- SDL transfers response to mobile app
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local commonSendLocation = require('test_scripts/API/Navigation/commonSendLocation')
+
+--[[ Local Variables ]]
+local requestParams = {
+    longitudeDegrees = 1.1,
+    latitudeDegrees = 1.1,
+    timeStamp = {
+        millisecond = 0,
+        second = 40,
+        minute = 30,
+        hour = 14,
+        day = 25,
+        month = 5,
+        year = 2017,
+        tz_hour = 5,
+        tz_minute = 30
+    },
+    locationName = "location Name",
+    locationDescription = "location Description",
+    phoneNumber = "phone Number",
+    deliveryMode = "PROMPT",
+    locationImage =
+    {
+        value = "icon.png",
+        imageType = "DYNAMIC",
+    }
+}
+
+--[[ Local Functions ]]
+local function sendLocation(params, self)
+    local cid = self.mobileSession1:SendRPC("SendLocation", params)
+
+    params.appID = commonSendLocation.getHMIAppId()
+    local deviceID = commonSendLocation.getDeviceMAC()
+    params.locationImage.value = commonSendLocation.getPathToSDL() .. "storage/"
+        .. commonSendLocation.getMobileAppId(1) .. "_" .. deviceID .. "/icon.png"
+
+    EXPECT_HMICALL("Navigation.SendLocation", params)
+    :Do(function(_,data)
+        self.hmiConnection:SendResponse(data.id, data.method, "SUCCESS", {})
+    end)
+
+    self.mobileSession1:ExpectResponse(cid, { success = true, resultCode = "SUCCESS" })
+    :ValidIf (function(_,data)
+        if data.payload.info then
+            return false, "SDL sent redundant info parameter to mobile App "
+        else
+            return true
+        end
+    end)
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", commonSendLocation.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", commonSendLocation.start)
+runner.Step("RAI, PTU", commonSendLocation.registerApplicationWithPTU)
+runner.Step("Activate App", commonSendLocation.activateApp)
+runner.Step("Upload file", commonSendLocation.putFile, {"icon.png"})
+
+runner.Title("Test")
+runner.Step("SendLocation without address parameter", sendLocation, {requestParams})
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", commonSendLocation.postconditions)

test_scripts/API/Navigation/SendLocation/004_SendLocation_wo_mandatory.lua

@@ -0,0 +1,107 @@
+---------------------------------------------------------------------------------------------------
+-- User story: https://github.com/smartdevicelink/sdl_requirements/issues/24
+-- Use case: https://github.com/smartdevicelink/sdl_requirements/blob/master/detailed_docs/TRS/embedded_navi/SendLocation_TRS.md
+-- Item: Use Case 1: Main Flow (Alternative flow 2)
+--
+-- Requirement summary:
+-- App requests SendLocation with address, deliveryMode, other parameters
+-- and without longitudeDegrees or latitudeDegrees or without both longitudeDegrees and latitudeDegrees
+--
+-- Description:
+-- App sends SendLocation without longitudeDegrees or latitudeDegrees parameters.
+
+-- Pre-conditions:
+-- a. HMI and SDL are started
+-- b. appID is registered on SDL
+
+-- Steps:
+-- appID requests SendLocation with address, longitudeDegrees, latitudeDegrees, deliveryMode and other parameters
+
+-- Expected:
+
+-- SDL validates parameters of the request
+-- SDL respond to the App with resultCode=INVALID_DATA, success=false
+
+---------------------------------------------------------------------------------------------------
+--[[ Required Shared libraries ]]
+local runner = require('user_modules/script_runner')
+local commonSendLocation = require('test_scripts/API/Navigation/commonSendLocation')
+
+--[[ Local Variables ]]
+local requestParams = {
+    longitudeDegrees = 1.1,
+    latitudeDegrees = 1.1,
+    addressLines =
+    {
+        "line1",
+        "line2",
+    },
+    address = {
+        countryName = "countryName",
+        countryCode = "countryName",
+        postalCode = "postalCode",
+        administrativeArea = "administrativeArea",
+        subAdministrativeArea = "subAdministrativeArea",
+        locality = "locality",
+        subLocality = "subLocality",
+        thoroughfare = "thoroughfare",
+        subThoroughfare = "subThoroughfare"
+    },
+    timeStamp = {
+        millisecond = 0,
+        second = 40,
+        minute = 30,
+        hour = 14,
+        day = 25,
+        month = 5,
+        year = 2017,
+        tz_hour = 5,
+        tz_minute = 30
+    },
+    locationName = "location Name",
+    locationDescription = "location Description",
+    phoneNumber = "phone Number",
+    deliveryMode = "PROMPT",
+    locationImage =
+    {
+        value = "icon.png",
+        imageType = "DYNAMIC",
+    }
+}
+
+--[[ Local Functions ]]
+local function sendLocation(params, parametersToCut, self)
+    for _,paramToCutOff in pairs(parametersToCut) do
+        params[paramToCutOff] = nil
+    end
+    local cid = self.mobileSession1:SendRPC("SendLocation", params)
+
+    params.appID = commonSendLocation.getHMIAppId()
+    local deviceID = commonSendLocation.getDeviceMAC()
+    params.locationImage.value = commonSendLocation.getPathToSDL() .. "storage/"
+        .. commonSendLocation.getMobileAppId(1) .. "_" .. deviceID .. "/icon.png"
+
+    EXPECT_HMICALL("Navigation.SendLocation")
+    :Times(0)
+
+    self.mobileSession1:ExpectResponse(cid, { success = false, resultCode = "INVALID_DATA" })
+    commonSendLocation.delayedExp()
+end
+
+--[[ Scenario ]]
+runner.Title("Preconditions")
+runner.Step("Clean environment", commonSendLocation.preconditions)
+runner.Step("Start SDL, HMI, connect Mobile, start Session", commonSendLocation.start)
+runner.Step("RAI, PTU", commonSendLocation.registerApplicationWithPTU)
+runner.Step("Activate App", commonSendLocation.activateApp)
+runner.Step("Upload file", commonSendLocation.putFile, {"icon.png"})
+
+runner.Title("Test")
+runner.Step("SendLocation witout mandatory longitudeDegrees", sendLocation, {requestParams, {"longitudeDegrees"}})
+runner.Step("SendLocation witout mandatory latitudeDegrees", sendLocation, {requestParams, {"latitudeDegrees"}})
+runner.Step("SendLocation witout both mandatory params",
+            sendLocation,
+            {requestParams, {"longitudeDegrees", "latitudeDegrees"}})
+
+runner.Title("Postconditions")
+runner.Step("Stop SDL", commonSendLocation.postconditions)