rkrtechnology/litestream
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename 'gcs' to 'gs' for consistency

Browse Source
This commit is contained in:
Ben Johnson
2022-03-05 11:12:29 -07:00
parent 8ee5fcb591
commit 07d220028a
7 changed files with 36 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/integration_test.yml vendored
View File

@@ -52,10 +52,10 @@ jobs:
env: env:
GOOGLE_APPLICATION_CREDENTIALS: ${{secrets.GOOGLE_APPLICATION_CREDENTIALS}} GOOGLE_APPLICATION_CREDENTIALS: ${{secrets.GOOGLE_APPLICATION_CREDENTIALS}}
- run: go test -v -run=TestReplicaClient ./integration -replica-type gcs - run: go test -v -run=TestReplicaClient ./integration -replica-type gs
env: env:
GOOGLE_APPLICATION_CREDENTIALS: /opt/gcp.json GOOGLE_APPLICATION_CREDENTIALS: /opt/gcp.json
LITESTREAM_GCS_BUCKET: integration.litestream.io LITESTREAM_GS_BUCKET: integration.litestream.io
abs-integration-test: abs-integration-test:
name: Run Azure Blob Store Integration Tests name: Run Azure Blob Store Integration Tests

18
cmd/litestream/main.go
View File

@@ -22,7 +22,7 @@ import (
"github.com/benbjohnson/litestream" "github.com/benbjohnson/litestream"
"github.com/benbjohnson/litestream/abs" "github.com/benbjohnson/litestream/abs"
"github.com/benbjohnson/litestream/gcs" "github.com/benbjohnson/litestream/gs"
"github.com/benbjohnson/litestream/http" "github.com/benbjohnson/litestream/http"
"github.com/benbjohnson/litestream/s3" "github.com/benbjohnson/litestream/s3"
"github.com/benbjohnson/litestream/sftp" "github.com/benbjohnson/litestream/sftp"
@@ -396,8 +396,8 @@ func NewReplicaFromConfig(c *ReplicaConfig, db *litestream.DB) (_ *litestream.Re
if client, err = newS3ReplicaClientFromConfig(c); err != nil { if client, err = newS3ReplicaClientFromConfig(c); err != nil {
return nil, err return nil, err
} }
case "gcs": case "gs":
if client, err = newGCSReplicaClientFromConfig(c); err != nil { if client, err = newGSReplicaClientFromConfig(c); err != nil {
return nil, err return nil, err
} }
case "abs": case "abs":
@@ -525,13 +525,13 @@ func newS3ReplicaClientFromConfig(c *ReplicaConfig) (_ *s3.ReplicaClient, err er
return client, nil return client, nil
} }
// newGCSReplicaClientFromConfig returns a new instance of gcs.ReplicaClient built from config. // newGSReplicaClientFromConfig returns a new instance of gs.ReplicaClient built from config.
func newGCSReplicaClientFromConfig(c *ReplicaConfig) (_ *gcs.ReplicaClient, err error) { func newGSReplicaClientFromConfig(c *ReplicaConfig) (_ *gs.ReplicaClient, err error) {
// Ensure URL & constituent parts are not both specified. // Ensure URL & constituent parts are not both specified.
if c.URL != "" && c.Path != "" { if c.URL != "" && c.Path != "" {
return nil, fmt.Errorf("cannot specify url & path for gcs replica") return nil, fmt.Errorf("cannot specify url & path for gs replica")
} else if c.URL != "" && c.Bucket != "" { } else if c.URL != "" && c.Bucket != "" {
return nil, fmt.Errorf("cannot specify url & bucket for gcs replica") return nil, fmt.Errorf("cannot specify url & bucket for gs replica")
} }
bucket, path := c.Bucket, c.Path bucket, path := c.Bucket, c.Path
@@ -554,11 +554,11 @@ func newGCSReplicaClientFromConfig(c *ReplicaConfig) (_ *gcs.ReplicaClient, err
// Ensure required settings are set. // Ensure required settings are set.
if bucket == "" { if bucket == "" {
return nil, fmt.Errorf("bucket required for gcs replica") return nil, fmt.Errorf("bucket required for gs replica")
} }
// Build replica. // Build replica.
client := gcs.NewReplicaClient() client := gs.NewReplicaClient()
client.Bucket = bucket client.Bucket = bucket
client.Path = path client.Path = path
return client, nil return client, nil

8
cmd/litestream/main_test.go
View File

@@ -11,7 +11,7 @@ import (
"github.com/benbjohnson/litestream" "github.com/benbjohnson/litestream"
main "github.com/benbjohnson/litestream/cmd/litestream" main "github.com/benbjohnson/litestream/cmd/litestream"
"github.com/benbjohnson/litestream/gcs" "github.com/benbjohnson/litestream/gs"
"github.com/benbjohnson/litestream/s3" "github.com/benbjohnson/litestream/s3"
) )
@@ -170,11 +170,11 @@ func TestNewS3ReplicaFromConfig(t *testing.T) {
}) })
} }
func TestNewGCSReplicaFromConfig(t *testing.T) { func TestNewGSReplicaFromConfig(t *testing.T) {
r, err := main.NewReplicaFromConfig(&main.ReplicaConfig{URL: "gcs://foo/bar"}, nil) r, err := main.NewReplicaFromConfig(&main.ReplicaConfig{URL: "gs://foo/bar"}, nil)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
} else if client, ok := r.Client().(*gcs.ReplicaClient); !ok { } else if client, ok := r.Client().(*gs.ReplicaClient); !ok {
t.Fatal("unexpected replica type") t.Fatal("unexpected replica type")
} else if got, want := client.Bucket, "foo"; got != want { } else if got, want := client.Bucket, "foo"; got != want {
t.Fatalf("Bucket=%s, want %s", got, want) t.Fatalf("Bucket=%s, want %s", got, want)

4
cmd/litestream/replicate.go
View File

@@ -11,7 +11,7 @@ import (
"github.com/benbjohnson/litestream" "github.com/benbjohnson/litestream"
"github.com/benbjohnson/litestream/abs" "github.com/benbjohnson/litestream/abs"
"github.com/benbjohnson/litestream/gcs" "github.com/benbjohnson/litestream/gs"
"github.com/benbjohnson/litestream/http" "github.com/benbjohnson/litestream/http"
"github.com/benbjohnson/litestream/s3" "github.com/benbjohnson/litestream/s3"
"github.com/benbjohnson/litestream/sftp" "github.com/benbjohnson/litestream/sftp"
@@ -133,7 +133,7 @@ func (c *ReplicateCommand) Run(ctx context.Context) (err error) {
log.Printf("replicating to: name=%q type=%q path=%q", r.Name(), client.Type(), client.Path()) log.Printf("replicating to: name=%q type=%q path=%q", r.Name(), client.Type(), client.Path())
case *s3.ReplicaClient: case *s3.ReplicaClient:
log.Printf("replicating to: name=%q type=%q bucket=%q path=%q region=%q endpoint=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, client.Region, client.Endpoint, r.SyncInterval) log.Printf("replicating to: name=%q type=%q bucket=%q path=%q region=%q endpoint=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, client.Region, client.Endpoint, r.SyncInterval)
case *gcs.ReplicaClient: case *gs.ReplicaClient:
log.Printf("replicating to: name=%q type=%q bucket=%q path=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, r.SyncInterval) log.Printf("replicating to: name=%q type=%q bucket=%q path=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, r.SyncInterval)
case *abs.ReplicaClient: case *abs.ReplicaClient:
log.Printf("replicating to: name=%q type=%q bucket=%q path=%q endpoint=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, client.Endpoint, r.SyncInterval) log.Printf("replicating to: name=%q type=%q bucket=%q path=%q endpoint=%q sync-interval=%s", r.Name(), client.Type(), client.Bucket, client.Path, client.Endpoint, r.SyncInterval)

14
gcs/replica_client.go → gs/replica_client.go
View File

@@ -1,4 +1,4 @@
package gcs package gs
import ( import (
"context" "context"
@@ -17,17 +17,17 @@ import (
) )
// ReplicaClientType is the client type for this package. // ReplicaClientType is the client type for this package.
const ReplicaClientType = "gcs" const ReplicaClientType = "gs"
var _ litestream.ReplicaClient = (*ReplicaClient)(nil) var _ litestream.ReplicaClient = (*ReplicaClient)(nil)
// ReplicaClient is a client for writing snapshots & WAL segments to disk. // ReplicaClient is a client for writing snapshots & WAL segments to disk.
type ReplicaClient struct { type ReplicaClient struct {
mu sync.Mutex mu sync.Mutex
client *storage.Client // gcs client client *storage.Client // gs client
bkt *storage.BucketHandle // gcs bucket handle bkt *storage.BucketHandle // gs bucket handle
// GCS bucket information // GS bucket information
Bucket string Bucket string
Path string Path string
} }
@@ -37,12 +37,12 @@ func NewReplicaClient() *ReplicaClient {
return &ReplicaClient{} return &ReplicaClient{}
} }
// Type returns "gcs" as the client type. // Type returns "gs" as the client type.
func (c *ReplicaClient) Type() string { func (c *ReplicaClient) Type() string {
return ReplicaClientType return ReplicaClientType
} }
// Init initializes the connection to GCS. No-op if already initialized. // Init initializes the connection to GS. No-op if already initialized.
func (c *ReplicaClient) Init(ctx context.Context) (err error) { func (c *ReplicaClient) Init(ctx context.Context) (err error) {
c.mu.Lock() c.mu.Lock()
defer c.mu.Unlock() defer c.mu.Unlock()

20
integration/replica_client_test.go
View File

@@ -16,7 +16,7 @@ import (
"github.com/benbjohnson/litestream" "github.com/benbjohnson/litestream"
"github.com/benbjohnson/litestream/abs" "github.com/benbjohnson/litestream/abs"
"github.com/benbjohnson/litestream/gcs" "github.com/benbjohnson/litestream/gs"
"github.com/benbjohnson/litestream/s3" "github.com/benbjohnson/litestream/s3"
"github.com/benbjohnson/litestream/sftp" "github.com/benbjohnson/litestream/sftp"
) )
@@ -45,8 +45,8 @@ var (
// Google cloud storage settings // Google cloud storage settings
var ( var (
gcsBucket = flag.String("gcs-bucket", os.Getenv("LITESTREAM_GCS_BUCKET"), "") gsBucket = flag.String("gs-bucket", os.Getenv("LITESTREAM_GS_BUCKET"), "")
gcsPath = flag.String("gcs-path", os.Getenv("LITESTREAM_GCS_PATH"), "") gsPath = flag.String("gs-path", os.Getenv("LITESTREAM_GS_PATH"), "")
) )
// Azure blob storage settings // Azure blob storage settings
@@ -480,8 +480,8 @@ func NewReplicaClient(tb testing.TB, typ string) litestream.ReplicaClient {
return litestream.NewFileReplicaClient(tb.TempDir()) return litestream.NewFileReplicaClient(tb.TempDir())
case s3.ReplicaClientType: case s3.ReplicaClientType:
return NewS3ReplicaClient(tb) return NewS3ReplicaClient(tb)
case gcs.ReplicaClientType: case gs.ReplicaClientType:
return NewGCSReplicaClient(tb) return NewGSReplicaClient(tb)
case abs.ReplicaClientType: case abs.ReplicaClientType:
return NewABSReplicaClient(tb) return NewABSReplicaClient(tb)
case sftp.ReplicaClientType: case sftp.ReplicaClientType:
@@ -508,13 +508,13 @@ func NewS3ReplicaClient(tb testing.TB) *s3.ReplicaClient {
return c return c
} }
// NewGCSReplicaClient returns a new client for integration testing. // NewGSReplicaClient returns a new client for integration testing.
func NewGCSReplicaClient(tb testing.TB) *gcs.ReplicaClient { func NewGSReplicaClient(tb testing.TB) *gs.ReplicaClient {
tb.Helper() tb.Helper()
c := gcs.NewReplicaClient() c := gs.NewReplicaClient()
c.Bucket = *gcsBucket c.Bucket = *gsBucket
c.Path = path.Join(*gcsPath, fmt.Sprintf("%016x", rand.Uint64())) c.Path = path.Join(*gsPath, fmt.Sprintf("%016x", rand.Uint64()))
return c return c
} }

4
sftp/replica_client.go
View File

@@ -52,12 +52,12 @@ func NewReplicaClient() *ReplicaClient {
} }
} }
// Type returns "gcs" as the client type. // Type returns "sftp" as the client type.
func (c *ReplicaClient) Type() string { func (c *ReplicaClient) Type() string {
return ReplicaClientType return ReplicaClientType
} }
// Init initializes the connection to GCS. No-op if already initialized. // Init initializes the connection to SFTP. No-op if already initialized.
func (c *ReplicaClient) Init(ctx context.Context) (_ *sftp.Client, err error) { func (c *ReplicaClient) Init(ctx context.Context) (_ *sftp.Client, err error) {
c.mu.Lock() c.mu.Lock()
defer c.mu.Unlock() defer c.mu.Unlock()