PiwigoDirectoryUploader/internal/pkg/images/images_test.go

561 lines
18 KiB
Go

/*
* Copyright (C) 2019 Philipp Haefelfinger (http://www.haefelfinger.ch/). All Rights Reserved.
* This application is licensed under GPLv2. See the LICENSE file in the root directory of the project.
*/
package images
//go:generate mockgen -destination=./piwigo_mock_test.go -package=images git.haefelfinger.net/piwigo/PiwigoDirectoryUploader/internal/pkg/piwigo PiwigoApi,PiwigoCategoryApi,PiwigoImageApi
//go:generate mockgen -destination=./datastore_mock_test.go -package=images git.haefelfinger.net/piwigo/PiwigoDirectoryUploader/internal/pkg/datastore ImageMetadataProvider,CategoryProvider
import (
"git.haefelfinger.net/piwigo/PiwigoDirectoryUploader/internal/pkg/datastore"
"git.haefelfinger.net/piwigo/PiwigoDirectoryUploader/internal/pkg/localFileStructure"
"git.haefelfinger.net/piwigo/PiwigoDirectoryUploader/internal/pkg/piwigo"
"github.com/golang/mock/gomock"
"testing"
"time"
)
func Test_synchronize_local_image_metadata_should_find_nothing_if_empty(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(0)
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().SaveImageMetadata(gomock.Any()).Times(0)
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_synchronize_local_image_metadata_should_add_new_metadata(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(1)
testFileSystemNode := &localFileStructure.FilesystemNode{
Key: "2019/shooting1/abc.jpg",
ModTime: time.Date(2019, 01, 01, 01, 0, 0, 0, time.UTC),
Name: "abc.jpg",
Path: "2019/shooting1/abc.jpg",
IsDir: false}
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
fileSystemNodes[testFileSystemNode.Key] = testFileSystemNode
image := createImageMetaDataFromFilesystem(testFileSystemNode, 0, true, false)
image.CategoryPiwigoId = category.PiwigoId
image.CategoryPath = category.Key
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().ImageMetadata(testFileSystemNode.Key).Return(datastore.ImageMetaData{}, datastore.ErrorRecordNotFound).Times(1)
db.EXPECT().SaveImageMetadata(image).Times(1)
// execute the sync metadata based on the file system results
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_synchronize_local_image_metadata_should_mark_unchanged_entries_without_piwigoid_as_uploads_and_reset_deleted(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(0)
testFileSystemNode := &localFileStructure.FilesystemNode{
Key: "2019/shooting1/abc.jpg",
ModTime: time.Date(2019, 01, 01, 00, 0, 0, 0, time.UTC),
Name: "abc.jpg",
Path: "2019/shooting1/abc.jpg",
IsDir: false}
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
fileSystemNodes[testFileSystemNode.Key] = testFileSystemNode
imageExptected := createImageMetaDataFromFilesystem(testFileSystemNode, 0, true, false)
imageStored := imageExptected
imageStored.DeleteRequired = true
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().ImageMetadata(testFileSystemNode.Key).Return(imageStored, nil).Times(1)
db.EXPECT().SaveImageMetadata(imageExptected).Times(1)
// execute the sync metadata based on the file system results
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_synchronize_local_image_metadata_should_mark_changed_entries_as_uploads_and_reset_deleted(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(0)
testFileSystemNode := &localFileStructure.FilesystemNode{
Key: "2019/shooting1/abc.jpg",
ModTime: time.Date(2019, 01, 01, 01, 0, 0, 0, time.UTC),
Name: "abc.jpg",
Path: "2019/shooting1/abc.jpg",
IsDir: false}
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
fileSystemNodes[testFileSystemNode.Key] = testFileSystemNode
imageExptected := createImageMetaDataFromFilesystem(testFileSystemNode, 0, true, false)
imageStored := imageExptected
imageStored.DeleteRequired = true
imageStored.UploadRequired = false
imageStored.LastChange = time.Date(2019, 01, 01, 00, 0, 0, 0, time.UTC)
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().ImageMetadata(testFileSystemNode.Key).Return(imageStored, nil).Times(1)
db.EXPECT().SaveImageMetadata(imageExptected).Times(1)
// execute the sync metadata based on the file system results
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_synchronize_local_image_metadata_should_not_mark_unchanged_files_to_upload_and_reset_deleted(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(0)
testFileSystemNode := &localFileStructure.FilesystemNode{
Key: "2019/shooting1/abc.jpg",
ModTime: time.Date(2019, 01, 01, 01, 0, 0, 0, time.UTC),
Name: "abc.jpg",
Path: "2019/shooting1/abc.jpg",
IsDir: false}
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
fileSystemNodes[testFileSystemNode.Key] = testFileSystemNode
imageExptected := createImageMetaDataFromFilesystem(testFileSystemNode, 5, false, false)
imageStored := imageExptected
imageStored.DeleteRequired = true
imageStored.UploadRequired = false
imageStored.LastChange = time.Date(2019, 01, 01, 01, 0, 0, 0, time.UTC)
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().ImageMetadata(testFileSystemNode.Key).Return(imageStored, nil).Times(1)
db.EXPECT().SaveImageMetadata(imageExptected).Times(1)
// execute the sync metadata based on the file system results
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_synchronize_local_image_metadata_should_not_process_directories(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
category := datastore.CategoryData{CategoryId: 1, Name: "shooting1", PiwigoId: 1, Key: "2019/shooting1"}
categoryMock := NewMockCategoryProvider(mockCtrl)
categoryMock.EXPECT().GetCategoryByKey(category.Key).Return(category, nil).Times(0)
testFileSystemNode := &localFileStructure.FilesystemNode{
Key: "2019/shooting1",
ModTime: time.Date(2019, 01, 01, 01, 0, 0, 0, time.UTC),
Name: "shooting1",
Path: "2019/shooting1/",
IsDir: true}
fileSystemNodes := map[string]*localFileStructure.FilesystemNode{}
fileSystemNodes[testFileSystemNode.Key] = testFileSystemNode
db := NewMockImageMetadataProvider(mockCtrl)
db.EXPECT().ImageMetadataAll().Times(1)
db.EXPECT().SaveImageMetadata(gomock.Any()).Times(0)
// execute the sync metadata based on the file system results
err := SynchronizeLocalImageMetadata(db, categoryMock, fileSystemNodes, testChecksumCalculator)
if err != nil {
t.Error(err)
}
}
func Test_checkPiwigoForChangedImages_none_with_piwigoId(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{ImageId: 1, UploadRequired: true}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(0)
piwigomock.EXPECT().ImageCheckFile(gomock.Any(), gomock.Any()).Times(0)
err := checkPiwigoForChangedImages(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_checkPiwigoForChangedImages_with_empty_list(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
images := []datastore.ImageMetaData{}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(0)
piwigomock.EXPECT().ImageCheckFile(gomock.Any(), gomock.Any()).Times(0)
err := checkPiwigoForChangedImages(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_checkPiwigoForChangedImages_should_call_piwigo_set_uploadRequired_to_false(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: 1,
UploadRequired: true,
Md5Sum: "1234",
}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
imgExpected := img
imgExpected.UploadRequired = false
dbmock.EXPECT().SaveImageMetadata(imgExpected).Times(1)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImageCheckFile(1, "1234").Return(piwigo.ImageStateUptodate, nil)
err := checkPiwigoForChangedImages(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_checkPiwigoForChangedImages_return_image_differs(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: 1,
UploadRequired: true,
Md5Sum: "1234",
}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
dbmock.EXPECT().SaveImageMetadata(gomock.Any()).Times(0)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImageCheckFile(1, "1234").Return(piwigo.ImageStateDifferent, nil)
err := checkPiwigoForChangedImages(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_updatePiwigoIdIfAlreadyUploaded_without_images_to_upload(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
images := []datastore.ImageMetaData{}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
dbmock.EXPECT().SavePiwigoIdAndUpdateUploadFlag(gomock.Any(), gomock.Any()).Times(0)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(0)
err := updatePiwigoIdIfAlreadyUploaded(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_updatePiwigoIdIfAlreadyUploaded_without_image_to_check(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: 1,
UploadRequired: true,
Md5Sum: "1234",
}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
dbmock.EXPECT().SavePiwigoIdAndUpdateUploadFlag(gomock.Any(), gomock.Any()).Times(0)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(0)
err := updatePiwigoIdIfAlreadyUploaded(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_updatePiwigoIdIfAlreadyUploaded_with_image_to_check(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: 0,
UploadRequired: true,
Md5Sum: "1234",
}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
dbmock.EXPECT().SavePiwigoIdAndUpdateUploadFlag("1234", 1).Times(1)
piwigoResponose := make(map[string]int)
piwigoResponose["1234"] = 1
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(1).Return(piwigoResponose, nil)
err := updatePiwigoIdIfAlreadyUploaded(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_updatePiwigoIdIfAlreadyUploaded_with_image_to_check_missing_on_server(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: 0,
UploadRequired: true,
Md5Sum: "1234",
}
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Return(images, nil)
dbmock.EXPECT().SavePiwigoIdAndUpdateUploadFlag("1234", 1).Times(0)
piwigoResponose := make(map[string]int)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().ImagesExistOnPiwigo(gomock.Any()).Times(1).Return(piwigoResponose, nil)
err := updatePiwigoIdIfAlreadyUploaded(dbmock, piwigomock)
if err != nil {
t.Error(err)
}
}
func Test_uploadImages_saves_new_id_to_db(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := createTestImageMetaData(0)
images := []datastore.ImageMetaData{img}
imgToSave := img
imgToSave.PiwigoId = 5
imgToSave.UploadRequired = false
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Times(1).Return(images, nil)
dbmock.EXPECT().SaveImageMetadata(imgToSave).Times(1)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().UploadImage(0, "/nonexisting/file.jpg", "1234", 2).Times(1).Return(5, nil)
err := UploadImages(piwigomock, dbmock)
if err != nil {
t.Error(err)
}
}
func Test_uploadImages_saves_same_id_to_db(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := createTestImageMetaData(5)
images := []datastore.ImageMetaData{img}
imgToSave := img
imgToSave.UploadRequired = false
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToUpload().Times(1).Return(images, nil)
dbmock.EXPECT().SaveImageMetadata(imgToSave).Times(1)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().UploadImage(5, "/nonexisting/file.jpg", "1234", 2).Times(1).Return(5, nil)
err := UploadImages(piwigomock, dbmock)
if err != nil {
t.Error(err)
}
}
func Test_synchronizeLocalImageMetadataFindFilesToDelete(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := createTestImageMetaData(5)
images := []datastore.ImageMetaData{img}
imgToSave := img
imgToSave.UploadRequired = false
imgToSave.DeleteRequired = true
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataAll().Times(1).Return(images, nil)
dbmock.EXPECT().SaveImageMetadata(imgToSave).Times(1)
err := synchronizeLocalImageMetadataFindFilesToDelete(dbmock)
if err != nil {
t.Error(err)
}
}
func Test_deleteImages_should_call_piwigo_and_remove_metadata(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := createTestImageMetaData(5)
img.UploadRequired = false
img.DeleteRequired = true
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToDelete().Times(1).Return(images, nil)
dbmock.EXPECT().DeleteMarkedImages().Times(1).Return(nil)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().DeleteImages([]int{5}).Times(1).Return(nil)
err := DeleteImages(piwigomock, dbmock)
if err != nil {
t.Error(err)
}
}
func Test_deleteImages_should_not_call_piwigo_for_not_uploaded_images_and_remove_metadata(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
img := createTestImageMetaData(0)
img.UploadRequired = false
img.DeleteRequired = true
images := []datastore.ImageMetaData{img}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToDelete().Times(1).Return(images, nil)
dbmock.EXPECT().DeleteMarkedImages().Times(1).Return(nil)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().DeleteImages(gomock.Any()).Times(0)
err := DeleteImages(piwigomock, dbmock)
if err != nil {
t.Error(err)
}
}
func Test_deleteImages_should_not_call_anything_if_no_images_are_marked_for_deletion(t *testing.T) {
mockCtrl := gomock.NewController(t)
defer mockCtrl.Finish()
images := []datastore.ImageMetaData{}
dbmock := NewMockImageMetadataProvider(mockCtrl)
dbmock.EXPECT().ImageMetadataToDelete().Times(1).Return(images, nil)
dbmock.EXPECT().DeleteMarkedImages().Times(0)
piwigomock := NewMockPiwigoImageApi(mockCtrl)
piwigomock.EXPECT().DeleteImages(gomock.Any()).Times(0)
err := DeleteImages(piwigomock, dbmock)
if err != nil {
t.Error(err)
}
}
// to make the sync testable, we pass in a simple mock that returns the filepath as checksum
func testChecksumCalculator(file string) (string, error) {
return file, nil
}
func createTestImageMetaData(piwigoId int) datastore.ImageMetaData {
img := datastore.ImageMetaData{
ImageId: 1,
PiwigoId: piwigoId,
FullImagePath: "/nonexisting/file.jpg",
UploadRequired: true,
Md5Sum: "1234",
CategoryPiwigoId: 2,
}
return img
}
func createImageMetaDataFromFilesystem(testFileSystemNode *localFileStructure.FilesystemNode, piwigoId int, uploadRequired bool, deleteRequired bool) datastore.ImageMetaData {
imageExptected := datastore.ImageMetaData{
Md5Sum: testFileSystemNode.Key,
FullImagePath: testFileSystemNode.Key,
PiwigoId: piwigoId,
UploadRequired: uploadRequired,
LastChange: testFileSystemNode.ModTime,
Filename: testFileSystemNode.Name,
DeleteRequired: deleteRequired,
}
return imageExptected
}