primal/athens
1
0
Fork 0
mirror of https://github.com/gomods/athens synced 2026-02-03 11:00:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove storage connector (#457)

Browse Source 
* get rid of fake storage.Connector

* get rid of the storage.Connector for mango & rdbms

* Remove all the connector interfaces

* Updating all the test to get rid of the connect

* Updating connection to storage for proxy

* Updating connection to storage for olympus

* get rid of fake storage.Connector

* get rid of the storage.Connector for mango & rdbms

* Remove all the connector interfaces

* Updating all the test to get rid of the connect

* Updating connection to storage for proxy

* Updating connection to storage for olympus

* Fix reviews

* Fix reviews

* fixing op Name

* fix replace the check of an error insted of the object exists

* Fix error message in the test
This commit is contained in:
kteb
2018-08-15 17:51:10 +01:00
committed by Rob j Loranger
parent 889de448dc
commit cdab5c515c
15 changed files with 57 additions and 114 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/olympus/actions/storage.go
+5 -5
View File
@@ -12,8 +12,8 @@ import (
"github.com/spf13/afero"
)
// GetStorage returns storage.BackendConnector implementation
func GetStorage() (storage.BackendConnector, error) {
// GetStorage returns storage.Backend implementation
func GetStorage() (storage.Backend, error) {
storageType := env.StorageTypeWithDefault("memory")
switch storageType {
case "memory":
@@ -27,19 +27,19 @@ func GetStorage() (storage.BackendConnector, error) {
if err != nil {
return nil, fmt.Errorf("could not create new storage from os fs (%s)", err)
}
return storage.NoOpBackendConnector(s), nil
return s, nil
case "mongo":
mongoURI, err := env.MongoURI()
if err != nil {
return nil, err
}
return mongo.NewStorage(mongoURI), nil
return mongo.NewStorage(mongoURI)
case "postgres", "sqlite", "cockroach", "mysql":
connectionName, err := env.RdbmsName()
if err != nil {
return nil, err
}
return rdbms.NewRDBMSStorage(connectionName), nil
return rdbms.NewRDBMSStorage(connectionName)
default:
return nil, fmt.Errorf("storage type %s is unknown", storageType)
}
cmd/olympus/main.go
-3
View File
@@ -48,8 +48,5 @@ func getStorage() (storage.Backend, error) {
if err != nil {
return nil, fmt.Errorf("error creating storage (%s)", err)
}
if err := storage.Connect(); err != nil {
return nil, fmt.Errorf("unable to connect to backing store: %v", err)
}
return storage, nil
}
cmd/proxy/actions/app.go
-4
View File
@@ -66,10 +66,6 @@ func App() (*buffalo.App, error) {
err = fmt.Errorf("error getting storage configuration (%s)", err)
return nil, err
}
if err := store.Connect(); err != nil {
err = fmt.Errorf("error connecting to storage (%s)", err)
return nil, err
}
worker, err := getWorker(ctx, store, mf)
if err != nil {
cmd/proxy/actions/storage.go
+5 -6
View File
@@ -17,7 +17,7 @@ import (
)
// GetStorage returns storage backend based on env configuration
func GetStorage() (storage.BackendConnector, error) {
func GetStorage() (storage.Backend, error) {
storageType := env.StorageTypeWithDefault("memory")
var storageRoot string
var err error
@@ -30,7 +30,7 @@ func GetStorage() (storage.BackendConnector, error) {
if err != nil {
return nil, err
}
return mongo.NewStorage(storageRoot), nil
return mongo.NewStorage(storageRoot)
case "disk":
storageRoot, err = env.DiskRoot()
if err != nil {
@@ -40,13 +40,13 @@ func GetStorage() (storage.BackendConnector, error) {
if err != nil {
return nil, fmt.Errorf("could not create new storage from os fs (%s)", err)
}
return storage.NoOpBackendConnector(s), nil
return s, nil
case "postgres", "sqlite", "cockroach", "mysql":
storageRoot, err = env.RdbmsName()
if err != nil {
return nil, err
}
return rdbms.NewRDBMSStorage(storageRoot), nil
return rdbms.NewRDBMSStorage(storageRoot)
case "minio":
endpoint, err := env.MinioEndpoint()
if err != nil {
@@ -65,8 +65,7 @@ func GetStorage() (storage.BackendConnector, error) {
if useSSLVar := env.MinioSSLWithDefault("yes"); strings.ToLower(useSSLVar) == "no" {
useSSL = false
}
s, err := minio.NewStorage(endpoint, accessKeyID, secretAccessKey, bucketName, useSSL)
return storage.NoOpBackendConnector(s), err
return minio.NewStorage(endpoint, accessKeyID, secretAccessKey, bucketName, useSSL)
case "gcp":
return gcp.New(context.Background())
default:
pkg/storage/backendconnector.go
-48
View File
@@ -1,48 +0,0 @@
package storage
import (
"context"
"io"
)
// BackendConnector is a regular storage backend with Connect functionality
type BackendConnector interface {
Backend
Connect() error
}
type noOpConnectedBackend struct {
backend Backend
}
// NoOpBackendConnector wraps storage backend with Connect functionality
func NoOpBackendConnector(b Backend) BackendConnector {
return noOpConnectedBackend{backend: b}
}
func (n noOpConnectedBackend) Connect() error {
return nil
}
func (n noOpConnectedBackend) Exists(ctx context.Context, module, version string) bool {
return n.backend.Exists(ctx, module, version)
}
func (n noOpConnectedBackend) Info(ctx context.Context, module, vsn string) ([]byte, error) {
return n.backend.Info(ctx, module, vsn)
}
func (n noOpConnectedBackend) GoMod(ctx context.Context, module, vsn string) ([]byte, error) {
return n.backend.GoMod(ctx, module, vsn)
}
func (n noOpConnectedBackend) Zip(ctx context.Context, module, vsn string) (io.ReadCloser, error) {
return n.backend.Zip(ctx, module, vsn)
}
func (n noOpConnectedBackend) List(ctx context.Context, module string) ([]string, error) {
return n.backend.List(ctx, module)
}
func (n noOpConnectedBackend) Save(ctx context.Context, module, version string, mod []byte, zip io.Reader, info []byte) error {
return n.backend.Save(ctx, module, version, mod, zip, info)
}
func (n noOpConnectedBackend) Delete(ctx context.Context, module, version string) error {
return n.backend.Delete(ctx, module, version)
}
pkg/storage/connector.go
-7
View File
@@ -1,7 +0,0 @@
package storage
// Connector connects storage to its backing engine
type Connector interface {
// Connect connects storage to its backing engine
Connect() error
}
pkg/storage/gcp/gcp.go
-5
View File
@@ -88,8 +88,3 @@ func (s *Storage) BaseURL() *url.URL {
func (s *Storage) Close() error {
return s.closeStorage()
}
// Connect is noop.
func (s *Storage) Connect() error {
return nil
}
pkg/storage/mem/mem.go
+3 -4
View File
@@ -12,11 +12,11 @@ import (
var (
l sync.Mutex
memStorage storage.BackendConnector
memStorage storage.Backend
)
// NewStorage creates new in-memory storage using the afero.NewMemMapFs() in memory file system
func NewStorage() (storage.BackendConnector, error) {
func NewStorage() (storage.Backend, error) {
const op errors.Op = "mem.NewStorage"
l.Lock()
defer l.Unlock()
@@ -35,6 +35,5 @@ func NewStorage() (storage.BackendConnector, error) {
if err != nil {
return nil, errors.E(op, fmt.Errorf("could not create storage from memory fs (%s)", err))
}
memStorage = storage.NoOpBackendConnector(s)
return memStorage, nil
return s, nil
}
pkg/storage/mongo/all_test.go
+4 -3
View File
@@ -9,12 +9,13 @@ import (
type MongoTests struct {
suite.Suite
storage storage.BackendConnector
storage storage.Backend
}
func (d *MongoTests) SetupTest() {
store := NewStorage("mongodb://127.0.0.1:27017")
store.Connect()
store, err := NewStorage("mongodb://127.0.0.1:27017")
d.NoError(err)
store.s.DB(store.d).C(store.c).RemoveAll(nil)
d.storage = store
pkg/storage/mongo/mongo.go
+15 -8
View File
@@ -16,18 +16,25 @@ type ModuleStore struct {
url string
}
// NewStorage returns an unconnected Mongo backed storage
// that satisfies the Backend interface. You must call
// Connect() on the returned store before using it.
func NewStorage(url string) *ModuleStore {
return &ModuleStore{url: url}
// NewStorage returns a connected Mongo backed storage
// that satisfies the Backend interface.
func NewStorage(url string) (*ModuleStore, error) {
const op errors.Op = "fs.NewStorage"
ms := &ModuleStore{url: url}
err := ms.connect()
if err != nil {
return nil, errors.E(op, err)
}
return ms, nil
}
// Connect conntect the the newly created mongo backend.
func (m *ModuleStore) Connect() error {
const op errors.Op = "mongo.Connect"
func (m *ModuleStore) connect() error {
const op errors.Op = "mongo.connect"
timeout := env.MongoConnectionTimeoutSecWithDefault(1)
s, err := mgo.DialWithTimeout(m.url, timeout)
if err != nil {
return errors.E(op, err)
}
pkg/storage/mongo/mongo_test.go
+2 -2
View File
@@ -3,9 +3,9 @@ package mongo
func (m *MongoTests) TestNewMongoStorage() {
r := m.Require()
url := "mongodb://127.0.0.1:27017"
getterSaver := NewStorage(url)
getterSaver.Connect()
getterSaver, err := NewStorage(url)
r.NoError(err)
r.NotNil(getterSaver.c)
r.NotNil(getterSaver.d)
r.NotNil(getterSaver.s)
pkg/storage/mongo/test_suite.go
+4 -4
View File
@@ -33,12 +33,12 @@ func newTestStore() (*ModuleStore, error) {
return nil, err
}
mongoStore := NewStorage(muri)
if mongoStore == nil {
return nil, fmt.Errorf("Mongo storage is nil")
mongoStore, err := NewStorage(muri)
if err != nil {
return nil, fmt.Errorf("Not able to connect to mongo storage")
}
return mongoStore, mongoStore.Connect()
return mongoStore, nil
}
// Storage retrieves initialized storage backend
pkg/storage/rdbms/all_test.go
+1 -1
View File
@@ -9,7 +9,7 @@ import (
type RDBMSTestSuite struct {
*suite.Model
storage storage.BackendConnector
storage storage.Backend
}
func (rd *RDBMSTestSuite) SetupTest() {
pkg/storage/rdbms/rdbms.go
+16 -12
View File
@@ -2,6 +2,7 @@ package rdbms
import (
"github.com/gobuffalo/pop"
"github.com/gomods/athens/pkg/errors"
)
// ModuleStore represents a rdbms(postgres, mysql, sqlite, cockroachdb) backed storage backend.
@@ -10,28 +11,31 @@ type ModuleStore struct {
connectionName string // settings name from database.yml
}
// NewRDBMSStorage returns an unconnected RDBMS Module Storage
// that satisfies the Storage interface. You must call
// Connect() on the returned store before using it.
// connectionName
func NewRDBMSStorage(connectionName string) *ModuleStore {
return &ModuleStore{
// NewRDBMSStorage returns a connected RDBMS Module Storage
// that satisfies the Storage interface.
func NewRDBMSStorage(connectionName string) (*ModuleStore, error) {
const op errors.Op = "rdbms.NewRDBMSStorage"
ms := &ModuleStore{
connectionName: connectionName,
}
err := ms.connect()
if err != nil {
return nil, errors.E(op, err)
}
return ms, nil
}
// NewRDBMSStorageWithConn returns a connected RDBMS Module Storage
// that satisfies the Storage interface. You must call
// Connect() on the returned store before using it.
// connectionName
// that satisfies the Storage interface.
func NewRDBMSStorageWithConn(connection *pop.Connection) *ModuleStore {
return &ModuleStore{
ms := &ModuleStore{
conn: connection,
}
return ms
}
// Connect creates connection to rdmbs backend.
func (r *ModuleStore) Connect() error {
func (r *ModuleStore) connect() error {
c, err := pop.Connect(r.connectionName)
if err != nil {
return err
pkg/storage/rdbms/rdbms_test.go
+2 -2
View File
@@ -3,8 +3,8 @@ package rdbms
func (rd *RDBMSTestSuite) TestNewRDBMSStorage() {
r := rd.Require()
e := "development"
getterSaver := NewRDBMSStorage(e)
getterSaver.Connect()
getterSaver, err := NewRDBMSStorage(e)
r.NoError(err)
r.NotNil(getterSaver.conn)
r.Equal(getterSaver.connectionName, e)