Add mason lint command to run chplcheck

test/mason/SKIPIF

@@ -1,10 +1,12 @@
-#!/usr/bin/env python3
+#!/usr/bin/env bash
 
-"""
-mason requires CHPL_COMM=none (local)
-"""
 
-from __future__ import print_function
-from os import environ
-
-print(environ['CHPL_COMM'] != 'none' or environ['CHPL_RE2'] == 'none' or environ['CHPL_LAUNCHER'] != 'none')
+if [[ "$CHPL_COMM" != "none" || "$CHPL_RE2" == "none" || "$CHPL_LAUNCHER" != "none" ]]; then
+  echo "True"
+else
+  if command -v chplcheck >/dev/null 2>&1; then
+    echo "False"
+  else
+    echo "True"
+  fi
+fi

test/mason/mason-lint/COMPOPTS

@@ -0,0 +1 @@
+-M ../../../tools/mason/

test/mason/mason-lint/EXECENV

@@ -0,0 +1 @@
+../EXECENV

test/mason/mason-lint/Pkg/.gitignore

@@ -0,0 +1,3 @@
+target/
+Mason.lock
+doc

test/mason/mason-lint/Pkg/Mason.toml

@@ -0,0 +1,9 @@
+[brick]
+name = "Pkg"
+version = "0.1.0"
+chplVersion = "1.20.0"
+
+[dependencies]
+
+[tool.chplcheck]
+disable-rule = ["IncorrectIndentation"]

test/mason/mason-lint/Pkg/example/myExample.chpl

@@ -0,0 +1,5 @@
+use Pkg;
+config var doit = false;
+if doit == true {
+  foo();
+}

test/mason/mason-lint/Pkg/src/Pkg.chpl

@@ -0,0 +1,4 @@
+/* Documentation for Pkg */
+module Pkg {
+  proc Foo() { }
+}

test/mason/mason-lint/Pkg/test/myTest.chpl

@@ -0,0 +1,8 @@
+use UnitTest;
+
+proc test(test: borrowed Test) throws {
+  test.assertTrue(true);
+   test.assertFalse(false);
+}
+
+UnitTest.main();

test/mason/mason-lint/SKIPIF

@@ -0,0 +1 @@
+../SKIPIF

test/mason/mason-lint/lint.chpl

@@ -0,0 +1,22 @@
+use FileSystem, IO;
+
+use MasonLint only;
+use MasonUtils only;
+
+here.chdir('Pkg');
+
+try! {
+  MasonLint.masonLint(["lint"]);
+  writeln("Error: linting passed unexpectedly");
+} catch e: MasonUtils.MasonError {
+  writeln("Got Lints as expected - ", e.message());
+}
+
+try! {
+  // TODO: passing cli args overrides whats in the config file
+  // https://github.com/chapel-lang/chapel/issues/28330
+  MasonLint.masonLint(["lint", "--", "--disable-rule=CamelCaseFunctions"]);
+  writeln("Error: linting passed unexpectedly");
+} catch e: MasonUtils.MasonError {
+  writeln("Got Lints as expected - ", e.message());
+}

test/mason/mason-lint/lint.good

@@ -0,0 +1,6 @@
+src/Pkg.chpl:3: node violates rule CamelCaseFunctions
+example/myExample.chpl:3: node violates rule BoolComparison
+Got Lints as expected - chplcheck found issues
+test/myTest.chpl:5: node violates rule IncorrectIndentation
+example/myExample.chpl:3: node violates rule BoolComparison
+Got Lints as expected - chplcheck found issues

tools/mason/Mason.chpl

@@ -63,6 +63,7 @@ module Mason {
   use MasonExternal;
   use MasonHelp;
   use MasonInit;
+  use MasonLint;
   use MasonModify;
   use MasonNew;
   use MasonPublish;
@@ -84,9 +85,9 @@ module Mason {
     var subCmds = new map(string, shared Argument);
 
     // define all the supported subcommand strings here
-    var cmds = ["add","build","clean","doc","env","external","init","publish",
-                "new","rm","run","search","system","test","update",
-                "help","version","modules"];
+    const cmds = ["add","build","clean","doc","env","external","init","lint",
+                  "publish","new","rm","run","search","system","test","update",
+                  "help","version","modules"];
     for cmd in cmds {
       subCmds.add(cmd,parser.addSubCommand(cmd));
     }
@@ -131,6 +132,7 @@ module Mason {
         when "external" do masonExternal(cmdArgs);
         when "help" do masonHelp();
         when "init" do masonInit(cmdArgs);
+        when "lint" do masonLint(cmdArgs);
         when "new" do masonNew(cmdArgs);
         when "publish" do masonPublish(cmdArgs);
         when "rm" do masonModify(cmdArgs);

tools/mason/MasonHelp.chpl

@@ -170,6 +170,12 @@ class MasonModulesHelpHandler : HelpHandler {
   }
 }
 
+class MasonLintHelpHandler: HelpHandler {
+  override proc printHelp() {
+    masonLintHelp();
+  }
+}
+
 proc masonHelp() {
   writeln("Chapel's package manager");
   writeln();
@@ -620,3 +626,24 @@ proc masonModulesHelp() {
   writeln('    mason modules');
   writeln();
 }
+
+proc masonLintHelp() {
+  const s = """
+  Check the mason package for any style or formatting issues"
+
+  Usage:
+      mason doc [options] [-- <chplcheck options>...]
+
+  Options:
+      -h, --help                  Display this message
+
+  Extra options can be passed to chplcheck after a double dash (`--`).
+  Alternatively, chplcheck can be configured in the Mason.toml file under
+  the [tool.chplcheck] table.
+
+  Requires that chplcheck is set up in order to work.
+  For instructions on setting up chplcheck, please view its documentation.
+  """.dedent().strip();
+  writeln(s);
+  writeln();
+}

tools/mason/MasonLint.chpl

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2020-2026 Hewlett Packard Enterprise Development LP
+ * Copyright 2004-2019 Cray Inc.
+ * Other additional copyright holders may be indicated within.
+ *
+ * The entirety of this work is licensed under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ *
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module MasonLint {
+  use ArgumentParser;
+  use FileSystem;
+  use IO;
+  import MasonHelp;
+  import MasonUtils;
+  import MasonUtils.MasonError;
+  import MasonLogger;
+  use List only list;
+
+  private var log = new MasonLogger.logger("mason lint");
+
+  proc masonLint(args: [] string) throws {
+
+    var parser =
+      new argumentParser(helpHandler=new MasonHelp.MasonLintHelpHandler());
+    var passArgs = parser.addPassThrough();
+    parser.parseArgs(args);
+
+    const tomlName = 'Mason.toml';
+    const cwd = here.cwd();
+
+    const projectHome = MasonUtils.getProjectHome(cwd, tomlName);
+    here.chdir(projectHome);
+
+    if MasonUtils.runWithStatus("chplcheck --version", quiet=true) != 0 {
+      throw new MasonError("chplcheck is not installed or not found in PATH");
+    }
+
+    const cmd = new list([
+      "chplcheck",
+      "-c",
+      "Mason.toml",
+      "src/**/*.chpl",
+      "test/**/*.chpl",
+      "example/**/*.chpl",
+    ]);
+    cmd.pushBack(passArgs.values());
+    const cmdArr = cmd.toArray();
+    const cmdStr = " ".join(cmdArr);
+    log.infoln(cmdStr);
+    const output =
+      MasonUtils.runCommand(cmdStr, quiet=true, errorOk=true).strip();
+
+    if output != "" {
+      // change projectHome to "" to make output paths relative
+      const filtered = output.replace(projectHome + "/", "");
+      writeln(filtered);
+      throw new MasonError("chplcheck found issues");
+    }
+  }
+}

tools/mason/MasonUtils.chpl

@@ -101,7 +101,7 @@ proc stripExt(toStrip: string, ext: string) : string {
 
 
 /* Uses the Subprocess module to create a subprocess */
-proc runCommand(cmd: [] string, quiet=false) : string throws {
+proc runCommand(cmd: [] string, quiet=false, errorOk=false) : string throws {
   var ret : string;
   try {
     log.debugf("runCommand: %?\n", cmd);
@@ -125,7 +125,7 @@ proc runCommand(cmd: [] string, quiet=false) : string throws {
     process.wait();
 
     log.debugf("exitCode: %i\n", process.exitCode);
-    if process.exitCode != 0 {
+    if !errorOk && process.exitCode != 0 {
       var cmdStr = " ".join(cmd);
       throw new owned MasonError("Command failed: '" + cmdStr + "'");
     }
@@ -141,10 +141,10 @@ proc runCommand(cmd: [] string, quiet=false) : string throws {
   }
   return ret;
 }
-proc runCommand(cmd: string, quiet=false) : string throws {
+proc runCommand(cmd: string, quiet=false, errorOk=false) : string throws {
   // temporary is a workaround for #27504
   const cmds = cmd.split();
-  return runCommand(cmds, quiet=quiet);
+  return runCommand(cmds, quiet=quiet, errorOk=errorOk);
 }
 
 

util/cron/test-linux64.bash

@@ -9,4 +9,4 @@ source $UTIL_CRON_DIR/common-localnode-paratest.bash
 
 export CHPL_NIGHTLY_TEST_CONFIG_NAME="linux64"
 
-$UTIL_CRON_DIR/nightly -cron -mason -protobuf -futures ${nightly_args} $(get_nightly_paratest_args 8)
+$UTIL_CRON_DIR/nightly -cron -mason -chplcheck -protobuf -futures ${nightly_args} $(get_nightly_paratest_args 8)