Victor Lyuboslavsky
aaac4b1dfe
<!-- Add the related story/sub-task/bug number, like Resolves #123, or remove if NA --> **Related issue:** Resolves #38889 PLEASE READ BELOW before looking at file changes Before converting individual files/packages to slog, we generally need to make these 2 changes to make the conversion easier: - Replace uses of `kitlog.With` since they are not fully compatible with our kitlog adapter - Directly use the kitlog adapter logger type instead of the kitlog interface, which will let us have direct access to the underlying slog logger: `*logging.Logger` Note: that I did not replace absolutely all uses of `kitlog.Logger`, but I did remove all uses of `kitlog.With` except for these due to complexity: - server/logging/filesystem.go and the other log writers (webhook, firehose, kinesis, lambda, pubsub, nats) - server/datastore/mysql/nanomdm_storage.go (adapter pattern) - server/vulnerabilities/nvd/* (cascades to CLI tools) - server/service/osquery_utils/queries.go (callback type signatures cascade broadly) - cmd/maintained-apps/ (standalone, so can be transitioned later all at once) Most of the changes in this PR follow these patterns: - `kitlog.Logger` type → `*logging.Logger` - `kitlog.With(logger, ...)` → `logger.With(...)` - `kitlog.NewNopLogger() → logging.NewNopLogger()`, including similar variations such as `logging.NewLogfmtLogger(w)` and `logging.NewJSONLogger(w)` - removed many now-unused kitlog imports Unique changes that the PR review should focus on: - server/platform/logging/kitlog_adapter.go: Core adapter changes - server/platform/logging/logging.go: New convenience functions - server/service/integration_logger_test.go: Test changes for slog # Checklist for submitter If some of the following don't apply, delete the relevant line. - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. - Was added in previous PR ## Testing - [x] Added/updated automated tests - [x] QA'd all new/changed functionality manually <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Migrated the codebase to a unified internal structured logging system for more consistent, reliable logs and observability. * No user-facing functionality changed; runtime behavior and APIs remain compatible. * **Tests** * Updated tests to use the new logging helpers to ensure consistent test logging and validation. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
87 lines
2.8 KiB
Go
87 lines
2.8 KiB
Go
package integrationtest
|
|
|
|
import (
|
|
"context"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/fleetdm/fleet/v4/server/config"
|
|
"github.com/fleetdm/fleet/v4/server/datastore/mysql"
|
|
"github.com/fleetdm/fleet/v4/server/datastore/redis/redistest"
|
|
"github.com/fleetdm/fleet/v4/server/fleet"
|
|
"github.com/fleetdm/fleet/v4/server/platform/logging"
|
|
"github.com/fleetdm/fleet/v4/server/platform/mysql/testing_utils"
|
|
"github.com/fleetdm/fleet/v4/server/service"
|
|
"github.com/fleetdm/fleet/v4/server/test"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
type BaseSuite struct {
|
|
Logger *logging.Logger
|
|
FleetCfg config.FleetConfig
|
|
Server *httptest.Server
|
|
DS *mysql.Datastore
|
|
Users map[string]fleet.User
|
|
Token string
|
|
|
|
cachedAdminToken string
|
|
}
|
|
|
|
func (s *BaseSuite) GetTestAdminToken(t *testing.T) string {
|
|
// because the login endpoint is rate-limited, use the cached admin token
|
|
// if available (if for some reason a test needs to logout the admin user,
|
|
// then set cachedAdminToken = "" so that a new token is retrieved).
|
|
if s.cachedAdminToken == "" {
|
|
s.cachedAdminToken = s.GetTestToken(t, service.TestAdminUserEmail, test.GoodPassword)
|
|
}
|
|
return s.cachedAdminToken
|
|
}
|
|
|
|
func (s *BaseSuite) GetTestToken(t *testing.T, email string, password string) string {
|
|
return service.GetToken(t, email, password, s.Server.URL)
|
|
}
|
|
|
|
func SetUpServerURL(t *testing.T, ds *mysql.Datastore, server *httptest.Server) {
|
|
appConf, err := ds.AppConfig(t.Context())
|
|
require.NoError(t, err)
|
|
appConf.ServerSettings.ServerURL = server.URL
|
|
err = ds.SaveAppConfig(t.Context(), appConf)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func SetUpMySQLAndService(t *testing.T, uniqueTestName string, opts ...*service.TestServerOpts) (
|
|
*mysql.Datastore,
|
|
config.FleetConfig,
|
|
fleet.Service, context.Context,
|
|
) {
|
|
ds := mysql.CreateMySQLDSWithOptions(t, &testing_utils.DatastoreTestOptions{
|
|
UniqueTestName: uniqueTestName,
|
|
})
|
|
test.AddAllHostsLabel(t, ds)
|
|
|
|
// Set up the required fields on AppConfig
|
|
appConf, err := ds.AppConfig(testContext())
|
|
require.NoError(t, err)
|
|
appConf.OrgInfo.OrgName = "FleetTest"
|
|
appConf.ServerSettings.ServerURL = "https://example.org"
|
|
err = ds.SaveAppConfig(testContext(), appConf)
|
|
require.NoError(t, err)
|
|
|
|
fleetCfg := config.TestConfig()
|
|
fleetSvc, ctx := service.NewTestService(t, ds, fleetCfg, opts...)
|
|
return ds, fleetCfg, fleetSvc, ctx
|
|
}
|
|
|
|
func SetUpMySQLAndRedisAndService(t *testing.T, uniqueTestName string, opts ...*service.TestServerOpts) (*mysql.Datastore, fleet.RedisPool,
|
|
config.FleetConfig,
|
|
fleet.Service, context.Context,
|
|
) {
|
|
redisPool := redistest.SetupRedis(t, uniqueTestName, false, false, false)
|
|
ds, fleetCfg, fleetSvc, ctx := SetUpMySQLAndService(t, uniqueTestName, opts...)
|
|
return ds, redisPool, fleetCfg, fleetSvc, ctx
|
|
}
|
|
|
|
func testContext() context.Context {
|
|
return context.Background()
|
|
}
|