Nugridium Web Portal Guide

Welcome! This guide will help you navigate the Nugridium Server web interface.

These are the initial setup steps you need to take before you can start executing tests:

  • Connect at least one agent to the server
  • Create a project
  • Create a test environment
  • Add at least one agent to the test environment
  • Upload some test binaries that contain the tests to run

Agents

Once your server web portal is up and running, the first thing you will need to do is add at least one Nugridium agent by establishing a trusted connection with the server. The agent can be installed on the same machine as the server, however if you need more than one agent you will have to install agent instances on other machines as well.

Add a Trusted Agent

In order to add a new agent navigate to the Agents page on the server web portal and click on the 'Add agent' button.

Nugridium Web Portal add new agent

Once you enter the agent's certificate thumbprint (found on the Agents Manager's Security section), you need to click the Create button.

add new agent

Once you start your agent instance (assuming you've entered the server's thumbprint on your agent's manager interface), the agent will start pinging the server and the newly added agent will turn green. Also, the agent's machine name will now be associated with the agent.

Nugridium Web Portal agents view

Projects

Before you can do anything else in the web portal, you will need to create a Project. A Project will represent the web application that you wish to test. You can add a new project by clicking on the 'New Project' button on the Projects page.

projects

The Projects lists your projects. Each project row gives you a quick summary of the test session counts for that project.

Project Detail view

If you click on the project name you will be redirected to the Project Detail page, which gives you a quick look at all the main areas related to your tests. The Project Detail page consists of the following sections

  • Overview
  • Test Environments
  • Test Binaries
  • Test Run Configurations
  • Scheduled Test Runs
  • Test Runs

Overview

This section gives you a quick glance at your test run configurations and their most recent test runs for each environment.

projects overview

Test Environments

Test environments represent the website urls that you intend to target when running your tests. A test environment is specific to each project (website) and it must contain a unique url. Two projects can have a UAT environment, however each UAT environment will have a unique url and will be specific to that project.

environments

Create New Test Environment

To create a new test environment you need to provide a name and a url you wish to test with your Webdriver tests.

new environment dialog

Add Agent to Environment

In order to be able to run tests against an environment, that environment must have at least one active agent. You can add agents to a test environments by clicking on the 'Add agent' button on the Agents page. The same agent can be part of more than one environment.

add agent to environment

The agents that are green are connected and ready to start executing tests.

Environment Detail

If you click on the environment name you will be redirected to the environment detail page. This is a dashboard-like page which shows you several charts and tables related to the test executions on that environment.

environment detail

Selenium Test Binaries

The Selenium test binaries section shows the uploaded test binaries for the project. These test binaries are zip files which contain your test dlls.

selenium test binaries

Uploading your Selenium Test Binaries

Test binaries can be uploaded to the server via the 'Upload Zip File' button. When you've selected a zip file on your computeter for uploading, a dialog will open which allows you to select any of the dlls in the zip file and scan them: the scanning process will find all the test methods and NUnit categories in the selected dlls.

new selenium test binaries dialog

Selenium Test Binaries Detail

Once you save the uploaded zip file, you will land on the test binaries detail page, which shows the uploaded zip file, the files in the zip file, the test methods and test categories discovered in the scanned dll(s). Each dll file can be scanned using a 'scan' button.

selenium test binaries detail

Once scanned, the dll can be expanded and once expanded it will show the list of NUnit test methods found on the scanned dll.

dll expanded view

Selenium Test Method Detail

Each of the test methods in the dll can be further drilled down into showing a test method detail page which contains various metrics and test session info from past executions of the selected test method.

selenium test method detail

Test Session Detail

The test sessions table in the bottom of the test method detail page allows you to drill down into each test session detail page (by clicking on the test session id).

test session detail arrow

selenium test session detail view

Updating an Existing Selenium Test Binaries Zip File

An existing test binaries zip file can be updated by simply going to the test binaries edit page and uploading a new version of the zip file. Any changes to the test code in the test dlls will be detected during the upload process. Any new, removed or edited test methods (and categories) will be automatically added/updated/removed during the upload process.

This is a useful feature when triggering test runs from a third party such as Octopus Deploy that might contain test dlls with new test methods as part of it's deployment process. In this scenario the Octopus deploy step can upload the new dlls before executing the test methods in those dlls.

Test Run Configurations

This section is where you create and manage your test run configurations. A test run configuration is a grouping of test methods that are to be executed as part of a test run.

selenium test run configurations

New Test Run Configuration

To create a new test run configuration click on the 'New Configuration' button in the Test Run Configuration section.

new test run configuration

In the New Test Run Configuration dialog you will have to enter a configuration name, select the test binaries and select the test methods that you want to include in the new configuration.

A test run configuration can be created by selecting individual tests or by selecting one or more test categories.

There is a field called 'Custom Data' on the test run config dialog which you can use to pass any string which you can read from within your NUnit tests. The string will be written to the test's settings file. See more about how to read this file here.

new test run configuration custom data

You will also be able to specify if you wish to receive an email with the results of the test run.

new test run configuration send email

Triggering a Test Run Configuration

A test run configuration once created can be triggered to execute against a selected test environment. It can be triggered manually, via a custom schedule or via a thrid party client such as a CI/CD server (TeamCity or Octopus Deploy for example).

You can trigger a test run configuration by clicking on its Run button.

Nugridium Web Portal new test run step 1

run test configuration

Selenium Test Run Configuration Detail

You can edit/remove a test run configuration from the test run configuration detail page. This page also shows all the test runs for the selected test run configuration (order by most recent).

test run configuration detail

Schedula a Selenium Test Run

You can schedule you Selenium test runs to execute on a daily or hourly schedule.

Nugridium Web Portal schedule a Selenium test run

To create a new schedule for an existing test run configuration, click on the 'Schedule' button in the Test Run Configurations section on the Project detail page.

Nugridium Web Portal schedule test run

In the New Schedule Dialog that opens you can select the test environment to target, the browser(s) to use for testing and the schedule parameters.

Nugridium Web Portal schedule test run

If you click on the schedule name you will be taken to the scheduled test run detail page.

Nugridium Web Portal schedule test run

Test Runs

A test run is the result of executing a test run configuration. A test run configuration can be triggered either manually or via the API. A test run can also be the result of executing manually selected tests on the fly from the web portal.

Trigger Existing Test Run Configuration

You can trigger an existing test run configuration from the project detail page.

Nugridium Web Portal new test run step 1

Once the new test run dialog opens you need to select the environment to test and the browsers to test on.

new selenium test run dialog

The new test run dialog displays the number of available agents and the number of active browser slots in real time. The available agents are updated as you select specific browsers or test environments. If you select a test url and browser combination that has no available agents, you will not be able to enqueue it.

You will also be able to specify if you wish to receive an email with the results of the test run. The email settings you specify here will override any email settings that carried from the associated test run configuration.

new test run configuration send email

Selenium Test Run Detail

Once you click on the 'Enqueue test run' button you will be redirected to the Test Run Detail page for the test run you've enqueued.

selenium test run detail

The test run detail page among other calculated properties has a property called 'Max Concurrency' which represents the highest number of parallel test sessions achieved during the execution of the test run. In the snapshot above we have a test run with 4 test sessions of which 3 executed in parallel.

The test run detail page also has a couple of charts. One of them is a time line chart that shows you the concurrency of the tests executions.

selenium test run detail time line chart

Test Session Detail

By clicking on the test session id you can drill into the test sessions detail page. A test session represents the execution of a test method against a test environment using a specific browser.

selenium test session detail

The test session detail allows you to view the execution metrics, any images that your test produced as well as the test log. Any images that your tests produce on their executing directory as well as any text that is written to the console in your tests will appear in the logs.

Test Method Detail

If you click on the test method name you will be taken to the test method detail page which will show you some aggregate properties calculated based on previous test runs of the selected test method.

test method detail

Searching

There are two search pages: Test Runs Search page and Test Sessions Search page. You can get to them from the Search menu option.

By clicking on the filter icon on the top left of either search page you will be presented with a search filters panel.

Search Test Runs

You have the option of searching by test runs (groups of test sessions).

Nugridium Web Portal schedule test run

The test runs can be expanded by clicking on the left arrow. The expanded view will show the test methods (test sessions) that were executed during the test run. You can view the logs from there or you can drill in further inside the test method session detail page.

Nugridium Web Portal schedule test run

Search Test Sessions

You also have the option of searching by the individual test sessions.

Nugridium Web Portal schedule test run

User Management

The Users pages allow you to manage access to your Nugridium server.

Client API Keys

The user detail page allows you to generate an API secret key that you can use to access the API from 3rd party clients. The generated key will inherit the same privileges as the user of the account. To remove access simply delete the key.

Nugridium Web Portal client api keys view

Nugridium Web Portal new client api key

User Claims

In this page you can give permissions to the users. The access permissions are View, Trigger and Upload and they are specific to the test environments.

Nugridium Web Portal user claims view