Support upcoming PMD 7.0.0-rc1 release

Author: adangel

dist/index.js

@@ -35,10 +35,17 @@ const downloadPmd = async function(version, token) {
 
 const executePmd = async function(pmdInfo, fileListOrSourcePath, ruleset, reportFormat, reportFile) {
     let pmdExecutable = '/bin/run.sh pmd';
+    if (isPmd7Cli(pmdInfo.version)) {
+        pmdExecutable = '/bin/pmd.sh';
+    }
     if (os.platform() === 'win32') {
         pmdExecutable = '\\bin\\pmd.bat';
     }
 
+    if (isPmd7Cli(pmdInfo.version)) {
+        pmdExecutable += ' check';
+    }
+
     let sourceParameter = ['-d', fileListOrSourcePath];
     if (Array.isArray(fileListOrSourcePath)) {
         await writeFileList(fileListOrSourcePath);
@@ -69,6 +76,10 @@ function useNewArgsFormat(pmdVersion) {
     return semver.gte(pmdVersion, '6.41.0');
 }
 
+function isPmd7Cli(pmdVersion) {
+    return semver.gte(pmdVersion, '7.0.0-rc1');
+}
+
 async function determinePmdRelease(pmdVersion, token) {
     core.debug(`determine release info for ${pmdVersion}`);
 

lib/util.js

@@ -3,3 +3,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
+zip -r pmd-bin-7.0.0-rc1.zip pmd-bin-7.0.0-rc1

tests/data/create-zips.sh

@@ -0,0 +1,17 @@
+@echo off
+echo Running PMD 7.0.0-rc1 with: %*
+
+(
+    echo {
+    echo   "runs": [
+    echo     {
+    echo       "tool": {
+    echo         "driver": {
+    echo           "name": "PMD",
+    echo           "version": "7.0.0-rc1"
+    echo         }
+    echo       }
+    echo     }
+    echo   ]
+    echo }
+)>"pmd-report.sarif"

tests/data/pmd-bin-7.0.0-rc1.zip

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

tests/data/pmd-bin-7.0.0-rc1/bin/pmd.bat

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

tests/data/pmd-bin-7.0.0-rc1/bin/pmd.sh

@@ -7,6 +7,7 @@ const fs = require('fs').promises;
 const exec = require('@actions/exec');
 const util = require('../lib/util');
 const github_utils = require('@actions/github/lib/utils')
+const semver = require('semver');
 
 const cachePath = path.join(__dirname, 'CACHE')
 const tempPath = path.join(__dirname, 'TEMP')
@@ -403,6 +404,37 @@ describe('pmd-github-action-util', function () {
     expect(fileList).toStrictEqual(['src/main/java/AvoidCatchingThrowableSample.java', 'src/main/java2/NewFile.java', 'src/main/java/ChangedFile.java', 'README.md']
       .map(f => path.normalize(f)));
   })
+
+  test('can execute PMD 7 with correct parameters', async () => {
+    nock('https://api.github.com')
+      .get('/repos/pmd/pmd/releases/tags/pmd_releases%2F7.0.0-rc1')
+      .replyWithFile(200, __dirname + '/data/releases-7.0.0-rc1.json', {
+        'Content-Type': 'application/json',
+      })
+    nock('https://github.com')
+      .get('/pmd/pmd/releases/download/pmd_releases/7.0.0-rc1/pmd-bin-7.0.0-rc1.zip')
+      .replyWithFile(200, __dirname + '/data/pmd-bin-7.0.0-rc1.zip')
+
+    const pmdInfo = await util.downloadPmd('7.0.0-rc1', 'my_test_token');
+    const execOutput = await util.executePmd(pmdInfo, ['src/file1.txt', 'src/file2.txt'], 'ruleset.xml', 'sarif', 'pmd-report.sarif');
+    const pmdFilelist = path.join('.', 'pmd.filelist');
+    await expect(fs.access(pmdFilelist)).resolves.toBe(undefined);
+    const pmdFilelistContent = await fs.readFile(pmdFilelist, 'utf8');
+    expect(pmdFilelistContent).toBe('src/file1.txt,src/file2.txt');
+    expect(execOutput.exitCode).toBe(0);
+    expect(execOutput.stdout.trim()).toBe('Running PMD 7.0.0-rc1 with: check --no-cache --file-list pmd.filelist -f sarif -R ruleset.xml -r pmd-report.sarif');
+    await io.rmRF(pmdFilelist);
+    await io.rmRF(path.join('.', 'pmd-report.sarif'));
+  });
+
+  test('PMD 7 release candidates and final release version ordering', () => {
+    // see method util#isPmd7Cli
+    expect(semver.gte('6.55.0', '7.0.0-rc1')).toBe(false);
+    expect(semver.gte('7.0.0-rc1', '7.0.0-rc1')).toBe(true);
+    expect(semver.gte('7.0.0-rc2', '7.0.0-rc1')).toBe(true);
+    expect(semver.gte('7.0.0-rc3', '7.0.0-rc1')).toBe(true);
+    expect(semver.gte('7.0.0', '7.0.0-rc1')).toBe(true);
+  });
 });
 
 function setGlobal(key, value) {