Function TestNewCmdExtension_UpdateCheckIsNonblocking

pkg/cmd/root/extension_test.go:182–242

(t *testing.T)

}

func TestNewCmdExtension_UpdateCheckIsNonblocking(t *testing.T) {
	ios, _, _, _ := iostreams.Test()

	em := &extensions.ExtensionManagerMock{
		DispatchFunc: func(args []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (bool, error) {
			// Assume extension executed / dispatched without problems as test is focused on upgrade checking.
			return true, nil
		},
	}

	ext := &extensions.ExtensionMock{
		CurrentVersionFunc: func() string {
			return "1.0.0"
		},
		IsPinnedFunc: func() bool {
			return false
		},
		LatestVersionFunc: func() string {
			return "2.0.0"
		},
		NameFunc: func() string {
			return "major-update"
		},
		OwnerFunc: func() string {
			return ""
		},
		UpdateAvailableFunc: func() bool {
			return true
		},
		URLFunc: func() string {
			return "https//github.com/dne/major-update"
		},
	}

	// When the extension command is executed, the checkFunc will run in the background longer than the extension dispatch.
	// If the update check is non-blocking, then the extension command will complete immediately while checkFunc is still running.
	checkFunc := func(em extensions.ExtensionManager, ext extensions.Extension) (*update.ReleaseInfo, error) {
		time.Sleep(30 * time.Second)
		return nil, fmt.Errorf("update check should not have completed")
	}

	cmd := root.NewCmdExtension(ios, em, ext, checkFunc)

	// The test whether update check is non-blocking is based on how long it takes for the extension command execution.
	// If there is no wait time as checkFunc is sleeping sufficiently long, we can trust update check is non-blocking.
	// Otherwise, if any amount of wait is encountered, it is a decent indicator that update checking is blocking.
	// This is not an ideal test and indicates the update design should be revisited to be easier to understand and manage.
	completed := make(chan struct{})
	go func() {
		_, err := cmd.ExecuteC()
		require.NoError(t, err)
		close(completed)
	}()

	select {
	case <-completed:
		// Expected behavior assuming extension dispatch exits immediately while checkFunc is still running.
	case <-time.After(1 * time.Second):