Skip to content

docs: fix typo and missing import in tools.md #4917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
opjt wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −13
Open

docs: fix typo and missing import in tools.md #4917

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions docs/testing/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func TestMyThing(t *testing.T) {
// Declare your test
myTest := nerdtest.Setup()
// This is going to run `nerdctl info` (or `docker info`)
mytest.Command = test.Command("info")
myTest.Command = test.Command("info")
// Verify the command exits with 0, and stdout contains the word `Kernel`
myTest.Expected = test.Expects(0, nil, expect.Contains("Kernel"))
Copy link
Copy Markdown
Contributor

@sathiraumesh sathiraumesh May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some other changes if you like to do like there are constants in Tigron framework it self for these exit codes and so on

// Run it
Expand Down Expand Up @@ -82,9 +82,10 @@ import (

"gotest.tools/v3/assert"

"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/expect"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/tig"
)

func MyComparator(compare string) test.Comparator {
Expand Down Expand Up @@ -118,10 +119,12 @@ import (

"github.com/containerd/errdefs"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/expect"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/tig"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
)

func TestMyThing(t *testing.T) {
Expand Down Expand Up @@ -229,10 +232,12 @@ import (

"github.com/containerd/errdefs"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/expect"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/tig"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
)

func TestMyThing(t *testing.T) {
Expand Down Expand Up @@ -310,10 +315,12 @@ import (

"github.com/containerd/errdefs"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/expect"
"github.com/containerd/nerdctl/mod/tigron/require"
"github.com/containerd/nerdctl/mod/tigron/test"
"github.com/containerd/nerdctl/mod/tigron/tig"

"github.com/containerd/nerdctl/v2/pkg/testutil/nerdtest"
)

func TestMyThing(t *testing.T) {
Expand Down Expand Up @@ -421,7 +428,7 @@ nerdtest.CNIFirewallVersion("1.7.1") // CNI firewall plugin version check

### About `nerdtest.Private`

While all requirements above are self-descriptive or obvious, `nerdtest.Private` is a
While all requirements above are self-descriptive or obvious, `nerdtest.Private` is a
special case.

If set, it will run tests inside a dedicated namespace that is private to the test.
Expand Down
Loading