fix/nonascii_attributes #69

Merged
张泊明518370910136 merged 11 commits from fix/nonascii_attributes into master 2024-10-21 17:04:53 +08:00
3 changed files with 37 additions and 34 deletions

View File

@ -43,6 +43,7 @@ func main() {
showVersion := flag.Bool("version", false, "print current version") showVersion := flag.Bool("version", false, "print current version")
rootDir := flag.String("root", ".", "root dir for forbidden files check") rootDir := flag.String("root", ".", "root dir for forbidden files check")
repoSize := flag.Float64("repoSize", 2, "maximum size of the repo in MiB") repoSize := flag.Float64("repoSize", 2, "maximum size of the repo in MiB")
// TODO: remove localList, it is only for backward compatibility now
zzjc123 marked this conversation as resolved Outdated

typo here

typo here

i mean it should be "remove localList" here, and "remove gitWhitelist“ down there

i mean it should be "remove localList" here, and "remove gitWhitelist“ down there
localList := flag.String("localList", "", "local file list for non-ascii file check") localList := flag.String("localList", "", "local file list for non-ascii file check")
checkFileNameList := flag.String("checkFileNameList", "", "comma-separated list of files to check") checkFileNameList := flag.String("checkFileNameList", "", "comma-separated list of files to check")
checkFileSumList := flag.String("checkFileSumList", "", "comma-separated list of expected checksums") checkFileSumList := flag.String("checkFileSumList", "", "comma-separated list of expected checksums")
@ -77,7 +78,7 @@ func main() {
if err != nil { if err != nil {
fmt.Printf("### Forbidden File Check Failed:\n%s\n", err.Error()) fmt.Printf("### Forbidden File Check Failed:\n%s\n", err.Error())
} }
err = healthcheck.NonAsciiFiles(*rootDir, *localList) err = healthcheck.NonAsciiFiles(*rootDir)
if err != nil { if err != nil {
fmt.Printf("### Non-ASCII Characters File Check Failed:\n%s\n", err.Error()) fmt.Printf("### Non-ASCII Characters File Check Failed:\n%s\n", err.Error())
} }

View File

@ -8,47 +8,58 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"unicode" "unicode"
"github.com/go-git/go-git/v5/plumbing/format/gitattributes"
) )
// getNonAscii retrieves a list of files in the specified root directory that contain non-ASCII characters. // getNonAscii retrieves a list of files in the specified root directory that contain non-ASCII characters.
// It searches for non-ASCII characters in each file's content and returns a list of paths to files containing non-ASCII characters. // It searches for non-ASCII characters in each file's content and returns a list of paths to files containing non-ASCII characters.
func getNonAscii(root string, localList string) ([]string, error) { func getNonAscii(root string) ([]string, error) {
var nonAscii []string var nonAscii []string
gitattrExist := true
zzjc123 marked this conversation as resolved Outdated

the naming is weird, we need to think what is !noAttri. Just sth like gitattributesExist.

the naming is weird, we need to think what is `!noAttri`. Just sth like `gitattributesExist`.
var matcher gitattributes.Matcher
_, err := os.Stat(".gitattributes")
if os.IsNotExist(err) {
gitattrExist = false
}
var dirs []string if gitattrExist {
fs := os.DirFS(".")
if localList != "" { f, err := fs.Open(".gitattributes")
file, err := os.Open(localList)
if err != nil { if err != nil {
return nil, fmt.Errorf("Failed to open file %s: %v\n", localList, err) return nil, err
}
defer file.Close()
scanner := bufio.NewScanner(file)
for scanner.Scan() {
dirs = append(dirs, scanner.Text())
}
if err := scanner.Err(); err != nil {
return nil, fmt.Errorf("Error reading file %s: %v\n", localList, err)
}
} }
err := filepath.Walk(root, func(path string, info os.FileInfo, err error) error { attribute, err := gitattributes.ReadAttributes(f, nil, true)
if err != nil {
return nil, err
}
matcher = gitattributes.NewMatcher(attribute)
}
err = filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
if err != nil { if err != nil {
return err return err
} }
if info.IsDir() { if info.IsDir() {
if info.Name() == ".git" || info.Name() == ".gitea" || info.Name() == "ci" || (localList != "" && inString(info.Name(), dirs)) { if info.Name() == ".git" {
zzjc123 marked this conversation as resolved Outdated

Can we check the .gitea dir now?

Can we check the `.gitea` dir now?
return filepath.SkipDir return filepath.SkipDir
} else { } else {
return nil return nil
} }
} }
if info.Name() == "healthcheck" { if gitattrExist {
relPath, err := filepath.Rel(root, path)
zzjc123 marked this conversation as resolved Outdated

and can this healthcheck skip be removed now?

and can this healthcheck skip be removed now?

no we can't for now.

no we can't for now.

what about now?

what about now?

what do you mean? for now we still need to copy the healthcheck bin into /w to run for test case. I don't now what's the better solution.

what do you mean? for now we still need to copy the healthcheck bin into /w to run for test case. I don't now what's the better solution.

oh sorry, I didn't see your commit. I will try it soon.

oh sorry, I didn't see your commit. I will try it soon.

it got fixed.

it got fixed.
if err != nil {
return err
}
ret, matched := matcher.Match(strings.Split(relPath, "/"), nil)
zzjc123 marked this conversation as resolved Outdated

this line is too long now, should make it in two lines.

this line is too long now, should make it in two lines.
if matched && ret["text"].IsUnset() {
return nil return nil
} }
}
zzjc123 marked this conversation as resolved Outdated

just

			if _, ret := matcher.Match(strings.Split(relPath, "/"), nil); ret {
				return nil
			}
just ```go if _, ret := matcher.Match(strings.Split(relPath, "/"), nil); ret { return nil } ```
file, err := os.Open(path) file, err := os.Open(path)
if err != nil { if err != nil {
@ -79,8 +90,8 @@ func getNonAscii(root string, localList string) ([]string, error) {
// nonAsciiFiles checks for non-ASCII characters in files within the specified root directory. // nonAsciiFiles checks for non-ASCII characters in files within the specified root directory.
// It prints a message with the paths to files containing non-ASCII characters, if any. // It prints a message with the paths to files containing non-ASCII characters, if any.
func NonAsciiFiles(root string, localList string) error { func NonAsciiFiles(root string) error {
nonAscii, err := getNonAscii(root, localList) nonAscii, err := getNonAscii(root)
if err != nil { if err != nil {
slog.Error("getting non-ascii", "err", err) slog.Error("getting non-ascii", "err", err)
return fmt.Errorf("error getting non-ascii: %w", err) return fmt.Errorf("error getting non-ascii: %w", err)

View File

@ -5,15 +5,6 @@ import (
"regexp" "regexp"
) )
func inString(str1 string, strList []string) bool {
for _, str := range strList {
if str1 == str {
return true
}
}
return false
}
// addExt appends the specified extension to each file name in the given fileList. // addExt appends the specified extension to each file name in the given fileList.
// It modifies the original fileList in place. // It modifies the original fileList in place.
func addExt(fileList []string, ext string) { func addExt(fileList []string, ext string) {