refactor: factorize startup checks (#2386)

* refactor: factorize startup checks

* refactor: address linting issues

1 files changed, 30 insertions, 7 deletions

diff --git a/internal/authentication/ldap_user_provider_test.go b/internal/authentication/ldap_user_provider_test.go
index 701c8564b..b9b739f38 100644
--- a/internal/authentication/ldap_user_provider_test.go
+++ b/internal/authentication/ldap_user_provider_test.go
@@ -12,6 +12,7 @@ import (
 	"golang.org/x/text/encoding/unicode"
 
 	"github.com/authelia/authelia/v4/internal/configuration/schema"
+	"github.com/authelia/authelia/v4/internal/logging"
 	"github.com/authelia/authelia/v4/internal/utils"
 )
 
@@ -26,6 +27,7 @@ func TestShouldCreateRawConnectionWhenSchemeIsLDAP(t *testing.T) {
 		schema.LDAPAuthenticationBackendConfiguration{
 			URL: "ldap://127.0.0.1:389",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -55,6 +57,7 @@ func TestShouldCreateTLSConnectionWhenSchemeIsLDAPS(t *testing.T) {
 		schema.LDAPAuthenticationBackendConfiguration{
 			URL: "ldaps://127.0.0.1:389",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -83,6 +86,7 @@ func TestEscapeSpecialCharsFromUserInput(t *testing.T) {
 		schema.LDAPAuthenticationBackendConfiguration{
 			URL: "ldaps://127.0.0.1:389",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -115,6 +119,7 @@ func TestEscapeSpecialCharsInGroupsFilter(t *testing.T) {
 			URL:          "ldaps://127.0.0.1:389",
 			GroupsFilter: "(|(member={dn})(uid={username})(uid={input}))",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -179,6 +184,7 @@ func TestShouldCheckLDAPServerExtensions(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -210,7 +216,7 @@ func TestShouldCheckLDAPServerExtensions(t *testing.T) {
 
 	gomock.InOrder(dialURL, connBind, searchOIDs, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	assert.NoError(t, err)
 
 	assert.True(t, ldapClient.supportExtensionPasswdModify)
@@ -235,6 +241,7 @@ func TestShouldNotEnablePasswdModifyExtension(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -266,7 +273,7 @@ func TestShouldNotEnablePasswdModifyExtension(t *testing.T) {
 
 	gomock.InOrder(dialURL, connBind, searchOIDs, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	assert.NoError(t, err)
 
 	assert.False(t, ldapClient.supportExtensionPasswdModify)
@@ -291,6 +298,7 @@ func TestShouldReturnCheckServerConnectError(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -298,7 +306,7 @@ func TestShouldReturnCheckServerConnectError(t *testing.T) {
 		DialURL(gomock.Eq("ldap://127.0.0.1:389"), gomock.Any()).
 		Return(mockConn, errors.New("could not connect"))
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	assert.EqualError(t, err, "could not connect")
 
 	assert.False(t, ldapClient.supportExtensionPasswdModify)
@@ -323,6 +331,7 @@ func TestShouldReturnCheckServerSearchError(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -342,7 +351,7 @@ func TestShouldReturnCheckServerSearchError(t *testing.T) {
 
 	gomock.InOrder(dialURL, connBind, searchOIDs, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	assert.EqualError(t, err, "could not perform the search")
 
 	assert.False(t, ldapClient.supportExtensionPasswdModify)
@@ -384,6 +393,7 @@ func TestShouldEscapeUserInput(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -416,6 +426,7 @@ func TestShouldCombineUsernameFilterAndUsersFilter(t *testing.T) {
 			MailAttribute:        "mail",
 			DisplayNameAttribute: "displayName",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -463,6 +474,7 @@ func TestShouldNotCrashWhenGroupsAreNotRetrievedFromLDAP(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -532,6 +544,7 @@ func TestShouldNotCrashWhenEmailsAreNotRetrievedFromLDAP(t *testing.T) {
 			AdditionalUsersDN: "ou=users",
 			BaseDN:            "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -594,6 +607,7 @@ func TestShouldReturnUsernameFromLDAP(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -665,6 +679,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtension(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -740,7 +755,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtension(t *testing.T) {
 
 	gomock.InOrder(dialURLOIDs, connBindOIDs, searchOIDs, connCloseOIDs, dialURL, connBind, searchProfile, passwdModify, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	require.NoError(t, err)
 
 	err = ldapClient.UpdatePassword("john", "password")
@@ -767,6 +782,7 @@ func TestShouldUpdateUserPasswordActiveDirectory(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -846,7 +862,7 @@ func TestShouldUpdateUserPasswordActiveDirectory(t *testing.T) {
 
 	gomock.InOrder(dialURLOIDs, connBindOIDs, searchOIDs, connCloseOIDs, dialURL, connBind, searchProfile, passwdModify, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	require.NoError(t, err)
 
 	err = ldapClient.UpdatePassword("john", "password")
@@ -873,6 +889,7 @@ func TestShouldUpdateUserPasswordBasic(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -949,7 +966,7 @@ func TestShouldUpdateUserPasswordBasic(t *testing.T) {
 
 	gomock.InOrder(dialURLOIDs, connBindOIDs, searchOIDs, connCloseOIDs, dialURL, connBind, searchProfile, passwdModify, connClose)
 
-	err := ldapClient.checkServer()
+	err := ldapClient.StartupCheck(logging.Logger())
 	require.NoError(t, err)
 
 	err = ldapClient.UpdatePassword("john", "password")
@@ -975,6 +992,7 @@ func TestShouldCheckValidUserPassword(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -1042,6 +1060,7 @@ func TestShouldCheckInvalidUserPassword(t *testing.T) {
 			AdditionalUsersDN:    "ou=users",
 			BaseDN:               "dc=example,dc=com",
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -1110,6 +1129,7 @@ func TestShouldCallStartTLSWhenEnabled(t *testing.T) {
 			BaseDN:               "dc=example,dc=com",
 			StartTLS:             true,
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -1186,6 +1206,7 @@ func TestShouldParseDynamicConfiguration(t *testing.T) {
 			BaseDN:               "dc=example,dc=com",
 			StartTLS:             true,
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -1224,6 +1245,7 @@ func TestShouldCallStartTLSWithInsecureSkipVerifyWhenSkipVerifyTrue(t *testing.T
 				SkipVerify: true,
 			},
 		},
+		false,
 		nil,
 		mockFactory)
 
@@ -1306,6 +1328,7 @@ func TestShouldReturnLDAPSAlreadySecuredWhenStartTLSAttempted(t *testing.T) {
 				SkipVerify: true,
 			},
 		},
+		false,
 		nil,
 		mockFactory)