Hiking-Logbook

Hiking Logbook Testing Documentation

This document outlines the testing approach, tools, user stories, and acceptance tests for the Hiking Logbook application.
Testing ensures the app is reliable, secure, and production-ready.

Testing Strategy

We use a layered testing strategy:

Unit Testing
- Tests individual functions, components, and utilities.
- Ensures business logic works in isolation (e.g., hike distance calculation).
Integration Testing
- Verifies communication between backend routes, frontend components, and the database.
- Example: creating a hike and verifying it appears in the logbook.
End-to-End (E2E) Testing
- Simulates real user workflows across frontend + backend.
- Example: User starts a hike → hike is saved in Firestore → hike shows in the logbook.
User Acceptance Tests
- write user stories at the beginning of the sprint and test using User Acceptance tests towards the end of the sprint.

Tools & Frameworks

Tool / Framework	Purpose
Jest	Unit testing for backend logic and React components
React Testing Library	Testing React components in isolation
Firebase Emulator Suite	Local testing of Firestore, Auth, and Functions
Postman / curl	Testing API endpoints
ESLint + Prettier	Code quality & linting
GitHub Actions (CI/CD)	Running automated tests on every push

Example Test Cases

1. Backend API Tests

Endpoint	Test Case	Expected Result
`POST /api/hikes`	Create a new hike with valid data	Returns `201 Created` with hike ID
`GET /api/hikes`	Fetch all hikes for logged-in user	Returns list of hikes
`PATCH /api/hikes/:id/pin`	Pin a hike	Returns `success: true` and hike updated
`GET /api/stats`	Retrieve stats for user	Returns total hikes, distance, streak
`POST /api/messages`	Send a new message to a friend	Returns `201 Created` with message details
`POST /api/invitations`	Invite a friend to a hike	Returns `201 Created` and notifies invitee
`GET /api/achievements`	Fetch user’s achievements and badges	Returns list of badges and progress
`GET /api/friends`	Retrieve user’s friend list	Returns array of friend profiles

2. Frontend Component Tests

Component	Test Case	Expected Result
`LogbookPage`	Render hikes from API	Hike cards are displayed correctly
`ProgressCharts`	Load progress stats	Line and bar charts render with data
`PinnedHikes`	Pin/unpin hike buttons	UI updates without reload
`HikePlannerForm`	Form validation with missing fields	Error messages are shown
`MessagesPage`	Send and receive messages	Messages appear instantly in chat
`InvitationsPanel`	Display received invitations	Invitations render correctly
`AchievementsPage`	Display badges and progress charts	Charts update dynamically
`ActivityFeedPage`	Fetch and display friends’ activity	Posts load and render in correct order
`UserProfilePage`	Load and edit user details	Profile updates persist after reload

User Stories & Acceptance Tests

Story 1 – Log a new hike

As a user, I want to log my completed hike so that I can keep a history of my outdoor activities.

Acceptance Test:

Given the user is logged in
When they enter hike details (title, distance, date) and click Save
Then the hike is stored in the database and appears in the logbook immediately

Story 2 – View my progress

As a user, I want to view statistics and charts of my hikes so that I can track my progress over time.

Acceptance Test:

Given the user has logged hikes in the past
When they open the Stats & Charts page
Then a line graph of hikes over time and a bar chart of distances are displayed

Story 3 – Pin favorite hikes

As a user, I want to pin my favorite hikes so that I can easily access them later.

Acceptance Test:

Given the user has logged at least one hike
When they click the Pin icon
Then the hike appears under the Pinned Hikes section and remains pinned after refresh

Story 4 – Plan a future hike

As a user, I want to add planned hikes with dates and difficulty levels so that I can prepare in advance.

Acceptance Test:

Given the user is logged in
When they submit a planned hike through the Hike Planner Form
Then the hike is saved and displayed under Upcoming Hikes

Story 5 – Chat with friends

As a user, I want to send and receive messages in real time so that I can communicate with my hiking partners.

Acceptance Test:

Given two friends are logged in
When User A sends a message
Then User B sees the message instantly and can reply without refreshing

Story 6 – View activity feed

As a user, I want to see my friends’ recent hikes so that I can stay updated on their adventures.

Acceptance Test:

Given the user has connected friends
When they open the Activity Feed page
Then posts appear showing likes and comments

Story 8 – Manage user profile

As a user, I want to edit my profile information and view my hiking stats in one place.

Acceptance Test:

Given the user is logged in
When they update their profile details
Then the changes are saved and reflected immediately in their account view

Story 9 – Track achievements

As a user, I want to unlock badges based on my hiking milestones so that I stay motivated.

Acceptance Test:

Given the user completes several hikes
When thresholds (e.g., 10 hikes, 100 km) are reached
Then corresponding achievement badges appear automatically

How to Run Tests

Run backend tests ```bash cd backend npm test
Run frontend tests ```bash cd frontend npm test