MissingEAPIBlankLine: new check for missing blank after EAPI

Resolves: #570
Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>

Author: arthurzam

pyproject.toml

@@ -9,7 +9,7 @@ requires = [
 	"pathspec",
 	"tree-sitter>=0.19.0",
 	"snakeoil~=0.10.4",
-	"pkgcore~=0.12.20",
+	"pkgcore~=0.12.21",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -41,7 +41,7 @@ dependencies = [
 	"pathspec",
 	"tree-sitter>=0.19.0",
 	"snakeoil~=0.10.4",
-	"pkgcore~=0.12.18",
+	"pkgcore~=0.12.21",
 ]
 
 [project.optional-dependencies]

src/pkgcheck/checks/whitespace.py

@@ -73,6 +73,12 @@ def desc(self):
         )
 
 
+class MissingEAPIBlankLine(results.VersionResult, results.Style):
+    """Missing blank line after ``EAPI=`` assignment."""
+
+    desc = "missing blank line after EAPI= assignment"
+
+
 class WhitespaceData(NamedTuple):
     """Data format to register hardcoded list of bad whitespace characters."""
 
@@ -118,14 +124,15 @@ class WhitespaceCheck(Check):
 
     _source = sources.EbuildFileRepoSource
     known_results = frozenset(
-        [
+        {
             WhitespaceFound,
             WrongIndentFound,
             DoubleEmptyLine,
             TrailingEmptyLine,
             NoFinalNewline,
             BadWhitespaceCharacter,
-        ]
+            MissingEAPIBlankLine,
+        }
     )
 
     _indent_regex = re.compile("^\t* \t+")
@@ -141,8 +148,14 @@ def feed(self, pkg):
         leading = []
         indent = []
         double_empty = []
+        eapi_lineno = None
 
         for lineno, line in enumerate(pkg.lines, 1):
+            if line.startswith("EAPI="):
+                eapi_lineno = lineno
+            elif eapi_lineno is not None and lineno == eapi_lineno + 1 and line != "\n":
+                yield MissingEAPIBlankLine(pkg=pkg)
+
             for match in self.bad_whitespace_regex.finditer(line):
                 yield BadWhitespaceCharacter(
                     repr(match.group("char")),

testdata/data/repos/standalone/BadCommandsCheck/BannedEapiCommand/expected.json

@@ -1 +1 @@
-{"__class__": "BannedEapiCommand", "category": "BadCommandsCheck", "package": "BannedEapiCommand", "version": "0", "line": "dohtml doc/*", "lineno": 8, "command": "dohtml", "eapi": "7"}
+{"__class__": "BannedEapiCommand", "category": "BadCommandsCheck", "package": "BannedEapiCommand", "version": "0", "line": "dohtml doc/*", "lineno": 9, "command": "dohtml", "eapi": "7"}

testdata/data/repos/standalone/BadCommandsCheck/BannedEapiCommand/fix.patch

@@ -1,9 +1,9 @@
 diff -Naur standalone/BadCommandsCheck/BannedEapiCommand/BannedEapiCommand-0.ebuild fixed/BadCommandsCheck/BannedEapiCommand/BannedEapiCommand-0.ebuild
 --- standalone/BadCommandsCheck/BannedEapiCommand/BannedEapiCommand-0.ebuild	2019-10-01 15:48:21.121467232 -0600
 +++ fixed/BadCommandsCheck/BannedEapiCommand/BannedEapiCommand-0.ebuild	2019-10-01 15:50:51.970090195 -0600
-@@ -5,5 +5,6 @@
+@@ -6,5 +6,6 @@
  LICENSE="BSD"
- 
+
  src_install() {
 -	dohtml doc/*
 +	docinto html

testdata/data/repos/standalone/BadCommandsCheck/DeprecatedEapiCommand/expected.json

@@ -1 +1 @@
-{"__class__": "DeprecatedEapiCommand", "category": "BadCommandsCheck", "package": "DeprecatedEapiCommand", "version": "0", "line": "dohtml doc/*", "lineno": 8, "command": "dohtml", "eapi": "6"}
+{"__class__": "DeprecatedEapiCommand", "category": "BadCommandsCheck", "package": "DeprecatedEapiCommand", "version": "0", "line": "dohtml doc/*", "lineno": 9, "command": "dohtml", "eapi": "6"}

testdata/data/repos/standalone/BadCommandsCheck/DeprecatedEapiCommand/fix.patch

@@ -1,9 +1,9 @@
 diff -Naur standalone/BadCommandsCheck/DeprecatedEapiCommand/DeprecatedEapiCommand-0.ebuild fixed/BadCommandsCheck/DeprecatedEapiCommand/DeprecatedEapiCommand-0.ebuild
 --- standalone/BadCommandsCheck/DeprecatedEapiCommand/DeprecatedEapiCommand-0.ebuild	2019-10-01 15:50:01.517881845 -0600
 +++ fixed/BadCommandsCheck/DeprecatedEapiCommand/DeprecatedEapiCommand-0.ebuild	2019-10-01 15:51:40.877292175 -0600
-@@ -5,5 +5,6 @@
+@@ -6,5 +6,6 @@
  LICENSE="BSD"
- 
+
  src_install() {
 -	dohtml doc/*
 +	docinto html

testdata/data/repos/standalone/EapiCheck/BannedEapi/fix.patch

@@ -1,9 +1,10 @@
 diff -Naur standalone/EapiCheck/BannedEapi/BannedEapi-0.ebuild fixed/EapiCheck/BannedEapi/BannedEapi-0.ebuild
 --- standalone/EapiCheck/BannedEapi/BannedEapi-0.ebuild	2019-09-15 03:05:12.832870282 -0600
 +++ fixed/EapiCheck/BannedEapi/BannedEapi-0.ebuild	2019-09-15 03:11:08.602303656 -0600
-@@ -1,4 +1,4 @@
+@@ -1,5 +1,5 @@
 -EAPI=1
 +EAPI=7
+
  DESCRIPTION="Ebuild using banned EAPI"
  HOMEPAGE="https://github.com/pkgcore/pkgcheck"
  SLOT="0"

testdata/data/repos/standalone/EapiCheck/DeprecatedEapi/fix.patch

@@ -1,9 +1,10 @@
 diff -Naur standalone/EapiCheck/DeprecatedEapi/DeprecatedEapi-0.ebuild fixed/EapiCheck/DeprecatedEapi/DeprecatedEapi-0.ebuild
 --- standalone/EapiCheck/DeprecatedEapi/DeprecatedEapi-0.ebuild	2019-09-15 03:08:00.380545715 -0600
 +++ fixed/EapiCheck/DeprecatedEapi/DeprecatedEapi-0.ebuild	2019-09-15 03:11:41.260435170 -0600
-@@ -1,4 +1,4 @@
+@@ -1,5 +1,5 @@
 -EAPI=5
 +EAPI=7
+
  DESCRIPTION="Ebuild using deprecated EAPI"
  HOMEPAGE="https://github.com/pkgcore/pkgcheck"
  SLOT="0"

testdata/data/repos/standalone/EbuildUnquotedVariablesCheck/EbuildUnquotedVariable/expected.json

@@ -1,3 +1,3 @@
-{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "FILESDIR", "lines": [9, 19]}
-{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "T", "lines": [25, 27, 41, 42]}
-{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "WORKDIR", "lines": [34]}
+{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "FILESDIR", "lines": [10, 20]}
+{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "T", "lines": [26, 28, 42, 43]}
+{"__class__": "EbuildUnquotedVariable", "category": "EbuildUnquotedVariablesCheck", "package": "EbuildUnquotedVariable", "version": "0", "variable": "WORKDIR", "lines": [35]}

testdata/data/repos/standalone/EbuildUnquotedVariablesCheck/EbuildUnquotedVariable/fix.patch

@@ -1,6 +1,6 @@
 --- standalone/EbuildUnquotedVariablesCheck/EbuildUnquotedVariable/EbuildUnquotedVariable-0.ebuild	2022-05-18 20:27:34.657647175 +0200
 +++ fixed/EbuildUnquotedVariablesCheck/EbuildUnquotedVariable/EbuildUnquotedVariable-0.ebuild	2022-05-18 20:50:00.271294657 +0200
-@@ -6,7 +6,7 @@
+@@ -7,7 +7,7 @@
  S=${WORKDIR}/${PV} # ok
 
  PATCHES=(
@@ -9,7 +9,7 @@
  	"${FILESDIR}"/foo.patch # ok
  	"${FILESDIR}/foo.patch" # ok
  )
-@@ -16,28 +16,28 @@
+@@ -17,28 +17,28 @@
  		:
  	fi