Merge pull request #29776 from hashicorp/alisdair/fix-flaky-init-cancel-test

cli: Fix flaky init cancel test
This commit is contained in:
Alisdair McDiarmid 2021-10-19 09:34:00 -04:00 committed by GitHub
commit 1bc3e593f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 8 deletions

View File

@ -1372,14 +1372,12 @@ func TestInit_cancel(t *testing.T) {
defer os.RemoveAll(td)
defer testChdir(t, td)()
providerSource, closeSrc := newMockProviderSource(t, map[string][]string{
"test": {"1.2.3", "1.2.4"},
"test-beta": {"1.2.4"},
"source": {"1.2.2", "1.2.3", "1.2.1"},
})
defer closeSrc()
// Use a provider source implementation which is designed to hang indefinitely,
// to avoid a race between the closed shutdown channel and the provider source
// operations.
providerSource := &getproviders.HangingSource{}
// our shutdown channel is pre-closed so init will exit as soon as it
// Our shutdown channel is pre-closed so init will exit as soon as it
// starts a cancelable portion of the process.
shutdownCh := make(chan struct{})
close(shutdownCh)
@ -1401,7 +1399,7 @@ func TestInit_cancel(t *testing.T) {
args := []string{}
if code := c.Run(args); code == 0 {
t.Fatalf("succeeded; wanted error")
t.Fatalf("succeeded; wanted error\n%s", ui.OutputWriter.String())
}
// Currently the first operation that is cancelable is provider
// installation, so our error message comes from there. If we

View File

@ -0,0 +1,29 @@
package getproviders
import (
"context"
"github.com/hashicorp/terraform/internal/addrs"
)
// HangingSource is an implementation of Source which hangs until the given
// context is cancelled. This is useful only for unit tests of user-controlled
// cancels.
type HangingSource struct {
}
var _ Source = (*HangingSource)(nil)
func (s *HangingSource) AvailableVersions(ctx context.Context, provider addrs.Provider) (VersionList, Warnings, error) {
<-ctx.Done()
return nil, nil, nil
}
func (s *HangingSource) PackageMeta(ctx context.Context, provider addrs.Provider, version Version, target Platform) (PackageMeta, error) {
<-ctx.Done()
return PackageMeta{}, nil
}
func (s *HangingSource) ForDisplay(provider addrs.Provider) string {
return "hanging source"
}