upstream-ory-kratos/pkg/driver.go

// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0

package pkg

import (
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/gofrs/uuid"
	"github.com/sirupsen/logrus"
	"github.com/stretchr/testify/require"

	"github.com/ory/kratos/driver"
	"github.com/ory/kratos/driver/config"
	"github.com/ory/kratos/embedx"
	"github.com/ory/kratos/selfservice/hook"
	"github.com/ory/kratos/x/nosurfx"
	"github.com/ory/x/configx"
	"github.com/ory/x/contextx"
	"github.com/ory/x/dbal"
	"github.com/ory/x/jsonnetsecure"
	"github.com/ory/x/logrusx"
	"github.com/ory/x/randx"
)

func NewConfigurationWithDefaults(t testing.TB, opts ...configx.OptionModifier) *config.Config {
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
		w.WriteHeader(http.StatusOK)
		_, _ = w.Write([]byte(`OK`))
	}))
	t.Cleanup(ts.Close)

	configOpts := append([]configx.OptionModifier{
		configx.WithValues(map[string]interface{}{
			"log.level":                                  "error",
			config.ViperKeyDSN:                           dbal.NewSQLiteTestDatabase(t),
			config.ViperKeyHasherArgon2ConfigMemory:      16384,
			config.ViperKeyHasherArgon2ConfigIterations:  1,
			config.ViperKeyHasherArgon2ConfigParallelism: 1,
			config.ViperKeyHasherArgon2ConfigSaltLength:  16,
			// The invalid-credentials login/webauthn paths sleep for
			// RandomDelay(expected_duration, expected_deviation) to mask timing
			// attacks. In tests this adds 0–1s per negative path; shrink it to
			// keep the timing-defense code exercised without the wall-clock cost.
			config.ViperKeyHasherArgon2ConfigExpectedDuration:  "1ns",
			config.ViperKeyHasherArgon2ConfigExpectedDeviation: "1ns",
			config.ViperKeyHasherBcryptCost:                    4,
			config.ViperKeyHasherArgon2ConfigKeyLength:         16,
			config.ViperKeyCourierSMTPURL:                      "smtp://foo:bar@baz.com/",
			config.ViperKeySelfServiceBrowserDefaultReturnTo:   ts.URL,
			config.ViperKeySecretsCipher:                       []string{"secret-thirty-two-character-long"},
			config.ViperKeySecretsPagination:                   []string{uuid.Must(uuid.NewV4()).String()},
			config.ViperKeySelfServiceLoginFlowStyle:           "unified",
		}),
		configx.SkipValidation(),
		configx.DisableEnvLoading(),
	}, opts...)
	return config.MustNew(t, logrusx.New("", ""),
		contextx.NewTestConfigProvider(embedx.ConfigSchema, configOpts...),
		configOpts...,
	)
}

// NewFastRegistryWithMocks returns a registry with several mocks and an SQLite in memory database that make testing
// easier and way faster. This suite does not work for e2e or advanced integration tests.
func NewFastRegistryWithMocks(t *testing.T, opts ...configx.OptionModifier) (*config.Config, *driver.RegistryDefault) {
	conf, reg := NewRegistryDefaultWithDSN(t, "", opts...)
	reg.WithCSRFTokenGenerator(nosurfx.FakeCSRFTokenGenerator)
	reg.WithCSRFHandler(nosurfx.NewFakeCSRFHandler(reg))
	reg.WithHooks(map[string]driver.NewHookFn{
		"err": func(c config.SelfServiceHook, _ driver.Registry) interface{} {
			return &hook.Error{Config: c.Config}
		},
	})

	return conf, reg
}

// NewRegistryDefaultWithDSN returns a more standard registry without mocks. Good for e2e and advanced integration testing!
func NewRegistryDefaultWithDSN(t testing.TB, dsn string, opts ...configx.OptionModifier) (*config.Config, *driver.RegistryDefault) {
	if dsn == "" {
		dsn = dbal.NewSQLiteTestDatabase(t)
	}
	c := NewConfigurationWithDefaults(t, append([]configx.OptionModifier{configx.WithValues(map[string]interface{}{
		config.ViperKeyDSN:             dsn,
		"dev":                          true,
		config.ViperKeySecretsCipher:   []string{randx.MustString(32, randx.AlphaNum)},
		config.ViperKeySecretsCookie:   []string{randx.MustString(32, randx.AlphaNum)},
		config.ViperKeySecretsDefault:  []string{randx.MustString(32, randx.AlphaNum)},
		config.ViperKeyCipherAlgorithm: "xchacha20-poly1305",
	})}, opts...)...)
	reg, err := driver.NewRegistryFromDSN(t.Context(), c, logrusx.New("", "", logrusx.ForceLevel(logrus.ErrorLevel)))
	require.NoError(t, err)

	reg.SetJSONNetVMProvider(jsonnetsecure.NewTestProvider(t))

	require.NoError(t, reg.Init(t.Context(), contextx.NewTestConfigProvider(embedx.ConfigSchema), driver.SkipNetworkInit, driver.WithDisabledMigrationLogging()))
	require.NoError(t, reg.Persister().MigrateUp(t.Context())) // always migrate up

	actual, err := reg.Persister().DetermineNetwork(t.Context())
	require.NoError(t, err)
	reg.SetPersister(reg.Persister().WithNetworkID(actual.ID))

	require.EqualValues(t, reg.Persister().NetworkID(t.Context()), actual.ID)
	require.NotEqual(t, uuid.Nil, reg.Persister().NetworkID(t.Context()))

	return c, reg
}

func NewVeryFastRegistryWithoutDB(t *testing.T) (*config.Config, *driver.RegistryDefault) {
	c := NewConfigurationWithDefaults(t)
	reg, err := driver.NewRegistryFromDSN(t.Context(), c, logrusx.New("", ""))
	require.NoError(t, err)
	return c, reg
}