91 lines
1.9 KiB
Go
91 lines
1.9 KiB
Go
//go:build enable_linters
|
|
|
|
package docsorder
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"regexp"
|
|
"sort"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
const repoPath = "../../.."
|
|
|
|
var numberedFileRe = regexp.MustCompile(`^(\d+)-`)
|
|
|
|
type numberedFile struct {
|
|
name string
|
|
numStr string
|
|
num int
|
|
}
|
|
|
|
func TestDocsOrder(t *testing.T) {
|
|
entries, err := os.ReadDir(repoPath + "/docs")
|
|
require.NoError(t, err)
|
|
|
|
for _, entry := range entries {
|
|
if !entry.IsDir() {
|
|
continue
|
|
}
|
|
|
|
dirPath := fmt.Sprintf("%s/docs/%s", repoPath, entry.Name())
|
|
|
|
files, err := os.ReadDir(dirPath)
|
|
require.NoError(t, err)
|
|
|
|
var numbered []numberedFile
|
|
for _, f := range files {
|
|
if f.IsDir() {
|
|
continue
|
|
}
|
|
m := numberedFileRe.FindStringSubmatch(f.Name())
|
|
if m == nil {
|
|
continue
|
|
}
|
|
num, err2 := strconv.Atoi(m[1])
|
|
if err2 != nil {
|
|
t.Errorf("docs/%s/%s: cannot parse numeric prefix %q", entry.Name(), f.Name(), m[1])
|
|
continue
|
|
}
|
|
numbered = append(numbered, numberedFile{
|
|
name: f.Name(),
|
|
numStr: m[1],
|
|
num: num,
|
|
})
|
|
}
|
|
|
|
if len(numbered) == 0 {
|
|
continue
|
|
}
|
|
|
|
sort.Slice(numbered, func(i, j int) bool {
|
|
return numbered[i].name < numbered[j].name
|
|
})
|
|
|
|
usesPadding := len(numbered) >= 10
|
|
|
|
for i, nf := range numbered {
|
|
// Check for gaps. Expected number matches 1-based index (1, 2, 3...)
|
|
expectedNum := i + 1
|
|
if nf.num != expectedNum {
|
|
t.Errorf("docs/%s/%s: gap detected in sequence, expected number %d but got %d", entry.Name(), nf.name, expectedNum, nf.num)
|
|
}
|
|
|
|
if usesPadding {
|
|
if len(nf.numStr) != 2 {
|
|
t.Errorf("docs/%s/%s: expected zero-padded prefix, got %q", entry.Name(), nf.name, nf.numStr)
|
|
}
|
|
} else {
|
|
if strings.HasPrefix(nf.numStr, "0") {
|
|
t.Errorf("docs/%s/%s: unexpected zero-padded prefix %q (directory has fewer than 10 files)", entry.Name(), nf.name, nf.numStr)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|