我用 Go 写了一个 SSH 客户端，我想写一些测试。问题是我以前从未真正编写过正确的单元测试，而且大多数教程似乎都侧重于为添加两个数字或其他玩具问题的函数编写测试。我读过有关模拟、使用接口(interface)和其他技术的信息，但我在应用它们时遇到了麻烦。此外，我的客户端将同时使用，以允许一次快速配置多个设备。不确定这是否会改变我编写测试的方式或是否会添加额外的测试。感谢您的帮助。

这是我的代码。基本上，Device 有 4 个主要功能:Connect、Send、Output/Err 和 Close 分别用于连接到设备、向其发送一组配置命令、捕获 session 的输出以及关闭客户端。

package device

import (
    "bufio"
    "fmt"
    "golang.org/x/crypto/ssh"
    "io"
    "net"
    "time"
)

// A Device represents a remote network device.
type Device struct {
    Host    string         // the device's hostname or IP address
    client  *ssh.Client    // the client connection
    session *ssh.Session   // the connection to the remote shell
    stdin   io.WriteCloser // the remote shell's standard input
    stdout  io.Reader      // the remote shell's standard output
    stderr  io.Reader      // the remote shell's standard error
}

// Connect establishes an SSH connection to a device and sets up the session IO.
func (d *Device) Connect(user, password string) error {
    // Create a client connection
    client, err := ssh.Dial("tcp", net.JoinHostPort(d.Host, "22"), configureClient(user, password))
    if err != nil {
        return err
    }
    d.client = client
    // Create a session
    session, err := client.NewSession()
    if err != nil {
        return err
    }
    d.session = session
    return nil
}

// configureClient sets up the client configuration for login
func configureClient(user, password string) *ssh.ClientConfig {
    var sshConfig ssh.Config
    sshConfig.SetDefaults()
    sshConfig.Ciphers = append(sshConfig.Ciphers, "aes128-cbc", "aes256-cbc", "3des-cbc", "des-cbc", "aes192-cbc")
    config := &ssh.ClientConfig{
        Config:          sshConfig,
        User:            user,
        Auth:            []ssh.AuthMethod{ssh.Password(password)},
        HostKeyCallback: ssh.InsecureIgnoreHostKey(),
        Timeout:         time.Second * 5,
    }
    return config
}

// setupIO creates the pipes connected to the remote shell's standard input, output, and error
func (d *Device) setupIO() error {
    // Setup standard input pipe
    stdin, err := d.session.StdinPipe()
    if err != nil {
        return err
    }
    d.stdin = stdin
    // Setup standard output pipe
    stdout, err := d.session.StdoutPipe()
    if err != nil {
        return err
    }
    d.stdout = stdout
    // Setup standard error pipe
    stderr, err := d.session.StderrPipe()
    if err != nil {
        return err
    }
    d.stderr = stderr
    return nil
}

// Send sends cmd(s) to the device's standard input. A device only accepts one call
// to Send, as it closes the session and its standard input pipe.
func (d *Device) Send(cmds ...string) error {
    if d.session == nil {
        return fmt.Errorf("device: session is closed")
    }
    defer d.session.Close()
    // Start the shell
    if err := d.startShell(); err != nil {
        return err
    }
    // Send commands
    for _, cmd := range cmds {
        if _, err := d.stdin.Write([]byte(cmd + "\r")); err != nil {
            return err
        }
    }
    defer d.stdin.Close()
    // Wait for the commands to exit
    d.session.Wait()
    return nil
}

// startShell requests a pseudo terminal (VT100) and starts the remote shell.
func (d *Device) startShell() error {
    modes := ssh.TerminalModes{
        ssh.ECHO:          0, // disable echoing
        ssh.OCRNL:         0,
        ssh.TTY_OP_ISPEED: 14400,
        ssh.TTY_OP_OSPEED: 14400,
    }
    err := d.session.RequestPty("vt100", 0, 0, modes)
    if err != nil {
        return err
    }
    if err := d.session.Shell(); err != nil {
        return err
    }
    return nil
}

// Output returns the remote device's standard output output.
func (d *Device) Output() ([]string, error) {
    return readPipe(d.stdout)
}

// Err returns the remote device's standard error output.
func (d *Device) Err() ([]string, error) {
    return readPipe(d.stdout)
}

// reapPipe reads an io.Reader line by line
func readPipe(r io.Reader) ([]string, error) {
    var lines []string
    scanner := bufio.NewScanner(r)
    for scanner.Scan() {
        lines = append(lines, scanner.Text())
    }
    if err := scanner.Err(); err != nil {
        return nil, err
    }
    return lines, nil
}

// Close closes the client connection.
func (d *Device) Close() error {
    return d.client.Close()
}

// String returns the string representation of a `Device`.
func (d *Device) String() string {
    return fmt.Sprintf("%s", d.Host)
}

最佳答案

单元测试教程几乎总是玩具问题(为什么它总是斐波那契数列？)，当我们拥有的是数据库和 http 服务器时，你提出了一个很好的观点。对我有帮助的最大认识是，您只能对可以控制单元输入和输出的事物进行单元测试。 configureClient 或 readPipe(给它一个 strings.Reader)将是不错的选择。从这里开始。

任何通过直接与磁盘、网络、stdout 等对话而离开您的程序的东西，例如 Connect 方法，您可以将其视为程序外部接口(interface)的一部分。你不对那些进行单元测试。您对它们进行集成测试。

将 Device 更改为接口(interface)而不是结构，并制作一个实现它的 MockDevice。真正的设备现在可能是 SSHDevice。您可以通过插入 MockDevice 对程序的其余部分(使用设备接口(interface))进行单元测试，以将自己与网络隔离。

SSHDevice 将在您的集成测试中进行测试。启动一个真正的 ssh 服务器(也许是你使用 crypto/ssh 包在 Go 中编写的测试服务器，但任何 sshd 都可以)。使用 SSHDevice 启动您的程序，让它们相互对话，并检查输出。您将经常使用 os/exec 包。编写集成测试比编写单元测试更有趣!

关于unit-testing - 在 Go 中对 SSH 客户端进行单元测试，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/49418982/