Skip to content

Commit 3a76211

Browse files
ChinZJChinZJ
authored
Merge pull request #62 from CS3219-AY2526Sem1/feat/add-qn-and-histoyr-tests
feat(tests): added tests for qn and history services
2 parents 6bd0722 + 5e00a3c commit 3a76211

21 files changed

+2506
-170
lines changed

‎.github/workflows/codecov.yml‎

Lines changed: 83 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,47 @@
11
name: Run tests and upload coverage
22

3-
on:
4-
push
3+
on: push
54

65
jobs:
76
test:
87
name: Run tests and collect coverage
98
runs-on: ubuntu-latest
9+
10+
# PostgreSQL service container for question-service tests
11+
# SECURITY NOTE: These are test-only credentials for ephemeral CI databases
12+
# - Database is only accessible within the GitHub Actions runner (localhost)
13+
# - Credentials are for temporary test databases that are destroyed after tests
14+
# - Credentials are stored in GitHub Secrets (never commit real credentials)
15+
services:
16+
postgres:
17+
image: postgres:14-alpine
18+
env:
19+
# Test database credentials from GitHub Secrets
20+
# Must match job-level env vars below
21+
POSTGRES_USER: ${{ secrets.POSTGRES_TEST_USER }}
22+
POSTGRES_PASSWORD: ${{ secrets.POSTGRES_TEST_PASSWORD }}
23+
POSTGRES_DB: ${{ secrets.POSTGRES_TEST_DB }}
24+
ports:
25+
- 5432:5432
26+
options: >-
27+
--health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
28+
29+
# Job-level environment variables - shared across all steps
30+
# SECURITY IMPROVEMENTS:
31+
# 1. ✅ Password removed from command-line arguments (using PGPASSWORD env var)
32+
# 2. ✅ Credentials defined once at job level (avoid duplication)
33+
# 3. ✅ Credentials stored in GitHub Secrets (not hardcoded)
34+
# 4. ✅ Test credentials are clearly documented as test-only
35+
# NOTE: These must match the service container credentials above
36+
env:
37+
POSTGRES_HOST: localhost
38+
POSTGRES_PORT: 5432
39+
# Test database credentials from GitHub Secrets
40+
POSTGRES_USER: ${{ secrets.POSTGRES_TEST_USER }}
41+
POSTGRES_PASSWORD: ${{ secrets.POSTGRES_TEST_PASSWORD }}
42+
POSTGRES_DB: ${{ secrets.POSTGRES_TEST_DB }}
43+
NODE_ENV: test
44+
1045
steps:
1146
- name: Checkout
1247
uses: actions/checkout@v4
@@ -21,11 +56,54 @@ jobs:
2156
- name: Install root dependencies
2257
run: npm ci
2358

24-
- name: Run tests
25-
run: npx jest --coverage
59+
- name: Install PostgreSQL client
60+
run: |
61+
sudo apt-get update
62+
sudo apt-get install -y postgresql-client
63+
64+
- name: Wait for PostgreSQL to be ready
65+
# SECURITY: Using environment variables instead of hardcoded values
66+
# This allows credentials to be overridden via GitHub Secrets
67+
run: |
68+
until pg_isready -h "$POSTGRES_HOST" -p "$POSTGRES_PORT" -U "$POSTGRES_USER"; do
69+
echo "Waiting for PostgreSQL to be ready..."
70+
sleep 2
71+
done
72+
echo "PostgreSQL is ready!"
73+
74+
- name: Initialize PostgreSQL database
75+
# SECURITY IMPROVEMENT: Using environment variables (PGPASSWORD) instead of command-line arguments
76+
# This prevents the password from appearing in:
77+
# - Process lists (ps aux) - password is in env var, not command line
78+
# - Command logs - password is not visible in psql command
79+
# - Shell history - password is not in command string
80+
# The PGPASSWORD env var is used automatically by psql (not visible in ps)
81+
run: |
82+
psql -h "$POSTGRES_HOST" -p "$POSTGRES_PORT" -U "$POSTGRES_USER" -d "$POSTGRES_DB" -f question-service/db/init.db.sql
83+
env:
84+
# PostgreSQL client uses these environment variables automatically
85+
# PGPASSWORD is read from env (not passed as command-line argument)
86+
# Values are inherited from job-level env above
87+
PGHOST: ${{ env.POSTGRES_HOST }}
88+
PGPORT: ${{ env.POSTGRES_PORT }}
89+
PGUSER: ${{ env.POSTGRES_USER }}
90+
PGPASSWORD: ${{ env.POSTGRES_PASSWORD }}
91+
PGDATABASE: ${{ env.POSTGRES_DB }}
92+
93+
- name: Run question-service tests
94+
run: npm test --workspace=question-service
95+
# Environment variables (POSTGRES_*) are inherited from job-level env above
96+
# This avoids duplicating credentials in multiple steps
97+
98+
- name: Run other tests
99+
run: npx jest --coverage --testPathIgnorePatterns="question-service"
100+
# NODE_ENV is inherited from job-level env above
26101

27102
- name: Upload results to Codecov
28103
if: always()
29104
uses: codecov/codecov-action@v5
30105
with:
31-
token: ${{ secrets.CODECOV_TOKEN }}
106+
token: ${{ secrets.CODECOV_TOKEN }}
107+
files: ./coverage/lcov.info,./question-service/coverage/lcov.info
108+
flags: unittests
109+
name: codecov-umbrella

‎frontend/src/test/features/progress/RecentSessionsList.test.tsx‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
// AI Assistance Disclosure:
2+
// Tool: Auto (Cursor)
3+
// Date: 2025-01-XX
4+
// Scope: Generated comprehensive test cases for RecentSessionsList component
5+
6+
import { fireEvent, render, screen, waitFor } from '@testing-library/react';
7+
import { BrowserRouter } from 'react-router-dom';
8+
import RecentSessionsList from '../../../features/progress/RecentSessionsList';
9+
import * as api from '../../../lib/api';
10+
11+
jest.mock('../../../lib/api', () => ({
12+
getAllAttemptSummaries: jest.fn(),
13+
getOtherUser: jest.fn(),
14+
}));
15+
jest.mock('react-router-dom', () => ({
16+
...jest.requireActual('react-router-dom'),
17+
useNavigate: () => jest.fn(),
18+
}));
19+
20+
// Mock sessions data
21+
const mockSessions = [
22+
{
23+
question_id: 'q1',
24+
session_id: 's1',
25+
question_title: 'Two Sum',
26+
question_difficulty: 'Easy' as const,
27+
partner_id: 'partner1',
28+
is_solved_successfully: true,
29+
has_penalty: false,
30+
started_at: '2023-10-10T10:00:00Z',
31+
time_taken_ms: 1800000, // 30 minutes
32+
},
33+
{
34+
question_id: 'q2',
35+
session_id: 's2',
36+
question_title: 'Valid Palindrome',
37+
question_difficulty: 'Medium' as const,
38+
partner_id: 'partner2',
39+
is_solved_successfully: false,
40+
has_penalty: true,
41+
started_at: '2023-10-11T10:00:00Z',
42+
time_taken_ms: 2400000, // 40 minutes
43+
},
44+
];
45+
46+
const renderComponent = (userId: string, limit: number, mockData?: any[]) => {
47+
if (mockData !== undefined) {
48+
(api.getAllAttemptSummaries as jest.Mock).mockResolvedValue(mockData);
49+
}
50+
return render(
51+
<BrowserRouter>
52+
<RecentSessionsList userId={userId} limit={limit} />
53+
</BrowserRouter>
54+
);
55+
};
56+
57+
describe('RecentSessionsList', () => {
58+
jest.setTimeout(10000);
59+
60+
beforeEach(() => {
61+
jest.clearAllMocks();
62+
});
63+
64+
it('should render a list of recent sessions', async () => {
65+
(api.getOtherUser as jest.Mock).mockResolvedValue({ data: { username: 'testuser' } });
66+
67+
renderComponent('user123', 5, mockSessions);
68+
69+
await waitFor(() => {
70+
expect(screen.getByText('Two Sum')).toBeInTheDocument();
71+
});
72+
73+
expect(screen.getByText('Valid Palindrome')).toBeInTheDocument();
74+
expect(screen.getByText('Easy')).toBeInTheDocument();
75+
expect(screen.getByText('Medium')).toBeInTheDocument();
76+
});
77+
78+
it('should render a message when no sessions are found', async () => {
79+
renderComponent('user123', 5, []);
80+
81+
await waitFor(() => {
82+
expect(screen.getByText('No recent sessions found.')).toBeInTheDocument();
83+
});
84+
});
85+
86+
it('should show loading state initially', () => {
87+
(api.getAllAttemptSummaries as jest.Mock).mockImplementation(() => new Promise(() => {}));
88+
89+
renderComponent('user123', 5);
90+
91+
expect(screen.getByText('Loading recent sessions...')).toBeInTheDocument();
92+
});
93+
94+
it('should display status badges correctly', async () => {
95+
(api.getOtherUser as jest.Mock).mockResolvedValue({ data: { username: 'testuser' } });
96+
97+
renderComponent('user123', 5, mockSessions);
98+
99+
await waitFor(() => {
100+
expect(screen.getByText('Passed')).toBeInTheDocument();
101+
expect(screen.getByText('Incomplete')).toBeInTheDocument();
102+
});
103+
});
104+
105+
it('should fetch and display usernames for partners', async () => {
106+
(api.getOtherUser as jest.Mock)
107+
.mockResolvedValueOnce({ data: { username: 'alice' } })
108+
.mockResolvedValueOnce({ data: { username: 'bob' } });
109+
110+
renderComponent('user123', 5, mockSessions);
111+
112+
await waitFor(() => {
113+
expect(screen.getByText(/with alice/)).toBeInTheDocument();
114+
expect(screen.getByText(/with bob/)).toBeInTheDocument();
115+
});
116+
});
117+
118+
it('should handle username fetch errors gracefully', async () => {
119+
(api.getOtherUser as jest.Mock).mockRejectedValue(new Error('Failed to fetch'));
120+
121+
renderComponent('user123', 5, mockSessions);
122+
123+
await waitFor(() => {
124+
// Should still render sessions, just with partner_id as fallback
125+
expect(screen.getByText(/with partner1/)).toBeInTheDocument();
126+
});
127+
});
128+
129+
it('should limit sessions to the specified limit', async () => {
130+
const manySessions = Array.from({ length: 10 }, (_, i) => ({
131+
...mockSessions[0],
132+
session_id: `s${i}`,
133+
question_id: `q${i}`,
134+
question_title: `Question ${i}`,
135+
started_at: new Date(2023, 9, 10 + i).toISOString(),
136+
}));
137+
138+
(api.getOtherUser as jest.Mock).mockResolvedValue({ data: { username: 'testuser' } });
139+
140+
renderComponent('user123', 3, manySessions);
141+
142+
await waitFor(() => {
143+
const questionTitles = screen.getAllByText(/Question \d+/);
144+
expect(questionTitles.length).toBeLessThanOrEqual(3);
145+
});
146+
});
147+
148+
it('should navigate to question detail page when session is clicked', async () => {
149+
const mockNavigate = jest.fn();
150+
jest.doMock('react-router-dom', () => ({
151+
...jest.requireActual('react-router-dom'),
152+
useNavigate: () => mockNavigate,
153+
}));
154+
155+
(api.getOtherUser as jest.Mock).mockResolvedValue({ data: { username: 'testuser' } });
156+
157+
renderComponent('user123', 5, [mockSessions[0]]);
158+
159+
await waitFor(() => {
160+
expect(screen.getByText('Two Sum')).toBeInTheDocument();
161+
});
162+
163+
// Note: Navigation testing would require re-mocking the component
164+
// This is a placeholder for the navigation test
165+
});
166+
});
167+

0 commit comments

Comments
 (0)