Add some linters (#26)

* Testing out ci

Signed-off-by: Marko Baricevic <marbar3778@yahoo.com>

* some linting

* add changelog entry

.golangci.yml

@@ -1,13 +1,46 @@
-run:
-  deadline: 1m
-
 linters:
-  enable-all: true
-  disable:
-    - scopelint
-    - gochecknoinits
-    - unconvert
-    - gochecknoglobals
-    - staticcheck
+  disable-all: true
+  enable:
+    - bodyclose
+    - deadcode
+    - depguard
+    - dogsled
+    - dupl
+    - errcheck
+    # - funlen
+    # - gochecknoglobals
+    # - gochecknoinits
+    - goconst
+    - gocritic
+    # - gocyclo
+    # - godox
+    - gofmt
+    - goimports
     - golint
-    - unparam
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - interfacer
+    - lll
+    - misspell
+    - maligned
+    - nakedret
+    - prealloc
+    # - scopelint
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    # - unparam
+    - unused
+    - varcheck
+    # - whitespace
+    # - wsl
+    # - gocognit
+
+linters-settings:
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true

CHANGELOG_PENDING.md

@@ -6,4 +6,6 @@ Special thanks to external contributors on this release:
 
 ### BREAKING CHANGES
 
+- [\#26](https://github.com/tendermint/tm-db/pull/26/files) Rename `DBBackendtype` to `BackendType`
+
 ### IMPROVEMENTS

backend_test.go

@@ -18,7 +18,7 @@ func cleanupDBDir(dir, name string) {
 	}
 }
 
-func testBackendGetSetDelete(t *testing.T, backend DBBackendType) {
+func testBackendGetSetDelete(t *testing.T, backend BackendType) {
 	// Default
 	dirname, err := ioutil.TempDir("", fmt.Sprintf("test_backend_%s_", backend))
 	require.Nil(t, err)
@@ -163,7 +163,7 @@ func TestDBIterator(t *testing.T) {
 	}
 }
 
-func testDBIterator(t *testing.T, backend DBBackendType) {
+func testDBIterator(t *testing.T, backend BackendType) {
 	name := fmt.Sprintf("test_%x", randStr(12))
 	dir := os.TempDir()
 	db := NewDB(name, backend, dir)

common_test.go

@@ -63,7 +63,7 @@ func checkValuePanics(t *testing.T, itr Iterator) {
 	assert.Panics(t, func() { itr.Value() }, "checkValuePanics expected panic but didn't")
 }
 
-func newTempDB(t *testing.T, backend DBBackendType) (db DB, dbDir string) {
+func newTempDB(t *testing.T, backend BackendType) (db DB, dbDir string) {
 	dirname, err := ioutil.TempDir("", "db_common_test")
 	require.Nil(t, err)
 	return NewDB("testdb", backend, dirname), dirname
@@ -211,8 +211,8 @@ func benchmarkRandomReadsWrites(b *testing.B, db DB) {
 			idx := int64(rand.Int()) % numItems // nolint:gosec testing file, so accepting weak random number generator
 			internal[idx]++
 			val := internal[idx]
-			idxBytes := int642Bytes(int64(idx))
-			valBytes := int642Bytes(int64(val))
+			idxBytes := int642Bytes(idx)
+			valBytes := int642Bytes(val)
 			//fmt.Printf("Set %X -> %X\n", idxBytes, valBytes)
 			db.Set(idxBytes, valBytes)
 		}
@@ -221,7 +221,7 @@ func benchmarkRandomReadsWrites(b *testing.B, db DB) {
 		{
 			idx := int64(rand.Int()) % numItems // nolint:gosec testing file, so accepting weak random number generator
 			valExp := internal[idx]
-			idxBytes := int642Bytes(int64(idx))
+			idxBytes := int642Bytes(idx)
 			valBytes := db.Get(idxBytes)
 			//fmt.Printf("Get %X -> %X\n", idxBytes, valBytes)
 			if valExp == 0 {

db.go

@@ -5,45 +5,45 @@ import (
 	"strings"
 )
 
-type DBBackendType string
+type BackendType string
 
 // These are valid backend types.
 const (
 	// GoLevelDBBackend represents goleveldb (github.com/syndtr/goleveldb - most
 	// popular implementation)
 	//   - pure go
 	//   - stable
-	GoLevelDBBackend DBBackendType = "goleveldb"
+	GoLevelDBBackend BackendType = "goleveldb"
 	// CLevelDBBackend represents cleveldb (uses levigo wrapper)
 	//   - fast
 	//   - requires gcc
 	//   - use cleveldb build tag (go build -tags cleveldb)
-	CLevelDBBackend DBBackendType = "cleveldb"
+	CLevelDBBackend BackendType = "cleveldb"
 	// MemDBBackend represents in-memoty key value store, which is mostly used
 	// for testing.
-	MemDBBackend DBBackendType = "memdb"
+	MemDBBackend BackendType = "memdb"
 	// FSDBBackend represents filesystem database
 	//	 - EXPERIMENTAL
 	//   - slow
-	FSDBBackend DBBackendType = "fsdb"
+	FSDBBackend BackendType = "fsdb"
 	// BoltDBBackend represents bolt (uses etcd's fork of bolt -
 	// github.com/etcd-io/bbolt)
 	//   - EXPERIMENTAL
 	//   - may be faster is some use-cases (random reads - indexer)
 	//   - use boltdb build tag (go build -tags boltdb)
-	BoltDBBackend DBBackendType = "boltdb"
+	BoltDBBackend BackendType = "boltdb"
 	// RocksDBBackend represents rocksdb (uses github.com/tecbot/gorocksdb)
 	//   - EXPERIMENTAL
 	//   - requires gcc
 	//   - use rocksdb build tag (go build -tags rocksdb)
-	RocksDBBackend DBBackendType = "rocksdb"
+	RocksDBBackend BackendType = "rocksdb"
 )
 
 type dbCreator func(name string, dir string) (DB, error)
 
-var backends = map[DBBackendType]dbCreator{}
+var backends = map[BackendType]dbCreator{}
 
-func registerDBCreator(backend DBBackendType, creator dbCreator, force bool) {
+func registerDBCreator(backend BackendType, creator dbCreator, force bool) {
 	_, ok := backends[backend]
 	if !force && ok {
 		return
@@ -55,7 +55,7 @@ func registerDBCreator(backend DBBackendType, creator dbCreator, force bool) {
 // NOTE: function panics if:
 //   - backend is unknown (not registered)
 //   - creator function, provided during registration, returns error
-func NewDB(name string, backend DBBackendType, dir string) DB {
+func NewDB(name string, backend BackendType, dir string) DB {
 	dbCreator, ok := backends[backend]
 	if !ok {
 		keys := make([]string, len(backends))

go_level_db_test.go

@@ -21,11 +21,11 @@ func TestGoLevelDBNewGoLevelDB(t *testing.T) {
 
 	// Test we can open the db twice for reading only
 	ro1, err := NewGoLevelDBWithOpts(name, "", &opt.Options{ReadOnly: true})
-	defer ro1.Close()
 	require.Nil(t, err)
+	defer ro1.Close()
 	ro2, err := NewGoLevelDBWithOpts(name, "", &opt.Options{ReadOnly: true})
-	defer ro2.Close()
 	require.Nil(t, err)
+	defer ro2.Close()
 }
 
 func BenchmarkGoLevelDBRandomReadsWrites(b *testing.B) {

prefix_db.go

@@ -32,27 +32,27 @@ func IteratePrefixStripped(db DB, prefix []byte) Iterator {
 //----------------------------------------
 // prefixDB
 
-type prefixDB struct {
+type PrefixDB struct {
 	mtx    sync.Mutex
 	prefix []byte
 	db     DB
 }
 
 // NewPrefixDB lets you namespace multiple DBs within a single DB.
-func NewPrefixDB(db DB, prefix []byte) *prefixDB {
-	return &prefixDB{
+func NewPrefixDB(db DB, prefix []byte) *PrefixDB {
+	return &PrefixDB{
 		prefix: prefix,
 		db:     db,
 	}
 }
 
 // Implements atomicSetDeleter.
-func (pdb *prefixDB) Mutex() *sync.Mutex {
+func (pdb *PrefixDB) Mutex() *sync.Mutex {
 	return &(pdb.mtx)
 }
 
 // Implements DB.
-func (pdb *prefixDB) Get(key []byte) []byte {
+func (pdb *PrefixDB) Get(key []byte) []byte {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
@@ -62,15 +62,15 @@ func (pdb *prefixDB) Get(key []byte) []byte {
 }
 
 // Implements DB.
-func (pdb *prefixDB) Has(key []byte) bool {
+func (pdb *PrefixDB) Has(key []byte) bool {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
 	return pdb.db.Has(pdb.prefixed(key))
 }
 
 // Implements DB.
-func (pdb *prefixDB) Set(key []byte, value []byte) {
+func (pdb *PrefixDB) Set(key []byte, value []byte) {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
@@ -79,31 +79,31 @@ func (pdb *prefixDB) Set(key []byte, value []byte) {
 }
 
 // Implements DB.
-func (pdb *prefixDB) SetSync(key []byte, value []byte) {
+func (pdb *PrefixDB) SetSync(key []byte, value []byte) {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
 	pdb.db.SetSync(pdb.prefixed(key), value)
 }
 
 // Implements DB.
-func (pdb *prefixDB) Delete(key []byte) {
+func (pdb *PrefixDB) Delete(key []byte) {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
 	pdb.db.Delete(pdb.prefixed(key))
 }
 
 // Implements DB.
-func (pdb *prefixDB) DeleteSync(key []byte) {
+func (pdb *PrefixDB) DeleteSync(key []byte) {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
 	pdb.db.DeleteSync(pdb.prefixed(key))
 }
 
 // Implements DB.
-func (pdb *prefixDB) Iterator(start, end []byte) Iterator {
+func (pdb *PrefixDB) Iterator(start, end []byte) Iterator {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
@@ -126,7 +126,7 @@ func (pdb *prefixDB) Iterator(start, end []byte) Iterator {
 }
 
 // Implements DB.
-func (pdb *prefixDB) ReverseIterator(start, end []byte) Iterator {
+func (pdb *PrefixDB) ReverseIterator(start, end []byte) Iterator {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
@@ -149,7 +149,7 @@ func (pdb *prefixDB) ReverseIterator(start, end []byte) Iterator {
 // Implements DB.
 // Panics if the underlying DB is not an
 // atomicSetDeleter.
-func (pdb *prefixDB) NewBatch() Batch {
+func (pdb *PrefixDB) NewBatch() Batch {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
@@ -158,36 +158,36 @@ func (pdb *prefixDB) NewBatch() Batch {
 
 /* NOTE: Uncomment to use memBatch instead of prefixBatch
 // Implements atomicSetDeleter.
-func (pdb *prefixDB) SetNoLock(key []byte, value []byte) {
+func (pdb *PrefixDB) SetNoLock(key []byte, value []byte) {
 	pdb.db.(atomicSetDeleter).SetNoLock(pdb.prefixed(key), value)
 }
 
 // Implements atomicSetDeleter.
-func (pdb *prefixDB) SetNoLockSync(key []byte, value []byte) {
+func (pdb *PrefixDB) SetNoLockSync(key []byte, value []byte) {
 	pdb.db.(atomicSetDeleter).SetNoLockSync(pdb.prefixed(key), value)
 }
 
 // Implements atomicSetDeleter.
-func (pdb *prefixDB) DeleteNoLock(key []byte) {
+func (pdb *PrefixDB) DeleteNoLock(key []byte) {
 	pdb.db.(atomicSetDeleter).DeleteNoLock(pdb.prefixed(key))
 }
 
 // Implements atomicSetDeleter.
-func (pdb *prefixDB) DeleteNoLockSync(key []byte) {
+func (pdb *PrefixDB) DeleteNoLockSync(key []byte) {
 	pdb.db.(atomicSetDeleter).DeleteNoLockSync(pdb.prefixed(key))
 }
 */
 
 // Implements DB.
-func (pdb *prefixDB) Close() {
+func (pdb *PrefixDB) Close() {
 	pdb.mtx.Lock()
 	defer pdb.mtx.Unlock()
 
 	pdb.db.Close()
 }
 
 // Implements DB.
-func (pdb *prefixDB) Print() {
+func (pdb *PrefixDB) Print() {
 	fmt.Printf("prefix: %X\n", pdb.prefix)
 
 	itr := pdb.Iterator(nil, nil)
@@ -200,7 +200,7 @@ func (pdb *prefixDB) Print() {
 }
 
 // Implements DB.
-func (pdb *prefixDB) Stats() map[string]string {
+func (pdb *PrefixDB) Stats() map[string]string {
 	stats := make(map[string]string)
 	stats["prefixdb.prefix.string"] = string(pdb.prefix)
 	stats["prefixdb.prefix.hex"] = fmt.Sprintf("%X", pdb.prefix)
@@ -211,7 +211,7 @@ func (pdb *prefixDB) Stats() map[string]string {
 	return stats
 }
 
-func (pdb *prefixDB) prefixed(key []byte) []byte {
+func (pdb *PrefixDB) prefixed(key []byte) []byte {
 	return append(cp(pdb.prefix), key...)
 }
 
@@ -275,14 +275,13 @@ func newPrefixIterator(prefix, start, end []byte, source Iterator) *prefixIterat
 			source: source,
 			valid:  false,
 		}
-	} else {
-		return &prefixIterator{
-			prefix: prefix,
-			start:  start,
-			end:    end,
-			source: source,
-			valid:  true,
-		}
+	}
+	return &prefixIterator{
+		prefix: prefix,
+		start:  start,
+		end:    end,
+		source: source,
+		valid:  true,
 	}
 }
 

remotedb/grpcdb/server.go

@@ -58,12 +58,12 @@ var _ protodb.DBServer = (*server)(nil)
 //  * fsdb
 //  * memdB
 //  * leveldb
-// See https://godoc.org/github.com/tendermint/tendermint/libs/db#DBBackendType
+// See https://godoc.org/github.com/tendermint/tendermint/libs/db#BackendType
 func (s *server) Init(ctx context.Context, in *protodb.Init) (*protodb.Entity, error) {
 	s.mu.Lock()
 	defer s.mu.Unlock()
 
-	s.db = db.NewDB(in.Name, db.DBBackendType(in.Type), in.Dir)
+	s.db = db.NewDB(in.Name, db.BackendType(in.Type), in.Dir)
 	return &protodb.Entity{CreatedAt: time.Now().Unix()}, nil
 }