Tests for the brokers package (#9)

This adds mock utilities in `testutils` and adds tests for the `brokers`
package, for both `manager.go` and `broker.go`

UDENG-1065

.gitignore

@@ -3,7 +3,8 @@
 #
 # Binaries for programs and plugins
 *.so
-authd
+/authd
+cmd/authd/authd
 pam/pam_authd.h
 pam/pam
 

internal/brokers/broker.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"hash/fnv"
+	"os"
 	"strings"
 
 	"github.com/godbus/dbus/v5"
@@ -58,7 +59,8 @@ func newBroker(ctx context.Context, name, configFile string, bus *dbus.Conn) (b
 		if err != nil {
 			return Broker{}, err
 		}
-	} else if name != localBrokerName {
+	} else if _, set := os.LookupEnv("AUTHD_USE_EXAMPLES"); set && name != localBrokerName {
+		// if the broker does not have a config file and the AUTHD_USE_EXAMPLES env var is set, use the example broker
 		broker, fullName, brandIcon = examplebroker.New(name)
 	}
 

internal/brokers/broker_test.go

@@ -0,0 +1,293 @@
+package brokers_test
+
+import (
+	"context"
+	"fmt"
+	"path/filepath"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+	"github.com/ubuntu/authd/internal/brokers"
+	"github.com/ubuntu/authd/internal/responses"
+	"github.com/ubuntu/authd/internal/testutils"
+)
+
+func TestNewBroker(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		name       string
+		configFile string
+		wantErr    bool
+	}{
+		"No config means local broker":                        {name: "local"},
+		"Successfully create broker with correct config file": {name: "broker", configFile: "valid"},
+
+		// General config errors
+		"Error when config file is invalid":     {configFile: "invalid", wantErr: true},
+		"Error when config file does not exist": {configFile: "do not exist", wantErr: true},
+
+		// Missing field errors
+		"Error when config does not have name field":           {configFile: "no_name", wantErr: true},
+		"Error when config does not have brand_icon field":     {configFile: "no_brand_icon", wantErr: true},
+		"Error when config does not have dbus.name field":      {configFile: "no_dbus_name", wantErr: true},
+		"Error when config does not have dbus.object field":    {configFile: "no_dbus_object", wantErr: true},
+		"Error when config does not have dbus.interface field": {configFile: "no_dbus_interface", wantErr: true},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			conn, err := testutils.GetSystemBusConnection(t)
+			require.NoError(t, err, "Setup: could not connect to system bus")
+
+			configDir := filepath.Join(fixturesPath, "valid_brokers")
+			if tc.wantErr {
+				configDir = filepath.Join(fixturesPath, "invalid_brokers")
+			}
+			if tc.configFile != "" {
+				tc.configFile = filepath.Join(configDir, tc.configFile)
+			}
+
+			got, err := brokers.NewBroker(context.Background(), tc.name, tc.configFile, conn)
+			if tc.wantErr {
+				require.Error(t, err, "NewBroker should return an error, but did not")
+				return
+			}
+			require.NoError(t, err, "NewBroker should not return an error, but did")
+
+			gotString := fmt.Sprintf("ID: %s\nName: %s\nBrand Icon: %s\n", got.ID, got.Name, got.BrandIconPath)
+
+			wantString := testutils.LoadWithUpdateFromGolden(t, gotString)
+			require.Equal(t, wantString, gotString, "NewBroker should return the expected broker, but did not")
+		})
+	}
+}
+
+func TestGetAuthenticationModes(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		sessionID string
+
+		wantErr bool
+	}{
+		"Successfully get authentication modes":                        {sessionID: "success"},
+		"Does not error out when no authentication modes are returned": {sessionID: "GAM_empty"},
+
+		// broker errors
+		"Error when getting authentication modes": {sessionID: "GAM_error", wantErr: true},
+		"Error when broker returns invalid modes": {sessionID: "GAM_invalid", wantErr: true},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			b, _ := newBrokerForTests(t)
+
+			gotModes, err := b.GetAuthenticationModes(context.Background(), tc.sessionID, nil)
+			if tc.wantErr {
+				require.Error(t, err, "GetAuthenticationModes should return an error, but did not")
+				return
+			}
+			require.NoError(t, err, "GetAuthenticationModes should not return an error, but did")
+
+			wantModes := testutils.LoadWithUpdateFromGoldenYAML(t, gotModes)
+			require.Equal(t, wantModes, gotModes, "GetAuthenticationModes should return the expected modes, but did not")
+		})
+	}
+}
+
+func TestSelectAuthenticationMode(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		sessionID string
+
+		wantErr bool
+	}{
+		"Successfully select form authentication mode":        {sessionID: "SAM_form_success"},
+		"Successfully select qrcode authentication mode":      {sessionID: "SAM_qrcode_success"},
+		"Successfully select newpassword authentication mode": {sessionID: "SAM_newpassword_success"},
+
+		// broker errors
+		"Error when selecting authentication mode": {sessionID: "SAM_error", wantErr: true},
+
+		/* Layout errors */
+
+		// Layout type errors
+		"Error when broker returns no layout":           {sessionID: "SAM_no_layout", wantErr: true},
+		"Error when broker returns invalid layout type": {sessionID: "SAM_invalid_layout_type", wantErr: true},
+
+		// Type "form" errors
+		"Error when broker returns form with no label":      {sessionID: "SAM_form_no_label", wantErr: true},
+		"Error when broker returns form with invalid entry": {sessionID: "SAM_form_invalid_entry", wantErr: true},
+		"Error when broker returns form with invalid wait":  {sessionID: "SAM_form_invalid_wait", wantErr: true},
+
+		// Type "qrcode" errors
+		"Error when broker returns qrcode with no content":   {sessionID: "SAM_qrcode_no_content", wantErr: true},
+		"Error when broker returns qrcode with invalid wait": {sessionID: "SAM_qrcode_invalid_wait", wantErr: true},
+
+		// Type "newpassword" errors
+		"Error when broker returns newpassword with no label":      {sessionID: "SAM_newpassword_no_label", wantErr: true},
+		"Error when broker returns newpassword with invalid entry": {sessionID: "SAM_newpassword_invalid_entry", wantErr: true},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			b, _ := newBrokerForTests(t)
+
+			gotUI, err := b.SelectAuthenticationMode(context.Background(), tc.sessionID, "mode1")
+			if tc.wantErr {
+				require.Error(t, err, "SelectAuthenticationMode should return an error, but did not")
+				return
+			}
+			require.NoError(t, err, "SelectAuthenticationMode should not return an error, but did")
+
+			wantUI := testutils.LoadWithUpdateFromGoldenYAML(t, gotUI)
+			require.Equal(t, wantUI, gotUI, "SelectAuthenticationMode should return the expected mode UI, but did not")
+		})
+	}
+}
+
+func TestIsAuthorized(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		sessionID           string
+		sessionIDSecondCall string
+
+		wantAccess           string
+		wantErr              bool
+		wantAccessSecondCall string
+		wantErrSecondCall    bool
+	}{
+		//TODO: Once validation is implemented, add cases to check if the data returned by the broker matches what is expected from the access code.
+
+		"Successfully authorize":                             {sessionID: "success", wantAccess: responses.AuthAllowed},
+		"Successfully authorize after cancelling first call": {sessionID: "IA_second_call", wantAccess: responses.AuthCancelled, sessionIDSecondCall: "success", wantAccessSecondCall: responses.AuthAllowed},
+		"Denies authentication when broker times out":        {sessionID: "IA_timeout", wantAccess: responses.AuthDenied},
+
+		"Empty data gets JSON formatted": {sessionID: "IA_empty_data", wantAccess: responses.AuthAllowed},
+
+		// broker errors
+		"Error when authorizing":                                           {sessionID: "IA_error", wantErr: true},
+		"Error when broker returns invalid access":                         {sessionID: "IA_invalid", wantErr: true},
+		"Error when broker returns invalid data":                           {sessionID: "IA_invalid_data", wantErr: true},
+		"Error when calling IsAuthorized a second time without cancelling": {sessionID: "IA_second_call", wantAccess: responses.AuthAllowed, sessionIDSecondCall: "IA_second_call", wantErrSecondCall: true},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			b, _ := newBrokerForTests(t)
+
+			// Stores the combined output of both calls to IsAuthorized
+			var firstCallReturn, secondCallReturn string
+
+			var access string
+			var gotData string
+			var err error
+			ctx, cancel := context.WithCancel(context.Background())
+			defer cancel()
+
+			done := make(chan struct{})
+			go func() {
+				defer close(done)
+				access, gotData, err = b.IsAuthorized(ctx, tc.sessionID, "password")
+				firstCallReturn = fmt.Sprintf("FIRST CALL:\n\taccess: %s\n\tdata: %s\n\terr: %v\n", access, gotData, err)
+				if tc.wantErr {
+					require.Error(t, err, "IsAuthorized should return an error, but did not")
+					return
+				}
+				require.NoError(t, err, "IsAuthorized should not return an error, but did")
+			}()
+
+			// Give some time for the first call to block
+			time.Sleep(time.Second)
+
+			if tc.wantAccessSecondCall != "" {
+				cancel()
+				// Wait for the cancel to go through
+				time.Sleep(time.Millisecond)
+			}
+			if tc.sessionIDSecondCall != "" {
+				access, gotData, err := b.IsAuthorized(context.Background(), tc.sessionID, "password")
+				secondCallReturn = fmt.Sprintf("SECOND CALL:\n\taccess: %s\n\tdata: %s\n\terr: %v\n", access, gotData, err)
+				if tc.wantErrSecondCall {
+					require.Error(t, err, "IsAuthorized second call should return an error, but did not")
+				} else {
+					require.NoError(t, err, "IsAuthorized second call should not return an error, but did")
+				}
+			}
+
+			<-done
+			if tc.wantErr {
+				return
+			}
+			gotStr := firstCallReturn + secondCallReturn
+			want := testutils.LoadWithUpdateFromGolden(t, gotStr)
+			require.Equal(t, want, gotStr, "IsAuthorized should return the expected combined data, but did not")
+		})
+	}
+}
+
+func TestCancelIsAuthorized(t *testing.T) {
+	t.Parallel()
+
+	tests := map[string]struct {
+		sessionID string
+
+		wantAnswer string
+	}{
+		"Successfully cancels IsAuthorized":    {sessionID: "IA_wait", wantAnswer: responses.AuthCancelled},
+		"Call returns denied if not cancelled": {sessionID: "IA_timeout", wantAnswer: responses.AuthDenied},
+	}
+	for name, tc := range tests {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			b, _ := newBrokerForTests(t)
+
+			var access string
+			ctx, cancel := context.WithCancel(context.Background())
+			done := make(chan struct{})
+			go func() {
+				access, _, _ = b.IsAuthorized(ctx, tc.sessionID, "password")
+				close(done)
+			}()
+			defer cancel()
+
+			if tc.sessionID == "IA_wait" {
+				// Give some time for the IsAuthorized routine to start.
+				time.Sleep(time.Second)
+				cancel()
+			}
+			<-done
+			require.Equal(t, tc.wantAnswer, access, "IsAuthorized should return the expected access, but did not")
+		})
+	}
+}
+
+func newBrokerForTests(t *testing.T) (b brokers.Broker, cfgPath string) {
+	t.Helper()
+
+	cfgPath = testutils.StartBusBrokerMock(t)
+
+	conn, err := testutils.GetSystemBusConnection(t)
+	require.NoError(t, err, "Setup: could not connect to system bus")
+	t.Cleanup(func() { require.NoError(t, conn.Close(), "Teardown: Failed to close the connection") })
+
+	b, err = brokers.NewBroker(context.Background(), strings.ReplaceAll(t.Name(), "/", "_"), cfgPath, conn)
+	require.NoError(t, err, "Setup: could not create broker")
+
+	return b, cfgPath
+}

internal/brokers/export_test.go

@@ -0,0 +1,28 @@
+package brokers
+
+import (
+	"context"
+
+	"github.com/godbus/dbus/v5"
+)
+
+// NewBroker exports the private newBroker function for testing purposes.
+func NewBroker(ctx context.Context, name, configFile string, bus *dbus.Conn) (Broker, error) {
+	return newBroker(ctx, name, configFile, bus)
+}
+
+// WithCfgDir uses a dedicated path for the broker config dir.
+func WithCfgDir(p string) func(o *options) {
+	return func(o *options) {
+		o.brokerCfgDir = p
+	}
+}
+
+// SetBrokerForSession sets the broker for a given session.
+//
+// This is to be used only in tests.
+func (m *Manager) SetBrokerForSession(b *Broker, sessionID string) {
+	m.transactionsToBrokerMu.Lock()
+	m.transactionsToBroker[sessionID] = b
+	m.transactionsToBrokerMu.Unlock()
+}