Getting Started
Debugging Tests
Debugging Tests
Introduction
The Skyramp Dashboard helps you analyze the results of test runs, track actively mocked endpoints, and debug the tests themselves. With the Skyramp Dashboard you can quickly identify and resolve issues in your test suite and ensure the reliability of your applications.
Bringing Up the Dashboard
Docker
If you followed the instructions for a Docker deployment from the installation guide, including bringing up the optional services (dashboard-server, dashboard-client, and mongodb), then you can bring up the Skyramp Dashboard for Docker on localhost by executing the following command:
This will bring up a browser window where the Skyramp Dashboard is running. Alternatively, you can navigate to http://localhost:3000/ to access it. For more details on, refer to the skyramp dashboard command documentation.
Kubernetes
To bring up the Skyramp Dashboard for Kubernetes deployments, execute the following command:
This command automates the deployment process, creating essential Kubernetes assets (client, server, and MongoDB Kubernetes Operator) within the skyramp namespace of your cluster. It also initiates port forwarding for local access. Once the dashboard is live, the terminal client will provide the forwarding address:
No manual opening of this address in your browser is required; it should be done automatically.
Viewing the Dashboard
Running skyramp dashboard up will open the dashboard in a new browser tab. If you’re starting fresh without previous test runs, you’ll see an empty test result page:
Analyzing Test Results
Once your dashboard is running, you can view the results of executed tests automatically on the dashboard. For example, if you start the hello world test and the hello world load test, they will then appear in the Test Results section of the dashboard:
From the Test Results page of the dashboard, you can click through to the hello world test to see the functional test results, including output, errors, duration, and status:
Navigate to the hello world load test to view the load test results:
You can scroll down and view various load-related outputs and graphs related to latency, error rate, requests per second (RPS), and pod-specific utilization. Dashboard test results are valuable for retaining test run history and tracking test runs overtime.
Tracking Active Mocks
Once your dashboard is running, you can track active mocks of services and specific endpoints. For example, if you mock the hello world service, you can view active mocks and responses in the Mocked Services section:
This is particularly useful when managing multiple mocks across teams on a shared cluster or environment and keeping track of the payloads for each endpoint. You are now ready to efficiently manage your testing environment with the Skyramp Dashboard!
What's Next
Now that you know how to write, generate, run, and debug tests using the Skyramp Dashboard, you're equipped to streamline your testing process and ensure the reliability of your applications. Dive deeper into the specifics of Skyramp testing in the Test Configuration, Test Runner, Parallelism, and Parameterize Tests sections to further enhance your testing workflow.