2020-12-21 20:59:18 +03:00
// Copyright 2020 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2020-12-21 20:59:18 +03:00
package setting
import (
2023-08-04 06:41:16 +03:00
"path/filepath"
2020-12-21 20:59:18 +03:00
"testing"
"github.com/stretchr/testify/assert"
)
func Test_getStorageMultipleName ( t * testing . T ) {
iniStr := `
[ lfs ]
MINIO_BUCKET = gitea - lfs
[ attachment ]
MINIO_BUCKET = gitea - attachment
[ storage ]
2023-06-14 06:42:38 +03:00
STORAGE_TYPE = minio
2020-12-21 20:59:18 +03:00
MINIO_BUCKET = gitea - storage
`
Rewrite queue (#24505)
# ⚠️ Breaking
Many deprecated queue config options are removed (actually, they should
have been removed in 1.18/1.19).
If you see the fatal message when starting Gitea: "Please update your
app.ini to remove deprecated config options", please follow the error
messages to remove these options from your app.ini.
Example:
```
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].ISSUE_INDEXER_QUEUE_TYPE`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].UPDATE_BUFFER_LEN`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [F] Please update your app.ini to remove deprecated config options
```
Many options in `[queue]` are are dropped, including:
`WRAP_IF_NECESSARY`, `MAX_ATTEMPTS`, `TIMEOUT`, `WORKERS`,
`BLOCK_TIMEOUT`, `BOOST_TIMEOUT`, `BOOST_WORKERS`, they can be removed
from app.ini.
# The problem
The old queue package has some legacy problems:
* complexity: I doubt few people could tell how it works.
* maintainability: Too many channels and mutex/cond are mixed together,
too many different structs/interfaces depends each other.
* stability: due to the complexity & maintainability, sometimes there
are strange bugs and difficult to debug, and some code doesn't have test
(indeed some code is difficult to test because a lot of things are mixed
together).
* general applicability: although it is called "queue", its behavior is
not a well-known queue.
* scalability: it doesn't seem easy to make it work with a cluster
without breaking its behaviors.
It came from some very old code to "avoid breaking", however, its
technical debt is too heavy now. It's a good time to introduce a better
"queue" package.
# The new queue package
It keeps using old config and concept as much as possible.
* It only contains two major kinds of concepts:
* The "base queue": channel, levelqueue, redis
* They have the same abstraction, the same interface, and they are
tested by the same testing code.
* The "WokerPoolQueue", it uses the "base queue" to provide "worker
pool" function, calls the "handler" to process the data in the base
queue.
* The new code doesn't do "PushBack"
* Think about a queue with many workers, the "PushBack" can't guarantee
the order for re-queued unhandled items, so in new code it just does
"normal push"
* The new code doesn't do "pause/resume"
* The "pause/resume" was designed to handle some handler's failure: eg:
document indexer (elasticsearch) is down
* If a queue is paused for long time, either the producers blocks or the
new items are dropped.
* The new code doesn't do such "pause/resume" trick, it's not a common
queue's behavior and it doesn't help much.
* If there are unhandled items, the "push" function just blocks for a
few seconds and then re-queue them and retry.
* The new code doesn't do "worker booster"
* Gitea's queue's handlers are light functions, the cost is only the
go-routine, so it doesn't make sense to "boost" them.
* The new code only use "max worker number" to limit the concurrent
workers.
* The new "Push" never blocks forever
* Instead of creating more and more blocking goroutines, return an error
is more friendly to the server and to the end user.
There are more details in code comments: eg: the "Flush" problem, the
strange "code.index" hanging problem, the "immediate" queue problem.
Almost ready for review.
TODO:
* [x] add some necessary comments during review
* [x] add some more tests if necessary
* [x] update documents and config options
* [x] test max worker / active worker
* [x] re-run the CI tasks to see whether any test is flaky
* [x] improve the `handleOldLengthConfiguration` to provide more
friendly messages
* [x] fine tune default config values (eg: length?)
## Code coverage:
2023-05-08 14:49:59 +03:00
cfg , err := NewConfigProviderFromData ( iniStr )
2023-02-19 19:12:01 +03:00
assert . NoError ( t , err )
2020-12-21 20:59:18 +03:00
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadAttachmentFrom ( cfg ) )
assert . EqualValues ( t , "gitea-attachment" , Attachment . Storage . MinioConfig . Bucket )
2023-08-13 23:09:25 +03:00
assert . EqualValues ( t , "attachments/" , Attachment . Storage . MinioConfig . BasePath )
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "gitea-lfs" , LFS . Storage . MinioConfig . Bucket )
2023-08-13 23:09:25 +03:00
assert . EqualValues ( t , "lfs/" , LFS . Storage . MinioConfig . BasePath )
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadAvatarsFrom ( cfg ) )
assert . EqualValues ( t , "gitea-storage" , Avatar . Storage . MinioConfig . Bucket )
2023-08-13 23:09:25 +03:00
assert . EqualValues ( t , "avatars/" , Avatar . Storage . MinioConfig . BasePath )
2020-12-21 20:59:18 +03:00
}
func Test_getStorageUseOtherNameAsType ( t * testing . T ) {
iniStr := `
[ attachment ]
STORAGE_TYPE = lfs
[ storage . lfs ]
2023-06-14 06:42:38 +03:00
STORAGE_TYPE = minio
2020-12-21 20:59:18 +03:00
MINIO_BUCKET = gitea - storage
`
Rewrite queue (#24505)
# ⚠️ Breaking
Many deprecated queue config options are removed (actually, they should
have been removed in 1.18/1.19).
If you see the fatal message when starting Gitea: "Please update your
app.ini to remove deprecated config options", please follow the error
messages to remove these options from your app.ini.
Example:
```
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].ISSUE_INDEXER_QUEUE_TYPE`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].UPDATE_BUFFER_LEN`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [F] Please update your app.ini to remove deprecated config options
```
Many options in `[queue]` are are dropped, including:
`WRAP_IF_NECESSARY`, `MAX_ATTEMPTS`, `TIMEOUT`, `WORKERS`,
`BLOCK_TIMEOUT`, `BOOST_TIMEOUT`, `BOOST_WORKERS`, they can be removed
from app.ini.
# The problem
The old queue package has some legacy problems:
* complexity: I doubt few people could tell how it works.
* maintainability: Too many channels and mutex/cond are mixed together,
too many different structs/interfaces depends each other.
* stability: due to the complexity & maintainability, sometimes there
are strange bugs and difficult to debug, and some code doesn't have test
(indeed some code is difficult to test because a lot of things are mixed
together).
* general applicability: although it is called "queue", its behavior is
not a well-known queue.
* scalability: it doesn't seem easy to make it work with a cluster
without breaking its behaviors.
It came from some very old code to "avoid breaking", however, its
technical debt is too heavy now. It's a good time to introduce a better
"queue" package.
# The new queue package
It keeps using old config and concept as much as possible.
* It only contains two major kinds of concepts:
* The "base queue": channel, levelqueue, redis
* They have the same abstraction, the same interface, and they are
tested by the same testing code.
* The "WokerPoolQueue", it uses the "base queue" to provide "worker
pool" function, calls the "handler" to process the data in the base
queue.
* The new code doesn't do "PushBack"
* Think about a queue with many workers, the "PushBack" can't guarantee
the order for re-queued unhandled items, so in new code it just does
"normal push"
* The new code doesn't do "pause/resume"
* The "pause/resume" was designed to handle some handler's failure: eg:
document indexer (elasticsearch) is down
* If a queue is paused for long time, either the producers blocks or the
new items are dropped.
* The new code doesn't do such "pause/resume" trick, it's not a common
queue's behavior and it doesn't help much.
* If there are unhandled items, the "push" function just blocks for a
few seconds and then re-queue them and retry.
* The new code doesn't do "worker booster"
* Gitea's queue's handlers are light functions, the cost is only the
go-routine, so it doesn't make sense to "boost" them.
* The new code only use "max worker number" to limit the concurrent
workers.
* The new "Push" never blocks forever
* Instead of creating more and more blocking goroutines, return an error
is more friendly to the server and to the end user.
There are more details in code comments: eg: the "Flush" problem, the
strange "code.index" hanging problem, the "immediate" queue problem.
Almost ready for review.
TODO:
* [x] add some necessary comments during review
* [x] add some more tests if necessary
* [x] update documents and config options
* [x] test max worker / active worker
* [x] re-run the CI tasks to see whether any test is flaky
* [x] improve the `handleOldLengthConfiguration` to provide more
friendly messages
* [x] fine tune default config values (eg: length?)
## Code coverage:
2023-05-08 14:49:59 +03:00
cfg , err := NewConfigProviderFromData ( iniStr )
2023-02-19 19:12:01 +03:00
assert . NoError ( t , err )
2020-12-21 20:59:18 +03:00
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadAttachmentFrom ( cfg ) )
assert . EqualValues ( t , "gitea-storage" , Attachment . Storage . MinioConfig . Bucket )
2023-08-13 23:09:25 +03:00
assert . EqualValues ( t , "attachments/" , Attachment . Storage . MinioConfig . BasePath )
2020-12-21 20:59:18 +03:00
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "gitea-storage" , LFS . Storage . MinioConfig . Bucket )
2023-08-13 23:09:25 +03:00
assert . EqualValues ( t , "lfs/" , LFS . Storage . MinioConfig . BasePath )
2020-12-21 20:59:18 +03:00
}
2020-12-22 02:03:18 +03:00
func Test_getStorageInheritStorageType ( t * testing . T ) {
iniStr := `
[ storage ]
STORAGE_TYPE = minio
`
Rewrite queue (#24505)
# ⚠️ Breaking
Many deprecated queue config options are removed (actually, they should
have been removed in 1.18/1.19).
If you see the fatal message when starting Gitea: "Please update your
app.ini to remove deprecated config options", please follow the error
messages to remove these options from your app.ini.
Example:
```
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].ISSUE_INDEXER_QUEUE_TYPE`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].UPDATE_BUFFER_LEN`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [F] Please update your app.ini to remove deprecated config options
```
Many options in `[queue]` are are dropped, including:
`WRAP_IF_NECESSARY`, `MAX_ATTEMPTS`, `TIMEOUT`, `WORKERS`,
`BLOCK_TIMEOUT`, `BOOST_TIMEOUT`, `BOOST_WORKERS`, they can be removed
from app.ini.
# The problem
The old queue package has some legacy problems:
* complexity: I doubt few people could tell how it works.
* maintainability: Too many channels and mutex/cond are mixed together,
too many different structs/interfaces depends each other.
* stability: due to the complexity & maintainability, sometimes there
are strange bugs and difficult to debug, and some code doesn't have test
(indeed some code is difficult to test because a lot of things are mixed
together).
* general applicability: although it is called "queue", its behavior is
not a well-known queue.
* scalability: it doesn't seem easy to make it work with a cluster
without breaking its behaviors.
It came from some very old code to "avoid breaking", however, its
technical debt is too heavy now. It's a good time to introduce a better
"queue" package.
# The new queue package
It keeps using old config and concept as much as possible.
* It only contains two major kinds of concepts:
* The "base queue": channel, levelqueue, redis
* They have the same abstraction, the same interface, and they are
tested by the same testing code.
* The "WokerPoolQueue", it uses the "base queue" to provide "worker
pool" function, calls the "handler" to process the data in the base
queue.
* The new code doesn't do "PushBack"
* Think about a queue with many workers, the "PushBack" can't guarantee
the order for re-queued unhandled items, so in new code it just does
"normal push"
* The new code doesn't do "pause/resume"
* The "pause/resume" was designed to handle some handler's failure: eg:
document indexer (elasticsearch) is down
* If a queue is paused for long time, either the producers blocks or the
new items are dropped.
* The new code doesn't do such "pause/resume" trick, it's not a common
queue's behavior and it doesn't help much.
* If there are unhandled items, the "push" function just blocks for a
few seconds and then re-queue them and retry.
* The new code doesn't do "worker booster"
* Gitea's queue's handlers are light functions, the cost is only the
go-routine, so it doesn't make sense to "boost" them.
* The new code only use "max worker number" to limit the concurrent
workers.
* The new "Push" never blocks forever
* Instead of creating more and more blocking goroutines, return an error
is more friendly to the server and to the end user.
There are more details in code comments: eg: the "Flush" problem, the
strange "code.index" hanging problem, the "immediate" queue problem.
Almost ready for review.
TODO:
* [x] add some necessary comments during review
* [x] add some more tests if necessary
* [x] update documents and config options
* [x] test max worker / active worker
* [x] re-run the CI tasks to see whether any test is flaky
* [x] improve the `handleOldLengthConfiguration` to provide more
friendly messages
* [x] fine tune default config values (eg: length?)
## Code coverage:
2023-05-08 14:49:59 +03:00
cfg , err := NewConfigProviderFromData ( iniStr )
2023-02-19 19:12:01 +03:00
assert . NoError ( t , err )
2020-12-22 02:03:18 +03:00
2023-06-14 06:42:38 +03:00
assert . NoError ( t , loadPackagesFrom ( cfg ) )
assert . EqualValues ( t , "minio" , Packages . Storage . Type )
assert . EqualValues ( t , "gitea" , Packages . Storage . MinioConfig . Bucket )
assert . EqualValues ( t , "packages/" , Packages . Storage . MinioConfig . BasePath )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "minio" , RepoArchive . Storage . Type )
assert . EqualValues ( t , "gitea" , RepoArchive . Storage . MinioConfig . Bucket )
assert . EqualValues ( t , "repo-archive/" , RepoArchive . Storage . MinioConfig . BasePath )
assert . NoError ( t , loadActionsFrom ( cfg ) )
assert . EqualValues ( t , "minio" , Actions . LogStorage . Type )
assert . EqualValues ( t , "gitea" , Actions . LogStorage . MinioConfig . Bucket )
assert . EqualValues ( t , "actions_log/" , Actions . LogStorage . MinioConfig . BasePath )
assert . EqualValues ( t , "minio" , Actions . ArtifactStorage . Type )
assert . EqualValues ( t , "gitea" , Actions . ArtifactStorage . MinioConfig . Bucket )
assert . EqualValues ( t , "actions_artifacts/" , Actions . ArtifactStorage . MinioConfig . BasePath )
assert . NoError ( t , loadAvatarsFrom ( cfg ) )
assert . EqualValues ( t , "minio" , Avatar . Storage . Type )
assert . EqualValues ( t , "gitea" , Avatar . Storage . MinioConfig . Bucket )
assert . EqualValues ( t , "avatars/" , Avatar . Storage . MinioConfig . BasePath )
assert . NoError ( t , loadRepoAvatarFrom ( cfg ) )
assert . EqualValues ( t , "minio" , RepoAvatar . Storage . Type )
assert . EqualValues ( t , "gitea" , RepoAvatar . Storage . MinioConfig . Bucket )
assert . EqualValues ( t , "repo-avatars/" , RepoAvatar . Storage . MinioConfig . BasePath )
2020-12-22 02:03:18 +03:00
}
2023-08-04 06:41:16 +03:00
2024-05-30 10:33:50 +03:00
func Test_getStorageInheritStorageTypeAzureBlob ( t * testing . T ) {
iniStr := `
[ storage ]
STORAGE_TYPE = azureblob
`
cfg , err := NewConfigProviderFromData ( iniStr )
assert . NoError ( t , err )
assert . NoError ( t , loadPackagesFrom ( cfg ) )
assert . EqualValues ( t , "azureblob" , Packages . Storage . Type )
assert . EqualValues ( t , "gitea" , Packages . Storage . AzureBlobConfig . Container )
assert . EqualValues ( t , "packages/" , Packages . Storage . AzureBlobConfig . BasePath )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "azureblob" , RepoArchive . Storage . Type )
assert . EqualValues ( t , "gitea" , RepoArchive . Storage . AzureBlobConfig . Container )
assert . EqualValues ( t , "repo-archive/" , RepoArchive . Storage . AzureBlobConfig . BasePath )
assert . NoError ( t , loadActionsFrom ( cfg ) )
assert . EqualValues ( t , "azureblob" , Actions . LogStorage . Type )
assert . EqualValues ( t , "gitea" , Actions . LogStorage . AzureBlobConfig . Container )
assert . EqualValues ( t , "actions_log/" , Actions . LogStorage . AzureBlobConfig . BasePath )
assert . EqualValues ( t , "azureblob" , Actions . ArtifactStorage . Type )
assert . EqualValues ( t , "gitea" , Actions . ArtifactStorage . AzureBlobConfig . Container )
assert . EqualValues ( t , "actions_artifacts/" , Actions . ArtifactStorage . AzureBlobConfig . BasePath )
assert . NoError ( t , loadAvatarsFrom ( cfg ) )
assert . EqualValues ( t , "azureblob" , Avatar . Storage . Type )
assert . EqualValues ( t , "gitea" , Avatar . Storage . AzureBlobConfig . Container )
assert . EqualValues ( t , "avatars/" , Avatar . Storage . AzureBlobConfig . BasePath )
assert . NoError ( t , loadRepoAvatarFrom ( cfg ) )
assert . EqualValues ( t , "azureblob" , RepoAvatar . Storage . Type )
assert . EqualValues ( t , "gitea" , RepoAvatar . Storage . AzureBlobConfig . Container )
assert . EqualValues ( t , "repo-avatars/" , RepoAvatar . Storage . AzureBlobConfig . BasePath )
}
2023-08-04 06:41:16 +03:00
type testLocalStoragePathCase struct {
loader func ( rootCfg ConfigProvider ) error
storagePtr * * Storage
expectedPath string
}
func testLocalStoragePath ( t * testing . T , appDataPath , iniStr string , cases [ ] testLocalStoragePathCase ) {
cfg , err := NewConfigProviderFromData ( iniStr )
assert . NoError ( t , err )
AppDataPath = appDataPath
for _ , c := range cases {
assert . NoError ( t , c . loader ( cfg ) )
storage := * c . storagePtr
assert . EqualValues ( t , "local" , storage . Type )
assert . True ( t , filepath . IsAbs ( storage . Path ) )
assert . EqualValues ( t , filepath . Clean ( c . expectedPath ) , filepath . Clean ( storage . Path ) )
}
}
func Test_getStorageInheritStorageTypeLocal ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/appdata/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/repo-archive" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalPath ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
PATH = / data / gitea
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/data/gitea/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/data/gitea/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/data/gitea/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/data/gitea/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/repo-archive" } ,
{ loadActionsFrom , & Actions . LogStorage , "/data/gitea/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/data/gitea/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/data/gitea/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalRelativePath ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
PATH = storages
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/storages/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/storages/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/storages/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/appdata/storages/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/storages/repo-archive" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/storages/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/storages/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/storages/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalPathOverride ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
PATH = / data / gitea
[ repo - archive ]
PATH = / data / gitea / the - archives - dir
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/data/gitea/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/data/gitea/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/data/gitea/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/data/gitea/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/the-archives-dir" } ,
{ loadActionsFrom , & Actions . LogStorage , "/data/gitea/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/data/gitea/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/data/gitea/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalPathOverrideEmpty ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
PATH = / data / gitea
[ repo - archive ]
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/data/gitea/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/data/gitea/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/data/gitea/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/data/gitea/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/repo-archive" } ,
{ loadActionsFrom , & Actions . LogStorage , "/data/gitea/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/data/gitea/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/data/gitea/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalRelativePathOverride ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage ]
STORAGE_TYPE = local
PATH = / data / gitea
[ repo - archive ]
PATH = the - archives - dir
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/data/gitea/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/data/gitea/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/data/gitea/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/data/gitea/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/the-archives-dir" } ,
{ loadActionsFrom , & Actions . LogStorage , "/data/gitea/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/data/gitea/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/data/gitea/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalPathOverride3 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
STORAGE_TYPE = local
PATH = / data / gitea / archives
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/appdata/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/archives" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/repo-avatars" } ,
} )
}
2023-08-13 23:09:25 +03:00
func Test_getStorageInheritStorageTypeLocalPathOverride3_5 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
STORAGE_TYPE = local
PATH = a - relative - path
` , [ ] testLocalStoragePathCase {
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/actions_artifacts" } ,
{ loadPackagesFrom , & Packages . Storage , "/appdata/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/a-relative-path" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/repo-avatars" } ,
} )
}
2023-08-04 06:41:16 +03:00
func Test_getStorageInheritStorageTypeLocalPathOverride4 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
STORAGE_TYPE = local
PATH = / data / gitea / archives
[ repo - archive ]
PATH = / tmp / gitea / archives
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/appdata/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/tmp/gitea/archives" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/repo-avatars" } ,
} )
}
func Test_getStorageInheritStorageTypeLocalPathOverride5 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
STORAGE_TYPE = local
PATH = / data / gitea / archives
[ repo - archive ]
` , [ ] testLocalStoragePathCase {
2023-08-13 23:09:25 +03:00
{ loadAttachmentFrom , & Attachment . Storage , "/appdata/attachments" } ,
{ loadLFSFrom , & LFS . Storage , "/appdata/lfs" } ,
{ loadActionsFrom , & Actions . ArtifactStorage , "/appdata/actions_artifacts" } ,
2023-08-04 06:41:16 +03:00
{ loadPackagesFrom , & Packages . Storage , "/appdata/packages" } ,
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/data/gitea/archives" } ,
{ loadActionsFrom , & Actions . LogStorage , "/appdata/actions_log" } ,
{ loadAvatarsFrom , & Avatar . Storage , "/appdata/avatars" } ,
{ loadRepoAvatarFrom , & RepoAvatar . Storage , "/appdata/repo-avatars" } ,
} )
}
2023-08-13 23:09:25 +03:00
func Test_getStorageInheritStorageTypeLocalPathOverride72 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ repo - archive ]
STORAGE_TYPE = local
PATH = archives
` , [ ] testLocalStoragePathCase {
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/archives" } ,
} )
}
func Test_getStorageConfiguration20 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = my_storage
PATH = archives
` )
assert . NoError ( t , err )
assert . Error ( t , loadRepoArchiveFrom ( cfg ) )
}
func Test_getStorageConfiguration21 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
` , [ ] testLocalStoragePathCase {
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/repo-archive" } ,
} )
}
func Test_getStorageConfiguration22 ( t * testing . T ) {
testLocalStoragePath ( t , "/appdata" , `
[ storage . repo - archive ]
PATH = archives
` , [ ] testLocalStoragePathCase {
{ loadRepoArchiveFrom , & RepoArchive . Storage , "/appdata/archives" } ,
} )
}
func Test_getStorageConfiguration23 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
` )
assert . NoError ( t , err )
_ , err = getStorage ( cfg , "" , "" , nil )
assert . Error ( t , err )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
cp := RepoArchive . Storage . ToShadowCopy ( )
assert . EqualValues ( t , "******" , cp . MinioConfig . AccessKeyID )
assert . EqualValues ( t , "******" , cp . MinioConfig . SecretAccessKey )
}
func Test_getStorageConfiguration24 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = my_archive
[ storage . my_archive ]
; unsupported , storage type should be defined explicitly
PATH = archives
` )
assert . NoError ( t , err )
assert . Error ( t , loadRepoArchiveFrom ( cfg ) )
}
func Test_getStorageConfiguration25 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = my_archive
[ storage . my_archive ]
; unsupported , storage type should be known type
STORAGE_TYPE = unknown // should be local or minio
PATH = archives
` )
assert . NoError ( t , err )
assert . Error ( t , loadRepoArchiveFrom ( cfg ) )
}
func Test_getStorageConfiguration26 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
; wrong configuration
MINIO_USE_SSL = abc
` )
assert . NoError ( t , err )
// assert.Error(t, loadRepoArchiveFrom(cfg))
// FIXME: this should return error but now ini package's MapTo() doesn't check type
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
}
func Test_getStorageConfiguration27 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ storage . repo - archive ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
MINIO_USE_SSL = true
` )
assert . NoError ( t , err )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "my_access_key" , RepoArchive . Storage . MinioConfig . AccessKeyID )
assert . EqualValues ( t , "my_secret_key" , RepoArchive . Storage . MinioConfig . SecretAccessKey )
assert . EqualValues ( t , true , RepoArchive . Storage . MinioConfig . UseSSL )
assert . EqualValues ( t , "repo-archive/" , RepoArchive . Storage . MinioConfig . BasePath )
}
2023-11-01 14:17:18 +03:00
func Test_getStorageConfiguration28 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
MINIO_USE_SSL = true
MINIO_BASE_PATH = / prefix
` )
assert . NoError ( t , err )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "my_access_key" , RepoArchive . Storage . MinioConfig . AccessKeyID )
assert . EqualValues ( t , "my_secret_key" , RepoArchive . Storage . MinioConfig . SecretAccessKey )
assert . EqualValues ( t , true , RepoArchive . Storage . MinioConfig . UseSSL )
assert . EqualValues ( t , "/prefix/repo-archive/" , RepoArchive . Storage . MinioConfig . BasePath )
cfg , err = NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
MINIO_USE_SSL = true
MINIO_BASE_PATH = / prefix
[ lfs ]
MINIO_BASE_PATH = / lfs
` )
assert . NoError ( t , err )
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "my_access_key" , LFS . Storage . MinioConfig . AccessKeyID )
assert . EqualValues ( t , "my_secret_key" , LFS . Storage . MinioConfig . SecretAccessKey )
assert . EqualValues ( t , true , LFS . Storage . MinioConfig . UseSSL )
assert . EqualValues ( t , "/lfs" , LFS . Storage . MinioConfig . BasePath )
cfg , err = NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = minio
MINIO_ACCESS_KEY_ID = my_access_key
MINIO_SECRET_ACCESS_KEY = my_secret_key
MINIO_USE_SSL = true
MINIO_BASE_PATH = / prefix
[ storage . lfs ]
MINIO_BASE_PATH = / lfs
` )
assert . NoError ( t , err )
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "my_access_key" , LFS . Storage . MinioConfig . AccessKeyID )
assert . EqualValues ( t , "my_secret_key" , LFS . Storage . MinioConfig . SecretAccessKey )
assert . EqualValues ( t , true , LFS . Storage . MinioConfig . UseSSL )
assert . EqualValues ( t , "/lfs" , LFS . Storage . MinioConfig . BasePath )
}
2024-05-30 10:33:50 +03:00
func Test_getStorageConfiguration29 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ repo - archive ]
STORAGE_TYPE = azureblob
AZURE_BLOB_ACCOUNT_NAME = my_account_name
AZURE_BLOB_ACCOUNT_KEY = my_account_key
` )
assert . NoError ( t , err )
// assert.Error(t, loadRepoArchiveFrom(cfg))
// FIXME: this should return error but now ini package's MapTo() doesn't check type
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
}
func Test_getStorageConfiguration30 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ storage . repo - archive ]
STORAGE_TYPE = azureblob
AZURE_BLOB_ACCOUNT_NAME = my_account_name
AZURE_BLOB_ACCOUNT_KEY = my_account_key
` )
assert . NoError ( t , err )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "my_account_name" , RepoArchive . Storage . AzureBlobConfig . AccountName )
assert . EqualValues ( t , "my_account_key" , RepoArchive . Storage . AzureBlobConfig . AccountKey )
assert . EqualValues ( t , "repo-archive/" , RepoArchive . Storage . AzureBlobConfig . BasePath )
}
func Test_getStorageConfiguration31 ( t * testing . T ) {
cfg , err := NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = azureblob
AZURE_BLOB_ACCOUNT_NAME = my_account_name
AZURE_BLOB_ACCOUNT_KEY = my_account_key
AZURE_BLOB_BASE_PATH = / prefix
` )
assert . NoError ( t , err )
assert . NoError ( t , loadRepoArchiveFrom ( cfg ) )
assert . EqualValues ( t , "my_account_name" , RepoArchive . Storage . AzureBlobConfig . AccountName )
assert . EqualValues ( t , "my_account_key" , RepoArchive . Storage . AzureBlobConfig . AccountKey )
assert . EqualValues ( t , "/prefix/repo-archive/" , RepoArchive . Storage . AzureBlobConfig . BasePath )
cfg , err = NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = azureblob
AZURE_BLOB_ACCOUNT_NAME = my_account_name
AZURE_BLOB_ACCOUNT_KEY = my_account_key
AZURE_BLOB_BASE_PATH = / prefix
[ lfs ]
AZURE_BLOB_BASE_PATH = / lfs
` )
assert . NoError ( t , err )
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "my_account_name" , LFS . Storage . AzureBlobConfig . AccountName )
assert . EqualValues ( t , "my_account_key" , LFS . Storage . AzureBlobConfig . AccountKey )
assert . EqualValues ( t , "/lfs" , LFS . Storage . AzureBlobConfig . BasePath )
cfg , err = NewConfigProviderFromData ( `
[ storage ]
STORAGE_TYPE = azureblob
AZURE_BLOB_ACCOUNT_NAME = my_account_name
AZURE_BLOB_ACCOUNT_KEY = my_account_key
AZURE_BLOB_BASE_PATH = / prefix
[ storage . lfs ]
AZURE_BLOB_BASE_PATH = / lfs
` )
assert . NoError ( t , err )
assert . NoError ( t , loadLFSFrom ( cfg ) )
assert . EqualValues ( t , "my_account_name" , LFS . Storage . AzureBlobConfig . AccountName )
assert . EqualValues ( t , "my_account_key" , LFS . Storage . AzureBlobConfig . AccountKey )
assert . EqualValues ( t , "/lfs" , LFS . Storage . AzureBlobConfig . BasePath )
}
