Question

我在Go写了一个SSH客户端，我想写一些测试。问题是我之前从未真正编写过正确的单元测试，大多数教程似乎都专注于为一个函数编写测试，这个函数会增加两个数字或其他一些玩具问题。我读过关于模拟，使用接口和其他技术，但我在应用它们时遇到了麻烦。此外，我的客户端将同时使用，以允许一次快速配置多个设备。不确定这是否会改变我编写测试的方式或添加其他测试。任何帮助表示赞赏。

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

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)
}

Answer 1

关于单元测试教程几乎总是存在玩具问题（为什么它总是斐波那契？），当我们拥有的是数据库和http服务器时，你提出了一个很好的观点。帮助我的重要实现是，您只能对可以控制单元输入和输出的单元进行单元测试。 configureClient或readPipe（给它strings.Reader）将是不错的候选人。从那里开始。

通过直接与磁盘，网络，标准输出等进行对话而离开程序的任何事情，例如您将被视为程序外部接口的Connect方法。你不进行单元测试。您集成测试它们。

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

SSHDevice将在集成测试中进行测试。启动一个真正的ssh服务器（也许是你使用crypto / ssh包在Go中编写的测试服务器，但任何sshd都可以工作）。使用SSHDevice启动程序，让它们相互通信，并检查输出。您将大量使用os/exec包。集成测试比单元测试更有趣！

在Go中单元测试SSH客户端

1 个答案: