如何對這個用 golang 編寫的 promptui package 進行單元測試？

Question

我是 golang 的新手，我在我的一個項目中使用了一個名為 promptui ( https://github.com/manifoldco/promptui ) 的交互式提示。 我已經為這個項目編寫了幾個單元測試，但我正在努力解決如何對這個需要輸入的特定 package 進行單元測試的問題。

例如，我 go 如何測試以下代碼行（封裝在一個函數中）：

func setEmail() string {
  prompt := promptui.Prompt{Label: "Input your Email",
     Validate: emailValidations,
  }

  email, err := prompt.Run()
  if err != nil {
    color.red("failed getting email")
    os.exit(3)
  }
  return email
}

我想我需要以某種方式模擬 stdin 但無法在測試中找到最好的方法。

Answer 1

您不應該嘗試測試promptui因為它應該由作者測試。

你可以測試什么：

1. 您在創建promptui.Prompt時發送正確的參數
2. 您在代碼中使用了promptui.Prompt
3. 你正確處理promptui.Prompt結果

如您所見，所有這些測試都不驗證promptui.Prompt是否在內部正常工作。

可以組合測試＃2和＃3。 您需要針對模擬運行代碼，如果結果正確，您可以相信＃2和＃3都是正確的。

創建模擬：

type Runner interface {
    Run() (int, string, error)
}

type promptMock struct {
    // t is not required for this test, but it is would be helpful to assert input parameters if we have it in Run()
    t *testing.T
}

func (p promptMock) Run() (int, string, error) {
    // return expected result
    return 1, "", nil
}

您將需要單獨的模擬來測試錯誤流。

更新你的代碼以注入mock：

func setEmail(runner Runner) string {
    email, err := runner.Run()
    if err != nil {
      color.red("failed getting email")
      os.exit(3)
    }
    return email
}

現在它是可測試的。

創建創建prompt函數：

func getRunner() promptui.Prompt {
  return promptui.Prompt{Label: "Input your Email",
     Validate: emailValidations,
  }
} 

編寫簡單的斷言測試以驗證我們是否創建了正確的結構。

唯一沒有測試的行將是setEmail(getRunner())但它很簡單，可以被其他類型的測試覆蓋。

Answer 2

promptui 現在具有 Stdin 屬性。

這里有一個小提琴： https://play.golang.org/p/-mSgjY2kAw-

這是我們將要測試的 function：

func mock(p promptui.Prompt) string {
    p.Label = "[Y/N]"
    user_input, err := p.Run()
    if err != nil {
        fmt.Printf("Prompt failed %v\n", err)
    }

    return user_input
}

我們需要創建p ，它將是 promptui.Prompt 的一個實例並具有自定義標准輸入。

我在這里得到了一些幫助 - https://groups.google.com/g/golang-nuts/c/J-Y4LtdGNSw?pli=1 - 如何制作自定義 Stdin 值，它只需要符合 io.ReadCloser .

type ClosingBuffer struct {
    *bytes.Buffer
}

func (cb ClosingBuffer) Close() error {
    return nil
}

然后在閱讀器中將其用作 Stdin：

func TestMock(t *testing.T) {

    reader := ClosingBuffer{
        bytes.NewBufferString("N\n"),
    }

    p := promptui.Prompt{
        Stdin: reader,
    }

    response := mock(p)

    if !strings.EqualFold(response, "N") {
        t.Errorf("nope!")
    }
    //t.Errorf(response)
}

---

編輯：以上內容不適用於同一個 function 中的多個提示，正如此處討論的解決方案： https://github.com/manifoldco/promptui/issues/63 - “promptui 內部使用 4096 字節的緩沖區。這意味着您必須填充緩沖區，否則 promptui 將引發 EOF。”

我從那個交易所拿了這個pad() function - https://github.com/sandokandias/capiroto/blob/master/cmd/capiroto/main.go ：

func pad(siz int, buf *bytes.Buffer) {
    pu := make([]byte, 4096-siz)
    for i := 0; i < 4096-siz; i++ {
        pu[i] = 97
    }
    buf.Write(pu)
}

然后測試——這個解決方案使用 ioutil.NopCloser 而不是創建一個新的結構：

func TestMock(t *testing.T) {

    i1 := "N\n"
    i2 := "Y\n"

    b := bytes.NewBuffer([]byte(i1))
    pad(len(i1), b)
    reader := ioutil.NopCloser(
        b,
    )
    b.WriteString(i2)
    pad(len(i2), b)

    p := promptui.Prompt{
        Stdin: reader,
    }

    response := mock(p)

    if !strings.EqualFold(response, "NY") {
        t.Errorf("nope!")
        t.Errorf(response)
    }
}

和我們正在測試的 function：

func mock(p promptui.Prompt) string {
    p.Label = "[Y/N]"
    user_input, err := p.Run()
    if err != nil {
        fmt.Printf("Prompt failed %v\n", err)
    }
    user_input2, err := p.Run()

    return user_input + user_input2
}

多個提示的小提琴在這里： https://play.golang.org/p/ElPysYq8aM1

Answer 3

無論出於何種原因，他們不會導出他們的stdin界面（ https://github.com/manifoldco/promptui/blob/master/prompt.go#L49 ），所以你不能嘲笑它，但你可以直接嘲笑os.Stdin並預先os.Stdin測試所需的一切。 雖然我同意@Adrian，但它有自己的測試，所以這不應該是必要的。

從源中提取和重構/簡化： 填寫os.Stdin以獲取從中讀取的函數

以這種方式重構，它可以用於從os.Stdin讀取並期望特定字符串的任何函數。

游樂場鏈接： https ： //play.golang.org/p/rjgcGIaftBK

func TestSetEmail(t *testing.T) {
    if err := TestExpectedStdinFunc("email@test.com", setEmail); err != nil {
        t.Error(err)
        return
    }
    fmt.Println("success")
}

func TestExpectedStdinFunc(expected string, f func() string) error {
    content := []byte(expected)
    tmpfile, err := ioutil.TempFile("", "example")
    if err != nil {
        return err
    }

    defer os.Remove(tmpfile.Name()) // clean up

    if _, err := tmpfile.Write(content); err != nil {
        return err
    }

    if _, err := tmpfile.Seek(0, 0); err != nil {
        return err
    }

    oldStdin := os.Stdin
    defer func() { os.Stdin = oldStdin }() // Restore original Stdin

    os.Stdin = tmpfile
    actual := f()
    if actual != expected {
        return errors.New(fmt.Sprintf("test failed, exptected: %s actual: %s", expected, actual))
    }

    if err := tmpfile.Close(); err != nil {
        return err
    }
    return nil
}