stash/pkg/models/setup_test.go

// +build integration

package models_test

import (
	"context"
	"database/sql"
	"errors"
	"fmt"
	"io/ioutil"
	"os"
	"strconv"
	"testing"
	"time"

	"github.com/jmoiron/sqlx"

	"github.com/stashapp/stash/pkg/database"
	"github.com/stashapp/stash/pkg/models"
	"github.com/stashapp/stash/pkg/models/modelstest"
	"github.com/stashapp/stash/pkg/utils"
)

const totalScenes = 12
const totalImages = 6
const performersNameCase = 6
const performersNameNoCase = 2
const moviesNameCase = 2
const moviesNameNoCase = 1
const totalGalleries = 3
const tagsNameNoCase = 2
const tagsNameCase = 9
const studiosNameCase = 5
const studiosNameNoCase = 1

var sceneIDs []int
var imageIDs []int
var performerIDs []int
var movieIDs []int
var galleryIDs []int
var tagIDs []int
var studioIDs []int
var markerIDs []int

var tagNames []string
var studioNames []string
var movieNames []string
var performerNames []string

const sceneIdxWithMovie = 0
const sceneIdxWithGallery = 1
const sceneIdxWithPerformer = 2
const sceneIdxWithTwoPerformers = 3
const sceneIdxWithTag = 4
const sceneIdxWithTwoTags = 5
const sceneIdxWithStudio = 6
const sceneIdxWithMarker = 7

const imageIdxWithGallery = 0
const imageIdxWithPerformer = 1
const imageIdxWithTwoPerformers = 2
const imageIdxWithTag = 3
const imageIdxWithTwoTags = 4
const imageIdxWithStudio = 5

const performerIdxWithScene = 0
const performerIdx1WithScene = 1
const performerIdx2WithScene = 2
const performerIdxWithImage = 3
const performerIdx1WithImage = 4
const performerIdx2WithImage = 5

// performers with dup names start from the end
const performerIdx1WithDupName = 6
const performerIdxWithDupName = 7

const movieIdxWithScene = 0
const movieIdxWithStudio = 1

// movies with dup names start from the end
const movieIdxWithDupName = 2

const galleryIdxWithScene = 0
const galleryIdxWithImage = 1

const tagIdxWithScene = 0
const tagIdx1WithScene = 1
const tagIdx2WithScene = 2
const tagIdxWithPrimaryMarker = 3
const tagIdxWithMarker = 4
const tagIdxWithCoverImage = 5
const tagIdxWithImage = 6
const tagIdx1WithImage = 7
const tagIdx2WithImage = 8

// tags with dup names start from the end
const tagIdx1WithDupName = 9
const tagIdxWithDupName = 10

const studioIdxWithScene = 0
const studioIdxWithMovie = 1
const studioIdxWithChildStudio = 2
const studioIdxWithParentStudio = 3
const studioIdxWithImage = 4

// studios with dup names start from the end
const studioIdxWithDupName = 5

const markerIdxWithScene = 0

const pathField = "Path"
const checksumField = "Checksum"
const titleField = "Title"

func TestMain(m *testing.M) {
	ret := runTests(m)
	os.Exit(ret)
}

func testTeardown(databaseFile string) {
	err := database.DB.Close()

	if err != nil {
		panic(err)
	}

	err = os.Remove(databaseFile)
	if err != nil {
		panic(err)
	}
}

func runTests(m *testing.M) int {
	// create the database file
	f, err := ioutil.TempFile("", "*.sqlite")
	if err != nil {
		panic(fmt.Sprintf("Could not create temporary file: %s", err.Error()))
	}

	f.Close()
	databaseFile := f.Name()
	database.Initialize(databaseFile)

	// defer close and delete the database
	defer testTeardown(databaseFile)

	err = populateDB()
	if err != nil {
		panic(fmt.Sprintf("Could not populate database: %s", err.Error()))
	} else {
		// run the tests
		return m.Run()
	}
}

func populateDB() error {
	ctx := context.TODO()
	tx := database.DB.MustBeginTx(ctx, nil)

	if err := createScenes(tx, totalScenes); err != nil {
		tx.Rollback()
		return err
	}

	if err := createImages(tx, totalImages); err != nil {
		tx.Rollback()
		return err
	}

	if err := createGalleries(tx, totalGalleries); err != nil {
		tx.Rollback()
		return err
	}

	if err := createMovies(tx, moviesNameCase, moviesNameNoCase); err != nil {
		tx.Rollback()
		return err
	}

	if err := createPerformers(tx, performersNameCase, performersNameNoCase); err != nil {
		tx.Rollback()
		return err
	}

	if err := createTags(tx, tagsNameCase, tagsNameNoCase); err != nil {
		tx.Rollback()
		return err
	}

	if err := addTagImage(tx, tagIdxWithCoverImage); err != nil {
		tx.Rollback()
		return err
	}

	if err := createStudios(tx, studiosNameCase, studiosNameNoCase); err != nil {
		tx.Rollback()
		return err
	}

	// TODO - the link methods use Find which don't accept a transaction, so
	// to commit the transaction and start a new one
	if err := tx.Commit(); err != nil {
		return fmt.Errorf("Error committing: %s", err.Error())
	}

	tx = database.DB.MustBeginTx(ctx, nil)

	if err := linkSceneGallery(tx, sceneIdxWithGallery, galleryIdxWithScene); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkSceneMovie(tx, sceneIdxWithMovie, movieIdxWithScene); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkScenePerformers(tx); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkSceneTags(tx); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkSceneStudio(tx, sceneIdxWithStudio, studioIdxWithScene); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkImageGallery(tx, imageIdxWithGallery, galleryIdxWithImage); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkImagePerformers(tx); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkImageTags(tx); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkImageStudio(tx, imageIdxWithStudio, studioIdxWithImage); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkMovieStudio(tx, movieIdxWithStudio, studioIdxWithMovie); err != nil {
		tx.Rollback()
		return err
	}

	if err := linkStudioParent(tx, studioIdxWithChildStudio, studioIdxWithParentStudio); err != nil {
		tx.Rollback()
		return err
	}

	if err := createMarker(tx, sceneIdxWithMarker, tagIdxWithPrimaryMarker, []int{tagIdxWithMarker}); err != nil {
		tx.Rollback()
		return err
	}

	if err := tx.Commit(); err != nil {
		return fmt.Errorf("Error committing: %s", err.Error())
	}

	return nil
}

func getSceneStringValue(index int, field string) string {
	return fmt.Sprintf("scene_%04d_%s", index, field)
}

func getRating(index int) sql.NullInt64 {
	rating := index % 6
	return sql.NullInt64{Int64: int64(rating), Valid: rating > 0}
}

func getOCounter(index int) int {
	return index % 3
}

func getSceneDuration(index int) sql.NullFloat64 {
	duration := index % 4
	duration = duration * 100

	return sql.NullFloat64{
		Float64: float64(duration) + 0.432,
		Valid:   duration != 0,
	}
}

func getHeight(index int) sql.NullInt64 {
	heights := []int64{0, 200, 240, 300, 480, 700, 720, 800, 1080, 1500, 2160, 3000}
	height := heights[index%len(heights)]
	return sql.NullInt64{
		Int64: height,
		Valid: height != 0,
	}
}

func getSceneDate(index int) models.SQLiteDate {
	dates := []string{"null", "", "0001-01-01", "2001-02-03"}
	date := dates[index%len(dates)]
	return models.SQLiteDate{
		String: date,
		Valid:  date != "null",
	}
}

func createScenes(tx *sqlx.Tx, n int) error {
	sqb := models.NewSceneQueryBuilder()

	for i := 0; i < n; i++ {
		scene := models.Scene{
			Path:     getSceneStringValue(i, pathField),
			Title:    sql.NullString{String: getSceneStringValue(i, titleField), Valid: true},
			Checksum: sql.NullString{String: getSceneStringValue(i, checksumField), Valid: true},
			Details:  sql.NullString{String: getSceneStringValue(i, "Details"), Valid: true},
			Rating:   getRating(i),
			OCounter: getOCounter(i),
			Duration: getSceneDuration(i),
			Height:   getHeight(i),
			Date:     getSceneDate(i),
		}

		created, err := sqb.Create(scene, tx)

		if err != nil {
			return fmt.Errorf("Error creating scene %v+: %s", scene, err.Error())
		}

		sceneIDs = append(sceneIDs, created.ID)
	}

	return nil
}

func getImageStringValue(index int, field string) string {
	return fmt.Sprintf("image_%04d_%s", index, field)
}

func createImages(tx *sqlx.Tx, n int) error {
	qb := models.NewImageQueryBuilder()

	for i := 0; i < n; i++ {
		image := models.Image{
			Path:     getImageStringValue(i, pathField),
			Title:    sql.NullString{String: getImageStringValue(i, titleField), Valid: true},
			Checksum: getImageStringValue(i, checksumField),
			Rating:   getRating(i),
			OCounter: getOCounter(i),
			Height:   getHeight(i),
		}

		created, err := qb.Create(image, tx)

		if err != nil {
			return fmt.Errorf("Error creating image %v+: %s", image, err.Error())
		}

		imageIDs = append(imageIDs, created.ID)
	}

	return nil
}

func getGalleryStringValue(index int, field string) string {
	return "gallery_" + strconv.FormatInt(int64(index), 10) + "_" + field
}

func createGalleries(tx *sqlx.Tx, n int) error {
	gqb := models.NewGalleryQueryBuilder()

	for i := 0; i < n; i++ {
		gallery := models.Gallery{
			Path:     modelstest.NullString(getGalleryStringValue(i, pathField)),
			Checksum: getGalleryStringValue(i, checksumField),
		}

		created, err := gqb.Create(gallery, tx)

		if err != nil {
			return fmt.Errorf("Error creating gallery %v+: %s", gallery, err.Error())
		}

		galleryIDs = append(galleryIDs, created.ID)
	}

	return nil
}

func getMovieStringValue(index int, field string) string {
	return "movie_" + strconv.FormatInt(int64(index), 10) + "_" + field
}

//createMoviees creates n movies with plain Name and o movies with camel cased NaMe included
func createMovies(tx *sqlx.Tx, n int, o int) error {
	mqb := models.NewMovieQueryBuilder()
	const namePlain = "Name"
	const nameNoCase = "NaMe"

	for i := 0; i < n+o; i++ {
		index := i
		name := namePlain

		if i >= n { // i<n tags get normal names
			name = nameNoCase       // i>=n movies get dup names if case is not checked
			index = n + o - (i + 1) // for the name to be the same the number (index) must be the same also
		} // so count backwards to 0 as needed
		// movies [ i ] and [ n + o - i - 1  ] should have similar names with only the Name!=NaMe part different

		name = getMovieStringValue(index, name)
		movie := models.Movie{
			Name:     sql.NullString{String: name, Valid: true},
			Checksum: utils.MD5FromString(name),
		}

		created, err := mqb.Create(movie, tx)

		if err != nil {
			return fmt.Errorf("Error creating movie [%d] %v+: %s", i, movie, err.Error())
		}

		movieIDs = append(movieIDs, created.ID)
		movieNames = append(movieNames, created.Name.String)
	}

	return nil
}

func getPerformerStringValue(index int, field string) string {
	return "performer_" + strconv.FormatInt(int64(index), 10) + "_" + field
}

func getPerformerBoolValue(index int) bool {
	index = index % 2
	return index == 1
}

func getPerformerBirthdate(index int) string {
	const minAge = 18
	birthdate := time.Now()
	birthdate = birthdate.AddDate(-minAge-index, -1, -1)
	return birthdate.Format("2006-01-02")
}

//createPerformers creates n performers with plain Name and o performers with camel cased NaMe included
func createPerformers(tx *sqlx.Tx, n int, o int) error {
	pqb := models.NewPerformerQueryBuilder()
	const namePlain = "Name"
	const nameNoCase = "NaMe"

	name := namePlain

	for i := 0; i < n+o; i++ {
		index := i

		if i >= n { // i<n tags get normal names
			name = nameNoCase       // i>=n performers get dup names if case is not checked
			index = n + o - (i + 1) // for the name to be the same the number (index) must be the same also
		} // so count backwards to 0 as needed
		// performers [ i ] and [ n + o - i - 1  ] should have similar names with only the Name!=NaMe part different

		performer := models.Performer{
			Name:     sql.NullString{String: getPerformerStringValue(index, name), Valid: true},
			Checksum: getPerformerStringValue(i, checksumField),
			Favorite: sql.NullBool{Bool: getPerformerBoolValue(i), Valid: true},
			Birthdate: models.SQLiteDate{
				String: getPerformerBirthdate(i),
				Valid:  true,
			},
		}

		created, err := pqb.Create(performer, tx)

		if err != nil {
			return fmt.Errorf("Error creating performer %v+: %s", performer, err.Error())
		}

		performerIDs = append(performerIDs, created.ID)
		performerNames = append(performerNames, created.Name.String)
	}

	return nil
}

func getTagStringValue(index int, field string) string {
	return "tag_" + strconv.FormatInt(int64(index), 10) + "_" + field
}

func getTagSceneCount(id int) int {
	if id == tagIDs[tagIdx1WithScene] || id == tagIDs[tagIdx2WithScene] || id == tagIDs[tagIdxWithScene] {
		return 1
	}

	return 0
}

func getTagMarkerCount(id int) int {
	if id == tagIDs[tagIdxWithMarker] || id == tagIDs[tagIdxWithPrimaryMarker] {
		return 1
	}

	return 0
}

//createTags creates n tags with plain Name and o tags with camel cased NaMe included
func createTags(tx *sqlx.Tx, n int, o int) error {
	tqb := models.NewTagQueryBuilder()
	const namePlain = "Name"
	const nameNoCase = "NaMe"

	name := namePlain

	for i := 0; i < n+o; i++ {
		index := i

		if i >= n { // i<n tags get normal names
			name = nameNoCase       // i>=n tags get dup names if case is not checked
			index = n + o - (i + 1) // for the name to be the same the number (index) must be the same also
		} // so count backwards to 0 as needed
		// tags [ i ] and [ n + o - i - 1  ] should have similar names with only the Name!=NaMe part different

		tag := models.Tag{
			Name: getTagStringValue(index, name),
		}

		created, err := tqb.Create(tag, tx)

		if err != nil {
			return fmt.Errorf("Error creating tag %v+: %s", tag, err.Error())
		}

		tagIDs = append(tagIDs, created.ID)
		tagNames = append(tagNames, created.Name)
	}

	return nil
}

func getStudioStringValue(index int, field string) string {
	return "studio_" + strconv.FormatInt(int64(index), 10) + "_" + field
}

func createStudio(tx *sqlx.Tx, name string, parentID *int64) (*models.Studio, error) {
	sqb := models.NewStudioQueryBuilder()
	studio := models.Studio{
		Name:     sql.NullString{String: name, Valid: true},
		Checksum: utils.MD5FromString(name),
	}

	if parentID != nil {
		studio.ParentID = sql.NullInt64{Int64: *parentID, Valid: true}
	}

	created, err := sqb.Create(studio, tx)

	if err != nil {
		return nil, fmt.Errorf("Error creating studio %v+: %s", studio, err.Error())
	}

	return created, nil
}

//createStudios creates n studios with plain Name and o studios with camel cased NaMe included
func createStudios(tx *sqlx.Tx, n int, o int) error {
	const namePlain = "Name"
	const nameNoCase = "NaMe"

	for i := 0; i < n+o; i++ {
		index := i
		name := namePlain

		if i >= n { // i<n studios get normal names
			name = nameNoCase       // i>=n studios get dup names if case is not checked
			index = n + o - (i + 1) // for the name to be the same the number (index) must be the same also
		} // so count backwards to 0 as needed
		// studios [ i ] and [ n + o - i - 1  ] should have similar names with only the Name!=NaMe part different

		name = getStudioStringValue(index, name)
		created, err := createStudio(tx, name, nil)

		if err != nil {
			return err
		}

		studioIDs = append(studioIDs, created.ID)
		studioNames = append(studioNames, created.Name.String)
	}

	return nil
}

func createMarker(tx *sqlx.Tx, sceneIdx, primaryTagIdx int, tagIdxs []int) error {
	mqb := models.NewSceneMarkerQueryBuilder()

	marker := models.SceneMarker{
		SceneID:      sql.NullInt64{Int64: int64(sceneIDs[sceneIdx]), Valid: true},
		PrimaryTagID: tagIDs[primaryTagIdx],
	}

	created, err := mqb.Create(marker, tx)

	if err != nil {
		return fmt.Errorf("Error creating marker %v+: %s", marker, err.Error())
	}

	markerIDs = append(markerIDs, created.ID)

	jqb := models.NewJoinsQueryBuilder()

	joins := []models.SceneMarkersTags{}

	for _, tagIdx := range tagIdxs {
		join := models.SceneMarkersTags{
			SceneMarkerID: created.ID,
			TagID:         tagIDs[tagIdx],
		}
		joins = append(joins, join)
	}

	if err := jqb.CreateSceneMarkersTags(joins, tx); err != nil {
		return fmt.Errorf("Error creating marker/tag join: %s", err.Error())
	}

	return nil
}

func linkSceneMovie(tx *sqlx.Tx, sceneIndex, movieIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddMoviesScene(sceneIDs[sceneIndex], movieIDs[movieIndex], nil, tx)
	return err
}

func linkScenePerformers(tx *sqlx.Tx) error {
	if err := linkScenePerformer(tx, sceneIdxWithPerformer, performerIdxWithScene); err != nil {
		return err
	}
	if err := linkScenePerformer(tx, sceneIdxWithTwoPerformers, performerIdx1WithScene); err != nil {
		return err
	}
	if err := linkScenePerformer(tx, sceneIdxWithTwoPerformers, performerIdx2WithScene); err != nil {
		return err
	}

	return nil
}

func linkScenePerformer(tx *sqlx.Tx, sceneIndex, performerIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddPerformerScene(sceneIDs[sceneIndex], performerIDs[performerIndex], tx)
	return err
}

func linkSceneGallery(tx *sqlx.Tx, sceneIndex, galleryIndex int) error {
	gqb := models.NewGalleryQueryBuilder()

	gallery, err := gqb.Find(galleryIDs[galleryIndex], nil)

	if err != nil {
		return fmt.Errorf("error finding gallery: %s", err.Error())
	}

	if gallery == nil {
		return errors.New("gallery is nil")
	}

	gallery.SceneID = sql.NullInt64{Int64: int64(sceneIDs[sceneIndex]), Valid: true}
	_, err = gqb.Update(*gallery, tx)

	return err
}

func linkSceneTags(tx *sqlx.Tx) error {
	if err := linkSceneTag(tx, sceneIdxWithTag, tagIdxWithScene); err != nil {
		return err
	}
	if err := linkSceneTag(tx, sceneIdxWithTwoTags, tagIdx1WithScene); err != nil {
		return err
	}
	if err := linkSceneTag(tx, sceneIdxWithTwoTags, tagIdx2WithScene); err != nil {
		return err
	}

	return nil
}

func linkSceneTag(tx *sqlx.Tx, sceneIndex, tagIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddSceneTag(sceneIDs[sceneIndex], tagIDs[tagIndex], tx)
	return err
}

func linkSceneStudio(tx *sqlx.Tx, sceneIndex, studioIndex int) error {
	sqb := models.NewSceneQueryBuilder()

	scene := models.ScenePartial{
		ID:       sceneIDs[sceneIndex],
		StudioID: &sql.NullInt64{Int64: int64(studioIDs[studioIndex]), Valid: true},
	}
	_, err := sqb.Update(scene, tx)

	return err
}

func linkImageGallery(tx *sqlx.Tx, imageIndex, galleryIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddImageGallery(imageIDs[imageIndex], galleryIDs[galleryIndex], tx)

	return err
}

func linkImageTags(tx *sqlx.Tx) error {
	if err := linkImageTag(tx, imageIdxWithTag, tagIdxWithImage); err != nil {
		return err
	}
	if err := linkImageTag(tx, imageIdxWithTwoTags, tagIdx1WithImage); err != nil {
		return err
	}
	if err := linkImageTag(tx, imageIdxWithTwoTags, tagIdx2WithImage); err != nil {
		return err
	}

	return nil
}

func linkImageTag(tx *sqlx.Tx, imageIndex, tagIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddImageTag(imageIDs[imageIndex], tagIDs[tagIndex], tx)
	return err
}

func linkImageStudio(tx *sqlx.Tx, imageIndex, studioIndex int) error {
	sqb := models.NewImageQueryBuilder()

	image := models.ImagePartial{
		ID:       imageIDs[imageIndex],
		StudioID: &sql.NullInt64{Int64: int64(studioIDs[studioIndex]), Valid: true},
	}
	_, err := sqb.Update(image, tx)

	return err
}

func linkImagePerformers(tx *sqlx.Tx) error {
	if err := linkImagePerformer(tx, imageIdxWithPerformer, performerIdxWithImage); err != nil {
		return err
	}
	if err := linkImagePerformer(tx, imageIdxWithTwoPerformers, performerIdx1WithImage); err != nil {
		return err
	}
	if err := linkImagePerformer(tx, imageIdxWithTwoPerformers, performerIdx2WithImage); err != nil {
		return err
	}

	return nil
}

func linkImagePerformer(tx *sqlx.Tx, imageIndex, performerIndex int) error {
	jqb := models.NewJoinsQueryBuilder()

	_, err := jqb.AddPerformerImage(imageIDs[imageIndex], performerIDs[performerIndex], tx)
	return err
}

func linkMovieStudio(tx *sqlx.Tx, movieIndex, studioIndex int) error {
	mqb := models.NewMovieQueryBuilder()

	movie := models.MoviePartial{
		ID:       movieIDs[movieIndex],
		StudioID: &sql.NullInt64{Int64: int64(studioIDs[studioIndex]), Valid: true},
	}
	_, err := mqb.Update(movie, tx)

	return err
}

func linkStudioParent(tx *sqlx.Tx, parentIndex, childIndex int) error {
	sqb := models.NewStudioQueryBuilder()

	studio := models.StudioPartial{
		ID:       studioIDs[childIndex],
		ParentID: &sql.NullInt64{Int64: int64(studioIDs[parentIndex]), Valid: true},
	}
	_, err := sqb.Update(studio, tx)

	return err
}

func addTagImage(tx *sqlx.Tx, tagIndex int) error {
	qb := models.NewTagQueryBuilder()

	return qb.UpdateTagImage(tagIDs[tagIndex], models.DefaultTagImage, tx)
}