Avoid using deprecated CLI options for PMD >= 6.41.0

dist/licenses.txt

@@ -734,6 +734,25 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
+lru-cache
+ISC
+The ISC License
+
+Copyright (c) Isaac Z. Schlueter and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
 minimatch
 ISC
 The ISC License
@@ -1011,3 +1030,22 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+yallist
+ISC
+The ISC License
+
+Copyright (c) Isaac Z. Schlueter and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

lib/index.js

@@ -7,17 +7,16 @@ const validator = require('../lib/validator');
 const reportFormat = 'sarif';
 const reportFile = 'pmd-report.sarif'
 
-let pmdPath, exitCode, violations;
-
 async function run() {
+  let pmdInfo, execOutput, violations;
   try {
-    pmdPath = await util.downloadPmd(validator.validateVersion(core.getInput('version'), { required: true }));
-    exitCode = await util.executePmd(pmdPath,
+    pmdInfo = await util.downloadPmd(validator.validateVersion(core.getInput('version'), { required: true }));
+    execOutput = await util.executePmd(pmdInfo,
       validator.validateSourcePath(core.getInput('sourcePath', { required: true })),
       validator.validateRulesets(core.getInput('rulesets', { required: true })),
       reportFormat, reportFile)
 
-    core.info(`PMD exited with ${exitCode}`);
+    core.info(`PMD exited with ${execOutput.exitCode}`);
 
     violations = sarif.countViolations(reportFile);
     core.setOutput('violations', violations);

lib/util.js

@@ -2,6 +2,7 @@ const core = require('@actions/core');
 const { Octokit } = require("@octokit/rest");
 const tc = require('@actions/tool-cache');
 const exec = require('@actions/exec');
+const semver = require('semver');
 
 const downloadPmd = async function(version) {
     try {
@@ -17,18 +18,21 @@ const downloadPmd = async function(version) {
         }
 
         core.info(`Using PMD ${pmdVersion} from cached path ${cachedPmdPath}`);
-        return `${cachedPmdPath}/pmd-bin-${pmdVersion}`;
+        return {
+            version: pmdVersion,
+            path: `${cachedPmdPath}/pmd-bin-${pmdVersion}`
+        };
     } catch (error) {
         core.setFailed(error.message || error);
     }
 }
 
-const executePmd = async function(pmdPath, sourcePath, ruleset, reportFormat, reportFile) {
+const executePmd = async function(pmdInfo, sourcePath, ruleset, reportFormat, reportFile) {
     try {
-        const { exitCode, stdout, stderr } = await exec.getExecOutput(`${pmdPath}/bin/run.sh`,
+        const execOutput = await exec.getExecOutput(`${pmdInfo.path}/bin/run.sh`,
             [
                 'pmd',
-                '-no-cache',
+                useNewArgsFormat(pmdInfo.version) ? '--no-cache' : '-no-cache',
                 '-d', sourcePath,
                 '-f', reportFormat,
                 '-R', ruleset,
@@ -37,15 +41,19 @@ const executePmd = async function(pmdPath, sourcePath, ruleset, reportFormat, re
             {
                 ignoreReturnCode: true
             });
-        core.debug(`stdout: ${stdout}`);
-        core.debug(`stderr: ${stderr}`);
-        core.debug(`exitCode: ${exitCode}`);
-        return exitCode;
+        core.debug(`stdout: ${execOutput.stdout}`);
+        core.debug(`stderr: ${execOutput.stderr}`);
+        core.debug(`exitCode: ${execOutput.exitCode}`);
+        return execOutput;
     } catch (error) {
         core.setFailed(error.message || error);
     }
 }
 
+function useNewArgsFormat(pmdVersion) {
+    return semver.gte(pmdVersion, '6.41.0');
+}
+
 async function determinePmdRelease(pmdVersion) {
     core.debug(`determine release info for ${pmdVersion}`);
     const octokit = new Octokit({baseUrl: getGithubBaseUrl()});

lib/validator.js

@@ -1,8 +1,9 @@
 const path = require('path');
+const semver = require('semver');
 
 const validateVersion = function(version) {
     if (typeof(version) === 'string'
-       && (version === 'latest' || version.match(/^\d+\.\d+\.\d+$/))) {
+       && (version === 'latest' || semver.valid(version) === version)) {
         // valid
         return version;
     }

package.json

@@ -28,7 +28,8 @@
     "@actions/core": "^1.6.0",
     "@actions/exec": "^1.1.0",
     "@actions/tool-cache": "^1.7.1",
-    "@octokit/rest": "^18.12.0"
+    "@octokit/rest": "^18.12.0",
+    "semver": "^7.3.5"
   },
   "devDependencies": {
     "@actions/io": "^1.1.1",

tests/data/create-zips.sh

@@ -2,3 +2,4 @@
 
 zip -r pmd-bin-6.39.0.zip pmd-bin-6.39.0
 zip -r pmd-bin-6.40.0.zip pmd-bin-6.40.0
+zip -r pmd-bin-6.41.0.zip pmd-bin-6.41.0

tests/data/pmd-bin-6.41.0/bin/run.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+echo "Running PMD 6.41.0 with: $@"
+
+echo '{
+  "runs": [
+    {
+      "tool": {
+        "driver": {
+          "name": "PMD",
+          "version": "6.41.0"
+        }
+      }
+    }
+  ]
+}' > pmd-report.sarif
+

tests/data/releases-6.41.0.json

@@ -0,0 +1,11 @@
+{
+    "id": "1",
+    "name": "pmd release for test (6.41.0)",
+    "tag_name": "pmd_releases/6.41.0",
+    "assets": [
+        {
+            "browser_download_url": "https://github.com/pmd/pmd/releases/download/pmd_releases/6.41.0/pmd-bin-6.41.0.zip",
+            "name": "pmd-bin-6.41.0.zip"
+        }
+    ]
+}

tests/util.test.js

@@ -12,23 +12,23 @@ const tempPath = path.join(__dirname, 'TEMP')
 process.env['RUNNER_TEMP'] = tempPath
 process.env['RUNNER_TOOL_CACHE'] = cachePath
 
-describe('pmd-github-action-util', function() {
-  beforeAll(function() {
+describe('pmd-github-action-util', function () {
+  beforeAll(function () {
     setGlobal('TEST_DOWNLOAD_TOOL_RETRY_MIN_SECONDS', 0)
     setGlobal('TEST_DOWNLOAD_TOOL_RETRY_MAX_SECONDS', 0)
   })
 
-  beforeEach(async function() {
+  beforeEach(async function () {
     await io.rmRF(cachePath)
     await io.rmRF(tempPath)
     await io.mkdirP(cachePath)
     await io.mkdirP(tempPath)
   })
 
-  afterEach(function() {
+  afterEach(function () {
   })
 
-  afterAll(async function() {
+  afterAll(async function () {
     await io.rmRF(tempPath)
     await io.rmRF(cachePath)
     setGlobal('TEST_DOWNLOAD_TOOL_RETRY_MIN_SECONDS', undefined)
@@ -38,52 +38,75 @@ describe('pmd-github-action-util', function() {
   it('use latest PMD', async () => {
     nock('https://api.github.com')
       .get('/repos/pmd/pmd/releases/latest')
-        .replyWithFile(200, __dirname + '/data/releases-latest.json', {
-          'Content-Type': 'application/json',
-        })
+      .replyWithFile(200, __dirname + '/data/releases-latest.json', {
+        'Content-Type': 'application/json',
+      })
     nock('https://github.com')
       .get('/pmd/pmd/releases/download/pmd_releases/6.40.0/pmd-bin-6.40.0.zip')
       .replyWithFile(200, __dirname + '/data/pmd-bin-6.40.0.zip')
 
-    const cachedPmdPath = await util.downloadPmd('latest');
+    const pmdInfo = await util.downloadPmd('latest');
 
     const toolCache = path.join(cachePath, 'pmd', '6.40.0', os.arch(), 'pmd-bin-6.40.0');
-    expect(cachedPmdPath).toBe(toolCache);
+    expect(pmdInfo).toStrictEqual({ path: toolCache, version: '6.40.0' });
     expect(fs.existsSync(toolCache)).toBeTruthy();
   })
 
   it('use specific PMD version', async () => {
     nock('https://api.github.com')
       .get('/repos/pmd/pmd/releases/tags/pmd_releases%2F6.39.0')
-        .replyWithFile(200, __dirname + '/data/releases-6.39.0.json', {
-          'Content-Type': 'application/json',
-        })
+      .replyWithFile(200, __dirname + '/data/releases-6.39.0.json', {
+        'Content-Type': 'application/json',
+      })
     nock('https://github.com')
       .get('/pmd/pmd/releases/download/pmd_releases/6.39.0/pmd-bin-6.39.0.zip')
       .replyWithFile(200, __dirname + '/data/pmd-bin-6.39.0.zip');
-    const cachedPmdPath = await util.downloadPmd('6.39.0');
+    const pmdInfo = await util.downloadPmd('6.39.0');
 
     const toolCache = path.join(cachePath, 'pmd', '6.39.0', os.arch(), 'pmd-bin-6.39.0');
-    expect(cachedPmdPath).toBe(toolCache);
+    expect(pmdInfo).toStrictEqual({ path: toolCache, version: '6.39.0' });
     expect(fs.existsSync(toolCache)).toBeTruthy();
   })
 
   it('can execute PMD', async () => {
     nock('https://api.github.com')
       .get('/repos/pmd/pmd/releases/latest')
-        .replyWithFile(200, __dirname + '/data/releases-latest.json', {
-          'Content-Type': 'application/json',
-        })
+      .replyWithFile(200, __dirname + '/data/releases-latest.json', {
+        'Content-Type': 'application/json',
+      })
     nock('https://github.com')
       .get('/pmd/pmd/releases/download/pmd_releases/6.40.0/pmd-bin-6.40.0.zip')
       .replyWithFile(200, __dirname + '/data/pmd-bin-6.40.0.zip')
 
-    const cachedPmdPath = await util.downloadPmd('latest');
-    await util.executePmd(cachedPmdPath, '.', 'ruleset.xml', 'sarif', 'pmd-report.sarif');
+    const pmdInfo = await util.downloadPmd('latest');
+    const execOutput = await util.executePmd(pmdInfo, '.', 'ruleset.xml', 'sarif', 'pmd-report.sarif');
     const reportFile = path.join('.', 'pmd-report.sarif');
     expect(fs.existsSync(reportFile)).toBeTruthy();
     const report = JSON.parse(fs.readFileSync(reportFile));
     expect(report.runs[0].tool.driver.version).toBe('6.40.0');
+    expect(execOutput.exitCode).toBe(0);
+    expect(execOutput.stdout).toBe('Running PMD 6.40.0 with: pmd -no-cache -d . -f sarif -R ruleset.xml -r pmd-report.sarif\n');
+    await io.rmRF(reportFile)
+  })
+
+  it('can execute PMD >= 6.41.0', async () => {
+    nock('https://api.github.com')
+      .get('/repos/pmd/pmd/releases/tags/pmd_releases%2F6.41.0')
+      .replyWithFile(200, __dirname + '/data/releases-6.41.0.json', {
+        'Content-Type': 'application/json',
+      })
+    nock('https://github.com')
+      .get('/pmd/pmd/releases/download/pmd_releases/6.41.0/pmd-bin-6.41.0.zip')
+      .replyWithFile(200, __dirname + '/data/pmd-bin-6.41.0.zip')
+
+    const pmdInfo = await util.downloadPmd('6.41.0');
+    const execOutput = await util.executePmd(pmdInfo, '.', 'ruleset.xml', 'sarif', 'pmd-report.sarif');
+    const reportFile = path.join('.', 'pmd-report.sarif');
+    expect(fs.existsSync(reportFile)).toBeTruthy();
+    const report = JSON.parse(fs.readFileSync(reportFile));
+    expect(report.runs[0].tool.driver.version).toBe('6.41.0');
+    expect(execOutput.exitCode).toBe(0);
+    expect(execOutput.stdout).toBe('Running PMD 6.41.0 with: pmd --no-cache -d . -f sarif -R ruleset.xml -r pmd-report.sarif\n');
     await io.rmRF(reportFile)
   })
 });