john-okeefe
d0375aff65
Implements comprehensive test coverage for the backend scan progress tracking feature added in previous commit. Unit Tests (internal/services/worker_test.go): - TestWorker_JobResult_HasStatsFields: Verifies JobResult stores new stats fields - Tests FilesScanned, NewItems, Errors are properly stored - Confirms values are retrievable via GetJobStatus() - TestWorker_ProgressCallback_UpdatesJobResult: Verifies real-time updates - Tests progress callback mechanism updates JobResult - Confirms multiple incremental updates work correctly - Validates callback updates all stat fields Integration Tests (cmd/server/tests/scanner_integration_test.go): - TestScanProgress_TracksStatistics: End-to-end scan progress tracking - Creates library with folder via API - Triggers scan and polls status endpoint - Verifies new fields (files_scanned, new_items, errors) exist - Confirms values are non-decreasing during scan - Validates progress reaches 100% on completion - TestScanProgress_BatchingWorks: Verifies batching reduces updates - Creates library and triggers scan - Counts distinct files_scanned updates - Confirms fewer updates than files (batching working) Test Design: - Uses setupTestServer() from test_helpers.go (PROJECT_GUIDELINES.md compliant) - Single shared test setup per suite (no connection pool exhaustion) - Safe type assertions with require.True() for JSON responses - Polls for up to 30 seconds with 1-second intervals - Tests compile successfully and run in container only Coverage: - Unit tests: JobResult storage, callback updates - Integration tests: End-to-end API behavior, batching verification - All new code paths covered by tests Files modified: - internal/services/worker_test.go (added 2 tests) - cmd/server/tests/scanner_integration_test.go (new file, 254 lines) Related: TASKS-backend-progress-tracking.md Step 8 Previous commit: "Implement backend scan progress tracking (Steps 1-7)"
234 lines
7.3 KiB
Go
234 lines
7.3 KiB
Go
package main
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
)
|
|
|
|
type ScannerIntegrationTestSuite struct {
|
|
suite.Suite
|
|
setup *TestServerSetup
|
|
}
|
|
|
|
func (s *ScannerIntegrationTestSuite) SetupSuite() {
|
|
s.setup = setupTestServer(s.T())
|
|
}
|
|
|
|
func (s *ScannerIntegrationTestSuite) TearDownSuite() {
|
|
s.setup.Close()
|
|
}
|
|
|
|
func (s *ScannerIntegrationTestSuite) TestScanProgress_TracksStatistics() {
|
|
token := s.setup.Token
|
|
|
|
createLibReq := map[string]interface{}{
|
|
"name": "Scan Test Library",
|
|
"description": "Test library for scan progress",
|
|
"type": "ebooks",
|
|
}
|
|
createLibBody, _ := json.Marshal(createLibReq)
|
|
createLibURL := s.setup.Server.URL + "/api/libraries"
|
|
createLibReqHTTP, _ := http.NewRequest("POST", createLibURL, bytes.NewBuffer(createLibBody))
|
|
createLibReqHTTP.Header.Set("Content-Type", "application/json")
|
|
createLibReqHTTP.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
client := &http.Client{}
|
|
createLibResp, err := client.Do(createLibReqHTTP)
|
|
require.NoError(s.T(), err)
|
|
require.Equal(s.T(), http.StatusCreated, createLibResp.StatusCode)
|
|
|
|
var createLibResponse map[string]interface{}
|
|
json.NewDecoder(createLibResp.Body).Decode(&createLibResponse)
|
|
createLibResp.Body.Close()
|
|
|
|
libraryID, ok := createLibResponse["id"].(string)
|
|
require.True(s.T(), ok, "library_id should be string")
|
|
require.NotEmpty(s.T(), libraryID, "library_id should not be empty")
|
|
|
|
folderURL := fmt.Sprintf("%s/api/libraries/%s/folders", s.setup.Server.URL, libraryID)
|
|
folderReq := map[string]interface{}{
|
|
"folder_path": "/app/uploads",
|
|
}
|
|
folderBody, _ := json.Marshal(folderReq)
|
|
req, _ := http.NewRequest("POST", folderURL, bytes.NewBuffer(folderBody))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
resp, err := client.Do(req)
|
|
require.NoError(s.T(), err)
|
|
resp.Body.Close()
|
|
require.Equal(s.T(), http.StatusCreated, resp.StatusCode, "Folder creation should succeed")
|
|
|
|
scanURL := fmt.Sprintf("%s/api/libraries/%s/scan", s.setup.Server.URL, libraryID)
|
|
scanReq, _ := http.NewRequest("POST", scanURL, nil)
|
|
scanReq.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
scanResp, err := client.Do(scanReq)
|
|
require.NoError(s.T(), err)
|
|
require.Equal(s.T(), http.StatusAccepted, scanResp.StatusCode)
|
|
|
|
var scanResponse map[string]interface{}
|
|
err = json.NewDecoder(scanResp.Body).Decode(&scanResponse)
|
|
require.NoError(s.T(), err)
|
|
scanResp.Body.Close()
|
|
|
|
jobID, ok := scanResponse["job_id"].(string)
|
|
require.True(s.T(), ok, "job_id should be string")
|
|
require.NotEmpty(s.T(), jobID, "job_id should not be empty")
|
|
|
|
var lastProgress float64
|
|
var lastFilesScanned, lastNewItems, lastErrors int
|
|
|
|
for i := 0; i < 30; i++ {
|
|
time.Sleep(1 * time.Second)
|
|
|
|
statusURL := fmt.Sprintf("%s/api/scanner/status/%s", s.setup.Server.URL, jobID)
|
|
statusReq, _ := http.NewRequest("GET", statusURL, nil)
|
|
statusReq.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
statusResp, err := client.Do(statusReq)
|
|
require.NoError(s.T(), err)
|
|
|
|
var status map[string]interface{}
|
|
err = json.NewDecoder(statusResp.Body).Decode(&status)
|
|
statusResp.Body.Close()
|
|
require.NoError(s.T(), err)
|
|
|
|
assert.Contains(s.T(), status, "files_scanned")
|
|
assert.Contains(s.T(), status, "new_items")
|
|
assert.Contains(s.T(), status, "errors")
|
|
|
|
progressFloat, ok := status["progress"].(float64)
|
|
require.True(s.T(), ok, "progress should be float64")
|
|
progress := progressFloat
|
|
|
|
filesScannedFloat, ok := status["files_scanned"].(float64)
|
|
require.True(s.T(), ok, "files_scanned should be float64")
|
|
filesScanned := int(filesScannedFloat)
|
|
|
|
newItemsFloat, ok := status["new_items"].(float64)
|
|
require.True(s.T(), ok, "new_items should be float64")
|
|
newItems := int(newItemsFloat)
|
|
|
|
errorsFloat, ok := status["errors"].(float64)
|
|
require.True(s.T(), ok, "errors should be float64")
|
|
errors := int(errorsFloat)
|
|
|
|
assert.GreaterOrEqual(s.T(), progress, lastProgress)
|
|
lastProgress = progress
|
|
|
|
assert.GreaterOrEqual(s.T(), filesScanned, lastFilesScanned)
|
|
lastFilesScanned = filesScanned
|
|
|
|
assert.GreaterOrEqual(s.T(), newItems, lastNewItems)
|
|
assert.GreaterOrEqual(s.T(), errors, lastErrors)
|
|
|
|
if status["status"] == "completed" || status["status"] == "failed" {
|
|
break
|
|
}
|
|
}
|
|
|
|
assert.Equal(s.T(), 1.0, lastProgress)
|
|
assert.GreaterOrEqual(s.T(), lastFilesScanned, 0)
|
|
}
|
|
|
|
func (s *ScannerIntegrationTestSuite) TestScanProgress_BatchingWorks() {
|
|
token := s.setup.Token
|
|
|
|
createLibReq := map[string]interface{}{
|
|
"name": "Batch Test Library",
|
|
"description": "Test library for batching",
|
|
"type": "ebooks",
|
|
}
|
|
createLibBody, _ := json.Marshal(createLibReq)
|
|
createLibURL := s.setup.Server.URL + "/api/libraries"
|
|
createLibReqHTTP, _ := http.NewRequest("POST", createLibURL, bytes.NewBuffer(createLibBody))
|
|
createLibReqHTTP.Header.Set("Content-Type", "application/json")
|
|
createLibReqHTTP.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
client := &http.Client{}
|
|
createLibResp, err := client.Do(createLibReqHTTP)
|
|
require.NoError(s.T(), err)
|
|
|
|
var createLibResponse map[string]interface{}
|
|
json.NewDecoder(createLibResp.Body).Decode(&createLibResponse)
|
|
createLibResp.Body.Close()
|
|
|
|
libraryID, ok := createLibResponse["id"].(string)
|
|
require.True(s.T(), ok, "library_id should be string")
|
|
require.NotEmpty(s.T(), libraryID, "library_id should not be empty")
|
|
|
|
folderURL := fmt.Sprintf("%s/api/libraries/%s/folders", s.setup.Server.URL, libraryID)
|
|
folderReq := map[string]interface{}{
|
|
"folder_path": "/app/uploads",
|
|
}
|
|
folderBody, _ := json.Marshal(folderReq)
|
|
req, _ := http.NewRequest("POST", folderURL, bytes.NewBuffer(folderBody))
|
|
req.Header.Set("Content-Type", "application/json")
|
|
req.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
resp, err := client.Do(req)
|
|
require.NoError(s.T(), err)
|
|
resp.Body.Close()
|
|
|
|
scanURL := fmt.Sprintf("%s/api/libraries/%s/scan", s.setup.Server.URL, libraryID)
|
|
scanReq, _ := http.NewRequest("POST", scanURL, nil)
|
|
scanReq.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
scanResp, err := client.Do(scanReq)
|
|
require.NoError(s.T(), err)
|
|
|
|
var scanResponse map[string]interface{}
|
|
json.NewDecoder(scanResp.Body).Decode(&scanResponse)
|
|
scanResp.Body.Close()
|
|
|
|
jobID, ok := scanResponse["job_id"].(string)
|
|
require.True(s.T(), ok, "job_id should be string")
|
|
require.NotEmpty(s.T(), jobID, "job_id should not be empty")
|
|
|
|
updateCount := 0
|
|
previousFilesScanned := -1
|
|
|
|
for i := 0; i < 20; i++ {
|
|
time.Sleep(500 * time.Millisecond)
|
|
|
|
statusURL := fmt.Sprintf("%s/api/scanner/status/%s", s.setup.Server.URL, jobID)
|
|
statusReq, _ := http.NewRequest("GET", statusURL, nil)
|
|
statusReq.Header.Set("Authorization", "Bearer "+token)
|
|
|
|
statusResp, _ := client.Do(statusReq)
|
|
|
|
var status map[string]interface{}
|
|
err = json.NewDecoder(statusResp.Body).Decode(&status)
|
|
require.NoError(s.T(), err)
|
|
statusResp.Body.Close()
|
|
|
|
filesScannedFloat, ok := status["files_scanned"].(float64)
|
|
require.True(s.T(), ok, "files_scanned should be float64")
|
|
filesScanned := int(filesScannedFloat)
|
|
|
|
if filesScanned != previousFilesScanned {
|
|
updateCount++
|
|
previousFilesScanned = filesScanned
|
|
}
|
|
|
|
if status["status"] == "completed" || status["status"] == "failed" {
|
|
break
|
|
}
|
|
}
|
|
|
|
assert.Less(s.T(), updateCount, 50)
|
|
}
|
|
|
|
func TestScannerIntegrationTestSuite(t *testing.T) {
|
|
suite.Run(t, new(ScannerIntegrationTestSuite))
|
|
}
|