Back to Repositories

Testing Notification Permission Management in NW.js

This test suite validates notification permission handling in NW.js across different contexts and domains. It systematically tests permission states (granted, denied, default) for both local and remote windows/frames using Selenium WebDriver automation.

Test Coverage Overview

The test suite provides comprehensive coverage of notification permission scenarios in NW.js applications.

Key areas tested include:

Default permission states across domains
Permission behavior in local and remote windows
Permission handling in iframe contexts
Permission state transitions (block/allow/ask)

Implementation Analysis

The testing approach uses Selenium WebDriver with Python to automate permission verification workflows. The implementation follows a modular pattern with the test_perm() function handling different permission scenarios. It leverages Chrome options and window handling for testing both main window and popup contexts.

Technical Details

Tools and Configuration:

Selenium WebDriver with Chrome
Python test framework
Local HTTP server for remote context testing
Custom nw_util helper functions
Chrome driver with NW.js app configuration

Best Practices Demonstrated

The test implementation showcases several testing best practices including proper test isolation, cleanup between scenarios, and explicit wait conditions. It handles both success and failure cases, manages browser windows effectively, and includes comprehensive error handling with try-finally blocks.

nwjs/nwJs

test/sanity/issue4521-notification-perm/test.py

            
import time
import os
import subprocess
import sys
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from nw_util import *

from selenium import webdriver
from selenium.webdriver.chrome.options import Options
from selenium.webdriver.common import utils

def test_perm(driver, click_id, find_id, should_close_window=False, expected='granted'):
    driver.find_element_by_id(click_id).click()
    result = wait_for_element_id(driver, find_id)
    print(result)
    assert(expected in result)
    if should_close_window == True:
        wait_window_handles(driver, 2)
        driver.switch_to.window(driver.window_handles[1])
        driver.close()
        driver.switch_to.window(driver.window_handles[0])
        wait_window_handles(driver, 1)

chrome_options = Options()
chrome_options.add_argument("nwapp=" + os.path.dirname(os.path.abspath(__file__)))
chrome_options.add_argument("skip-reopen-app-devtools")

testdir = os.path.dirname(os.path.abspath(__file__))
os.chdir(testdir)

try:
    os.remove('port.txt')
except:
    pass

server = subprocess.Popen(['python', '../http-server-node.py', 'server.js'])

while not os.path.exists('port.txt') :
    time.sleep(1)

driver = webdriver.Chrome(executable_path=os.environ['CHROMEDRIVER'], chrome_options=chrome_options, service_log_path="log", service_args=["--verbose"])
driver.implicitly_wait(2)
try:
    print(driver.current_url)
    # 1. default 'granted' on all domains
    # perm for index.html
    test_perm(driver, 'show-perm', 'perm')

    # perm for local open window
    test_perm(driver, 'show-perm-open-inside', 'perm-open-inside', should_close_window=True)

    # perm for remote open window
    test_perm(driver, 'show-perm-open-remote', 'perm-open-remote', should_close_window=True)

    # perm for local frame
    test_perm(driver, 'show-perm-frame-inside', 'perm-frame-inside')

    # perm for remote frame
    test_perm(driver, 'show-perm-frame-remote', 'perm-frame-remote')

    # clear results
    test_perm(driver, 'clear-results', 'output', expected='cleared')

    # 2. block notification permission on localhost
    test_perm(driver, 'set-perm-block', 'set-perm-block-result', expected='success')

    # perm for index.html
    test_perm(driver, 'show-perm', 'perm')

    # perm for local open window
    test_perm(driver, 'show-perm-open-inside', 'perm-open-inside', should_close_window=True)

    # perm for remote open window
    test_perm(driver, 'show-perm-open-remote', 'perm-open-remote', should_close_window=True, expected='denied')

    # perm for local frame
    test_perm(driver, 'show-perm-frame-inside', 'perm-frame-inside')

    # perm for remote frame
    test_perm(driver, 'show-perm-frame-remote', 'perm-frame-remote', expected='denied')

    # clear results
    test_perm(driver, 'clear-results', 'output', expected='cleared')

    # 3. set notification permission to default on localhost
    test_perm(driver, 'set-perm-ask', 'set-perm-ask-result', expected='success')

    # perm for index.html
    test_perm(driver, 'show-perm', 'perm')

    # perm for local open window
    test_perm(driver, 'show-perm-open-inside', 'perm-open-inside', should_close_window=True)

    # perm for remote open window
    test_perm(driver, 'show-perm-open-remote', 'perm-open-remote', should_close_window=True, expected='default')

    # perm for local frame
    test_perm(driver, 'show-perm-frame-inside', 'perm-frame-inside')

    # perm for remote frame
    test_perm(driver, 'show-perm-frame-remote', 'perm-frame-remote', expected='denied')

    # clear results
    test_perm(driver, 'clear-results', 'output', expected='cleared')

    # 4. allow notification permission on localhost
    test_perm(driver, 'set-perm-allow', 'set-perm-allow-result', expected='success')

    # perm for index.html
    test_perm(driver, 'show-perm', 'perm')

    # perm for local open window
    test_perm(driver, 'show-perm-open-inside', 'perm-open-inside', should_close_window=True)

    # perm for remote open window
    test_perm(driver, 'show-perm-open-remote', 'perm-open-remote', should_close_window=True)

    # perm for local frame
    test_perm(driver, 'show-perm-frame-inside', 'perm-frame-inside')

    # perm for remote frame
    test_perm(driver, 'show-perm-frame-remote', 'perm-frame-remote')
finally:
    import platform
    if platform.system() == 'Windows':
        subprocess.call(['taskkill', '/F', '/T', '/PID', str(server.pid)])
    else:
        server.terminate()
    driver.quit()