From 636ee501cb143f066acb95aeba071dc88d2ee1f4 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 15 Jan 2025 16:20:09 +0100 Subject: [PATCH 1/4] Fix field names in test case names --- internal/brokers/broker_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/brokers/broker_test.go b/internal/brokers/broker_test.go index 6098637e9..6707b7199 100644 --- a/internal/brokers/broker_test.go +++ b/internal/brokers/broker_test.go @@ -57,8 +57,8 @@ func TestNewBroker(t *testing.T) { // Missing field errors "Error when config does not have name field": {configFile: "no_name.conf", wantErr: true}, "Error when config does not have brand_icon field": {configFile: "no_brand_icon.conf", wantErr: true}, - "Error when config does not have dbus.name field": {configFile: "no_dbus_name.conf", wantErr: true}, - "Error when config does not have dbus.object field": {configFile: "no_dbus_object.conf", wantErr: true}, + "Error when config does not have dbus_name field": {configFile: "no_dbus_name.conf", wantErr: true}, + "Error when config does not have dbus_object field": {configFile: "no_dbus_object.conf", wantErr: true}, } for name, tc := range tests { t.Run(name, func(t *testing.T) { From 112e109cef04143ccf50f112be2eb7b842a63217 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 15 Jan 2025 16:25:33 +0100 Subject: [PATCH 2/4] Fix spelling of "D-Bus" in user-visible strings --- internal/brokers/dbusbroker.go | 4 ++-- pam/go-exec/module.c | 2 +- pam/internal/dbusmodule/transaction_test.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/internal/brokers/dbusbroker.go b/internal/brokers/dbusbroker.go index 505004f18..853a1199f 100644 --- a/internal/brokers/dbusbroker.go +++ b/internal/brokers/dbusbroker.go @@ -23,9 +23,9 @@ type dbusBroker struct { // newDbusBroker returns a dbus broker and broker attributes from its configuration file. func newDbusBroker(ctx context.Context, bus *dbus.Conn, configFile string) (b dbusBroker, name, brandIcon string, err error) { - defer decorate.OnError(&err, "dbus broker from configuration file: %q", configFile) + defer decorate.OnError(&err, "D-Bus broker from configuration file: %q", configFile) - log.Debugf(ctx, "Dbus broker configuration at %q", configFile) + log.Debugf(ctx, "D-Bus broker configuration at %q", configFile) cfg, err := ini.Load(configFile) if err != nil { diff --git a/pam/go-exec/module.c b/pam/go-exec/module.c index 3348d557f..c6a82ecd5 100644 --- a/pam/go-exec/module.c +++ b/pam/go-exec/module.c @@ -1076,7 +1076,7 @@ do_pam_action_thread (pam_handle_t *pamh, server = setup_dbus_server (module_data, &error); if (!server) { - notify_error (pamh, action, "can't create DBus connection: %s", error->message); + notify_error (pamh, action, "can't create D-Bus connection: %s", error->message); return PAM_SYSTEM_ERR; } diff --git a/pam/internal/dbusmodule/transaction_test.go b/pam/internal/dbusmodule/transaction_test.go index 238a99dc2..19f7caebd 100644 --- a/pam/internal/dbusmodule/transaction_test.go +++ b/pam/internal/dbusmodule/transaction_test.go @@ -654,7 +654,7 @@ func prepareTestServer(t *testing.T, expectedReturns []methodReturn) (string, *t require.NoError(t, err, "Setup: Connecting to system Bus failed") t.Cleanup(func() { if err := conn.Close(); err != nil { - t.Logf("Failed closing the dbus connection: %v", err) + t.Logf("Failed closing the D-Bus connection: %v", err) } }) From dc681056e5d11628ce585b51e15168333bd13514 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 15 Jan 2025 16:27:50 +0100 Subject: [PATCH 3/4] Fix spelling of "gRPC" in user-visible strings --- internal/daemon/daemon.go | 4 ++-- internal/services/manager.go | 4 ++-- internal/services/nss/nss.go | 2 +- internal/services/pam/pam.go | 2 +- internal/services/pam/pam_test.go | 2 +- internal/services/permissions/permissions.go | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/internal/daemon/daemon.go b/internal/daemon/daemon.go index 4480baa66..a7d6c1ea7 100644 --- a/internal/daemon/daemon.go +++ b/internal/daemon/daemon.go @@ -122,9 +122,9 @@ func (d *Daemon) Serve(ctx context.Context) (err error) { log.Debug(context.Background(), "Ready state sent to systemd") } - log.Infof(ctx, "Serving GRPC requests on %v", d.lis.Addr()) + log.Infof(ctx, "Serving gRPC requests on %v", d.lis.Addr()) if err := d.grpcServer.Serve(d.lis); err != nil { - return fmt.Errorf("grpc error: %v", err) + return fmt.Errorf("gRPC error: %v", err) } return nil } diff --git a/internal/services/manager.go b/internal/services/manager.go index cc50ff10f..bb67bace8 100644 --- a/internal/services/manager.go +++ b/internal/services/manager.go @@ -59,7 +59,7 @@ func NewManager(ctx context.Context, cacheDir, brokersConfPath string, configure // RegisterGRPCServices returns a new grpc Server after registering both NSS and PAM services. func (m Manager) RegisterGRPCServices(ctx context.Context) *grpc.Server { - log.Debug(ctx, "Registering GRPC services") + log.Debug(ctx, "Registering gRPC services") opts := []grpc.ServerOption{permissions.WithUnixPeerCreds(), grpc.ChainUnaryInterceptor(m.globalPermissions, errmessages.RedactErrorInterceptor)} grpcServer := grpc.NewServer(opts...) @@ -80,7 +80,7 @@ func (m Manager) RegisterGRPCServices(ctx context.Context) *grpc.Server { // stop stops the underlying cache. func (m *Manager) stop() error { - log.Debug(context.TODO(), "Closing grpc manager and cache") + log.Debug(context.TODO(), "Closing gRPC manager and cache") return m.userManager.Stop() } diff --git a/internal/services/nss/nss.go b/internal/services/nss/nss.go index 50ef314f3..2f09f4621 100644 --- a/internal/services/nss/nss.go +++ b/internal/services/nss/nss.go @@ -28,7 +28,7 @@ type Service struct { // NewService returns a new NSS GRPC service. func NewService(ctx context.Context, userManager *users.Manager, brokerManager *brokers.Manager, permissionManager *permissions.Manager) Service { - log.Debug(ctx, "Building new GRPC NSS service") + log.Debug(ctx, "Building new gRPC NSS service") return Service{ userManager: userManager, diff --git a/internal/services/pam/pam.go b/internal/services/pam/pam.go index 586e8fa1d..fa9130d8d 100644 --- a/internal/services/pam/pam.go +++ b/internal/services/pam/pam.go @@ -34,7 +34,7 @@ type Service struct { // NewService returns a new PAM GRPC service. func NewService(ctx context.Context, userManager *users.Manager, brokerManager *brokers.Manager, permissionManager *permissions.Manager) Service { - log.Debug(ctx, "Building new GRPC PAM service") + log.Debug(ctx, "Building new gRPC PAM service") return Service{ userManager: userManager, diff --git a/internal/services/pam/pam_test.go b/internal/services/pam/pam_test.go index 2737069eb..f4c7d35a3 100644 --- a/internal/services/pam/pam_test.go +++ b/internal/services/pam/pam_test.go @@ -749,7 +749,7 @@ func newPamClient(t *testing.T, m *users.Manager, brokerManager *brokers.Manager }) conn, err := grpc.NewClient("unix://"+socketPath, grpc.WithTransportCredentials(insecure.NewCredentials()), grpc.WithUnaryInterceptor(errmessages.FormatErrorMessage)) - require.NoError(t, err, "Setup: Could not connect to GRPC server") + require.NoError(t, err, "Setup: Could not connect to gRPC server") t.Cleanup(func() { _ = conn.Close() }) // We don't care about the error on cleanup diff --git a/internal/services/permissions/permissions.go b/internal/services/permissions/permissions.go index b34f8d04b..8d786a7b0 100644 --- a/internal/services/permissions/permissions.go +++ b/internal/services/permissions/permissions.go @@ -48,11 +48,11 @@ func (m Manager) IsRequestFromRoot(ctx context.Context) (err error) { p, ok := peer.FromContext(ctx) if !ok { - return errors.New("context request doesn't have grpc peer information") + return errors.New("context request doesn't have gRPC peer information") } pci, ok := p.AuthInfo.(peerCredsInfo) if !ok { - return errors.New("context request doesn't have valid grpc peer credential information") + return errors.New("context request doesn't have valid gRPC peer credential information") } if pci.uid != m.rootUID { From 892a29d92f58b0f2364b1a6323cb176a54682020 Mon Sep 17 00:00:00 2001 From: Adrian Dombeck Date: Wed, 15 Jan 2025 16:29:07 +0100 Subject: [PATCH 4/4] Fix spelling of "gRPC" in error messages (in tests) --- internal/daemon/daemon_test.go | 2 +- internal/services/manager_test.go | 2 +- internal/services/nss/nss_test.go | 6 +++--- internal/services/permissions/permissions_test.go | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/internal/daemon/daemon_test.go b/internal/daemon/daemon_test.go index e515231ce..93ce7e9a5 100644 --- a/internal/daemon/daemon_test.go +++ b/internal/daemon/daemon_test.go @@ -120,7 +120,7 @@ func TestNew(t *testing.T) { } require.NoError(t, err, "New() should not return an error") - require.True(t, registered, "daemon should register GRPC services") + require.True(t, registered, "daemon should register gRPC services") require.Equal(t, tc.wantSelectedSocket, filepath.Base(d.SelectedSocketAddr()), "Desired socket is selected") }) } diff --git a/internal/services/manager_test.go b/internal/services/manager_test.go index 0bb4678c3..a519ee09e 100644 --- a/internal/services/manager_test.go +++ b/internal/services/manager_test.go @@ -108,7 +108,7 @@ func TestAccessAuthorization(t *testing.T) { // Global authorization for NSS is always granted for non root user. nssClient := authd.NewNSSClient(conn) _, err = nssClient.GetPasswdByName(context.Background(), &authd.GetPasswdByNameRequest{Name: ""}) - require.Error(t, err, "Expected a GRPC error from the server") + require.Error(t, err, "Expected a gRPC error from the server") err = conn.Close() require.NoError(t, err, "Teardown: could not close the client connection") diff --git a/internal/services/nss/nss_test.go b/internal/services/nss/nss_test.go index 6cce02300..4d828deee 100644 --- a/internal/services/nss/nss_test.go +++ b/internal/services/nss/nss_test.go @@ -303,7 +303,7 @@ func newNSSClient(t *testing.T, sourceDB string, currentUserNotRoot bool) (clien }) conn, err := grpc.NewClient("unix://"+socketPath, grpc.WithTransportCredentials(insecure.NewCredentials())) - require.NoError(t, err, "Setup: Could not connect to GRPC server") + require.NoError(t, err, "Setup: Could not connect to gRPC server") t.Cleanup(func() { _ = conn.Close() }) // We don't care about the error on cleanup @@ -359,7 +359,7 @@ func requireExpectedResult[T authd.PasswdEntry | authd.GroupEntry | authd.Shadow if wantErr { require.Error(t, err, fmt.Sprintf("%s should return an error but did not", funcName)) s, ok := status.FromError(err) - require.True(t, ok, "The error is always a GRPC error") + require.True(t, ok, "The error is always a gRPC error") if wantErrNotExists { require.Equal(t, codes.NotFound, s.Code(), fmt.Sprintf("%s should return NotFound error", funcName)) } @@ -377,7 +377,7 @@ func requireExpectedEntriesResult[T authd.PasswdEntry | authd.GroupEntry | authd if wantErr { require.Error(t, err, fmt.Sprintf("%s should return an error but did not", funcName)) s, ok := status.FromError(err) - require.True(t, ok, "The error is always a GRPC error") + require.True(t, ok, "The error is always a gRPC error") require.NotEqual(t, codes.NotFound, s.Code(), fmt.Sprintf("%s should never return NotFound error even with empty list", funcName)) return } diff --git a/internal/services/permissions/permissions_test.go b/internal/services/permissions/permissions_test.go index a7781e244..016deb366 100644 --- a/internal/services/permissions/permissions_test.go +++ b/internal/services/permissions/permissions_test.go @@ -82,5 +82,5 @@ func TestWithUnixPeerCreds(t *testing.T) { g := grpc.NewServer(permissions.WithUnixPeerCreds()) - require.NotNil(t, g, "New grpc with Unix Peer Creds is created") + require.NotNil(t, g, "New gRPC with Unix Peer Creds is created") }