Skip to content

Commit

Permalink
test: remove hardcoded files to check
Browse files Browse the repository at this point in the history
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
  • Loading branch information
crazy-max committed Jun 27, 2023
1 parent 5cb124c commit 2272c56
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 21 deletions.
40 changes: 32 additions & 8 deletions clidocstool_md_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,13 @@
package clidocstool

import (
"io/fs"
"os"
"path"
"path/filepath"
"strings"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

Expand All @@ -39,15 +40,38 @@ func TestGenMarkdownTree(t *testing.T) {
require.NoError(t, err)
require.NoError(t, c.GenMarkdownTree(buildxCmd))

for _, tt := range []string{"buildx.md", "buildx_build.md", "buildx_stop.md"} {
tt := tt
t.Run(tt, func(t *testing.T) {
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
seen := make(map[string]struct{})

require.NoError(t, filepath.Walk("fixtures", func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
// ignore dirs, .pre.md files and any file that is not a .md file
if info.IsDir() || !strings.HasSuffix(fname, ".md") || strings.HasSuffix(fname, ".pre.md") {
return nil
}
seen[fname] = struct{}{}
t.Run(fname, func(t *testing.T) {
require.NoError(t, err)

bres, err := os.ReadFile(filepath.Join(tmpdir, fname))
require.NoError(t, err)

bexc, err := os.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path)
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
require.Equal(t, string(bexc), string(bres))
})
return nil
}))

require.NoError(t, filepath.Walk(tmpdir, func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
if info.IsDir() || !strings.HasSuffix(fname, ".md") || strings.HasSuffix(fname, ".pre.md") {
return nil
}
t.Run("seen_"+fname, func(t *testing.T) {
if _, ok := seen[fname]; !ok {
t.Errorf("file %s not found in fixtures", fname)
}
})
}
return nil
}))
}
37 changes: 31 additions & 6 deletions clidocstool_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
package clidocstool

import (
"io/fs"
"os"
"path"
"path/filepath"
"strings"
"testing"

"github.com/docker/cli-docs-tool/annotation"
Expand Down Expand Up @@ -201,15 +203,38 @@ func TestGenAllTree(t *testing.T) {
require.NoError(t, err)
require.NoError(t, c.GenAllTree())

for _, tt := range []string{"buildx.md", "buildx_build.md", "buildx_stop.md", "docker_buildx.yaml", "docker_buildx_build.yaml", "docker_buildx_install.yaml", "docker_buildx_stop.yaml"} {
tt := tt
t.Run(tt, func(t *testing.T) {
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
seen := make(map[string]struct{})

require.NoError(t, filepath.Walk("fixtures", func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
// ignore dirs and .pre.md files
if info.IsDir() || strings.HasSuffix(fname, ".pre.md") {
return nil
}
seen[fname] = struct{}{}
t.Run(fname, func(t *testing.T) {
require.NoError(t, err)

bres, err := os.ReadFile(filepath.Join(tmpdir, fname))
require.NoError(t, err)

bexc, err := os.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path)
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
})
}
return nil
}))

require.NoError(t, filepath.Walk(tmpdir, func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
if info.IsDir() || strings.HasSuffix(fname, ".pre.md") {
return nil
}
t.Run("seen_"+fname, func(t *testing.T) {
if _, ok := seen[fname]; !ok {
t.Errorf("file %s not found in fixtures", fname)
}
})
return nil
}))
}
38 changes: 31 additions & 7 deletions clidocstool_yaml_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
package clidocstool

import (
"io/fs"
"os"
"path"
"path/filepath"
"strings"
"testing"

"github.com/stretchr/testify/assert"
Expand All @@ -36,15 +37,38 @@ func TestGenYamlTree(t *testing.T) {
require.NoError(t, err)
require.NoError(t, c.GenYamlTree(buildxCmd))

for _, tt := range []string{"docker_buildx.yaml", "docker_buildx_build.yaml", "docker_buildx_install.yaml", "docker_buildx_stop.yaml"} {
tt := tt
t.Run(tt, func(t *testing.T) {
bres, err := os.ReadFile(filepath.Join(tmpdir, tt))
seen := make(map[string]struct{})

require.NoError(t, filepath.Walk("fixtures", func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
// ignore dirs, .pany file that is not a .yaml file
if info.IsDir() || !strings.HasSuffix(fname, ".yaml") {
return nil
}
seen[fname] = struct{}{}
t.Run(fname, func(t *testing.T) {
require.NoError(t, err)

bres, err := os.ReadFile(filepath.Join(tmpdir, fname))
require.NoError(t, err)

bexc, err := os.ReadFile(path.Join("fixtures", tt))
bexc, err := os.ReadFile(path)
require.NoError(t, err)
assert.Equal(t, string(bexc), string(bres))
})
}
return nil
}))

require.NoError(t, filepath.Walk(tmpdir, func(path string, info fs.FileInfo, err error) error {
fname := filepath.Base(path)
if info.IsDir() || !strings.HasSuffix(fname, ".yaml") {
return nil
}
t.Run("seen_"+fname, func(t *testing.T) {
if _, ok := seen[fname]; !ok {
t.Errorf("file %s not found in fixtures", fname)
}
})
return nil
}))
}

0 comments on commit 2272c56

Please sign in to comment.