Made a database package and improved tests

agent/agent.go

@@ -3,14 +3,14 @@ package agent
 import (
 	"sync"
 
-	"github.com/observiq/stanza/operator"
+	"github.com/observiq/stanza/database"
 	"github.com/observiq/stanza/pipeline"
 	"go.uber.org/zap"
 )
 
 // LogAgent is an entity that handles log monitoring.
 type LogAgent struct {
-	database operator.Database
+	database database.Database
 	pipeline pipeline.Pipeline
 
 	startOnce sync.Once

agent/builder.go

@@ -1,6 +1,7 @@
 package agent
 
 import (
+	"github.com/observiq/stanza/database"
 	"github.com/observiq/stanza/errors"
 	"github.com/observiq/stanza/operator"
 	"go.uber.org/zap"
@@ -43,7 +44,7 @@ func (b *LogAgentBuilder) WithDefaultOutput(defaultOutput operator.Operator) *Lo
 
 // Build will build a new log agent using the values defined on the builder
 func (b *LogAgentBuilder) Build() (*LogAgent, error) {
-	database, err := operator.OpenDatabase(b.databaseFile)
+	db, err := database.OpenDatabase(b.databaseFile)
 	if err != nil {
 		return nil, errors.Wrap(err, "open database")
 	}
@@ -56,7 +57,7 @@ func (b *LogAgentBuilder) Build() (*LogAgent, error) {
 	buildContext := operator.BuildContext{
 		Logger:         b.logger,
 		PluginRegistry: registry,
-		Database:       database,
+		Database:       db,
 	}
 
 	pipeline, err := b.cfg.Pipeline.BuildPipeline(buildContext, b.defaultOutput)
@@ -66,7 +67,7 @@ func (b *LogAgentBuilder) Build() (*LogAgent, error) {
 
 	return &LogAgent{
 		pipeline:      pipeline,
-		database:      database,
+		database:      db,
 		SugaredLogger: b.logger,
 	}, nil
 }

operator/database.go → database/database.go

@@ -1,6 +1,6 @@
 //go:generate mockery -name=^(Database)$ -output=../testutil -outpkg=testutil -case=snake
 
-package operator
+package database
 
 import (
 	"fmt"

database/database_test.go

@@ -0,0 +1,89 @@
+package database
+
+import (
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+// NewTempDir will return a new temp directory for testing
+func NewTempDir(t testing.TB) string {
+	tempDir, err := ioutil.TempDir("", "")
+	if err != nil {
+		t.Errorf(err.Error())
+		t.FailNow()
+	}
+
+	t.Cleanup(func() {
+		os.RemoveAll(tempDir)
+	})
+
+	return tempDir
+}
+
+func TestOpenDatabase(t *testing.T) {
+	t.Run("Simple", func(t *testing.T) {
+		tempDir := NewTempDir(t)
+		db, err := OpenDatabase(filepath.Join(tempDir, "test.db"))
+		require.NoError(t, err)
+		require.NotNil(t, db)
+	})
+
+	t.Run("NoFile", func(t *testing.T) {
+		db, err := OpenDatabase("")
+		require.NoError(t, err)
+		require.NotNil(t, db)
+		require.IsType(t, &StubDatabase{}, db)
+	})
+
+	t.Run("NonexistantPathIsCreated", func(t *testing.T) {
+		tempDir := NewTempDir(t)
+		db, err := OpenDatabase(filepath.Join(tempDir, "nonexistdir", "test.db"))
+		require.NoError(t, err)
+		require.NotNil(t, db)
+	})
+
+	t.Run("BadPermissions", func(t *testing.T) {
+		if runtime.GOOS == "windows" {
+			t.Skip("Windows does not have the same kind of file permissions")
+		}
+		tempDir := NewTempDir(t)
+		err := os.MkdirAll(filepath.Join(tempDir, "badperms"), 0666)
+		require.NoError(t, err)
+		db, err := OpenDatabase(filepath.Join(tempDir, "badperms", "nonexistdir", "test.db"))
+		require.Error(t, err)
+		require.Nil(t, db)
+	})
+
+	t.Run("ExecuteOnlyPermissions", func(t *testing.T) {
+		if runtime.GOOS == "windows" {
+			t.Skip("Windows does not have the same kind of file permissions")
+		}
+		tempDir := NewTempDir(t)
+		err := os.MkdirAll(filepath.Join(tempDir, "badperms"), 0111)
+		require.NoError(t, err)
+		db, err := OpenDatabase(filepath.Join(tempDir, "badperms", "nonexistdir", "test.db"))
+		require.Error(t, err)
+		require.Nil(t, db)
+	})
+
+}
+
+func TestStubDatabase(t *testing.T) {
+	stubDatabase := NewStubDatabase()
+	err := stubDatabase.Close()
+	require.NoError(t, err)
+
+	err = stubDatabase.Sync()
+	require.NoError(t, err)
+
+	err = stubDatabase.Update(nil)
+	require.NoError(t, err)
+
+	err = stubDatabase.View(nil)
+	require.NoError(t, err)
+}

errors/error.go

@@ -32,10 +32,7 @@ func (e AgentError) MarshalLogObject(encoder zapcore.ObjectEncoder) error {
 	}
 
 	if len(e.Details) != 0 {
-		err := encoder.AddObject("details", e.Details)
-		if err != nil {
-			return err
-		}
+		_ = encoder.AddObject("details", e.Details)
 	}
 
 	return nil

internal/version/version_test.go

@@ -0,0 +1,29 @@
+package version
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func resetVersion() {
+	Version = ""
+	GitHash = ""
+}
+
+func TestGetVersionWithVersion(t *testing.T) {
+	Version = "0.1.1"
+	defer resetVersion()
+	require.Equal(t, Version, GetVersion())
+}
+
+func TestGetVersionWithGitHash(t *testing.T) {
+	GitHash = "git hash"
+	defer resetVersion()
+	require.Equal(t, GitHash, GetVersion())
+}
+
+func TestGetVersionWithUnknownVersion(t *testing.T) {
+	defer resetVersion()
+	require.Equal(t, "unknown", GetVersion())
+}

operator/config.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/observiq/stanza/database"
 	"go.uber.org/zap"
 )
 
@@ -23,7 +24,7 @@ type Builder interface {
 // BuildContext supplies contextual resources when building an operator.
 type BuildContext struct {
 	PluginRegistry PluginRegistry
-	Database       Database
+	Database       database.Database
 	Parameters     map[string]interface{}
 	Logger         *zap.SugaredLogger
 }

operator/config_test.go

@@ -4,12 +4,13 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/observiq/stanza/database"
 	"github.com/stretchr/testify/require"
 	yaml "gopkg.in/yaml.v2"
 )
 
 func TestStubDatabase(t *testing.T) {
-	stub := &StubDatabase{}
+	stub := &database.StubDatabase{}
 
 	err := stub.Close()
 	require.NoError(t, err)

operator/helper/persister.go

@@ -3,7 +3,7 @@ package helper
 import (
 	"sync"
 
-	"github.com/observiq/stanza/operator"
+	"github.com/observiq/stanza/database"
 	"go.etcd.io/bbolt"
 )
 
@@ -18,13 +18,13 @@ type Persister interface {
 // ScopedBBoltPersister is a persister that uses a database for the backend
 type ScopedBBoltPersister struct {
 	scope    []byte
-	db       operator.Database
+	db       database.Database
 	cache    map[string][]byte
 	cacheMux sync.Mutex
 }
 
 // NewScopedDBPersister returns a new ScopedBBoltPersister
-func NewScopedDBPersister(db operator.Database, scope string) *ScopedBBoltPersister {
+func NewScopedDBPersister(db database.Database, scope string) *ScopedBBoltPersister {
 	return &ScopedBBoltPersister{
 		scope: []byte(scope),
 		db:    db,