Endpoint Insights is a performance and integration testing dashboard that we are building for our senior project. Our client, VSP, is having us reimplement (from scratch) a dashboard that they used previously to schedule and execute api performance and integration testing.
Client: Vision Service Plan (VSP)
Project Duration: Fall 2025 - Spring 2026 (CSC 190/191)
- Support a single test or you can batch tests together
- Tests are configurable for their testing thresholds for performance testing
- Tests can be for APIs, Integration testing, and UI testing
- Schedule automated tests to run at certain times
- Single sign on via OpenID Connect
- Support for role based access control which enables control over what users are allowed access to in the application
- Emails the specified user a summary of tests performed and their configurations
- Provides the user with a synopsis of important information from the tests completed
- The emails will have color coordination for the test results so the user can quickly recognize the test performances
- Show the performance test result information
- Highlight important parts of the results such as the maximum, minimum, and average response times
- Shows what tests were performed, the duration of the tests, and who initiated the test
- Framework: Spring Boot 4.0.0-M3
- Language: Java 25
- Build Tool: Maven 3.9+
- Database: PostgreSQL 17
- ORM: Spring Data JPA with Hibernate
- Testing: JUnit 5
- Code Coverage: CodeCov
- Framework: Angular 20.3.0+
- Language: TypeScript 5.9.2
- Build Tool: Angular CLI 20.3.6
- UI Libraries: Angular Material 20.2.9, Bootstrap 5.3.6, ng-bootstrap 19.0.1
- Testing: Karma 6.4.0, Jasmine 5.9.0
- CI/CD: Jenkins
- Version Control: Git + GitHub
- Protocol: OpenID Connect (OIDC)
- Authorization: JWT with Bearer tokens
- Session Management: Stateless
- Identity Provider: External IdP (production)
architecture diagram ehre
The system consists of:
- Frontend
- Backend
- Database
- Authentication: Authelia for testing (client uses something else)
- CI/CD: Jenkins + CodeCov
- User will authenticate against external identity provider
- User will configure a new test with
- a name
- description
- test project git URL
- compile command
- run command
- User will add the new test to a list of multiple tests and configure pass/fail thresholds for the tests
- User will specify a schedule to run a single or batch of tests
- When the test is scheduled to run:
- pull git repository
- builds the test suite
- runs the tests
- interprets results
- triggers alerts based on thresholds
The dashboard page provides an overview of active jobs, fail rate, charts for performance, recent activity, and alerts.
The login page allows users to log in with the configured single-sign on provider.
The batches page shows test batches and allows users to modify run configurations.
The tests page allows users to create and modify individual test runs.
The test results page shows the latest tests and statistics for previous test runs.
Tests are run automatically on all first-party branches and pull requests.
Backend:
- Maven (mvn)
- Java 25
- PostgresSQL 17
Frontend:
- Node.js v24+
- Node Package Manager (npm)
-
Configure the following environment variables:
Environment Variable Description Required DB_NAME Username used for the db connection X DB_PASSWORD Password used for the db connection X DB_URI URI in jdbc format to the db (including database name) X OIDC_CLIENT_ID Client ID for OIDC authentication flow X OIDC_CLIENT_SECRET Client secret for authentication X OIDC_ISSUER_URI Token issuer URI X OIDC_CLIENT_REDIRECT_URI Redirect URI for the api call back when a user is authenticated. -
cd endpoint-insights-api -
Run directly with a maven goal
mvn spring-boot:runor build and runmvn clean package&java -jar target/endpoint-insights-api-*.jar -
Run a quick health check:
curl localhost:8080/api/health
- Ensure
endpoint-insights-apiis running cd endpoint-insights-ui- Install dependencies with
npm install - Run with
ng serve
cd endpoint-insights-apimvn clean compilemvn test
cd endpoint-insights-uinpm cinpm run buildnpm run test:ci
Code coverage reposts are automatically generated and published to CodeCov when github actions are run.
TBD
erDiagram
JOB {
uuid job_id PK
string name
string description
string git_url
string run_command
string compile_command
string test_type
string status
jsonb config
string created_by
timestamp created_date
string updated_by
timestamp updated_date
}
TEST_BATCH {
uuid id PK
string batch_name
bigint schedule_id
date start_time
date last_time_run
boolean active
string created_by
timestamp created_date
string updated_by
timestamp updated_date
}
BATCH_JOBS {
uuid batch_id PK, FK
uuid job_id PK, FK
}
TEST_RESULT {
uuid result_id PK
int job_type
}
PERF_TEST_RESULT {
uuid result_id PK, FK
int p50_latency_ms
int p95_latency_ms
int p99_latency_ms
int volume_last_minute
int volume_last_5_minutes
float error_rate_percent
}
PERF_TEST_RESULT_CODE {
uuid result_id PK, FK
int error_code PK
int count
}
JOB ||--o{ BATCH_JOBS : "is linked to"
TEST_BATCH ||--o{ BATCH_JOBS : "groups jobs"
TEST_RESULT ||--|| PERF_TEST_RESULT : "performance details"
PERF_TEST_RESULT ||--o{ PERF_TEST_RESULT_CODE : "per error code"
- Name your branch after your Jira story dedicated to the code implementation.
- Example:
feature/EI-21 - Clone repo to local machine and target to new branch
- Implement code changes.
- Run local unit tests to verify functionality.
- Refer to Testing
- Each commit should include comments describing:
- Related Jira story/subtask
- The feature implemented or task completed
- Open a PR into the
developbranch and include:- Related Jira story
- Feature or task implemented
- Commit any updates requested by Code Reviewer(s).
- Once approved and all tests are passing, merge branch into
develop. - Delete branch after merge.
For detailed information about the system architecture, deployment, and authentication:
- Brynn Crowley
- Nicholas Cooper
- Tyler Mains
- Caleb Brock
- Marcos Pantoja
- Daniel Carello
- Cardell Rankin
- Jino Enriquez