inholland/ros2-assignments
3
1
Fork 0
generated from wessel/boilerplate
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[PR] Add unit tests to documentation, add README, add launchfile #7

Merged
vincent merged 16 commits from 1-grade-generator/documentation-updates into 1-grade-generator/master 2025-10-09 13:27:22 +02:00
Conversation 2 Commits 16 Files Changed 25 +1032 -41
wessel commented 2025-10-07 19:53:22 +02:00
Owner
Copy Link

This PR will add some documentation about unit tests to all nodes and classes. It'll also saturate the repo with a decent README. A launch file is also added to easily start all required nodes.

Status

  • Code changes have been tested and there aren't any typos in it

Semantic versioning classification:

  • This PR changes ros2-assignments core codebase (methods or parameters added)
    • This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • This PR only includes non-code changes, like changes to documentation, README, etc.
This PR will add some documentation about unit tests to all nodes and classes. It'll also saturate the repo with a decent README. A launch file is also added to easily start all required nodes. **Status** - [x] Code changes have been tested and there aren't any typos in it **Semantic versioning classification:** - [ ] This PR changes ros2-assignments core codebase (methods or parameters added) - [ ] This PR includes breaking changes (methods removed or renamed, parameters moved or removed) - [ ] This PR **only** includes non-code changes, like changes to documentation, README, etc.
wessel added 8 commits 2025-10-07 19:53:23 +02:00
fix(documentation): Add test documentation to GradeCalculator and FinalGradeDeterminator fd07992eee
fix(documentation): Add parameter to documentation 2e02ccddc5
feat(launchfile): Add launchfile to project 6e1c0346b0
feat(readme): Add aditional content to the main readme 437c5bc16e
feat(readme): Add aditional content to the main readme f1878270dc
Merge branch '1-grade-generator/documentation-updates' of https://git.wessel.gg/inholland/ros2-assignments into 1-grade-generator/documentation-updates 517d4f5cb0
fix(exam_result_generator): Fix timestamp being 0 62995c13c2
docs: Add unit tests 130b495030 
- DatabaseManager: Added unit test documentation
- ConfigManager: Added unit test documentation
- ExamResultGenerator: Added unit test documentation
- FinalGradeDeterminator: Fix spacing
wessel requested review from mohammad 2025-10-07 19:53:36 +02:00
wessel requested review from vincent 2025-10-07 19:53:38 +02:00
wessel added the Assignment 1Kind/DocumentationKind/Feature labels 2025-10-07 19:53:55 +02:00
wessel reviewed 2025-10-08 13:27:17 +02:00
doc/nodes/FinalGradeDeterminator.md Outdated
@@ -28,8 +32,65 @@ FinalGradeDeterminator()
- Sends async request with collected exam grades for the student-course combination
- Uses callback to handle service response
wessel commented 2025-10-08 13:25:43 +02:00
Author
Owner
Copy Link

Formatting, below also a lot of extra newlines

Formatting, below also a lot of extra newlines
vincent marked this conversation as resolved
src/g2_2025_grade_calculator_pkg/launch/grade_calculator.launch.xml Outdated
@@ -0,0 +1,9 @@
<launch>
<node pkg="g2_2025_grade_calculator_pkg" exec="exam_result_generator"/>
wessel commented 2025-10-08 13:25:01 +02:00
Author
Owner
Copy Link

Add param delay_between_grades_ms

Add param `delay_between_grades_ms`
wessel marked this conversation as resolved
wessel changed title from WIP: [PR] Add unit tests to documentation, add README, add launchfile to [PR] Add unit tests to documentation, add README, add launchfile 2025-10-08 13:27:50 +02:00
wessel requested review from inholland 2025-10-08 13:27:51 +02:00
vincent added 1 commit 2025-10-08 16:31:14 +02:00
Major feat(Documentation): Complete documentation rework 5e1df5367c 
Split documentation into three folders: Architecture, Testing and
Installation.

Rework and expand architecture.md alongside interfaces.md

Split all parts to do with testing from Architecture md's into Test md's

Add parameter to ExamResultGenerator node documentation
wessel added 1 commit 2025-10-08 17:53:11 +02:00
feat(tests): Add integration tests e42856ae4e
vincent added 2 commits 2025-10-08 18:40:35 +02:00
fix(documentation): Update installation instructions 161b5084fc
fix(launch): Added parameter cb22dd4047
vincent added 2 commits 2025-10-08 18:44:34 +02:00
fix(launch): Added parameter cb22dd4047
fix(launch): Added parameter 6ccbc95b15
wessel reviewed 2025-10-08 18:56:48 +02:00
README.md Outdated
@@ -13,0 +19,4 @@
## System Architecture
The TI Minor Grade Generator is a ROS2-based distributed system for managing student exam results and calculating final grades. The system follows a microservices architecture with clear separation of concerns.
wessel commented 2025-10-08 18:49:55 +02:00
Author
Owner
Copy Link

Misschien dit naar "onze taal"verwoorden

Misschien dit naar "onze taal"verwoorden
vincent marked this conversation as resolved
README.md Outdated
@@ -13,0 +53,4 @@
#### Configuration Management
- **ConfigManager**: Loads and validates system configuration from TOML files
- Provides runtime access to configuration parameters for all nodes
wessel commented 2025-10-08 18:49:43 +02:00
Author
Owner
Copy Link

remove all

remove `all`
vincent marked this conversation as resolved
README.md Outdated
@@ -13,0 +77,4 @@
The system uses TOML configuration files for environment-specific settings:
- Database connection parameters
- ROS2 node configurations
wessel commented 2025-10-08 18:50:28 +02:00
Author
Owner
Copy Link

false

false
vincent marked this conversation as resolved
README.md Outdated
@@ -13,0 +85,4 @@
Unit tests are implemented using Google Test framework:
- Mock services and database managers for isolated testing
- Parameterized tests for various grade calculation scenarios
- Documentation on the tests are located in the full documentation of the nodes themselves
wessel commented 2025-10-08 18:51:04 +02:00
Author
Owner
Copy Link

In the tests directory

In the tests directory
vincent marked this conversation as resolved
doc/architecture/architecture.md
@@ -0,0 +1,147 @@
# TI Minor Grade Generator Design Document
wessel commented 2025-10-08 18:51:41 +02:00
Author
Owner
Copy Link

Same as readme? This section is also quite AI-y

Same as readme? This section is also quite AI-y
vincent marked this conversation as resolved
doc/architecture/architecture.md
@@ -0,0 +25,4 @@
#### 1. FinalGradeDeterminator Node
**Namespace**: `assignments::one::final_grade_determinator`
**Brief Description**: Collects exam results, triggers grade calculation when thresholds are met, and stores final grades.
wessel commented 2025-10-08 18:52:28 +02:00
Author
Owner
Copy Link

ctrl f, replace **Brief Description** into > *x*, can use regex replace. Personal preference :}

ctrl f, replace `**Brief Description**` into `> *x*`, can use regex replace. Personal preference :}
doc/architecture/interfaces/interfaces.md Outdated
@@ -0,0 +88,4 @@
#### Result
```
# Empty result section - completion indicates success
wessel commented 2025-10-08 18:54:07 +02:00
Author
Owner
Copy Link

Mohammad changed this in his branch

Mohammad changed this in his branch
vincent marked this conversation as resolved
doc/architecture/interfaces/interfaces.md Outdated
@@ -0,0 +167,4 @@
## Related Documentation
- [System Architecture](../Orig.md): Overall system design and communication patterns
wessel commented 2025-10-08 18:54:36 +02:00
Author
Owner
Copy Link

Non-existant

Non-existant
vincent marked this conversation as resolved
doc/architecture/nodes/FinalGradeDeterminator.md Outdated
@@ -0,0 +39,4 @@
- Logs final grade information
- Stores final course result in database
wessel commented 2025-10-08 18:55:09 +02:00
Author
Owner
Copy Link

Formatting

Formatting
vincent marked this conversation as resolved
doc/installation/installation.md
@@ -0,0 +1,43 @@
## Installation
wessel commented 2025-10-08 18:55:34 +02:00
Author
Owner
Copy Link

I'd recommend having it in only the readme

I'd recommend having it in only the readme
vincent marked this conversation as resolved
doc/tests/DatabaseManager.md
@@ -0,0 +1,65 @@
wessel commented 2025-10-08 18:56:12 +02:00
Author
Owner
Copy Link

Formatting

Formatting
vincent marked this conversation as resolved
wessel added 1 commit 2025-10-08 20:05:01 +02:00
fix(database): Fix database structure, remove from table if requested 493e69acd1 
- Fixes the `is_retake` field on all tables
- Makes the `ExamResultGenerator` remove the enrollment from the table
if it is popped from its queue
- Added the option to submit a grade as retake
wessel added 1 commit 2025-10-08 20:21:05 +02:00
feat(database): Add method to fetch failed courses 644697326d
vincent added 2 commits 2025-10-09 13:25:59 +02:00
fix(documentation): Fix formatting, move texst to correct location 1ceb691fae
Merge branch '1-grade-generator/documentation-updates' of https://git.wessel.gg/inholland/ros2-assignments into 1-grade-generator/documentation-updates 01c2788a99
vincent merged commit 964795d770 into 1-grade-generator/master 2025-10-09 13:27:22 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
mohammad
vincent
inholland
wessel
Labels
Clear labels
Assignment 1
Assignment 2
Assignment 3
Assignment 4
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label Assignment 1 Kind/Documentation Kind/Feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
wessel
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: inholland/ros2-assignments#7
Delete Branch "1-grade-generator/documentation-updates"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?