GoConvey 项目教程

GoConvey 项目教程

goconvey Go testing in the browser. Integrates with `go test`. Write behavioral tests in Go. 项目地址: https://gitcode.com/gh_mirrors/go/goconvey

1. 项目目录结构及介绍

GoConvey 项目的目录结构如下：

goconvey/
├── convey/
│   ├── convey.go
│   └── ...
├── examples/
│   ├── example1.go
│   └── ...
├── web/
│   ├── index.html
│   └── ...
├── .gitattributes
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── check_third_party.sh
├── go.mod
├── go.sum
└── ...

目录结构介绍

• convey/: 包含 GoConvey 的核心代码文件，如 convey.go。
• examples/: 包含一些示例代码，帮助用户理解如何使用 GoConvey 进行测试。
• web/: 包含 Web UI 相关的文件，如 index.html。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• check_third_party.sh: 检查第三方依赖的脚本。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块的校验和文件。

2. 项目启动文件介绍

GoConvey 的启动文件主要是 convey.go，位于 convey/ 目录下。这个文件包含了 GoConvey 的核心逻辑和功能实现。用户可以通过导入 github.com/smartystreets/goconvey/convey 包来使用 GoConvey 提供的测试功能。

启动文件示例

package convey

import (
    "testing"
    "github.com/smartystreets/goconvey/convey"
)

func TestSpec(t *testing.T) {
    // 仅在顶层 Convey 调用中传递 t
    convey.Convey("Given some integer with a starting value", t, func() {
        x := 1
        convey.Convey("When the integer is incremented", func() {
            x++
            convey.Convey("The value should be greater by one", func() {
                convey.So(x, convey.ShouldEqual, 2)
            })
        })
    })
}

3. 项目配置文件介绍

GoConvey 项目的配置文件主要包括 .travis.yml 和 go.mod。

.travis.yml

.travis.yml 是 Travis CI 的配置文件，用于定义项目的持续集成流程。以下是一个简单的示例：

language: go
go:
  - 1.16
  - 1.17

script:
  - go test -v ./...

go.mod

go.mod 是 Go 模块文件，定义了项目的依赖关系。以下是一个简单的示例：

module github.com/smartystreets/goconvey

go 1.16

require (
    github.com/smartystreets/assertions v1.1.0
    github.com/smartystreets/gunit v1.0.0
)

通过这些配置文件，用户可以了解项目的依赖关系和持续集成流程。

goconvey Go testing in the browser. Integrates with `go test`. Write behavioral tests in Go. 项目地址: https://gitcode.com/gh_mirrors/go/goconvey