[REOPEN] ALFMOB-178 | Project Documentation

[vascosousamindera]

Ticket: ALFMOB-178

This PR introduces documentation related to the project in order to improve architectural clarity, system understanding, and onboarding efficiency.

---

The following documentation has been added:

C4 Diagrams aligned with 4+1 Model

• Logical Views:

  • Level 1 - System Context Diagram
  • Level 2 - Container Diagram
  • Level 3 - Component Diagram (MelmacBE & DriverRunner)

• Physical View:

  • Level 2 Deployment Diagram showing execution context on local machines and device environments.

• Implementation Views:

  • Level 2 - High-level implementation structure (e.g., backend modules and runners)
  • Level 3 - Clean Architecture breakdown (Infrastructure, Adapters, Use Cases, Domain)

FURPS+ and Database Specification

• Updated FURPS+ quality model, covering:

  • Functionality, Usability, Reliability, Performance, and Supportability

• Added Database Specification:

  • Key tables, constraints, and relationships supporting bootstrap data, test executions, metrics, and thresholds.

---

🛠️ Updates to PR on June 04, 2025

• Process Views:

  • Level 1 - Describes the high-level interactions between users (e.g., QA engineers, CI/CD systems) and the Alfie Performance Testing system, focusing on how test execution requests are initiated and results are consumed.
  • Level 2 - Outlines the communication and concurrency between major containers (e.g., Melmac backend, DriverRunner, database, device emulators), showing how processes coordinate to schedule, execute, and monitor test plans.
  • Level 3 - Details the internal process flows within key containers, such as how the backend orchestrates test execution via job queues, manages concurrent runners, handles result aggregation, and ensures transactional integrity during test lifecycle events.

---

🛠️ Updates to PR on June 05, 2025

• Logical View Level 3 MelmacBE Alternative:

  • This view represents the architectural structure of the project prior to the adoption of Clean Architecture. It illustrates the previously implemented modular monolith design, where core responsibilities such as execution coordination, dispatching, and platform-specific execution were encapsulated within distinct components, without the separation of concerns enforced by layered architecture.

---

This documentation aims to fill existing gaps and establish a clear, extensible architectural foundation for development, testing, and future onboarding.

[github-actions]

📝 Performance Test Results

Performance Test Suite Results (Android)

Suite Execution: 8
Test Suite Version: 9

Test Execution Results

Test Execution: Startup Time Plan

• Metric: App Startup Time
• Device: Medium_Phone_API_35
• App Name: Alfie.apk
• App Version: 0.8.0
• App Package: au.com.alfie.ecomm.debug
• Main Activity: au.com.alfie.ecomm.MainActivity
• Execution Type: Cold Start

Test Result	Start Time	End Time
true	2025-06-05T13:38:02.518	2025-06-05T13:39:08.612

Thresholds

Target Value	Threshold Type	Metric Output
20000	Max	launchTime

Metric Output Results

Metric Output	Value
launchTime	15017
elementFound	true

[github-actions]

📝 Performance Test Results

Performance Test Suite Results (iOS)

Suite Execution: 9
Test Suite Version: 8

Test Execution Results

Test Execution: Startup Time Plan

• Metric: App Startup Time
• Device: iPhone 16 Pro
• App Name: Alfie.app
• App Version: 0.8.1
• App Package: com.mindera.alfie.debug
• Main Activity: N/A
• Execution Type: Cold Start

Test Result	Start Time	End Time
false	2025-06-05T13:37:13.744	2025-06-05T13:40:56.41

Thresholds

Target Value	Threshold Type	Metric Output
5000	Max	launchTime

Metric Output Results

Metric Output	Value
launchTime	6425
elementFound	true