(cleanup) pam: Move model code into specific package

.github/workflows/qa.yaml

@@ -148,14 +148,15 @@ jobs:
       - name: Run tests (with race detector)
         run: |
           go test -race ./...
+
       - name: Run PAM tests (with Address Sanitizer)
         env:
           # Do not optimize, keep debug symbols and frame pointer for better
           # stack trace information in case of ASAN errors.
           CGO_CFLAGS: "-O0 -g3 -fno-omit-frame-pointer"
         run: |
           # Use `-dwarflocationlists` to give ASAN a better time to unwind the stack trace
-          go test -asan -gcflags="-dwarflocationlists=true" ./pam/pam_test ./pam/gdm/
+          go test -C ./pam/internal -asan -gcflags="-dwarflocationlists=true" ./...
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

pam/authentication.go → pam/internal/adapter/authentication.go

@@ -1,5 +1,4 @@
-// Package main is the package for the PAM library
-package main
+package adapter
 
 import (
 	"context"
@@ -126,7 +125,7 @@ func (m *authenticationModel) Update(msg tea.Msg) (authenticationModel, tea.Cmd)
 		log.Infof(context.TODO(), "isAuthenticatedResultReceived: %v", msg.access)
 		switch msg.access {
 		case responses.AuthGranted:
-			return *m, sendEvent(pamSuccess{brokerID: m.currentBrokerID})
+			return *m, sendEvent(PamSuccess{BrokerID: m.currentBrokerID})
 
 		case responses.AuthRetry:
 			errorMsg, err := dataToMsg(msg.msg)

pam/authmodeselection.go → pam/internal/adapter/authmodeselection.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"context"
@@ -251,7 +251,7 @@ func getAuthenticationModes(client authd.PAMClient, sessionID string, uiLayouts
 
 		authModes := gamResp.GetAuthenticationModes()
 		if len(authModes) == 0 {
-			return pamIgnore{msg: "no supported authentication mode available for this provider"}
+			return PamIgnore{msg: "no supported authentication mode available for this provider"}
 		}
 		log.Info(context.TODO(), authModes)
 

pam/brokerselection.go → pam/internal/adapter/brokerselection.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"context"
@@ -141,8 +141,6 @@ func (m brokerSelectionModel) Update(msg tea.Msg) (brokerSelectionModel, tea.Cmd
 }
 
 // Focus focuses this model. It always returns nil.
-//
-//nolint:unparam // Always returns nil.
 func (m *brokerSelectionModel) Focus() tea.Cmd {
 	m.focused = true
 	return nil

pam/button.go → pam/internal/adapter/button.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"fmt"

pam/commands.go → pam/internal/adapter/commands.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"context"
@@ -23,7 +23,7 @@ func sendEvent(msg tea.Msg) tea.Cmd {
 func startBrokerSession(client authd.PAMClient, brokerID, username string) tea.Cmd {
 	return func() tea.Msg {
 		if brokerID == "local" {
-			return pamIgnore{localBrokerID: brokerID}
+			return PamIgnore{LocalBrokerID: brokerID}
 		}
 
 		// Start a transaction for this user with the broker.
@@ -96,11 +96,11 @@ func getLayout(client authd.PAMClient, sessionID, authModeID string) tea.Cmd {
 }
 
 // quit tears down any active session and quit the main loop.
-func (m *model) quit() tea.Cmd {
+func (m *UIModel) quit() tea.Cmd {
 	if m.currentSession == nil {
 		return tea.Quit
 	}
-	return tea.Sequence(endSession(m.client, m.currentSession), tea.Quit)
+	return tea.Sequence(endSession(m.Client, m.currentSession), tea.Quit)
 }
 
 // endSession requests the broker to end the session.

pam/formmodel.go → pam/internal/adapter/formmodel.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"fmt"

pam/model.go → pam/internal/adapter/model.go

@@ -1,4 +1,5 @@
-package main
+// Package adapter is the package for the PAM library
+package adapter
 
 import (
 	"context"
@@ -33,14 +34,17 @@ type sessionInfo struct {
 	encryptionKey string
 }
 
-// model is the global models orchestrator.
-type model struct {
-	pamMTx pam.ModuleTransaction
-	client authd.PAMClient
+// UIModel is the global models orchestrator.
+type UIModel struct {
+	// PamMTx is the [pam.ModuleTransaction] used to communicate with PAM.
+	PamMTx pam.ModuleTransaction
+	// Client is the [authd.PAMClient] handle used to communicate with authd.
+	Client authd.PAMClient
+	// InteractiveTerminal whether the underlying PAM system is using an interactive terminal.
+	InteractiveTerminal bool
 
-	height              int
-	width               int
-	interactiveTerminal bool
+	height int
+	width  int
 
 	currentSession *sessionInfo
 
@@ -49,7 +53,7 @@ type model struct {
 	authModeSelectionModel authModeSelectionModel
 	authenticationModel    authenticationModel
 
-	exitStatus pamReturnStatus
+	exitStatus PamReturnStatus
 }
 
 /* global events */
@@ -86,27 +90,27 @@ type UILayoutReceived struct {
 type SessionEnded struct{}
 
 // Init initializes the main model orchestrator.
-func (m *model) Init() tea.Cmd {
+func (m *UIModel) Init() tea.Cmd {
 	m.exitStatus = pamError{status: pam.ErrSystem, msg: "model did not return anything"}
-	m.userSelectionModel = newUserSelectionModel(m.pamMTx)
+	m.userSelectionModel = newUserSelectionModel(m.PamMTx)
 	var cmds []tea.Cmd
 	cmds = append(cmds, m.userSelectionModel.Init())
 
-	m.brokerSelectionModel = newBrokerSelectionModel(m.client)
+	m.brokerSelectionModel = newBrokerSelectionModel(m.Client)
 	cmds = append(cmds, m.brokerSelectionModel.Init())
 
 	m.authModeSelectionModel = newAuthModeSelectionModel()
 	cmds = append(cmds, m.authModeSelectionModel.Init())
 
-	m.authenticationModel = newAuthenticationModel(m.client)
+	m.authenticationModel = newAuthenticationModel(m.Client)
 	cmds = append(cmds, m.authenticationModel.Init())
 
 	cmds = append(cmds, m.changeStage(stageUserSelection))
 	return tea.Batch(cmds...)
 }
 
 // Update handles events and actions to be done from the main model orchestrator.
-func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
+func (m *UIModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 	log.Debugf(context.TODO(), "%+v", msg)
 
 	switch msg := msg.(type) {
@@ -141,7 +145,7 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		m.brokerSelectionModel.SetWidth(m.width)
 
 	// Exit cases
-	case pamReturnStatus:
+	case PamReturnStatus:
 		m.exitStatus = msg
 		return m, m.quit()
 
@@ -157,10 +161,10 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		// Got user and brokers? Time to auto or manually select.
 		return m, tea.Sequence(
 			m.changeStage(stageBrokerSelection),
-			AutoSelectForUser(m.client, m.username()))
+			AutoSelectForUser(m.Client, m.username()))
 
 	case BrokerSelected:
-		return m, startBrokerSession(m.client, msg.BrokerID, m.username())
+		return m, startBrokerSession(m.Client, msg.BrokerID, m.username())
 
 	case SessionStarted:
 		m.currentSession = &sessionInfo{
@@ -176,7 +180,7 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		}
 
 		return m, tea.Sequence(
-			getAuthenticationModes(m.client, m.currentSession.sessionID, m.authModeSelectionModel.SupportedUILayouts()),
+			getAuthenticationModes(m.Client, m.currentSession.sessionID, m.authModeSelectionModel.SupportedUILayouts()),
 			m.changeStage(stageAuthModeSelection),
 		)
 
@@ -191,7 +195,7 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 				msg:    "reselection of current auth mode without current ID",
 			})
 		}
-		return m, getLayout(m.client, m.currentSession.sessionID, msg.ID)
+		return m, getLayout(m.Client, m.currentSession.sessionID, msg.ID)
 
 	case UILayoutReceived:
 		log.Info(context.TODO(), "UILayoutReceived")
@@ -220,7 +224,7 @@ func (m *model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 }
 
 // View renders a text view of the whole UI.
-func (m *model) View() string {
+func (m *UIModel) View() string {
 	var view strings.Builder
 
 	log.Info(context.TODO(), m.currentStage())
@@ -245,7 +249,7 @@ func (m *model) View() string {
 }
 
 // currentStage returns our current stage step.
-func (m *model) currentStage() stage {
+func (m *UIModel) currentStage() stage {
 	if m.userSelectionModel.Focused() {
 		return stageUserSelection
 	}
@@ -262,7 +266,7 @@ func (m *model) currentStage() stage {
 }
 
 // changeStage returns a command acting to change the current stage and reset any previous views.
-func (m *model) changeStage(s stage) tea.Cmd {
+func (m *UIModel) changeStage(s stage) tea.Cmd {
 	switch s {
 	case stageUserSelection:
 		m.brokerSelectionModel.Blur()
@@ -271,7 +275,7 @@ func (m *model) changeStage(s stage) tea.Cmd {
 
 		// The session should be ended when going back to previous state, but we don’t quit the stage immediately
 		// and so, we should always ensure we cancel previous session.
-		return tea.Sequence(endSession(m.client, m.currentSession), m.userSelectionModel.Focus())
+		return tea.Sequence(endSession(m.Client, m.currentSession), m.userSelectionModel.Focus())
 
 	case stageBrokerSelection:
 		m.userSelectionModel.Blur()
@@ -280,7 +284,7 @@ func (m *model) changeStage(s stage) tea.Cmd {
 
 		m.authModeSelectionModel.Reset()
 
-		return tea.Sequence(endSession(m.client, m.currentSession), m.brokerSelectionModel.Focus())
+		return tea.Sequence(endSession(m.Client, m.currentSession), m.brokerSelectionModel.Focus())
 
 	case stageAuthModeSelection:
 		m.userSelectionModel.Blur()
@@ -303,12 +307,17 @@ func (m *model) changeStage(s stage) tea.Cmd {
 	return nil
 }
 
+// ExitStatus exposes the [PamReturnStatus] externally.
+func (m *UIModel) ExitStatus() PamReturnStatus {
+	return m.exitStatus
+}
+
 // username returns currently selected user name.
-func (m model) username() string {
+func (m UIModel) username() string {
 	return m.userSelectionModel.Value()
 }
 
 // availableBrokers returns currently available brokers.
-func (m model) availableBrokers() []*authd.ABResponse_BrokerInfo {
+func (m UIModel) availableBrokers() []*authd.ABResponse_BrokerInfo {
 	return m.brokerSelectionModel.availableBrokers
 }

pam/newpasswordmodel.go → pam/internal/adapter/newpasswordmodel.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"fmt"

pam/qrcodemodel.go → pam/internal/adapter/qrcodemodel.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"fmt"

pam/return.go → pam/internal/adapter/return.go

@@ -1,46 +1,46 @@
-package main
+package adapter
 
 import (
 	"github.com/msteinert/pam/v2"
 )
 
 // Various signalling return messaging to PAM.
 
-// pamReturnStatus is the interface that all PAM return types should implement.
-type pamReturnStatus interface {
+// PamReturnStatus is the interface that all PAM return types should implement.
+type PamReturnStatus interface {
 	Message() string
 }
 
-// pamReturnError is an interface that PAM errors return types should implement.
-type pamReturnError interface {
-	pamReturnStatus
+// PamReturnError is an interface that PAM errors return types should implement.
+type PamReturnError interface {
+	PamReturnStatus
 	Status() pam.Error
 }
 
-// pamSuccess signals PAM module to return with provided pam.Success and Quit tea.Model.
-type pamSuccess struct {
-	brokerID string
+// PamSuccess signals PAM module to return with provided pam.Success and Quit tea.Model.
+type PamSuccess struct {
+	BrokerID string
 	msg      string
 }
 
 // Message returns the message that should be sent to pam as info message.
-func (p pamSuccess) Message() string {
+func (p PamSuccess) Message() string {
 	return p.msg
 }
 
-// pamIgnore signals PAM module to return pam.Ignore and Quit tea.Model.
-type pamIgnore struct {
-	localBrokerID string // Only set for local broker to store it globally.
+// PamIgnore signals PAM module to return pam.Ignore and Quit tea.Model.
+type PamIgnore struct {
+	LocalBrokerID string // Only set for local broker to store it globally.
 	msg           string
 }
 
 // Status returns [pam.ErrIgnore].
-func (p pamIgnore) Status() pam.Error {
+func (p PamIgnore) Status() pam.Error {
 	return pam.ErrIgnore
 }
 
 // Message returns the message that should be sent to pam as info message.
-func (p pamIgnore) Message() string {
+func (p PamIgnore) Message() string {
 	return p.msg
 }
 

pam/textinputmodel.go → pam/internal/adapter/textinputmodel.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"context"

pam/userselection.go → pam/internal/adapter/userselection.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 import (
 	"github.com/charmbracelet/bubbles/textinput"

pam/utils.go → pam/internal/adapter/utils.go

@@ -1,4 +1,4 @@
-package main
+package adapter
 
 // convertTo converts an interface I value to T. It will panic (progamming error) if this is not the case.
 func convertTo[T any, I any](elem I) T {

pam/gdm/conversation_test.go → pam/internal/gdm/conversation_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/msteinert/pam/v2"
 	"github.com/stretchr/testify/require"
-	"github.com/ubuntu/authd/pam/pam_test"
+	"github.com/ubuntu/authd/pam/internal/pam_test"
 )
 
 func TestSendToGdm(t *testing.T) {

pam/gdm/extension_test.go → pam/internal/gdm/extension_test.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/msteinert/pam/v2"
 	"github.com/stretchr/testify/require"
-	"github.com/ubuntu/authd/pam/pam_test"
+	"github.com/ubuntu/authd/pam/internal/pam_test"
 )
 
 func TestMain(t *testing.T) {

pam/gdm/protocol.go → pam/internal/gdm/protocol.go

@@ -1,4 +1,4 @@
-//go:generate ../../tools/generate-proto.sh -I../.. gdm.proto
+//go:generate ../../../tools/generate-proto.sh -I../../.. gdm.proto
 
 // Package gdm is the package for the GDM pam module handing.
 package gdm