2019-05-06 23:18:10 +02:00
|
|
|
package config
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
import (
|
|
|
|
"flag"
|
|
|
|
"os"
|
2020-05-31 02:09:52 +02:00
|
|
|
"path/filepath"
|
2020-01-06 02:14:17 +01:00
|
|
|
"sync"
|
2019-05-03 18:57:28 +02:00
|
|
|
"testing"
|
2020-04-30 14:32:48 +02:00
|
|
|
"time"
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
_ "github.com/jinzhu/gorm/dialects/mysql"
|
|
|
|
_ "github.com/jinzhu/gorm/dialects/sqlite"
|
2020-01-06 14:32:15 +01:00
|
|
|
"github.com/photoprism/photoprism/internal/thumb"
|
2020-04-30 15:41:47 +02:00
|
|
|
"github.com/photoprism/photoprism/pkg/capture"
|
2020-01-13 11:07:09 +01:00
|
|
|
"github.com/photoprism/photoprism/pkg/fs"
|
2020-05-27 19:38:40 +02:00
|
|
|
"github.com/photoprism/photoprism/pkg/rnd"
|
2019-05-03 18:57:28 +02:00
|
|
|
"github.com/urfave/cli"
|
|
|
|
)
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// define constants used for testing the config package
|
2019-05-03 18:57:28 +02:00
|
|
|
const (
|
|
|
|
TestDataZip = "/tmp/photoprism/testdata.zip"
|
2019-05-04 00:53:02 +02:00
|
|
|
TestDataURL = "https://dl.photoprism.org/fixtures/testdata.zip"
|
2020-01-26 10:22:27 +01:00
|
|
|
TestDataHash = "be394d5bee8a5634d415e9e0663eef20b5604510" // sha1sum
|
2019-05-03 18:57:28 +02:00
|
|
|
)
|
|
|
|
|
2019-05-06 23:18:10 +02:00
|
|
|
var testConfig *Config
|
2020-04-13 18:08:21 +02:00
|
|
|
var testConfigOnce sync.Once
|
2020-04-09 19:39:09 +02:00
|
|
|
var testConfigMutex sync.Mutex
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
func testDataPath(assetsPath string) string {
|
|
|
|
return assetsPath + "/testdata"
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// NewTestParams inits valid params used for testing
|
2019-05-06 23:18:10 +02:00
|
|
|
func NewTestParams() *Params {
|
2020-01-31 15:29:06 +01:00
|
|
|
assetsPath := fs.Abs("../../assets")
|
2020-05-31 02:09:52 +02:00
|
|
|
storagePath := fs.Abs("../../storage")
|
|
|
|
testDataPath := filepath.Join(storagePath, "testdata")
|
2019-05-03 18:57:28 +02:00
|
|
|
|
2020-05-30 14:52:47 +02:00
|
|
|
dbDriver := os.Getenv("PHOTOPRISM_TEST_DRIVER")
|
|
|
|
dbDsn := os.Getenv("PHOTOPRISM_TEST_DSN")
|
|
|
|
|
|
|
|
// Config example for MySQL / MariaDB:
|
|
|
|
// dbDriver = MySQL,
|
|
|
|
// dbDsn = "photoprism:photoprism@tcp(photoprism-db:4001)/photoprism?parseTime=true",
|
|
|
|
|
2020-05-30 21:11:56 +02:00
|
|
|
if dbDriver == "test" || dbDriver == "sqlite" || dbDriver == "" || dbDsn == "" {
|
2020-05-30 14:52:47 +02:00
|
|
|
dbDriver = SQLite
|
|
|
|
dbDsn = ".test.db"
|
|
|
|
}
|
|
|
|
|
2019-05-06 23:18:10 +02:00
|
|
|
c := &Params{
|
2020-05-27 19:38:40 +02:00
|
|
|
Name: "PhotoPrism",
|
|
|
|
Version: "0.0.0",
|
2020-06-20 14:29:11 +02:00
|
|
|
Copyright: "(c) 2018-2020 Michael Mayer",
|
2020-04-30 15:41:47 +02:00
|
|
|
Debug: true,
|
2019-11-12 05:49:10 +01:00
|
|
|
Public: true,
|
|
|
|
ReadOnly: false,
|
2020-01-13 16:48:32 +01:00
|
|
|
DetectNSFW: true,
|
2019-12-15 17:19:16 +01:00
|
|
|
UploadNSFW: false,
|
2020-06-07 10:09:35 +02:00
|
|
|
SidecarPath: fs.HiddenPath,
|
2019-05-03 18:57:28 +02:00
|
|
|
AssetsPath: assetsPath,
|
2020-05-31 02:09:52 +02:00
|
|
|
StoragePath: testDataPath,
|
2019-05-03 18:57:28 +02:00
|
|
|
CachePath: testDataPath + "/cache",
|
|
|
|
OriginalsPath: testDataPath + "/originals",
|
|
|
|
ImportPath: testDataPath + "/import",
|
2020-04-06 22:50:04 +02:00
|
|
|
TempPath: testDataPath + "/temp",
|
2020-05-31 02:09:52 +02:00
|
|
|
SettingsPath: testDataPath + "/settings",
|
2020-05-30 14:52:47 +02:00
|
|
|
DatabaseDriver: dbDriver,
|
|
|
|
DatabaseDsn: dbDsn,
|
2020-06-30 08:50:44 +02:00
|
|
|
AdminPassword: "photoprism",
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return c
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// NewTestParamsError inits invalid params used for testing
|
2019-07-17 12:00:15 +02:00
|
|
|
func NewTestParamsError() *Params {
|
2020-01-31 15:29:06 +01:00
|
|
|
assetsPath := fs.Abs("../..")
|
2020-05-31 02:09:52 +02:00
|
|
|
testDataPath := fs.Abs("../../storage/testdata")
|
2019-07-17 12:00:15 +02:00
|
|
|
|
|
|
|
c := &Params{
|
|
|
|
DarktableBin: "/usr/bin/darktable-cli",
|
|
|
|
AssetsPath: assetsPath,
|
2020-05-31 02:09:52 +02:00
|
|
|
StoragePath: testDataPath,
|
2019-07-17 12:00:15 +02:00
|
|
|
CachePath: testDataPath + "/cache",
|
|
|
|
OriginalsPath: testDataPath + "/originals",
|
|
|
|
ImportPath: testDataPath + "/import",
|
2020-04-06 22:50:04 +02:00
|
|
|
TempPath: testDataPath + "/temp",
|
2020-07-13 20:41:16 +02:00
|
|
|
DatabaseDriver: SQLite,
|
|
|
|
DatabaseDsn: ".test-error.db",
|
2019-07-17 12:00:15 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
return c
|
|
|
|
}
|
|
|
|
|
2020-04-13 18:08:21 +02:00
|
|
|
func SetNewTestConfig() {
|
|
|
|
testConfig = NewTestConfig()
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// TestConfig inits the global testConfig if it was not already initialised
|
2019-05-06 23:18:10 +02:00
|
|
|
func TestConfig() *Config {
|
2020-04-13 18:08:21 +02:00
|
|
|
testConfigOnce.Do(SetNewTestConfig)
|
2019-05-03 18:57:28 +02:00
|
|
|
|
2019-05-06 23:18:10 +02:00
|
|
|
return testConfig
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// NewTestConfig inits valid config used for testing
|
2019-05-06 23:18:10 +02:00
|
|
|
func NewTestConfig() *Config {
|
2020-04-30 15:41:47 +02:00
|
|
|
defer log.Debug(capture.Time(time.Now(), "config: new test config created"))
|
|
|
|
|
2020-04-09 19:39:09 +02:00
|
|
|
testConfigMutex.Lock()
|
|
|
|
defer testConfigMutex.Unlock()
|
|
|
|
|
2020-05-27 19:38:40 +02:00
|
|
|
c := &Config{
|
|
|
|
params: NewTestParams(),
|
|
|
|
token: rnd.Token(8),
|
|
|
|
}
|
|
|
|
|
2020-05-31 02:09:52 +02:00
|
|
|
s := NewSettings()
|
|
|
|
|
|
|
|
if err := os.MkdirAll(c.SettingsPath(), os.ModePerm); err != nil {
|
|
|
|
log.Fatalf("config: %s", err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := s.Save(filepath.Join(c.SettingsPath(), "settings.yml")); err != nil {
|
|
|
|
log.Fatalf("config: %s", err.Error())
|
|
|
|
}
|
|
|
|
|
2020-10-08 08:52:03 +02:00
|
|
|
if err := c.Init(); err != nil {
|
2020-04-30 15:41:47 +02:00
|
|
|
log.Fatalf("config: %s", err.Error())
|
2019-06-03 22:58:15 +02:00
|
|
|
}
|
2019-05-03 18:57:28 +02:00
|
|
|
|
2020-05-08 19:34:29 +02:00
|
|
|
c.InitTestDb()
|
2020-01-06 02:14:17 +01:00
|
|
|
|
2020-05-05 17:04:13 +02:00
|
|
|
thumb.Size = c.ThumbSize()
|
2020-07-18 17:33:02 +02:00
|
|
|
thumb.SizeUncached = c.ThumbSizeUncached()
|
2020-05-05 17:17:19 +02:00
|
|
|
thumb.Filter = c.ThumbFilter()
|
2020-05-05 17:04:13 +02:00
|
|
|
thumb.JpegQuality = c.JpegQuality()
|
2020-01-06 14:32:15 +01:00
|
|
|
|
2019-05-03 18:57:28 +02:00
|
|
|
return c
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// NewTestErrorConfig inits invalid config used for testing
|
2019-07-17 12:00:15 +02:00
|
|
|
func NewTestErrorConfig() *Config {
|
2020-04-13 18:08:21 +02:00
|
|
|
c := &Config{params: NewTestParamsError()}
|
2020-07-04 12:54:35 +02:00
|
|
|
|
2019-07-17 12:00:15 +02:00
|
|
|
return c
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// CliTestContext returns example cli config for testing
|
2019-05-03 18:57:28 +02:00
|
|
|
func CliTestContext() *cli.Context {
|
2019-05-06 23:18:10 +02:00
|
|
|
config := NewTestParams()
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
globalSet := flag.NewFlagSet("test", 0)
|
|
|
|
globalSet.Bool("debug", false, "doc")
|
2020-05-31 02:09:52 +02:00
|
|
|
globalSet.String("storage-path", config.StoragePath, "doc")
|
2020-12-04 11:02:19 +01:00
|
|
|
globalSet.String("backup-path", config.StoragePath, "doc")
|
2020-07-13 20:25:47 +02:00
|
|
|
globalSet.String("sidecar-path", config.SidecarPath, "doc")
|
2019-05-03 18:57:28 +02:00
|
|
|
globalSet.String("config-file", config.ConfigFile, "doc")
|
|
|
|
globalSet.String("assets-path", config.AssetsPath, "doc")
|
|
|
|
globalSet.String("originals-path", config.OriginalsPath, "doc")
|
2020-01-31 15:29:06 +01:00
|
|
|
globalSet.String("import-path", config.OriginalsPath, "doc")
|
2020-04-06 22:50:04 +02:00
|
|
|
globalSet.String("temp-path", config.OriginalsPath, "doc")
|
2020-01-31 15:29:06 +01:00
|
|
|
globalSet.String("cache-path", config.OriginalsPath, "doc")
|
2019-06-06 14:44:29 +02:00
|
|
|
globalSet.String("darktable-cli", config.DarktableBin, "doc")
|
2020-06-30 08:50:44 +02:00
|
|
|
globalSet.String("admin-password", config.DarktableBin, "doc")
|
2020-01-13 16:48:32 +01:00
|
|
|
globalSet.Bool("detect-nsfw", config.DetectNSFW, "doc")
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
app := cli.NewApp()
|
2020-11-16 19:39:40 +01:00
|
|
|
app.Version = "0.0.0"
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
c := cli.NewContext(app, globalSet, nil)
|
|
|
|
|
2020-05-31 02:09:52 +02:00
|
|
|
LogError(c.Set("storage-path", config.StoragePath))
|
2020-12-04 11:02:19 +01:00
|
|
|
LogError(c.Set("backup-path", config.BackupPath))
|
2020-07-13 20:25:47 +02:00
|
|
|
LogError(c.Set("sidecar-path", config.SidecarPath))
|
2020-04-30 15:41:47 +02:00
|
|
|
LogError(c.Set("config-file", config.ConfigFile))
|
|
|
|
LogError(c.Set("assets-path", config.AssetsPath))
|
|
|
|
LogError(c.Set("originals-path", config.OriginalsPath))
|
|
|
|
LogError(c.Set("import-path", config.ImportPath))
|
|
|
|
LogError(c.Set("temp-path", config.TempPath))
|
|
|
|
LogError(c.Set("cache-path", config.CachePath))
|
|
|
|
LogError(c.Set("darktable-cli", config.DarktableBin))
|
2020-06-30 08:50:44 +02:00
|
|
|
LogError(c.Set("admin-password", config.AdminPassword))
|
2020-04-30 15:41:47 +02:00
|
|
|
LogError(c.Set("detect-nsfw", "true"))
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
return c
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// RemoveTestData deletes files in import, export, originals and cache folders
|
2019-05-06 23:18:10 +02:00
|
|
|
func (c *Config) RemoveTestData(t *testing.T) {
|
2020-04-30 16:44:04 +02:00
|
|
|
if err := os.RemoveAll(c.ImportPath()); err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := os.RemoveAll(c.TempPath()); err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := os.RemoveAll(c.OriginalsPath()); err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := os.RemoveAll(c.CachePath()); err != nil {
|
|
|
|
t.Fatal(err)
|
|
|
|
}
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// DownloadTestData downloads test data from photoprism.org server
|
2019-05-06 23:18:10 +02:00
|
|
|
func (c *Config) DownloadTestData(t *testing.T) {
|
2020-01-12 14:00:56 +01:00
|
|
|
if fs.FileExists(TestDataZip) {
|
|
|
|
hash := fs.Hash(TestDataZip)
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
if hash != TestDataHash {
|
2020-04-30 16:44:04 +02:00
|
|
|
if err := os.Remove(TestDataZip); err != nil {
|
|
|
|
t.Fatalf("config: %s", err.Error())
|
|
|
|
}
|
|
|
|
|
|
|
|
t.Logf("config: removed outdated test data zip file (fingerprint %s)", hash)
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-01-12 14:00:56 +01:00
|
|
|
if !fs.FileExists(TestDataZip) {
|
2020-04-30 16:44:04 +02:00
|
|
|
t.Logf("config: downloading latest test data zip file from %s", TestDataURL)
|
2019-05-03 18:57:28 +02:00
|
|
|
|
2020-01-12 14:00:56 +01:00
|
|
|
if err := fs.Download(TestDataZip, TestDataURL); err != nil {
|
2020-04-30 16:44:04 +02:00
|
|
|
t.Fatalf("config: test data download failed: %s", err.Error())
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// UnzipTestData in default test folder
|
2019-05-06 23:18:10 +02:00
|
|
|
func (c *Config) UnzipTestData(t *testing.T) {
|
2020-05-31 02:09:52 +02:00
|
|
|
if _, err := fs.Unzip(TestDataZip, c.StoragePath()); err != nil {
|
2020-04-30 16:44:04 +02:00
|
|
|
t.Fatalf("config: could not unzip test data: %s", err.Error())
|
2019-05-03 18:57:28 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-02-21 01:14:45 +01:00
|
|
|
// InitializeTestData using testing constant
|
2019-05-06 23:18:10 +02:00
|
|
|
func (c *Config) InitializeTestData(t *testing.T) {
|
2020-04-30 16:44:04 +02:00
|
|
|
defer t.Logf(capture.Time(time.Now(), "config: initialized test data"))
|
2019-05-03 18:57:28 +02:00
|
|
|
|
|
|
|
c.RemoveTestData(t)
|
|
|
|
|
|
|
|
c.DownloadTestData(t)
|
|
|
|
|
|
|
|
c.UnzipTestData(t)
|
|
|
|
}
|