Add FileMustStartWithPackageStatement check

CHANGES.md

@@ -26,6 +26,7 @@
 - Fix sslr-magik-toolkit's "Evaluate XPath"-button.
 - Add UndefinedVariable check to Sonar way profile.
 - Add ability to override aliases path and environment path in tasks in VSCode extension.
+- Add FileWithoutPackageStatement check to test if a file starts with a `_package`-statement.
 - Several fixes.
 
 ### Breaking changes (reiterated from above)
@@ -35,6 +36,7 @@
 - Add SimplifyIf check to Sonar way profile. This might result in more issues.
 - Add UnsafeEvaluateInvocation check to Sonar way profile. This might result in more issues.
 - Add UndefinedVariable check to Sonar way profile. This might result in more issues.
+- Add FileWithoutPackageStatement check to test if a file starts with a `_package`-statement. This might result in more issues.
 
 ## 0.10.1 (2024-08-14)
 

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/CheckList.java

@@ -8,6 +8,7 @@
 import nl.ramsolutions.sw.magik.checks.checks.ExemplarSlotCountCheck;
 import nl.ramsolutions.sw.magik.checks.checks.FileMethodCountCheck;
 import nl.ramsolutions.sw.magik.checks.checks.FileNotInLoadListCheck;
+import nl.ramsolutions.sw.magik.checks.checks.FileWithoutPackageStatementCheck;
 import nl.ramsolutions.sw.magik.checks.checks.ForbiddenCallCheck;
 import nl.ramsolutions.sw.magik.checks.checks.ForbiddenGlobalUsageCheck;
 import nl.ramsolutions.sw.magik.checks.checks.ForbiddenInheritanceCheck;
@@ -68,6 +69,7 @@ public static List<Class<? extends MagikCheck>> getChecks() {
         ExemplarSlotCountCheck.class,
         FileMethodCountCheck.class,
         FileNotInLoadListCheck.class,
+        FileWithoutPackageStatementCheck.class,
         ForbiddenCallCheck.class,
         ForbiddenGlobalUsageCheck.class,
         ForbiddenInheritanceCheck.class,

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/checks/FileWithoutPackageStatementCheck.java

@@ -0,0 +1,33 @@
+package nl.ramsolutions.sw.magik.checks.checks;
+
+import com.sonar.sslr.api.AstNode;
+import java.util.List;
+import nl.ramsolutions.sw.magik.api.MagikGrammar;
+import nl.ramsolutions.sw.magik.checks.MagikCheck;
+import org.sonar.check.Rule;
+
+/** Check if file starts with a _package-statement. */
+@Rule(key = FileWithoutPackageStatementCheck.CHECK_KEY)
+public class FileWithoutPackageStatementCheck extends MagikCheck {
+
+  @SuppressWarnings("checkstyle:JavadocVariable")
+  public static final String CHECK_KEY = "FileWithoutPackageStatement";
+
+  private static final String MESSAGE = "File has no package-statement.";
+
+  @Override
+  protected void walkPostMagik(final AstNode node) {
+    if (!this.hasPackageStatement(node)) {
+      this.addFileIssue(MESSAGE);
+    }
+  }
+
+  private boolean hasPackageStatement(final AstNode node) {
+    final List<AstNode> children = node.getChildren();
+    if (children.isEmpty()) {
+      return false;
+    }
+
+    return children.get(0).is(MagikGrammar.PACKAGE_SPECIFICATION);
+  }
+}

magik-checks/src/main/resources/nl/ramsolutions/sw/sonar/l10n/magik/rules/FileWithoutPackageStatement.html

@@ -0,0 +1,15 @@
+<p>File should start with a <code>_package</code>-statement. This ensures the code is loaded into the correct package.</p>
+<h2>Noncompliant Code Example</h2>
+<pre>
+_block
+  write(a)
+_endblock
+</pre>
+<h2>Compliant Solution</h2>
+<pre>
+_package user
+
+_block
+  write(a)
+_endblock
+</pre>

magik-checks/src/main/resources/nl/ramsolutions/sw/sonar/l10n/magik/rules/FileWithoutPackageStatement.json

@@ -0,0 +1,16 @@
+{
+  "title": "File should start with a package-statement",
+  "type": "CODE_SMELL",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "5min"
+  },
+  "tags": [
+    "bad-practice",
+    "confusing"
+  ],
+  "defaultSeverity": "Minor",
+  "ruleSpecification": "FileWithoutPackageStatement",
+  "sqKey": "file-without-package-statement"
+}

magik-checks/src/main/resources/nl/ramsolutions/sw/sonar/l10n/magik/rules/Sonar_way_profile.json

@@ -6,6 +6,7 @@
     "EmptyBlock",
     "ExemplarSlotCount",
     "FileNotInLoadList",
+    "FileWithoutPackageStatement",
     "ForbiddenCall",
     "ForbiddenGlobalUsage",
     "HidesVariable",

magik-checks/src/test/java/nl/ramsolutions/sw/magik/checks/checks/FileWithoutPackageStatementCheckTest.java

@@ -0,0 +1,53 @@
+package nl.ramsolutions.sw.magik.checks.checks;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import nl.ramsolutions.sw.magik.checks.MagikIssue;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+/** Test FileWithoutPackageStatementCheck. */
+class FileWithoutPackageStatementCheckTest extends MagikCheckTestBase {
+
+  @ParameterizedTest
+  @ValueSource(
+      strings = {
+        """
+        _package user
+
+        _method a.m1 _endmethod
+        """,
+        """
+        # This is just a comment
+        _package user
+
+        _method a.m1 _endmethod
+        """,
+      })
+  void testValid(final String code) {
+    final FileWithoutPackageStatementCheck check = new FileWithoutPackageStatementCheck();
+    final List<MagikIssue> issues = this.runCheck(code, check);
+    assertThat(issues).isEmpty();
+  }
+
+  @ParameterizedTest
+  @ValueSource(
+      strings = {
+        """
+        _method a.m1 _endmethod
+        """,
+        """
+        _method a.m1 _endmethod
+
+        _package user
+
+        _method a.m2 _endmethod
+        """,
+      })
+  void testInvalid(final String code) {
+    final FileWithoutPackageStatementCheck check = new FileWithoutPackageStatementCheck();
+    final List<MagikIssue> issues = this.runCheck(code, check);
+    assertThat(issues).hasSize(1);
+  }
+}