STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Comment the purpose of the helper config contract

Browse source
This commit is contained in:
William Martin 2024-05-17 14:33:19 +02:00
parent 540bda1a6b
commit 3fe555b0bb
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
pkg/cmd/auth/shared/contract/helper_config.go
View file

@ -7,6 +7,11 @@ import (
"github.com/stretchr/testify/require"
)
// This HelperConfig contract exist to ensure that any HelperConfig implementation conforms to this behaviour.
// This is useful because we can swap in fake implementations for testing, rather than requiring our tests to be
// isolated from git.
//
// See for example, TestAuthenticatingGitCredentials for LoginFlow.
type HelperConfig struct {
NewHelperConfig func(t *testing.T) shared.HelperConfig
ConfigureHelper func(t *testing.T, hostname string)