Add tests for sorting and filtering functionality
- Add integration tests for sorting (sorting_test.go) - Test sort by title, author, page_count, copyright_year, genre - Test pagination with sorting - Test invalid sort parameter defaults - Cover no user, user, and admin contexts - Add integration tests for filtering (filtering_test.go) - Test filter by genre, language, year range, has_cover - Test combining multiple filters - Test filtering with pagination and sorting - Cover no user, user, and admin contexts - Add Bruno API test for sorting - Add Bruno API test for filtering
This commit is contained in:
@@ -0,0 +1,135 @@
|
||||
meta {
|
||||
name: Filter Media Items
|
||||
type: http
|
||||
seq: 1
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{base_url}}/api/media-items/filtered?library_id={{library_id}}&genre_filter=Fiction&language_filter=en&year_min=2000&year_max=2024&limit=10&offset=0
|
||||
auth: inherit
|
||||
}
|
||||
|
||||
headers {
|
||||
Content-Type: application/json
|
||||
}
|
||||
|
||||
tests {
|
||||
test_filter_media_items(status, headers, body) {
|
||||
if (status !== 200) {
|
||||
throw new Error("Expected status 200, got " + status);
|
||||
}
|
||||
|
||||
const contentType = headers["content-type"];
|
||||
if (!contentType || !contentType.includes("application/json")) {
|
||||
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||
}
|
||||
|
||||
let data;
|
||||
try {
|
||||
const parsed = JSON.parse(body);
|
||||
data = parsed.data;
|
||||
} catch (e) {
|
||||
throw new Error("Response body is not valid JSON: " + e.message);
|
||||
}
|
||||
|
||||
if (!Array.isArray(data)) {
|
||||
throw new Error("Expected response data to be an array");
|
||||
}
|
||||
|
||||
// Verify filters are applied
|
||||
data.forEach((item, index) => {
|
||||
if (!item || typeof item !== "object") {
|
||||
throw new Error("Media item at index " + index + " is not an object");
|
||||
}
|
||||
|
||||
if (!item.id) {
|
||||
throw new Error("Media item at index " + index + " missing required field: id");
|
||||
}
|
||||
|
||||
if (!item.title) {
|
||||
throw new Error("Media item at index " + index + " missing required field: title");
|
||||
}
|
||||
|
||||
if (!item.library_id) {
|
||||
throw new Error("Media item at index " + index + " missing required field: library_id");
|
||||
}
|
||||
|
||||
// Check genre filter if genre is specified
|
||||
if (item.genre && item.genre !== 'Fiction') {
|
||||
throw new Error("Item at index " + index + " has incorrect genre: " + item.genre);
|
||||
}
|
||||
|
||||
// Check language filter if language is specified
|
||||
if (item.language && item.language !== 'en') {
|
||||
throw new Error("Item at index " + index + " has incorrect language: " + item.language);
|
||||
}
|
||||
|
||||
// Check year range if specified
|
||||
if (item.copyright_year) {
|
||||
if (item.copyright_year < 2000 || item.copyright_year > 2024) {
|
||||
throw new Error("Item at index " + index + " has copyright_year outside range: " + item.copyright_year);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
vars:pre-request {
|
||||
genre: "Fiction"
|
||||
language: "en"
|
||||
yearMin: 2000
|
||||
yearMax: 2024
|
||||
}
|
||||
|
||||
settings {
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
}
|
||||
|
||||
docs {
|
||||
## Filter Media Items
|
||||
|
||||
**Method:** GET
|
||||
|
||||
**Endpoint:** /api/media-items/filtered
|
||||
|
||||
**Authentication:** Required (Bearer token)
|
||||
|
||||
**Query Parameters:**
|
||||
- `library_id` (string, required): UUID of the library
|
||||
- `author_filter` (string, optional): Filter by author (partial match)
|
||||
- `series_filter` (string, optional): Filter by series (partial match)
|
||||
- `genre_filter` (string, optional): Filter by genre (exact match)
|
||||
- `language_filter` (string, optional): Filter by language (exact match, e.g., 'en', 'es', 'fr')
|
||||
- `year_min` (integer, optional): Minimum copyright year
|
||||
- `year_max` (integer, optional): Maximum copyright year
|
||||
- `has_cover` (boolean, optional): Filter for items with cover images only
|
||||
- `sort` (string, optional): Sort field and direction (same options as ListMediaItems)
|
||||
- `limit` (integer, optional): Number of items to return (default: 50, max: 1000)
|
||||
- `offset` (integer, optional): Number of items to skip (default: 0)
|
||||
|
||||
**Response:** Object containing array of filtered media items
|
||||
|
||||
**Status Codes:**
|
||||
- 200: Success
|
||||
- 400: Bad request (invalid parameters)
|
||||
- 401: Unauthorized
|
||||
- 500: Internal server error
|
||||
|
||||
**Examples:**
|
||||
- Filter by genre: `/api/media-items/filtered?library_id=xxx&genre_filter=Fiction`
|
||||
- Filter by language: `/api/media-items/filtered?library_id=xxx&language_filter=es`
|
||||
- Filter by year range: `/api/media-items/filtered?library_id=xxx&year_min=2000&year_max=2024`
|
||||
- Filter by cover: `/api/media-items/filtered?library_id=xxx&has_cover=true`
|
||||
- Combine filters: `/api/media-items/filtered?library_id=xxx&genre_filter=Sci-Fi&year_min=2010&language_filter=en`
|
||||
|
||||
**Filter Behavior:**
|
||||
- Multiple filters can be combined (AND logic)
|
||||
- Author and series filters use partial matching (ILIKE)
|
||||
- Genre and language filters use exact matching
|
||||
- Year range filters are inclusive
|
||||
- Filters are applied before sorting and pagination
|
||||
- User library visibility is respected
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
meta {
|
||||
name: List Media Items with Sorting
|
||||
type: http
|
||||
seq: 1
|
||||
}
|
||||
|
||||
get {
|
||||
url: {{base_url}}/api/media-items?library_id={{library_id}}&sort=title+ASC&limit=10&offset=0
|
||||
auth: inherit
|
||||
}
|
||||
|
||||
headers {
|
||||
Content-Type: application/json
|
||||
}
|
||||
|
||||
tests {
|
||||
test_list_media_items_sorted(status, headers, body) {
|
||||
if (status !== 200) {
|
||||
throw new Error("Expected status 200, got " + status);
|
||||
}
|
||||
|
||||
const contentType = headers["content-type"];
|
||||
if (!contentType || !contentType.includes("application/json")) {
|
||||
throw new Error("Expected content-type to contain application/json, got " + contentType);
|
||||
}
|
||||
|
||||
let data;
|
||||
try {
|
||||
const parsed = JSON.parse(body);
|
||||
data = parsed.data;
|
||||
} catch (e) {
|
||||
throw new Error("Response body is not valid JSON: " + e.message);
|
||||
}
|
||||
|
||||
if (!Array.isArray(data)) {
|
||||
throw new Error("Expected response data to be an array");
|
||||
}
|
||||
|
||||
// Verify items are sorted by title ascending
|
||||
for (let i = 1; i < data.length; i++) {
|
||||
const prevTitle = data[i - 1].title.toLowerCase();
|
||||
const currTitle = data[i].title.toLowerCase();
|
||||
if (prevTitle > currTitle) {
|
||||
throw new Error("Items not sorted by title ASC: " + prevTitle + " should come before " + currTitle);
|
||||
}
|
||||
}
|
||||
|
||||
data.forEach((item, index) => {
|
||||
if (!item || typeof item !== "object") {
|
||||
throw new Error("Media item at index " + index + " is not an object");
|
||||
}
|
||||
|
||||
if (!item.id) {
|
||||
throw new Error("Media item at index " + index + " missing required field: id");
|
||||
}
|
||||
|
||||
if (!item.title) {
|
||||
throw new Error("Media item at index " + index + " missing required field: title");
|
||||
}
|
||||
|
||||
if (!item.library_id) {
|
||||
throw new Error("Media item at index " + index + " missing required field: library_id");
|
||||
}
|
||||
|
||||
if (!item.library_name) {
|
||||
throw new Error("Media item at index " + index + " missing required field: library_name");
|
||||
}
|
||||
});
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
vars:pre-request {
|
||||
sortBy: "title ASC"
|
||||
}
|
||||
|
||||
settings {
|
||||
encodeUrl: true
|
||||
timeout: 0
|
||||
}
|
||||
|
||||
docs {
|
||||
## List Media Items with Sorting
|
||||
|
||||
**Method:** GET
|
||||
|
||||
**Endpoint:** /api/media-items
|
||||
|
||||
**Authentication:** Required (Bearer token)
|
||||
|
||||
**Query Parameters:**
|
||||
- `library_id` (string, required): UUID of the library
|
||||
- `sort` (string, optional): Sort field and direction
|
||||
- Available options:
|
||||
- `created_at ASC` - Oldest added first
|
||||
- `created_at DESC` - Newest added first (default)
|
||||
- `title ASC` - Title A-Z
|
||||
- `title DESC` - Title Z-A
|
||||
- `author ASC` - Author A-Z
|
||||
- `author DESC` - Author Z-A
|
||||
- `series ASC` - Series order
|
||||
- `series DESC` - Series reverse order
|
||||
- `date_published ASC` - Oldest published first
|
||||
- `date_published DESC` - Newest published first
|
||||
- `copyright_year ASC` - Oldest copyright first
|
||||
- `copyright_year DESC` - Newest copyright first
|
||||
- `page_count ASC` - Shortest first
|
||||
- `page_count DESC` - Longest first
|
||||
- `genre ASC` - Genre A-Z
|
||||
- `genre DESC` - Genre Z-A
|
||||
- `limit` (integer, optional): Number of items to return (default: 50, max: 1000)
|
||||
- `offset` (integer, optional): Number of items to skip (default: 0)
|
||||
|
||||
**Response:** Object containing array of media items
|
||||
|
||||
**Status Codes:**
|
||||
- 200: Success
|
||||
- 400: Bad request (invalid parameters)
|
||||
- 401: Unauthorized
|
||||
- 500: Internal server error
|
||||
|
||||
**Examples:**
|
||||
- Sort by title: `/api/media-items?library_id=xxx&sort=title+ASC`
|
||||
- Sort by author descending: `/api/media-items?library_id=xxx&sort=author+DESC`
|
||||
- Sort by page count: `/api/media-items?library_id=xxx&sort=page_count+ASC`
|
||||
|
||||
**Sorting Behavior:**
|
||||
- All sorts are secondary-sorted by series_number then title for consistency
|
||||
- NULL values are sorted last for ascending, first for descending
|
||||
- Sorting is case-insensitive for text fields
|
||||
}
|
||||
Reference in New Issue
Block a user