Add tests

Signed-off-by: Marius Sincovici <[email protected]>

* Test that FileWrite will set the correct file permissions if the file
  already exists
* Check that the moose DB permissions are correctly set

Author: mariusSincovici

cmd/daemon/main.go

@@ -280,7 +280,9 @@ func main() {
 	dnsHostSetter := dns.NewHostsFileSetter(dns.HostsFilePath)
 
 	eventsDbPath := filepath.Join(internal.DatFilesPathCommon, "moose.db")
-	createMooseDB(eventsDbPath)
+	if err := assignMooseDBPermissions(eventsDbPath); err != nil {
+		log.Fatalln(err)
+	}
 
 	machineID := machineIdGenerator.GetMachineID()
 
@@ -633,29 +635,26 @@ func main() {
 	}
 }
 
-// createMooseDB creates the moose DB with the desired permissions.
-// If the file already exists then its permissions and user group are updated
-func createMooseDB(eventsDbPath string) {
-	var permissions os.FileMode = internal.PermUserRWGroupRW
+// assignMooseDBPermissions updates moose DB permissions.
+// If the file doesn't exist it will be created withe the desired permissions.
+func assignMooseDBPermissions(eventsDbPath string) error {
+	const permissions os.FileMode = internal.PermUserRWGroupRW
 
 	if !internal.FileExists(eventsDbPath) {
-		file, err := internal.FileCreate(eventsDbPath, permissions)
-		if err != nil {
-			log.Fatalln(err)
-		}
-		defer file.Close()
-	} else {
-		// Change permission of the existing DB, because older versions had read for everyone
-		if err := os.Chmod(eventsDbPath, permissions); err != nil {
-			log.Println(err)
-		}
+		_, err := internal.FileCreate(eventsDbPath, permissions)
+		return err
+	}
+	// Change permission of the existing DB, because older versions had read for everyone
+	if err := os.Chmod(eventsDbPath, permissions); err != nil {
+		log.Println(err)
+	}
 
-		if gid, err := internal.GetNordvpnGid(); err == nil {
-			if err := os.Chown(eventsDbPath, os.Getuid(), gid); err != nil {
-				log.Println(err)
-			}
-		} else {
+	if gid, err := internal.GetNordvpnGid(); err == nil {
+		if err := os.Chown(eventsDbPath, os.Getuid(), gid); err != nil {
 			log.Println(err)
 		}
+	} else {
+		log.Println(err)
 	}
+	return nil
 }

cmd/daemon/moose_db_creation_test.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"os"
+	"testing"
+
+	"github.com/NordSecurity/nordvpn-linux/internal"
+	"github.com/NordSecurity/nordvpn-linux/test/category"
+	"github.com/stretchr/testify/assert"
+)
+
+const TestDataPath = "testdata/"
+
+func TestCreateMooseDB(t *testing.T) {
+	category.Set(t, category.Unit)
+
+	path := TestDataPath + "test_moose_db.db"
+	const perm os.FileMode = internal.PermUserRWGroupRW
+	defer os.Remove(path)
+
+	checkPermissionsFn := func() {
+		info, err := os.Stat(path)
+		assert.NoError(t, err)
+		assert.Equal(t, perm, info.Mode().Perm())
+	}
+
+	// create DB
+	assignMooseDBPermissions(path)
+
+	assert.FileExists(t, path)
+	checkPermissionsFn()
+
+	// file exists, check that the permissions are updated
+	os.Chmod(path, internal.PermUserRW)
+	assignMooseDBPermissions(path)
+
+	checkPermissionsFn()
+}

internal/filesystem.go

@@ -236,17 +236,19 @@ func EnsureDirFull(path string) error {
 
 // FileWrite writes the given string array to file, previously flushing it clean
 func FileWrite(path string, contents []byte, permissions os.FileMode) error {
-	err := EnsureDir(path)
-	if err != nil {
-		return err
+	if err := EnsureDir(path); err != nil {
+		return fmt.Errorf("failed to create parent folders: %w", err)
 	}
-	err = os.WriteFile(path, contents, permissions)
-	if err != nil {
-		return err
+
+	if err := os.WriteFile(path, contents, permissions); err != nil {
+		return fmt.Errorf("writing file: %w", err)
 	}
 	// if file exists os.WriteFile is not changing the permissions,
 	// ensure file has expected permissions
-	return os.Chmod(path, permissions)
+	if err := os.Chmod(path, permissions); err != nil {
+		return fmt.Errorf("change permissions failed: %w", err)
+	}
+	return nil
 }
 
 // FileCreate with the given permissions, but leave the closing to the caller.

internal/filesystem_test.go

@@ -103,6 +103,7 @@ func TestFileWrite(t *testing.T) {
 			assert.NoError(t, err)
 
 			file, err := os.OpenFile(path, os.O_RDONLY|os.O_EXCL, item.permissions)
+			assert.NoError(t, err)
 			defer func() {
 				file.Close()
 				os.Remove(file.Name())
@@ -112,10 +113,38 @@ func TestFileWrite(t *testing.T) {
 			_, err = file.Read(got)
 			assert.NoError(t, err)
 			assert.EqualValues(t, got, []byte(item.data))
+
+			info, err := os.Stat(path)
+			assert.NoError(t, err)
+			perm := info.Mode().Perm()
+			assert.Equal(t, item.permissions, perm)
 		})
 	}
 }
 
+func TestFileWriteSetsCorrectPermissionsWhenFileExists(t *testing.T) {
+	category.Set(t, category.File)
+
+	createFileAndCheckPerms := func(path string, permissions os.FileMode) {
+		err := FileWrite(path, []byte("data"), permissions)
+		assert.NoError(t, err)
+
+		info, err := os.Stat(path)
+		assert.NoError(t, err)
+		assert.Equal(t, permissions, info.Mode().Perm())
+	}
+
+	fileName := "tst_" + time.Now().String() + ".txt"
+	path := TestDataPath + fileName
+	defer os.Remove(path)
+
+	// create the file and check that the permissions are correct
+	createFileAndCheckPerms(path, PermUserRWGroupROthersR)
+
+	// file already exists, the permissions are updated
+	createFileAndCheckPerms(path, PermUserRW)
+}
+
 func TestFileCreate(t *testing.T) {
 	category.Set(t, category.File)