diff --git a/docs/DEVELOPER/dev-tools/automated-channel-testing/javascript-library.md b/docs/DEVELOPER/dev-tools/automated-channel-testing/javascript-library.md index 02cd4984..9c7095a8 100644 --- a/docs/DEVELOPER/dev-tools/automated-channel-testing/javascript-library.md +++ b/docs/DEVELOPER/dev-tools/automated-channel-testing/javascript-library.md @@ -10,38 +10,45 @@ metadata: next: description: '' --- -{` -
-

Roku's JavaScript Library enables keyword-driven testing of apps. The library resides in a JavaScript class that has methods that map directly to keyword names. The keywords take the same arguments as the methods implementing them. The keywords report failures with exceptions, create logs by writing to standard output, and return values using the return statement.

-

Instantiating the library

-

To create an instance of the Roku JavaScript Library, provide the following three arguments:

+Roku's JavaScript Library enables keyword-driven testing of apps. The library resides in a JavaScript class that has methods that map directly to keyword names. The keywords take the same arguments as the methods implementing them. The keywords report failures with exceptions, create logs by writing to standard output, and return values using the `return` statement. + +## Instantiating the library + +To create an instance of the Roku JavaScript Library, provide the following three arguments: +
- - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + +
ArgumentDescription
ipThe IP address of the device to be used for testing.
timeoutThe amount of time (in milliseconds) that commands are allowed to run.
pressDelayThe amount of time (in milliseconds) between keypress commands. This argument works with the sendKeys command.
ArgumentDescription
ipThe IP address of the device to be used for testing.
timeoutThe amount of time (in milliseconds) that commands are allowed to run.
pressDelayThe amount of time (in milliseconds) between keypress commands. This argument works with the sendKeys command.
-

The following example demonstrates how to instantiate the Roku JavaScript Library:

-
library = new rokuLibrary.Library("192.168.2.121", 20000, 2000);
-
-

The following example demonstrates how to instantiate the Roku JavaScript Library and runs test case with Mocha and Chai:

-
//import library
+
+The following example demonstrates how to instantiate the Roku JavaScript Library:
+
+```javascript
+library = new rokuLibrary.Library("192.168.2.121", 20000, 2000);
+```
+
+The following example demonstrates how to instantiate the Roku JavaScript Library and runs test case with Mocha and Chai:
+
+```javascript
+//import library
 const rokuLibrary = require("../library/rokuLibrary");
 const expect = require("chai").expect;
 const {
@@ -53,9 +60,9 @@ const childProcess = spawn('D:/projects/go/webDriver/src/main.exe');
 let library;
 
 //test suite
-describe('test_3-Grid', () => {
+describe('test_3-Grid', () => {
     //this method is executed before all test cases
-    before(() => {
+    before(() => {
         //create instance of jsLibrary
         library = new rokuLibrary.Library("192.168.2.121", 20000, 2000);
     });
@@ -68,836 +75,900 @@ describe('test_3-Grid', () => {
     });
 
     //this method executed after all tests
-    after(async () => {
+    after(async () => {
         //close session
         await library.close();
         //exit webDriver
         childProcess.kill();
     });
 });
-
-

Keywords

-

The Roku's JavaScript Library includes the following keywords:

- -
-

A keyword will fail if its respective WebDriver endpoint returns a 4xx or 500 error.

-
-

sideLoad

-

(available since release 2.0)

+``` + +## Keywords + +The Roku's JavaScript Library includes the following keywords: + +- Sideload (*available since release 2.0*) +- Launch the app +- Input deep linking data (*available since release 2.0*) +- Get apps +- Send key +- Send keys +- Send word +- Mark timer (*available since release 2.0*) +- Get timer (*available since release 2.0*) +- Verify is playback started +- Verify is screen loaded +- Get child nodes (*available since release 2.1*) +- Get element +- Get elements +- Get focused element +- Verify is app loaded +- Get current app info +- Get device info +- Get player info +- Verify is channel exist +- Set timeout +- Set press delay +- Get attribute + +> A keyword will fail if its respective WebDriver endpoint returns a 4xx or 500 error. + +### sideLoad + +(*available since release 2.0*) +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentDescriptionExample
sideLoad
    -
  • channel: The file path of a zipped package file.
    • -
  • username: Enter rokudev, which is the user name for the Development Application Installer.
    • -
  • password: The password for accessing the Development Application Installer on your Roku device.
    • -
Sideloads an app that has been packaged into a zip file.

If the sideLoad command fails, [sideload](doc:developer-setup#sideloading-channels) the app to be tested and use the launchTheChannel command.		await library.sideLoad("channel.zip", "rokudev", "your_device_password")
KeywordArgumentDescriptionExample
sideLoad
    +
  • channel: The file path of a zipped package file.
    • +
  • username: Enter rokudev, which is the user name for the Development Application Installer.
    • +
  • password: The password for accessing the Development Application Installer on your Roku device.
    • +
Sideloads an app that has been packaged into a zip file.

If the sideLoad command fails, [sideload](doc:developer-setup#sideloading-channels) the app to be tested and use the launchTheChannel command.		await library.sideLoad("channel.zip", "rokudev", "your_device_password")
-

launchTheChannel

+ +### launchTheChannel +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentDescriptionExample
launchTheChannel
    -
  • channel_code: The ID of the app to be launched.
    • -
  • contentId: The [contentId](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentType to execute deep linking tests.
    • -
  • mediaType: The [mediaType](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentId to execute deep linking tests.
    • -
Launches the app corresponding to the specified app ID.await library.launchTheChannel("dev", "myMovie123", "movie")
KeywordArgumentDescriptionExample
launchTheChannel
    +
  • channel_code: The ID of the app to be launched.
    • +
  • contentId: The [contentId](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentType to execute deep linking tests.
    • +
  • mediaType: The [mediaType](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentId to execute deep linking tests.
    • +
Launches the app corresponding to the specified app ID.await library.launchTheChannel("dev", "myMovie123", "movie")
-

inputDeepLinkingData

-

(available since release 2.0)

+ +### inputDeepLinkingData + +(*available since release 2.0*) +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentDescriptionExample
inputDeepLinkingData
    -
  • channelId: The ID of the app to be launched.
    • -
  • contentId: The [contentId](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentType to execute deep linking tests.
    • -
  • mediaType: The [mediaType](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentId to execute deep linking tests.
    • -
Launches the app corresponding to the specified app ID.await library.inputDeepLinkingData("dev", "myMovie123", "movie")
KeywordArgumentDescriptionExample
inputDeepLinkingData
    +
  • channelId: The ID of the app to be launched.
    • +
  • contentId: The [contentId](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentType to execute deep linking tests.
    • +
  • mediaType: The [mediaType](doc:implementing-deep-linking#understanding-deep-linking-parameters) of the content to be played. You can include this parameter and the contentId to execute deep linking tests.
    • +
Launches the app corresponding to the specified app ID.await library.inputDeepLinkingData("dev", "myMovie123", "movie")
-

getApps

+ +### getApps +
- - - - - - - - - - - - + + + + + + + + + + + - - + + +
KeywordDescriptionExample
getAppsReturns a list of installed apps as an array of objects. Each app object contains the following fields:
    -
  • title
    • -
  • id
    • -
  • type
    • -
  • version
    • -
  • subtype
    • -
expect(apps[0].ID).to.equal('some_id')
+
KeywordDescriptionExample
getAppsReturns a list of installed apps as an array of objects. Each app object contains the following fields:
    +
  • title
    • +
  • id
    • +
  • type
    • +
  • version
    • +
  • subtype
    • + 
expect(apps[0].ID).to.equal('some_id')
 const apps = await library.getApps()
-
-

sendKey

+ +### sendKey +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentsDescriptionExample
sendKey
    -
  • key_press: The key to be pressed and released, which may be one of the following: "up", "down", "right", "left", "back, "select", "instantreplay", "play", "stop", "rev", "fwd", and "info".
    • -
  • delay: The delay (in seconds) before the keypresses are executed. This argument is optional, and it defaults to 2 seconds if not specified.
    • -
Simulates the press and release of the specified key.await library.sendKey('select', 4)
KeywordArgumentsDescriptionExample
sendKey
    +
  • key_press: The key to be pressed and released, which may be one of the following: "up", "down", "right", "left", "back, "select", "instantreplay", "play", "stop", "rev", "fwd", and "info".
    • +
  • delay: The delay (in seconds) before the keypresses are executed. This argument is optional, and it defaults to 2 seconds if not specified.
    • +
Simulates the press and release of the specified key.await library.sendKey('select', 4)
-

sendKeys

+ +### sendKeys +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentsDescriptionExample
sendKeys
    -
  • sequence: An array containing the sequence of keys to be pressed and released (for example, down, down, down, down, select).
    • -
  • delay: The delay (in seconds) before the keypresses are executed. This argument is optional, and it defaults to 2 seconds if not specified.
    • -
Simulates the sequence of keypresses and releases.await library.sendKeys(['down', 'down', 'down', 'down', 'select'])
KeywordArgumentsDescriptionExample
sendKeys
    +
  • sequence: An array containing the sequence of keys to be pressed and released (for example, down, down, down, down, select).
    • +
  • delay: The delay (in seconds) before the keypresses are executed. This argument is optional, and it defaults to 2 seconds if not specified.
    • +
Simulates the sequence of keypresses and releases.await library.sendKeys(['down', 'down', 'down', 'down', 'select'])
-

sendWord

+ +### sendWord +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentsDescriptionExample
sendWord
    -
  • word: The specified word to be entered.
    • -
  • delay: The delay (in seconds) before the entry of each letter in the specified word. This argument is optional, and it defaults to 2 seconds if not specified.
    • -
Simulates the press and release of each letter in a word.await library.sendWord('user')
KeywordArgumentsDescriptionExample
sendWord
    +
  • word: The specified word to be entered.
    • +
  • delay: The delay (in seconds) before the entry of each letter in the specified word. This argument is optional, and it defaults to 2 seconds if not specified.
    • +
Simulates the press and release of each letter in a word.await library.sendWord('user')
-

markTimer

-

(available since release 2.0)

+ +### markTimer + +(*available since release 2.0*) +
- - - - - - - - - - - - - - + + + + + + + + + + + + + +
KeywordDescriptionExample
markTimerStarts the timer.library.markTimer();
KeywordDescriptionExample
markTimerStarts the timer.library.markTimer();
-

getTimer

-

(available since release 2.0)

+ +### getTimer + +(*available since release 2.0*) +
- - - - - - - - - - - - + + + + + + + + + + + - - + + +
KeywordDescriptionExample
getTimerReturns the number of milliseconds elapsed since the timer was last started.
let res = await library.verifyIsPlaybackStarted(25, 1);
-expect(res).to.equal(true);   
+
KeywordDescriptionExample
getTimerReturns the number of milliseconds elapsed since the timer was last started.
let res = await library.verifyIsPlaybackStarted(25, 1);
+expect(res).to.equal(true);
 let time = library.getTimer();
 expect(14000).greaterThan(time);
-
-

verifyIsPlaybackStarted

+ +### verifyIsPlaybackStarted +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentsDescriptionExample
verifyIsPlaybackStarted
    -
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • -
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • -
Verify playback has started on the Roku media player.

This keyword fails if player state is not "play".		verifyIsPlaybackStarted(25, 2)
KeywordArgumentsDescriptionExample
verifyIsPlaybackStarted
    +
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • +
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • +
Verify playback has started on the Roku media player.

This keyword fails if player state is not "play".		verifyIsPlaybackStarted(25, 2)
-

verifyIsScreenLoaded

+ +### verifyIsScreenLoaded +
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
KeywordArgumentsDescriptionExample
Verify is screen loaded
    -
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) command for more information.
    • -
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • -
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • -
Verify that the screen is loaded based on the provided element data.verifyIsScreenLoaded({'elementData': [{'using': 'text', 'value': 'Barack Gates, Bill Obama'}]})
KeywordArgumentsDescriptionExample
Verify is screen loaded
    +
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) command for more information.
    • +
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • +
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • +
Verify that the screen is loaded based on the provided element data.verifyIsScreenLoaded({'{'}'elementData': [{'{'}'using': 'text', 'value': 'Barack Gates, Bill Obama'{'}'}]{'}'})
-

getChildNodes

+ +### getChildNodes +
- - - - - - - - - - - - - - + + + + + + + + + + + + + - - + + +
KeywordArgumentsDescriptionExample
getChildNodes
    -
  • parentNode: The parent node for which the child nodes are to be retrieved.
    • -
Retrieves the child component of the specified node.
const rowList = await library.getElement({"elementData" :[{"using": "tag", "value": "ZoomRowList"}]});
-const searchData = [{"using": "tag", "value": "RenderableNode"}, {"using": "attr", "attribute": "focused", "value": "true"}];
+
KeywordArgumentsDescriptionExample
getChildNodes
    +
  • parentNode: The parent node for which the child nodes are to be retrieved.
    • +
Retrieves the child component of the specified node.
const rowList = await library.getElement({'{'}"elementData" :[{'{'}"using": "tag", "value": "ZoomRowList"{'}'}]{'}'});
+const searchData = [{'{'}"using": "tag", "value": "RenderableNode"{'}'}, {'{'}"using": "attr", "attribute": "focused", "value": "true"{'}'}];
 const result = library.getChildNodes(rowList, searchData);
-
- -

getElement

-
- - - - - - - - - - - - - -
KeywordArgumentsDescriptionExample
Get element
    -
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) for more information.
    • -
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • -
Searches for an element on the page based on the specified locator starting from the screen root. Returns information on the first matching element.
const element = await library.getElement({'elementData': [{'using': 'attr', 'attribute': 'name', 'value': 'poster'}]}, 4);
+  ```
+
+### getElement
 
+

+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
-
-
+        
+      
+    
KeywordArgumentsDescriptionExample
Get element
    
+            
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) for more information.
    • 
+            
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • 
+        
Searches for an element on the page based on the specified locator starting from the screen root.  Returns information on the first matching element.
const element = await library.getElement({'{'}'elementData': [{'{'}'using': 'attr', 'attribute': 'name', 'value': 'poster'{'}'}]{'}'}, 4);
 const poster = library.getAttribute(element, 'uri');
 expect(poster).to.equal('poster.png');
-

 

-
getElements

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
KeywordArgumentsDescriptionExample
getElements
    
-
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) for more information.
    • 
-
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • 
-
Searches for elements on the page based on the specified locators starting from the screen root. Returns information on the matching elements.
const elements= await library.getElements({'elementData': [{'using': 'attr', 'attribute': 'name', 'value': 'poster'}]}, 4);
 
+### getElements
+
+

+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
-
-
+        
+      
+    
KeywordArgumentsDescriptionExample
getElements
    
+            
  • data: An object with locators for elementData and parentData (parentData is optional). See the [WebDriver element command](doc:web-driver#POST-v1/session/:sessionId/elements) for more information.
    • 
+            
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • 
+        
Searches for elements on the page based on the specified locators starting from the screen root. Returns information on the matching elements.
const elements= await library.getElements({'{'}'elementData': [{'{'}'using': 'attr', 'attribute': 'name', 'value': 'poster'{'}'}]{'}'}, 4);
 const poster = library.getAttribute(elements[0], 'uri');
 expect(poster).to.equal('poster.png');
-

 

-
getFocusedElement

-

-
-
-
-
-
-
-
-
-
-
-
-
KeywordDescriptionExample
getFocusedElementReturn the element on the screen that currently has focus. See the [WebDriver active element command](doc:web-driver#get-v1/session/:sessionId/element/active) for more information.
const element = await library.getFocusedElement()
 
+### getFocusedElement
+
+

+    
+      
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
-
-
+        
+      
+    
KeywordDescriptionExample
getFocusedElementReturn the element on the screen that currently has focus. See the [WebDriver active element command](doc:web-driver#get-v1/session/:sessionId/element/active) for more information.
const element = await library.getFocusedElement()
 const poster = library.getAttribute(element, 'uri');
 expect(poster).to.equal('poster.png');
-

 

-
verifyIsChannelLoaded

+
+### verifyIsChannelLoaded
+
 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
+      
+    
KeywordArgumentsDescriptionExample
verifyIsChannelLoaded
    
-
  • id: The ID of the app to be launched. Use dev to verify a sideloaded app.
    • 
-
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • 
-
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • 
-
Verify that the specified app has been launched.

This keyword fails if the provided app ID does not match a valid app.		await library.verifyIsChannelLoaded('dev')
KeywordArgumentsDescriptionExample
verifyIsChannelLoaded
    
+            
  • id: The ID of the app to be launched. Use dev to verify a sideloaded app.
    • 
+            
  • retries: The number of requests that can be made before returning false. This argument is optional, and it defaults to 10 if not specified.
    • 
+            
  • delay: The delay (in seconds) between retries. This argument is optional, and it defaults to 1 second if not specified.
    • 
+        
Verify that the specified app has been launched.

This keyword fails if the provided app ID does not match a valid app.		await library.verifyIsChannelLoaded('dev')

 

-
###getCurrentChannelInfo

+
+###getCurrentChannelInfo
+
 

-
-
-
-
-
-
-
-
-
-
-
-
+      
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
-
-
+        
+      
+    
KeywordDescriptionExample
getCurrentChannelInfoReturns an object containing information about the app currently loaded. This object has the following fields:

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
KeyTypeDescription
sessionIdstringThe advertising ID of the device
statusintA status code summarizing the result of the command.
valuearray
value[i].TitlestringThe title of the app.
value[i].IDstringThe ID of the app.
value[i].VersionstringThe build version of the app.
value[i].Subtypestring"ndka"/"rsga"
value[i].Typestring"menu"/"appl"
const data = await library.getPlayerInfo();
+    
KeywordDescriptionExample
getCurrentChannelInfo
+          Returns an object containing information about the app currently loaded. This object has the following fields:

+          

+            
+              
+                
+                  
+                  
+                  
+                
+              
+              
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+              
+            
KeyTypeDescription
sessionIdstringThe advertising ID of the device
statusintA status code summarizing the result of the command.
valuearray
value[i].TitlestringThe title of the app.
value[i].IDstringThe ID of the app.
value[i].VersionstringThe build version of the app.
value[i].Subtypestring"ndka"/"rsga"
value[i].Typestring"menu"/"appl"

+          

+        
const data = await library.getPlayerInfo();
 expect(data.Position).greaterThan(9000);
-

 

-
getDeviceInfo

+
+### getDeviceInfo
+
 

-
-
-
-
-
-
-
-
-
-
-
-
+      
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
-
-
+        
+      
+    
KeywordDescriptionExample
getDeviceInfoReturns an object containing the information about the device. This object has the following fields:

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
KeyTypeDescription
sessionIdstringThe advertisement ID of the device.
statusintA status code summarizing the result of the command.
valueobject
value.vendorNamestringThe vendor of the device.
value.modelNamestringThe model of the device.
value.languagestringThe language of the device.
value.countrystringThe country of the device.
value.ipstringThe IP address of the device.
value.timeoutintThe specified timeout for WebDriver client requests.
value.pressDelayintThe specified delay between key presses.
const info = await library.getDeviceInfo()
+    
KeywordDescriptionExample
getDeviceInfo
+          Returns an object containing the information about the device. This object has the following fields:

+          

+            
+              
+                
+                  
+                  
+                  
+                
+              
+              
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+              
+            
KeyTypeDescription
sessionIdstringThe advertisement ID of the device.
statusintA status code summarizing the result of the command.
valueobject
value.vendorNamestringThe vendor of the device.
value.modelNamestringThe model of the device.
value.languagestringThe language of the device.
value.countrystringThe country of the device.
value.ipstringThe IP address of the device.
value.timeoutintThe specified timeout for WebDriver client requests.
value.pressDelayintThe specified delay between key presses.

+          

+        
const info = await library.getDeviceInfo()
 expect(info.language).to.equal('en')
-

 

-
getPlayerInfo

+
+### getPlayerInfo
+
 

-
-
-
-
-
-
-
-
-
-
-
-
+      
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
-
-
+        
+      
+    
KeywordDescriptionExample
getPlayerInfoReturns an object containing information about the Roku media player. This object has the following fields:

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
KeyTypeDescription
sessionIdstringThe advertising ID of the device
statusintA status code summarizing the result of the command
valueobject
value.errorstringIndicates whether there was a playback error. If no error occurred, this is set to "false"
value.statestringIndicates the current playback state ("play", "pause", "resume", and so on)
value.formatobjectThe format element contains the following attributes: audio, caption, container, drm, video, and res.
value.format.audiostringThe audio compression method ("aac", "aac_adts", and so on.)
value.format.captionstringThe closed caption format ("608_708", for example). This value is set to "none" if there are no captions.
value.format.containerstringThe container format ("hls", for example)
value.format.drmstringThe encoding type. If no encoding is used, this us set to "none".
value.format.videostringThe format of the currently playing video stream ("mpeg4-15", for example)
value.format.resstringThe resolution of the currently playing video stream ("1280X720", for example).
value.bufferingobjectThe buffering element contains the following attributes: current, max, target.
value.buffering.currentstringThe current buffering speed (in kbps).
value.buffering.maxstringThe maximum possible buffering speed (in kbps).
value.buffering.targetstringThe target buffering speed (in kbps).
value.newStreamobjectThe newStream element contains the following attribute: speed.
value.newStream.speedstringThe current playback speed (in bps)
value.positionstringThe time of the current position in the stream, expressed as the elapsed time (in ms) since the start of stream or UTC time, depending on the content.
value.durationstringThe duration of the video being played (in seconds). This becomes valid when playback begins and may change if the video is dynamic content, such as a live event.
value.isLivestringA flag indicating whether the video being played is a live stream.
value.runtimestringThe runtime of the video being played (in seconds).
value.streamSegmentobjectThe streamSegment attribute contains Information about the video segment that is currently streaming. This is only meaningful for segmented video transports, such as DASH and HLS  This element contains the following attributes: bitrate, mediaSequence, segmentType, and time.
value.streamSegment.bitratestringThe bitrate of the video segment (in bps).
value.streamSegment.mediaSequencestringThe HLS media sequence ID of the segment in the video.
value.streamSegment.segmentTypestringThe type of data in the segment, which may be one of the following values: "audio", "video", "captions", "mux".
value.streamSegment.timestringThe chunk start time.
const data = await library.getPlayerInfo();
+    
KeywordDescriptionExample
getPlayerInfo
+          Returns an object containing information about the Roku media player. This object has the following fields:

+          

+            
+              
+                
+                  
+                  
+                  
+                
+              
+              
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+                
+                  
+                  
+                  
+                
+              
+            
KeyTypeDescription
sessionIdstringThe advertising ID of the device
statusintA status code summarizing the result of the command
valueobject
value.errorstringIndicates whether there was a playback error. If no error occurred, this is set to "false"
value.statestringIndicates the current playback state ("play", "pause", "resume", and so on)
value.formatobjectThe format element contains the following attributes: audio, caption, container, drm, video, and res.
value.format.audiostringThe audio compression method ("aac", "aac_adts", and so on.)
value.format.captionstringThe closed caption format ("608_708", for example). This value is set to "none" if there are no captions.
value.format.containerstringThe container format ("hls", for example)
value.format.drmstringThe encoding type. If no encoding is used, this us set to "none".
value.format.videostringThe format of the currently playing video stream ("mpeg4-15", for example)
value.format.resstringThe resolution of the currently playing video stream ("1280X720", for example).
value.bufferingobjectThe buffering element contains the following attributes: current, max, target.
value.buffering.currentstringThe current buffering speed (in kbps).
value.buffering.maxstringThe maximum possible buffering speed (in kbps).
value.buffering.targetstringThe target buffering speed (in kbps).
value.newStreamobjectThe newStream element contains the following attribute: speed.
value.newStream.speedstringThe current playback speed (in bps)
value.positionstringThe time of the current position in the stream, expressed as the elapsed time (in ms) since the start of stream or UTC time, depending on the content.
value.durationstringThe duration of the video being played (in seconds). This becomes valid when playback begins and may change if the video is dynamic content, such as a live event.
value.isLivestringA flag indicating whether the video being played is a live stream.
value.runtimestringThe runtime of the video being played (in seconds).
value.streamSegmentobjectThe streamSegment attribute contains Information about the video segment that is currently streaming. This is only meaningful for segmented video transports, such as DASH and HLS  This element contains the following attributes: bitrate, mediaSequence, segmentType, and time.
value.streamSegment.bitratestringThe bitrate of the video segment (in bps).
value.streamSegment.mediaSequencestringThe HLS media sequence ID of the segment in the video.
value.streamSegment.segmentTypestringThe type of data in the segment, which may be one of the following values: "audio", "video", "captions", "mux".
value.streamSegment.timestringThe chunk start time.

+          

+        
const data = await library.getPlayerInfo();
 expect(data.Position).greaterThan(9000);
-

 

-
verifyIsChannelExist

+
+### verifyIsChannelExist
+
 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
-
-
+        
+      
+    
KeywordArgumentsDescriptionExample
verifyIsChannelExist
    
-
  • apps: An array containing  currently installed on the device.
    • 
-
  • id: The ID of the app to be verified. Use dev to verify a sideloaded app.
    • 
-
Verifies the specified app is installed on the device. This keyword fails if the apps array does not contain the app specified in the id argument.
const apps = await library.getApps();
+    
KeywordArgumentsDescriptionExample
verifyIsChannelExist
    
+            
  • apps: An array containing  currently installed on the device.
    • 
+            
  • id: The ID of the app to be verified. Use dev to verify a sideloaded app.
    • 
+        
Verifies the specified app is installed on the device. This keyword fails if the apps array does not contain the app specified in the id argument.
const apps = await library.getApps();
 const res = library.verifyIsChannelExist(apps, 'dev');
 expect(res).equal(true);
-

 

-
setTimeout

+
+### setTimeout
+
 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
+      
+    
KeywordArgumentsDescriptionExample
setTimeout
timeout: The amount of time (in milliseconds) that Web driver client requests are allowed to run.
Sets the timeout for Web driver client requests.await library.setTimeout(10000)
KeywordArgumentsDescriptionExample
setTimeout
timeout: The amount of time (in milliseconds) that Web driver client requests are allowed to run.
Sets the timeout for Web driver client requests.await library.setTimeout(10000)

 

-
setDelay

+
+### setDelay
+
 

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
+      
+    
KeywordArgumentsDescriptionExample
setDelay
delay: The interval (in milliseconds) to be used between key presses.
Sets the delay between key presses. This keyword works with the Send keys keyword.await library.setDelay(1000)
KeywordArgumentsDescriptionExample
setDelay
delay: The interval (in milliseconds) to be used between key presses.
Sets the delay between key presses. This keyword works with the Send keys keyword.await library.setDelay(1000)

 

-
getAttribute

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
KeywordArgumentsDescriptionExample
getAttribute
    
-
  • element: An object that contains element information (attributes, child nodes).
    • 
-
  • attr: The name of the attribute to be retrieved.
    • 
-
Get attribute value. This keyword fails if an element does not contain the specified attribute.
const elements= await library.getElements({'elementData': [{'using': 'attr', 'attribute': 'name', 'value': 'poster'}]}, 4);
 
+### getAttribute
+
+

+    
+      
+        
+        
+        
+        
+      
+    
+    
+      
+        
+        
+        
+        
-
-
+        
+      
+    
KeywordArgumentsDescriptionExample
getAttribute
    
+            
  • element: An object that contains element information (attributes, child nodes).
    • 
+            
  • attr: The name of the attribute to be retrieved.
    • 
+        
Get attribute value. This keyword fails if an element does not contain the specified attribute.
const elements= await library.getElements({'{'}'elementData': [{'{'}'using': 'attr', 'attribute': 'name', 'value': 'poster'{'}'}]{'}'}, 4);
 const poster = library.getAttribute(elements[0], 'uri');
 expect(poster).to.equal('poster.png')
-

 

-
Sample test cases

-
The Roku automated app testing repository includes a set of sample JavaScript test cases that can be executed on their corresponding SceneGraph Developer Extensions (SGDEX) sample apps. For example, you can execute the SGDEX GridView test case (test_3_Grid.js), which will sideload the corresponding sample app (3_Grid) on your device, and then view the test output. You can reference these samples when developing test scripts for the automated testing of your development apps.

-

-
Before running a sample test case, you need to update the sideload command in the test case with the Roku device password.

-

-
The test_basic.js sample demonstrates how to create a simple test case that checks whether a user is authenticated before playing content using the Roku JavaScript Library:

-
const rokuLibrary = require("../library/rokuLibrary");
+
+## Sample test cases
+
+The [Roku automated app testing repository](https://github.com/rokudev/automated-channel-testing) includes a set of sample JavaScript test cases that can be executed on their corresponding [SceneGraph Developer Extensions (SGDEX) sample apps](https://github.com/rokudev/SceneGraphDeveloperExtensions/tree/master/samples). For example, you can execute the SGDEX GridView test case (**test_3_Grid.js**), which will sideload the corresponding sample app (**3_Grid**) on your device, and then view the test output. You can reference these samples when developing test scripts for the automated testing of your development apps.
+
+> Before running a sample test case, you need to update the **sideload** command in the test case with the Roku device password.
+
+The [**test_basic.js** sample](https://github.com/rokudev/automated-channel-testing/blob/master/jsLibrary/tests/test_basic.js) demonstrates how to create a simple test case that checks whether a user is authenticated before playing content using the Roku JavaScript Library:
+
+```javascript
+const rokuLibrary = require("../library/rokuLibrary");
 const expect = require("chai").expect;
 const {
     spawn
 } = require('child_process');
 const childProcess = spawn('D:/projects/go/webDriver/src/main.exe');
 let library;
-describe('App should be launched', () => {
-    before(() => {
+describe('App should be launched', () => {
+    before(() => {
         library = newrokuLibrary.Library("192.168.1.64");
     });
 
@@ -914,15 +985,16 @@ describe('App should be launched', () => {
         await library.verifyIsChannelLoaded('dev');
     });
 
-    after(async () => {
+    after(async () => {
         await library.close();
         childProcess.kill();
     });
 
 });
-

-
Viewing the test case report and log

-
After you run a test case that uses the Roku JavaScript Library, you can view the generated report and log files in the specified output directory. The report summarizes the test case and provides statistics on the percentage of individual tests that passed/failed. The log details the success/failure of the individual keywords used in each test case.

-`}
+```
+
+## Viewing the test case report and log
+
+After you run a test case that uses the Roku JavaScript Library, you can view the generated report and log files in the specified output directory. The report summarizes the test case and provides statistics on the percentage of individual tests that passed/failed. The log details the success/failure of the individual keywords used in each test case.