Test a web socket based application

Testing a web socket application involves validating application headers, validating web socket URIs and overall testing.

Testing using header simulation allows you to validate header fields as required.
Complete testing should always be performed to validate that the application is behaving as expected for all URIs.

Topics

 

Configure application for simulation testing

Important Note

Important

This section covers testing using header based simulation and is only required if testing passing of values using application headers.

To configure an application for header simulation testing:

  1. Navigate to the Access Gateway Admin UI console
  2. From the Topology tab or the Applications tab, open the application.
  3. Select the Settings pane.
  4. Expand the Essentials sub tab.
  5. Note the current value of Protected Web Resource.
  6. Change the Protected Web Resource field to:
    ValueBehavior
    https://header.service.spgwWhen running a test, results in the display of information related to the header, cookie, session, and other information.
    Important Note

    Important

    Copy and save the original backend Protected Web Resource value.

  7. Expand the Advanced sub-tab.
  8. Set the Debug toggle to Enable.
    The debug toggle, which can be found in the Advanced application settings.
    Caution

    Caution

    When enabling Debug mode, ensure that the download log has also been set to level debug. Application debug events aren't visible in downloadable logs unless download logs are also configured to emit Debug level log events.
    See Manage log verbosity

  9. Click Done.
    10. Tip

    Tip

    When debugging header based applications: Consider testing attributes with static known good values. For example, change dynamic IDP based fields to static with known good values.
    When debugging policy based applications: Test with no policy or open policy first.

Configure Access Gateway for debug and monitoring

The Access Gateway Management console can be used to provide a running display of all system log messages. In this optional section we enable debug and monitor Access Gateway using this functionality.

  1. Open a terminal and using SSH connect to the Access Gateway Management console for example.
    ssh oag-mgmt@gw-admin.<domain.tld>
    or
    ssh oag-mgmt@gw-admin.mysite.myco.com
  2. Navigate to the log monitoring page:
    1. Enter 4 - Monitoring.
    2. Enter 2 - Enable Debug.
    3. Enter 1 - Monitor logs.

    The a running display of all log messages will begin to display. Return to the Access Gateway Admin UI console console and exercise the application being examined.
    See command line Access Gateway Management console/monitoring for a complete list of all monitoring and related commands.

  3. Enter [ctrl][c] to exit the log display.
Important Note

Important

The debug logging level rapidly generates log message. Be sure to always disable debug logging when you have finished examining logging.
Failure to disable debug logging could result in rapid log file growth and out of disk errors.

Simulation testing

Header and policy simulation testing involves temporarily replacing the Protected Web resource field in an application and then testing various target URLs, evaluating whether the headers and policies return the expected result.

To test an application using header or policy simulation:

  1. Configure the application for header or policy simulation testing as described in the Configure application for simulation testing section.
  2. Connect to the Access Gateway Management console and begin monitoring.
    For details see the monitoring section in Troubleshooting Applications.
  3. Select the Applications tab.
  4. On the row containing the application, click Goto application > SP Initiated.
  5. Examine the header or policy information returned.
  6. Repeat for each protected URI.
  7. When complete disable debugging as described in the Disable debug section.

Completed application testing

Completed application testing as required.

  1. The Applications tab, on the row containing the application, click Goto application > SP Initiated.
  2. Repeat testing using Goto application > IDP Initiated.
  3. Repeat testing using each specialized policy URI.
  4. If required, disable debugging.

Completed application testing as required.

Disable debug

If displaying debug statements at the command line:

  1. Return to the Access Gateway Management console.
  2. Enter [ctrl][c] to exit the log display.
  3. Enter 3 - Disable debug.
  4. Exit the command line console

If application debug is enabled:

  1. Return to the Access Gateway Admin UI console
  2. Navigate to the application being tested
  3. Expand the Setting sub tab.
  4. Expand the Essentials sub tab.
  5. Return the Protected Web Resource field back to its original value.
  6. Expand the Advanced sub tab.
  7. Set the Debug toggle to Disable.
  8. Save your changes.