pkgsrc-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[pkgsrc/trunk]: pkgsrc/pkgtools/pkglint/files pkgtools/pkglint: be strict abo...



details:   https://anonhg.NetBSD.org/pkgsrc/rev/0d2679a3f27c
branches:  trunk
changeset: 344176:0d2679a3f27c
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Nov 17 02:55:56 2019 +0000

description:
pkgtools/pkglint: be strict about invalid doc/CHANGES entries

diffstat:

 pkgtools/pkglint/files/pkgsrc.go      |  40 ++++++++++-----
 pkgtools/pkglint/files/pkgsrc_test.go |  91 ++++++++++++++++++++++------------
 2 files changed, 85 insertions(+), 46 deletions(-)

diffs (227 lines):

diff -r 19614049c2f5 -r 0d2679a3f27c pkgtools/pkglint/files/pkgsrc.go
--- a/pkgtools/pkglint/files/pkgsrc.go  Sun Nov 17 02:54:26 2019 +0000
+++ b/pkgtools/pkglint/files/pkgsrc.go  Sun Nov 17 02:55:56 2019 +0000
@@ -267,19 +267,39 @@
                return nil
        }
 
+       invalid := func() *Change {
+               if warn {
+                       line.Warnf("Invalid doc/CHANGES line: %s", line.Text)
+                       line.Explain(
+                               "See mk/misc/developer.mk for the rules.",
+                               "",
+                               "To generate these entries automatically, run",
+                               sprintf("%q.", bmakeHelp("cce")))
+               }
+               return nil
+       }
+
        f := strings.Fields(lex.Rest())
        n := len(f)
-       if n < 4 || n > 6 {
+       if n > 1 && hasSuffix(f[0], ":") {
                return nil
        }
+       if n == 0 {
+               return invalid()
+       }
 
        action := ParseChangeAction(f[0])
-       pkgpath := f[1]
-       author := f[len(f)-2]
-       date := f[len(f)-1]
+       var pkgpath, author, date string
+       if n > 1 {
+               pkgpath = f[1]
+               date = f[n-1]
+       }
+       if n > 2 {
+               author = f[n-2]
+       }
 
-       if !hasPrefix(author, "[") || !hasSuffix(date, "]") {
-               return nil
+       if !matches(author, `^\[\w+$`) || !matches(date, `\d\d\d\d-\d\d-\d\d]$`) {
+               return invalid()
        }
        author, date = author[1:], date[:len(date)-1]
 
@@ -300,13 +320,7 @@
                }
        }
 
-       if warn {
-               line.Warnf("Unknown doc/CHANGES line: %s", line.Text)
-               line.Explain(
-                       "See mk/misc/developer.mk for the rules.")
-       }
-
-       return nil
+       return invalid()
 }
 
 func (src *Pkgsrc) checkRemovedAfterLastFreeze() {
diff -r 19614049c2f5 -r 0d2679a3f27c pkgtools/pkglint/files/pkgsrc_test.go
--- a/pkgtools/pkglint/files/pkgsrc_test.go     Sun Nov 17 02:54:26 2019 +0000
+++ b/pkgtools/pkglint/files/pkgsrc_test.go     Sun Nov 17 02:55:56 2019 +0000
@@ -178,8 +178,11 @@
        t.CheckOutputLines(
                "WARN: ~/doc/CHANGES-2018:1: Year \"2015\" for category/package does not match the filename ~/doc/CHANGES-2018.",
                "WARN: ~/doc/CHANGES-2018:6: Date \"2018-01-06\" for category/package is earlier than \"2018-01-09\" in line 5.",
-               "WARN: ~/doc/CHANGES-2018:8: Unknown doc/CHANGES line: \tReworked category/package to 1.2 [author8 2018-01-08]",
-               "WARN: ~/doc/CHANGES-2018:13: Unknown doc/CHANGES line: \tAdded another [new package]")
+               "WARN: ~/doc/CHANGES-2018:8: Invalid doc/CHANGES line: \tReworked category/package to 1.2 [author8 2018-01-08]",
+               "WARN: ~/doc/CHANGES-2018:10: Invalid doc/CHANGES line: \ttoo few fields",
+               "WARN: ~/doc/CHANGES-2018:11: Invalid doc/CHANGES line: \ttoo many many many many many fields",
+               "WARN: ~/doc/CHANGES-2018:12: Invalid doc/CHANGES line: \tmissing brackets around author",
+               "WARN: ~/doc/CHANGES-2018:13: Invalid doc/CHANGES line: \tAdded another [new package]")
 }
 
 func (s *Suite) Test_Pkgsrc_loadDocChangesFromFile__not_found(c *check.C) {
@@ -246,7 +249,7 @@
        t.CheckOutputLines(
                "WARN: ~/doc/CHANGES-2018:6: Date \"2018-01-01\" for sysutils/checkperms is earlier than \"2018-01-05\" in line 5.",
                "WARN: ~/doc/CHANGES-2018:7: Package changes should be indented using a single tab, not \"\\t\\t\".",
-               "WARN: ~/doc/CHANGES-2018:8: Unknown doc/CHANGES line: \tInvalid pkgpath to 1.16 [rillig 2019-06-16]",
+               "WARN: ~/doc/CHANGES-2018:8: Invalid doc/CHANGES line: \tInvalid pkgpath to 1.16 [rillig 2019-06-16]",
                "WARN: ~/doc/CHANGES-2018:9: Year \"2019\" for category/package does not match the filename ~/doc/CHANGES-2018.",
                "4 warnings found.",
                t.Shquote("(Run \"pkglint -e -Cglobal -Wall %s\" to show explanations.)", "."))
@@ -331,9 +334,9 @@
        // The 2015 file is so old that the date is not checked.
        // Since 2018, each date in the file must match the filename.
        t.CheckOutputLines(
-               "WARN: ~/doc/CHANGES-2015:6: Unknown doc/CHANGES line: \tInvalid line [3 4]",
-               "WARN: ~/doc/CHANGES-2018:5: Year \"date\" for pkgpath does not match the filename ~/doc/CHANGES-2018.",
-               "WARN: ~/doc/CHANGES-2018:6: Date \"d\" for pkgpath is earlier than \"date\" in line 5.")
+               "WARN: ~/doc/CHANGES-2015:6: Invalid doc/CHANGES line: \tInvalid line [3 4]",
+               "WARN: ~/doc/CHANGES-2018:5: Invalid doc/CHANGES line: \tUpdated pkgpath to 1.0 [author date]",
+               "WARN: ~/doc/CHANGES-2018:6: Invalid doc/CHANGES line: \tUpdated pkgpath to 1.0 [author d]")
 }
 
 func (s *Suite) Test_Pkgsrc_parseDocChange(c *check.C) {
@@ -353,74 +356,96 @@
                nil...)
 
        test("\tAdded something [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tAdded something [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tAdded something [author date]")
 
        test("\tAdded category/package 1.0 [author 2019-11-17]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tAdded category/package 1.0 [author 2019-11-17]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tAdded category/package 1.0 [author 2019-11-17]")
 
        test("\t\tToo large indentation",
                "WARN: doc/CHANGES-2019:123: Package changes should be indented using a single tab, not \"\\t\\t\".")
        test("\t Too large indentation",
                "WARN: doc/CHANGES-2019:123: Package changes should be indented using a single tab, not \"\\t \".")
 
-       // TODO: Add a warning here, since it's easy to forget a bracket.
        test("\t1 2 3 4",
-               nil...)
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 3 4")
        test("\t1 2 3 4 5",
-               nil...)
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 3 4 5")
        test("\t1 2 3 4 5 6",
-               nil...)
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 3 4 5 6")
        test("\t1 2 3 4 5 6 7",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 3 4 5 6 7")
+       test("\t1 2 [3 4",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 [3 4")
+       test("\t1 2 [3 4]",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \t1 2 [3 4]")
+       test("\tAdded 2 [3 4]",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: \tAdded 2 [3 4]")
+
+       test("\tAdded pkgpath version 1.0 [author 2019-01-01]",
                nil...)
-       test("\t1 2 [3 4",
-               nil...)
-       test("\t1 2 [3 4]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \t1 2 [3 4]")
-       test("\tAdded 2 [3 4]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tAdded 2 [3 4]")
 
-       test("\tAdded pkgpath version 1.0 [author date]",
-               nil...)
        // "to" is wrong
        test("\tAdded pkgpath to 1.0 [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tAdded pkgpath to 1.0 [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tAdded pkgpath to 1.0 [author date]")
 
-       test("\tUpdated pkgpath to 1.0 [author date]",
+       test("\tUpdated pkgpath to 1.0 [author 2019-01-01]",
                nil...)
+
        // "from" is wrong
        test("\tUpdated pkgpath from 1.0 [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tUpdated pkgpath from 1.0 [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tUpdated pkgpath from 1.0 [author date]")
 
-       test("\tDowngraded pkgpath to 1.0 [author date]",
+       test("\tDowngraded pkgpath to 1.0 [author 2019-01-01]",
                nil...)
+
        // "from" is wrong
        test("\tDowngraded pkgpath from 1.0 [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tDowngraded pkgpath from 1.0 [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tDowngraded pkgpath from 1.0 [author date]")
 
-       test("\tRemoved pkgpath [author date]",
+       test("\tRemoved pkgpath [author 2019-01-01]",
                nil...)
-       test("\tRemoved pkgpath successor pkgpath [author date]",
+
+       test("\tRemoved pkgpath successor pkgpath [author 2019-01-01]",
                nil...)
+
        // "and" is wrong
        test("\tRemoved pkgpath and pkgpath [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tRemoved pkgpath and pkgpath [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tRemoved pkgpath and pkgpath [author date]")
 
-       test("\tRenamed pkgpath to other [author date]",
+       test("\tRenamed pkgpath to other [author 2019-01-01]",
                nil...)
+
        // "from" is wrong
        test("\tRenamed pkgpath from previous [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tRenamed pkgpath from previous [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tRenamed pkgpath from previous [author date]")
 
-       test("\tMoved pkgpath to other [author date]",
+       test("\tMoved pkgpath to other [author 2019-01-01]",
                nil...)
+
        // "from" is wrong
        test("\tMoved pkgpath from previous [author date]",
-               "WARN: doc/CHANGES-2019:123: Unknown doc/CHANGES line: \tMoved pkgpath from previous [author date]")
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tMoved pkgpath from previous [author date]")
 
        // "Split" is wrong
-       // TODO: Add a warning since this is probably a typo.
        test("\tSplit pkgpath into a and b [author date]",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tSplit pkgpath into a and b [author date]")
+
+       // Entries ending in a colon are used for infrastructure changes.
+       test("\tmk: remove support for USE_CROSSBASE [author 2016-06-19]",
                nil...)
+
+       test("\tAdded category/pkgpath version 1.0 [author-dash 2019-01-01]",
+               "WARN: doc/CHANGES-2019:123: Invalid doc/CHANGES line: "+
+                       "\tAdded category/pkgpath version 1.0 [author-dash 2019-01-01]")
 }
 
 func (s *Suite) Test_Pkgsrc_checkRemovedAfterLastFreeze(c *check.C) {



Home | Main Index | Thread Index | Old Index