Added additional unit tests for construction of objects containing deviceId property

This commit is contained in:
Jason Axley 2025-08-21 10:36:04 -07:00
parent 3a4aacb7bf
commit 974e17ee3e
9 changed files with 333 additions and 124 deletions

View file

@ -1 +1,70 @@
// TODO: test buildLibraryItemScanData
const chai = require('chai')
const expect = chai.expect
const sinon = require('sinon')
const rewire = require('rewire')
const Path = require('path')
const { stubFileUtils, getMockFileInfo, loadTestDatabase } = require('../MockDatabase')
const LibraryFile = require('../../../server/objects/files/LibraryFile')
const FileMetadata = require('../../../server/objects/metadata/FileMetadata')
const LibraryFolder = require('../../../server/models/LibraryFolder')
describe('buildLibraryItemScanData', () => {
let testLibrary = null
beforeEach(async () => {
stubFileUtils()
testLibrary = await loadTestDatabase()
})
afterEach(() => {
sinon.restore()
})
it('setsDeviceId', async () => {
const libraryItemScanner = rewire('../../../server/scanner/LibraryItemScanner')
/**
* @param {{ path?: any; relPath?: any; mediaMetadata?: any; }} libraryItemData
* @param {import("../../../server/models/LibraryFolder")} folder
* @param {import("../../../server/models/Library")} library
* @param {boolean} isSingleMediaItem
* @param {LibraryFile[]} libraryFiles
* @return {import('../../../server/scanner/LibraryItemScanData') | null}
* */
const buildLibraryItemScanData = libraryItemScanner.__get__('buildLibraryItemScanData')
const mockFileInfo = getMockFileInfo().get('/test/file.pdf')
const lf = new LibraryFile()
var fileMetadata = new FileMetadata()
fileMetadata.setData(mockFileInfo)
fileMetadata.filename = Path.basename(mockFileInfo?.path)
fileMetadata.path = mockFileInfo?.path
fileMetadata.relPath = mockFileInfo?.path
fileMetadata.ext = Path.extname(mockFileInfo?.path)
lf.ino = mockFileInfo?.ino
lf.deviceId = mockFileInfo?.dev
lf.metadata = fileMetadata
lf.addedAt = Date.now()
lf.updatedAt = Date.now()
lf.metadata = fileMetadata
const libraryItemData = {
path: mockFileInfo?.path, // full path
relPath: mockFileInfo?.path, // only filename
mediaMetadata: {
title: Path.basename(mockFileInfo?.path, Path.extname(mockFileInfo?.path))
}
}
const scanData = await buildLibraryItemScanData(libraryItemData, buildLibraryFolder(), testLibrary, true, [lf.toJSON()])
expect(scanData).to.not.be.null
expect(scanData.deviceId).to.equal(mockFileInfo?.dev)
})
})
/** @return {import("../../../server/models/LibraryFolder")} folder */
function buildLibraryFolder() {
return new LibraryFolder()
}

View file

@ -3,49 +3,18 @@ const expect = chai.expect
const sinon = require('sinon')
const rewire = require('rewire')
const fileUtils = require('../../../server/utils/fileUtils')
const Database = require('../../../server/Database')
const { Sequelize } = require('sequelize')
const LibraryFile = require('../../../server/objects/files/LibraryFile')
const LibraryItem = require('../../../server/models/LibraryItem')
const FileMetadata = require('../../../server/objects/metadata/FileMetadata')
const Path = require('path')
const Database = require('../../../server/Database')
const { stubFileUtils, loadTestDatabase, getMockFileInfo, getRenamedMockFileInfo, buildBookLibraryItemParams } = require('../MockDatabase')
describe('LibraryScanner', () => {
let getInoStub, getDeviceIdStub, getFileTimestampsWithInoStub, LibraryScanner, testLibrary
let LibraryScanner, testLibrary
beforeEach(async () => {
getInoStub = sinon.stub(fileUtils, 'getIno')
getInoStub.callsFake((path) => {
const normalizedPath = fileUtils.filePathToPOSIX(path).replace(/\/$/, '')
const stats = getMockFileInfo().get(normalizedPath)
if (stats) {
return stats.ino
} else {
return null
}
})
getDeviceIdStub = sinon.stub(fileUtils, 'getDeviceId')
getDeviceIdStub.callsFake(async (path) => {
const normalizedPath = fileUtils.filePathToPOSIX(path).replace(/\/$/, '')
const stats = getMockFileInfo().get(normalizedPath)
if (stats) {
return stats.dev
} else {
return null
}
})
getFileTimestampsWithInoStub = sinon.stub(fileUtils, 'getFileTimestampsWithIno')
getFileTimestampsWithInoStub.callsFake(async (path) => {
const normalizedPath = fileUtils.filePathToPOSIX(path).replace(/\/$/, '')
const stats = getMockFileInfo().get(normalizedPath)
if (stats) {
return stats
} else {
return null
}
})
stubFileUtils()
LibraryScanner = rewire('../../../server/scanner/LibraryScanner')
})
@ -245,79 +214,3 @@ describe('LibraryScanner', () => {
let ItemToItemInoMatch = LibraryScanner.__get__('ItemToItemInoMatch')
})
})
async function loadTestDatabase(mockFileInfo) {
let libraryItem1Id, libraryItem2Id
let fileInfo = mockFileInfo || getMockFileInfo()
let bookLibraryFiles = fileInfo.keys().reduce((acc, key) => {
let bookfile = new LibraryFile()
bookfile.setDataFromPath(key, key)
acc.push(bookfile)
return acc
}, [])
global.ServerSettings = {}
Database.sequelize = new Sequelize({
dialect: 'sqlite',
storage: ':memory:',
// Choose one of the logging options
logging: (...msg) => console.log(msg),
logQueryParameters: true
})
Database.sequelize.uppercaseFirst = (str) => (str ? `${str[0].toUpperCase()}${str.substr(1)}` : '')
await Database.buildModels()
const newLibrary = await Database.libraryModel.create({ name: 'Test Library', mediaType: 'book' })
const newLibraryFolder = await Database.libraryFolderModel.create({ path: '/test', libraryId: newLibrary.id })
const newLibraryFolder2 = await Database.libraryFolderModel.create({ path: '/mnt/drive', libraryId: newLibrary.id })
const newBook = await Database.bookModel.create({ title: 'Test Book', audioFiles: [], tags: [], narrators: [], genres: [], chapters: [] })
const newLibraryItem = await Database.libraryItemModel.create(buildBookLibraryItemParams(bookLibraryFiles[0], newBook.id, newLibrary.id, newLibraryFolder.id))
libraryItem1Id = newLibraryItem.id
const newBook2 = await Database.bookModel.create({ title: 'Test Book 2', audioFiles: [], tags: [], narrators: [], genres: [], chapters: [] })
const newLibraryItem2 = await Database.libraryItemModel.create(buildBookLibraryItemParams(bookLibraryFiles[1], newBook2.id, newLibrary.id, newLibraryFolder2.id))
libraryItem2Id = newLibraryItem2.id
return newLibrary
}
/**
* @param {LibraryFile} libraryFile
* @param {any} bookId
* @param {string} libraryId
* @param {any} libraryFolderId
*/
function buildBookLibraryItemParams(libraryFile, bookId, libraryId, libraryFolderId) {
return {
path: libraryFile.metadata.path,
isFile: true,
ino: libraryFile.ino,
deviceId: libraryFile.deviceId,
libraryFiles: [libraryFile.toJSON()],
mediaId: bookId,
mediaType: 'book',
libraryId: libraryId,
libraryFolderId: libraryFolderId
}
}
/** @returns {Map<string, import('fs').Stats>} */
function getMockFileInfo() {
// @ts-ignore
return new Map([
['/test/file.pdf', { path: '/test/file.pdf', isDirectory: () => false, size: 1024, mtimeMs: Date.now(), ino: '1', dev: '100' }],
['/mnt/drive/file-same-ino-different-dev.pdf', { path: '/mnt/drive/file-same-ino-different-dev.pdf', isDirectory: () => false, size: 42, mtimeMs: Date.now(), ino: '1', dev: '200' }]
])
}
/** @returns {Map<string, import('fs').Stats>} */
// this has the same data as above except one file has been renamed
function getRenamedMockFileInfo() {
// @ts-ignore
return new Map([
['/test/file-renamed.pdf', { path: '/test/file-renamed.pdf', isDirectory: () => false, size: 1024, mtimeMs: Date.now(), ino: '1', dev: '100' }],
['/mnt/drive/file-same-ino-different-dev.pdf', { path: '/mnt/drive/file-same-ino-different-dev.pdf', isDirectory: () => false, size: 42, mtimeMs: Date.now(), ino: '1', dev: '200' }]
])
}