extern/gatus
1
0
Fork 0
mirror of https://github.com/TwiN/gatus.git synced 2025-04-09 18:40:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename storage type inmemory to memory

Browse Source 
This is technically a breaking change, but given how long ago this field was implemented as well as the fact that this is the default value if the type is not specified, I doubt anybody's explicitly setting it as inmemory
This commit is contained in:
TwinProduction 2021-08-07 12:11:35 -04:00
parent 4ada6ee7c9
commit 3cbe068fc1
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -229,10 +229,10 @@ Here are some examples of conditions you can use:
| Parameter | Description | Default | | Parameter | Description | Default |
|:------------------ |:-------------------------------------------------------------------------------------- |:-------------- | |:------------------ |:-------------------------------------------------------------------------------------- |:-------------- |
| `storage` | Storage configuration | `{}` | | `storage` | Storage configuration | `{}` |
| `storage.file` | File to persist the data in. If the type is `inmemory`, data is persisted on interval. | `""` | | `storage.file` | File to persist the data in. If the type is `memory`, data is persisted on interval. | `""` |
| `storage.type` | Type of storage. Valid types: `inmemory`, `sqlite`. | `"inmemory"` | | `storage.type` | Type of storage. Valid types: `memory`, `sqlite`. | `"memory"` |
- If `storage.type` is `inmemory` (default) and `storage.file` is set to a non-blank value. - If `storage.type` is `memory` (default) and `storage.file` is set to a non-blank value.
Furthermore, the data is periodically persisted, but everything remains in memory. Furthermore, the data is periodically persisted, but everything remains in memory.
- If `storage.type` is `sqlite`, `storage.file` must not be blank. - If `storage.type` is `sqlite`, `storage.file` must not be blank.
```yaml ```yaml

2
config/config.go
View File

@ -177,7 +177,7 @@ func parseAndValidateConfigBytes(yamlBytes []byte) (config *Config, err error) {
func validateStorageConfig(config *Config) error { func validateStorageConfig(config *Config) error {
if config.Storage == nil { if config.Storage == nil {
config.Storage = &storage.Config{ config.Storage = &storage.Config{
Type: storage.TypeInMemory, Type: storage.TypeMemory,
} }
} }
err := storage.Initialize(config.Storage) err := storage.Initialize(config.Storage)

2
storage/storage.go
View File

@ -57,7 +57,7 @@ func Initialize(cfg *Config) error {
if err != nil { if err != nil {
return err return err
} }
case TypeInMemory: case TypeMemory:
fallthrough fallthrough
default: default:
if len(cfg.File) > 0 { if len(cfg.File) > 0 {

8
storage/storage_test.go
View File

@ -32,13 +32,13 @@ func TestInitialize(t *testing.T) {
ExpectedErr: nil, ExpectedErr: nil,
}, },
{ {
Name: "inmemory-no-file", Name: "memory-no-file",
Cfg: &Config{Type: TypeInMemory}, Cfg: &Config{Type: TypeMemory},
ExpectedErr: nil, ExpectedErr: nil,
}, },
{ {
Name: "inmemory-with-file", Name: "memory-with-file",
Cfg: &Config{Type: TypeInMemory, File: t.TempDir() + "/TestInitialize_inmemory-with-file.db"}, Cfg: &Config{Type: TypeMemory, File: t.TempDir() + "/TestInitialize_memory-with-file.db"},
ExpectedErr: nil, ExpectedErr: nil,
}, },
{ {

2
storage/type.go
View File

@ -4,6 +4,6 @@ package storage
type Type string type Type string
const ( const (
TypeInMemory Type = "inmemory" // In-memory store TypeMemory Type = "memory" // In-memory store
TypeSQLite Type = "sqlite" // SQLite store TypeSQLite Type = "sqlite" // SQLite store
) )