Merge pull request #6 from numbleroot/refactoring

First refactoring efforts.

Author: numbleroot

auth/authenticator.go

@@ -6,21 +6,17 @@ import (
 	"os"
 	"sort"
 	"strings"
-	"sync"
 
 	"github.com/numbleroot/pluto/config"
 )
 
 // Structs
 
-// FileAuthenticator contains file based authentication
+// File contains file based authentication
 // information including the in-memory map of username to
 // password mapping.
-type FileAuthenticator struct {
-	lock      *sync.RWMutex
-	File      string
-	Separator string
-	Users     []User
+type File struct {
+	Users []User
 }
 
 // User holds name and password from one line from users file.
@@ -30,49 +26,37 @@ type User struct {
 	Password string
 }
 
-// UsersByName defines a list type of users to search efficiently.
-type UsersByName []User
-
 // Functions
 
-// Make list of users searchable efficiently.
-func (u UsersByName) Len() int           { return len(u) }
-func (u UsersByName) Swap(i, j int)      { u[i], u[j] = u[j], u[i] }
-func (u UsersByName) Less(i, j int) bool { return u[i].Name < u[j].Name }
-
-// NewFileAuthenticator takes in a file name and a separator,
+// NewFile takes in a file name and a separator,
 // reads in specified file and parses it line by line as
 // username - password elements separated by the separator.
 // At the end, the returned struct contains the information
 // and an in-memory map of username mapped to password.
-func NewFileAuthenticator(file string, sep string) (*FileAuthenticator, error) {
-
-	i := 1
-	var err error
-	var handle *os.File
-	var nextUser User
+func NewFile(file string, sep string) (*File, error) {
 
 	// Reserve space for the ordered users list in memory.
 	users := make([]User, 0, 50)
 
 	// Open file with authentication information.
-	handle, err = os.Open(file)
+	handle, err := os.Open(file)
 	if err != nil {
-		return nil, fmt.Errorf("[auth.NewFileAuthenticator] Could not open supplied authentication file: %s\n", err.Error())
+		return nil, fmt.Errorf("[auth.NewFile] Could not open supplied authentication file: %v", err)
 	}
 	defer handle.Close()
 
 	// Create a new scanner on top of file handle.
 	scanner := bufio.NewScanner(handle)
 
+	i := 1
 	// As long as there are lines left, scan them into memory.
 	for scanner.Scan() {
 
 		// Split read line based on separator defined in config file.
 		userData := strings.Split(scanner.Text(), sep)
 
 		// Create new user struct.
-		nextUser = User{
+		nextUser := User{
 			ID:       i,
 			Name:     userData[0],
 			Password: userData[1],
@@ -87,23 +71,22 @@ func NewFileAuthenticator(file string, sep string) (*FileAuthenticator, error) {
 
 	// If the scanner ended with an error, report it.
 	if err := scanner.Err(); err != nil {
-		return nil, fmt.Errorf("[auth.NewFileAuthenticator] Experienced error while scanning authentication file: %s\n", err.Error())
+		return nil, fmt.Errorf("[auth.NewFile] Experienced error while scanning authentication file: %v", err)
 	}
 
 	// Sort users list to search it efficiently later on.
-	sort.Sort(UsersByName(users))
+	sort.Slice(users, func(i, j int) bool {
+		return users[i].Name < users[j].Name
+	})
 
-	return &FileAuthenticator{
-		lock:      new(sync.RWMutex),
-		File:      file,
-		Separator: sep,
-		Users:     users,
+	return &File{
+		Users: users,
 	}, nil
 }
 
 // GetWorkerForUser returns the name of the worker node
 // that is responsible for handling the user's mailbox.
-func (f *FileAuthenticator) GetWorkerForUser(workers map[string]config.Worker, id int) (string, error) {
+func (f *File) GetWorkerForUser(workers map[string]config.Worker, id int) (string, error) {
 
 	for name, worker := range workers {
 
@@ -122,12 +105,7 @@ func (f *FileAuthenticator) GetWorkerForUser(workers map[string]config.Worker, i
 // process by taking supplied credentials and attempting
 // to find a matching entry the in-memory list taken from
 // the authentication file.
-func (f *FileAuthenticator) AuthenticatePlain(username string, password string, clientAddr string) (int, string, error) {
-
-	// This routine has to be safe for concurrent usage,
-	// therefore lock the struct on entry.
-	f.lock.RLock()
-	defer f.lock.RUnlock()
+func (f *File) AuthenticatePlain(username string, password string, clientAddr string) (int, string, error) {
 
 	// Search in user list for user matching supplied name.
 	i := sort.Search(len(f.Users), func(i int) bool {

auth/file.go

@@ -507,8 +507,10 @@ func (recv *Receiver) ApplyStoredMsgs() {
 				// Calculate size of needed buffer.
 				bufferSize := logSize - curOffset
 
-				// Account for case when offset reached end of log file.
-				if logSize == curOffset {
+				// Account for case when offset reached end of log file
+				// or accidentally the current offset is bigger than the
+				// log file's size.
+				if logSize <= curOffset {
 
 					// Reset position to beginning of file.
 					_, err = recv.updLog.Seek(0, os.SEEK_SET)
@@ -562,7 +564,6 @@ func (recv *Receiver) ApplyStoredMsgs() {
 				// If not, set indicator to false.
 				if (msg.VClock[msg.Sender] != recv.vclock[msg.Sender]) &&
 					(msg.VClock[msg.Sender] != (recv.vclock[msg.Sender] + 1)) {
-					log.Printf("[comm.ApplyStoredMsgs] %s: not applying message because leap in causality and messages missing.\n", recv.name)
 					applyMsg = false
 				}
 
@@ -574,7 +575,6 @@ func (recv *Receiver) ApplyStoredMsgs() {
 						// and check if they do not exceed the locally stored
 						// values for these nodes.
 						if value > recv.vclock[node] {
-							log.Printf("[comm.ApplyStoredMsgs] %s: not applying message because other elements exceeded.\n", recv.name)
 							applyMsg = false
 							break
 						}
@@ -597,8 +597,6 @@ func (recv *Receiver) ApplyStoredMsgs() {
 
 						// Wait for done signal from node.
 						<-recv.doneCRDTUpdChan
-					} else {
-						log.Printf("[comm.ApplyStoredMsgs] %s: message was a duplicate, already seen.\n", recv.name)
 					}
 
 					for node, value := range msg.VClock {

comm/receiver.go

@@ -16,8 +16,6 @@ import (
 // will be used when verifying certificates.
 func NewPublicTLSConfig(certPath string, keyPath string) (*tls.Config, error) {
 
-	var err error
-
 	// Define very strict defaults for public TLS usage.
 	// Good parts of them were taken from the excellent post:
 	// "Achieving a Perfect SSL Labs Score with Go":
@@ -38,10 +36,11 @@ func NewPublicTLSConfig(certPath string, keyPath string) (*tls.Config, error) {
 
 	// Put certificate specified via arguments as the
 	// only certificate into config.
-	config.Certificates[0], err = tls.LoadX509KeyPair(certPath, keyPath)
+	cert, err := tls.LoadX509KeyPair(certPath, keyPath)
 	if err != nil {
-		return nil, fmt.Errorf("[crypto.NewPublicTLSConfig] Failed to load TLS cert and key: %s\n", err.Error())
+		return nil, fmt.Errorf("[crypto.NewPublicTLSConfig] Failed to load TLS cert and key: %v", err)
 	}
+	config.Certificates[0] = cert
 
 	// Build Common Name (CN) and Subject Alternate
 	// Name (SAN) from supplied certificate.
@@ -56,8 +55,6 @@ func NewPublicTLSConfig(certPath string, keyPath string) (*tls.Config, error) {
 // and requires all nodes to verify each other by TLS means.
 func NewInternalTLSConfig(certPath string, keyPath string, rootCertPath string) (*tls.Config, error) {
 
-	var err error
-
 	// Define very strict defaults for internal TLS usage.
 	// Good parts of them were taken from the excellent post:
 	// "Achieving a Perfect SSL Labs Score with Go":
@@ -84,25 +81,26 @@ func NewInternalTLSConfig(certPath string, keyPath string, rootCertPath string)
 	// via path in arguments.
 	rootCert, err := ioutil.ReadFile(rootCertPath)
 	if err != nil {
-		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Reading root certificate into memory failed with: %s\n", err.Error())
+		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Reading root certificate into memory failed with: %v", err)
 	}
 
 	// Append root certificate to root CA pool.
 	if ok := config.RootCAs.AppendCertsFromPEM(rootCert); !ok {
-		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to append root certificate to root CA pool: %s\n", err.Error())
+		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to append root certificate to root CA pool: %v", err)
 	}
 
 	// Append root certificate to client CA pool.
 	if ok := config.ClientCAs.AppendCertsFromPEM(rootCert); !ok {
-		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to append root certificate to client CA pool: %s\n", err.Error())
+		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to append root certificate to client CA pool: %v", err)
 	}
 
 	// Put certificate specified via arguments as the
 	// only certificate into config.
-	config.Certificates[0], err = tls.LoadX509KeyPair(certPath, keyPath)
+	cert, err := tls.LoadX509KeyPair(certPath, keyPath)
 	if err != nil {
-		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to load TLS cert and key: %s\n", err.Error())
+		return nil, fmt.Errorf("[crypto.NewInternalTLSConfig] Failed to load TLS cert and key: %v", err)
 	}
+	config.Certificates[0] = cert
 
 	// Build Common Name (CN) and Subject Alternate
 	// Name (SAN) from supplied certificate.

crypto/config.go

@@ -1,10 +1,9 @@
-package imap_test
+package main
 
 import (
 	"bufio"
 	"fmt"
 	"log"
-	"os"
 	"testing"
 
 	"crypto/tls"
@@ -67,35 +66,12 @@ var loginTests = []struct {
 
 // Functions
 
-func TestMain(m *testing.M) {
-
-	var err error
-
-	// Create needed test environment.
-	testEnv, err = utils.CreateTestEnv("../test-config.toml")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	// Run all nodes in background.
-	utils.RunAllNodes(testEnv, "worker-1")
-
-	// Run all tests of this package.
-	success := m.Run()
-
-	// Tear down test setup.
-	utils.TearDownNormalSetup(testEnv)
-
-	// Return with test return value.
-	os.Exit(success)
-}
-
 // TestCapability executes a black-box table test on the
 // implemented Capability() function.
 func TestCapability(t *testing.T) {
 
 	// Connect to IMAP distributor.
-	conn, err := tls.Dial("tcp", (testEnv.Config.Distributor.PublicIP + ":" + testEnv.Config.Distributor.Port), testEnv.TLSConfig)
+	conn, err := tls.Dial("tcp", testEnv.Addr, testEnv.TLSConfig)
 	if err != nil {
 		t.Fatalf("[imap.TestCapability] Error during connection attempt to IMAP distributor: %s\n", err.Error())
 	}
@@ -159,7 +135,7 @@ func TestLogout(t *testing.T) {
 		var answer string
 
 		// Connect to IMAP distributor.
-		conn, err := tls.Dial("tcp", (testEnv.Config.Distributor.PublicIP + ":" + testEnv.Config.Distributor.Port), testEnv.TLSConfig)
+		conn, err := tls.Dial("tcp", testEnv.Addr, testEnv.TLSConfig)
 		if err != nil {
 			t.Fatalf("[imap.TestLogout] Error during connection attempt to IMAP distributor: %s\n", err.Error())
 		}
@@ -218,7 +194,7 @@ func TestLogout(t *testing.T) {
 func TestStartTLS(t *testing.T) {
 
 	// Connect to IMAP server.
-	conn, err := tls.Dial("tcp", (testEnv.Config.Distributor.PublicIP + ":" + testEnv.Config.Distributor.Port), testEnv.TLSConfig)
+	conn, err := tls.Dial("tcp", testEnv.Addr, testEnv.TLSConfig)
 	if err != nil {
 		t.Fatalf("[imap.TestStartTLS] Error during connection attempt to IMAP server: %s\n", err.Error())
 	}
@@ -263,7 +239,7 @@ func TestStartTLS(t *testing.T) {
 func TestLogin(t *testing.T) {
 
 	// Connect to IMAP distributor.
-	conn, err := tls.Dial("tcp", (testEnv.Config.Distributor.PublicIP + ":" + testEnv.Config.Distributor.Port), testEnv.TLSConfig)
+	conn, err := tls.Dial("tcp", testEnv.Addr, testEnv.TLSConfig)
 	if err != nil {
 		t.Fatalf("[imap.TestLogin] Error during connection attempt to IMAP distributor: %s\n", err.Error())
 	}