Renamed interfaces to drop the I prefix and updated mocks accordingly. Added tests for alert, ristretto, socket, and document. Added Windows TPM support and a test helper script.

Author: jnbdz

.mockery.yaml

@@ -4,142 +4,142 @@ issue-845-fix: True
 packages:
   github.com/AmadlaOrg/LibraryUtils/configuration:
     interfaces:
-      IConfiguration:
+      Configuration:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockConfiguration"
           inpackage: True
-      IViper:
+      Viper:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockViper"
           inpackage: True
   github.com/AmadlaOrg/LibraryUtils/database/sqlite3:
     interfaces:
-      IDatabase:
+      Database:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockCacheDatabase"
           inpackage: True
-      IDatabaseSqlNullString:
+      NullString:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullString
-      IDatabaseSqlNullInt64:
+          mockName: MockNullString
+      NullInt64:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullInt64
-      IDatabaseSqlNullInt32:
+          mockName: MockNullInt64
+      NullInt32:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullInt32
-      IDatabaseSqlNullInt16:
+          mockName: MockNullInt32
+      NullInt16:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullInt16
-      IDatabaseSqlNullByte:
+          mockName: MockNullInt16
+      NullByte:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullByte
-      IDatabaseSqlNullFloat64:
+          mockName: MockNullByte
+      NullFloat64:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullFloat64
-      IDatabaseSqlNullBool:
+          mockName: MockNullFloat64
+      NullBool:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullBool
-      IDatabaseSqlNullTime:
+          mockName: MockNullBool
+      NullTime:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNullTime
-      IDatabaseSqlNull:
+          mockName: MockNullTime
+      Null:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlNull
-      IDatabaseSqlDriverStmt:
+          mockName: MockNull
+      DriverStmt:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlDriverStmt
-      IDatabaseSqlDsnConnector:
+          mockName: MockDriverStmt
+      DsnConnector:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlDsnConnector
-      IDatabaseSqlDB:
+          mockName: MockDsnConnector
+      DB:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlDB
-      IDatabaseSqlConn:
+          mockName: MockDB
+      Conn:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlConn
-      IDatabaseSqlTx:
+          mockName: MockConn
+      Tx:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlTx
-      IDatabaseSqlStmt:
+          mockName: MockTx
+      Stmt:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlStmt
-      IDatabaseSqlRows:
+          mockName: MockStmt
+      Rows:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlRows
-      IDatabaseSqlColumnType:
+          mockName: MockRows
+      ColumnType:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlColumnType
-      IDatabaseSqlRow:
+          mockName: MockColumnType
+      Row:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlRow
-      IDatabaseSqlConnRequestSet:
+          mockName: MockRow
+      ConnRequestSet:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIDatabaseSqlConnRequestSet
-      IGoSqlite3SQLiteConn:
+          mockName: MockConnRequestSet
+      SQLiteConn:
         config:
           dir: "{{.InterfaceDir}}"
-          mockName: MockIGoSqlite3SQLiteConn
+          mockName: MockSQLiteConn
   github.com/AmadlaOrg/LibraryUtils/file:
     interfaces:
-      IFile:
+      File:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: MockFile
           inpackage: True
   github.com/AmadlaOrg/LibraryUtils/git:
     interfaces:
-      IGit:
+      Git:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockUtilGit"
           inpackage: True
-      IGoGitRepository:
+      GoGitRepository:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockGoGitRepository"
           inpackage: True
-      IGoGitWorktree:
+      GoGitWorktree:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockGoGitWorktree"
           inpackage: True
   github.com/AmadlaOrg/LibraryUtils/git/remote:
     interfaces:
-      IRemote:
+      Remote:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockUtilGitRemote"
           inpackage: True
-      IGoGitRemote:
+      GoGitRemote:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockGoGitRemote"
           inpackage: True
   github.com/AmadlaOrg/LibraryUtils/location:
     interfaces:
-      ILocation:
+      Location:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: "MockLocation"
@@ -153,7 +153,7 @@ packages:
           inpackage: True
   github.com/AmadlaOrg/LibraryUtils/packaging/document:
     interfaces:
-      IDocument:
+      Document:
         config:
           dir: "{{.InterfaceDir}}"
           mockName: MockPackagingDocument

.script/test.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+output_dir=".reports"
+cov_unfiltered_out_file="${output_dir}/coverage.unfiltered.out"
+cov_out_file="${output_dir}/coverage.out"
+cov_out_xml_file="${output_dir}/coverage.xml"
+report_file="${output_dir}/coverage_summary.txt"
+
+rm -rf ${output_dir}
+mkdir -p ${output_dir}
+echo "" > ${report_file}
+
+echo "--->  Testing code..."
+
+go test -count=1 -tags=integration -coverpkg=./... -covermode=count -coverprofile ${cov_unfiltered_out_file} ./... | tee ${output_dir}/std.out
+grep -v -E -f .covignore ${cov_unfiltered_out_file} > ${cov_out_file}
+
+total="$(go tool cover -func ${cov_out_file} | tail -n 1 |  grep -Eo '[0-9]+\.[0-9]+')"
+subtotals+="\t${total}%"
+
+echo -e "Total coverage:\t${total}%" | tee -a $report_file
+
+# shellcheck disable=SC2002
+cat ${output_dir}/std.out | go-junit-report > ${output_dir}/reports.xml
+gocover-cobertura < ${cov_out_file} > ${cov_out_xml_file} --ignore-gen-files
+gcov2lcov -infile=${cov_out_file} -outfile=${output_dir}/lcov.info

alert/errors_test.go

@@ -0,0 +1,19 @@
+package alert
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestErrorNotFound(t *testing.T) {
+	assert.EqualError(t, ErrorNotFound, "not found")
+}
+
+func TestErrorMultipleFound(t *testing.T) {
+	assert.EqualError(t, ErrorMultipleFound, "multiple found")
+}
+
+func TestErrorsAreDistinct(t *testing.T) {
+	assert.NotEqual(t, ErrorNotFound, ErrorMultipleFound)
+}

cache/cache.go

@@ -1,20 +1,24 @@
 package cache
 
-import "time"
+import (
+	"time"
 
-type ICache interface {
+	"github.com/AmadlaOrg/LibraryUtils/database/sqlite"
+)
+
+type Cache interface {
 	Open() error
 	Close() error
 	Insert(entry *map[string]string, ttl time.Duration) error
 	Select() (*map[string]string, error)
 	Delete(entry string) error
 }
 
-type SCache struct {
-	database database.IDatabase
+type cacheImpl struct {
+	database sqlite.Database
 }
 
 // Open is for opening a connection with the cache storage (e.g.: SQLite3 database, Ristretto memory-bound Go cache)
-func (service *SCache) Open() error {
-
+func (service *cacheImpl) Open() error {
+	return nil
 }

cache/cache_test.go

@@ -1 +1,13 @@
 package cache
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCacheImpl_Open(t *testing.T) {
+	svc := &cacheImpl{}
+	err := svc.Open()
+	assert.NoError(t, err)
+}

configuration/configuration.go

@@ -2,18 +2,18 @@ package configuration
 
 import "github.com/spf13/viper"
 
-// IConfiguration 🧩 Is the interface for the NewConfigurationService.
-type IConfiguration interface {
+// Configuration 🧩 Is the interface for the NewConfigurationService.
+type Configuration interface {
 	Instance() *viper.Viper
 }
 
-// SConfiguration 🏛️ Is the main structure for the NewConfigurationService.
-type SConfiguration struct {
+// configImpl 🏛️ Is the main structure for the NewConfigurationService.
+type configImpl struct {
 	// 🐍 viperInstance - Is an instance of Viper
 	viperInstance *viper.Viper
 }
 
 // Instance 🗿 of Viper with all the settings set up in the new service.
-func (s *SConfiguration) Instance() *viper.Viper {
+func (s *configImpl) Instance() *viper.Viper {
 	return s.viperInstance
 }

configuration/configuration_test.go

@@ -1 +1,17 @@
 package configuration
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInstance(t *testing.T) {
+	svc := New("testapp", "/tmp/config")
+	instance := svc.Instance()
+
+	assert.NotNil(t, instance)
+
+	// Same instance returned each time
+	assert.Same(t, instance, svc.Instance())
+}

configuration/interface.go

@@ -12,8 +12,8 @@ import (
 	"github.com/spf13/pflag"
 )
 
-// IViper 🐍 is the interface for Viper methods.
-type IViper interface {
+// Viper 🐍 is the interface for Viper methods.
+type Viper interface {
 	OnConfigChange(run func(in fsnotify.Event))
 	WatchConfig()
 	SetConfigFile(in string)