From ffb29f5ba48f12f4eb80ee6d6491397160951999 Mon Sep 17 00:00:00 2001 From: "Sascha L. Teichmann" Date: Thu, 2 Feb 2023 22:36:37 +0100 Subject: [PATCH] Replace 'confirming filename' with 'conforming filename' --- cmd/csaf_aggregator/mirror.go | 6 +++--- cmd/csaf_checker/processor.go | 10 +++++----- cmd/csaf_checker/reporters.go | 2 +- cmd/csaf_downloader/downloader.go | 6 +++--- cmd/csaf_provider/actions.go | 4 ++-- cmd/csaf_provider/controller.go | 2 +- cmd/csaf_uploader/main.go | 4 ++-- cmd/csaf_validator/main.go | 2 +- util/file.go | 4 ++-- util/file_test.go | 4 ++-- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/cmd/csaf_aggregator/mirror.go b/cmd/csaf_aggregator/mirror.go index fd37b3e..2cda094 100644 --- a/cmd/csaf_aggregator/mirror.go +++ b/cmd/csaf_aggregator/mirror.go @@ -501,10 +501,10 @@ func (w *worker) mirrorFiles(tlpLabel csaf.TLPLabel, files []csaf.AdvisoryFile) continue } - // Ignore not confirming filenames. + // Ignore not conforming filenames. filename := filepath.Base(u.Path) - if !util.ConfirmingFileName(filename) { - log.Printf("Not confirming filename %q. Ignoring.\n", filename) + if !util.ConformingFileName(filename) { + log.Printf("Not conforming filename %q. Ignoring.\n", filename) continue } diff --git a/cmd/csaf_checker/processor.go b/cmd/csaf_checker/processor.go index b66a38b..76a8cb8 100644 --- a/cmd/csaf_checker/processor.go +++ b/cmd/csaf_checker/processor.go @@ -445,10 +445,10 @@ func (p *processor) integrity( } p.checkTLS(u) - // Check if the filename is confirming. + // Check if the filename is conforming. p.badFilenames.use() - if !util.ConfirmingFileName(filepath.Base(u)) { - p.badFilenames.error("%s has not a confirming filename.", u) + if !util.ConformingFileName(filepath.Base(u)) { + p.badFilenames.error("%s has not a conforming filename.", u) } var folderYear *int @@ -1054,14 +1054,14 @@ func (p *processor) checkMissing(string) error { } // checkInvalid goes over all found adivisories URLs and checks -// if file name confirms to standard. +// if file name conforms to standard. func (p *processor) checkInvalid(string) error { p.badDirListings.use() var invalids []string for f := range p.alreadyChecked { - if !util.ConfirmingFileName(filepath.Base(f)) { + if !util.ConformingFileName(filepath.Base(f)) { invalids = append(invalids, f) } } diff --git a/cmd/csaf_checker/reporters.go b/cmd/csaf_checker/reporters.go index ef3bb2a..f123e2d 100644 --- a/cmd/csaf_checker/reporters.go +++ b/cmd/csaf_checker/reporters.go @@ -66,7 +66,7 @@ func (r *filenameReporter) report(p *processor, domain *Domain) { if !p.badFilenames.used() { req.message(InfoType, "No filenames checked for conformance") } else if len(p.badFilenames) == 0 { - req.message(InfoType, "All found filenames are confirming.") + req.message(InfoType, "All found filenames are conforming.") } else { req.Append(p.badFilenames) } diff --git a/cmd/csaf_downloader/downloader.go b/cmd/csaf_downloader/downloader.go index 0da7748..de6355c 100644 --- a/cmd/csaf_downloader/downloader.go +++ b/cmd/csaf_downloader/downloader.go @@ -262,10 +262,10 @@ func (d *downloader) downloadFiles(label csaf.TLPLabel, files []csaf.AdvisoryFil continue } - // Ignore not confirming filenames. + // Ignore not conforming filenames. filename := filepath.Base(u.Path) - if !util.ConfirmingFileName(filename) { - log.Printf("Not confirming filename %q. Ignoring.\n", filename) + if !util.ConformingFileName(filename) { + log.Printf("Not conforming filename %q. Ignoring.\n", filename) continue } diff --git a/cmd/csaf_provider/actions.go b/cmd/csaf_provider/actions.go index dd917ca..34cb16f 100644 --- a/cmd/csaf_provider/actions.go +++ b/cmd/csaf_provider/actions.go @@ -47,8 +47,8 @@ func (c *controller) loadCSAF(r *http.Request) (string, []byte, error) { return "", nil, errors.New("expected content type 'application/json'") } - if !util.ConfirmingFileName(handler.Filename) { - return "", nil, errors.New("given csaf filename is not confirming") + if !util.ConformingFileName(handler.Filename) { + return "", nil, errors.New("given csaf filename is not conforming") } var buf bytes.Buffer diff --git a/cmd/csaf_provider/controller.go b/cmd/csaf_provider/controller.go index 88f12ea..c78f59f 100644 --- a/cmd/csaf_provider/controller.go +++ b/cmd/csaf_provider/controller.go @@ -72,7 +72,7 @@ func (c *controller) bind(pim *pathInfoMux) { pim.handleFunc("/api/create", c.auth(api(c.create))) } -// authenticate checks if the incoming request confirms with the +// authenticate checks if the incoming request conforms with the // configured authentication mechanism. func (c *controller) authenticate(r *http.Request) bool { diff --git a/cmd/csaf_uploader/main.go b/cmd/csaf_uploader/main.go index 621ab0c..6ac5027 100644 --- a/cmd/csaf_uploader/main.go +++ b/cmd/csaf_uploader/main.go @@ -314,8 +314,8 @@ func (p *processor) uploadRequest(filename string) (*http.Request, error) { // It prints the response messages. func (p *processor) process(filename string) error { - if bn := filepath.Base(filename); !util.ConfirmingFileName(bn) { - return fmt.Errorf("%q is not a confirming file name", bn) + if bn := filepath.Base(filename); !util.ConformingFileName(bn) { + return fmt.Errorf("%q is not a conforming file name", bn) } req, err := p.uploadRequest(filename) diff --git a/cmd/csaf_validator/main.go b/cmd/csaf_validator/main.go index 8676218..2c42839 100644 --- a/cmd/csaf_validator/main.go +++ b/cmd/csaf_validator/main.go @@ -70,7 +70,7 @@ func run(opts *options, files []string) error { for _, file := range files { // Check if the file name is valid. - if !util.ConfirmingFileName(filepath.Base(file)) { + if !util.ConformingFileName(filepath.Base(file)) { fmt.Printf("%q is not a valid advisory name.\n", file) } doc, err := loadJSONFromFile(file) diff --git a/util/file.go b/util/file.go index 3fd1f98..b4f44cf 100644 --- a/util/file.go +++ b/util/file.go @@ -33,8 +33,8 @@ func CleanFileName(s string) string { return invalidRune.ReplaceAllString(s, "_") + ".json" } -// ConfirmingFileName checks if the given filename is confirming the standard. -func ConfirmingFileName(fname string) bool { +// ConformingFileName checks if the given filename conforms to the standard. +func ConformingFileName(fname string) bool { return fname == CleanFileName(fname) } diff --git a/util/file_test.go b/util/file_test.go index 71b60a9..b224a31 100644 --- a/util/file_test.go +++ b/util/file_test.go @@ -23,7 +23,7 @@ func TestCleanFileName(t *testing.T) { } } -func TestConfirmingFileName(t *testing.T) { +func TestConformingFileName(t *testing.T) { for _, x := range []struct { s string b bool @@ -41,7 +41,7 @@ func TestConfirmingFileName(t *testing.T) { {`abc_.htm__l`, false}, {`foo+BAR`, false}, } { - if got := ConfirmingFileName(x.s); got != x.b { + if got := ConformingFileName(x.s); got != x.b { t.Errorf("%q: Expected %t but got %t.", x.s, x.b, got) } }