pmdtester 1.6.2 → 1.7.0

data/resources/js/project-report.js

@@ -1,32 +1,18 @@
 /*
-    This is what's included in project_diff_report.html
-    to make the violation table work.
+    This is what's included in project_diff_report.html, project_pmd_report.html and project_cpd_report.html
+    to make the violation table and duplication table work.
 
-    It depends on the `project` global var, which is generated
+    It depends on the `pmd_report` and `cpd_report` global vars, which is generated
     in another JS file by LiquidProjectRenderer
  */
 
 $(document).ready(function () {
 
-    function makeCodeLink(violation) {
-        let template = project.source_link_template
-        template = template.replace('{file}', project.file_index[violation.f])
-        template = template.replace('{line}', violation.l);
-        return template
-    }
-
     function extractFilename(path) {
         const pathArray = path.split("/");
         return pathArray[pathArray.length - 1];
     }
 
-    function renderCodeSnippet(violation) {
-        var node = document.createElement('p');
-        var url = project.source_link_base + '/' + project.file_index[violation.f];
-        window.pmd_code_snippets.fetch(document, node, url, violation.l, makeCodeLink(violation));
-        return node;
-    }
-
     const cssClass = {
         "+": "added",
         "-": "removed",
@@ -39,109 +25,304 @@ $(document).ready(function () {
         "~": "Changed",
     }
 
-    var table = $('#violationsTable').DataTable({
-        data: project.violations,
-        columns: [
-            // other attributes in data:
-            // l: line
-            // ol: old line
-            {"data": "f"}, // file
-            {"data": "r"}, // rule
-            {"data": "m"}, // message
-            {"data": "t"}, // type
-        ],
-        deferRender: true,
-        // scrollY: "6000px",
-        dom: 'Pfrtipl', // Search Panes, filtering input, processing display element, table, table information summary, pagination control, length changing input control
-        searchPanes: {
-            viewTotal: true,
-            cascadePanes: true,
-            columns: [0, 1, 3],
-            order: ['Rule', 'Location (click row to expand)', 'Type'],
-            threshold: 1 // always show filters in search pane (default: 0.6)
-        },
-        // scrollCollapse: true,
-        // paging: false,
-        columnDefs: [
-            { //file column
-                render(data, type, row) {
-                    data = project.file_index[data]
-                    // display only the file name (not full path), but use full
-                    // path for sorting and such
-                    if (type === "display") {
-                        let line = 'ol' in row ? row.ol + " -> " + row.l : row.l;
-                        //note : target='_blank' requires that the link open in a new tab
-                        return "<a href='" + makeCodeLink(row) + "' target='_blank' rel='noopener noreferrer'>" + extractFilename(data) + " @ line " + line + "</a>"
-                    } else if (type === "sort") {
-                        return data + "#" + row.line
-                    } else if (type === 'shortFile') {
-                        return extractFilename(data)
-                    } else {
-                        return data;
-                    }
-                },
-                searchPanes :{
-                    orthogonal: {
-                        'display': 'shortFile',
-                        'search':  undefined
-                    }
-                },
-                targets: 0
+    function renderViolationsTable() {
+        const COLUMN_LINE = 0;
+        const COLUMN_LOCATION = 1;
+        const COLUMN_TYPE = 2;
+        const COLUMN_FILE = 3; // reference to file name in pmd_report.file_index
+        const COLUMN_RULE = 4; // reference to rule name in pmd_report.rule_index
+        const COLUMN_MESSAGE = 5;
+        const COLUMN_OLD_LOCATION = 6;
+
+        function makeCodeLink(violation) {
+            let template = pmd_report.source_link_template;
+            template = template.replace('{file}', pmd_report.file_index[violation[COLUMN_FILE]]);
+            template = template.replace('{line}', violation[COLUMN_LINE]);
+            return template;
+        }
+        function renderCodeSnippet(violation) {
+            var node = document.createElement('p');
+            var url = pmd_report.source_link_base + '/' + pmd_report.file_index[violation[COLUMN_FILE]];
+            window.pmd_code_snippets.fetch(document, node, url, violation[COLUMN_LINE], makeCodeLink(violation));
+            return node;
+        }
+
+        var table = $('#violationsTable').DataTable({
+            data: pmd_report.violations,
+            columns: [
+                {"data": COLUMN_FILE},
+                {"data": COLUMN_RULE},
+                {"data": COLUMN_MESSAGE},
+                {"data": COLUMN_TYPE},
+            ],
+            deferRender: true,
+            // scrollY: "6000px",
+            dom: 'Pfrtipl', // Search Panes, filtering input, processing display element, table, table information summary, pagination control, length changing input control
+            searchPanes: {
+                viewTotal: true,
+                cascadePanes: true,
+                columns: [0, 1, 3],
+                order: ['Rule', 'Location (click row to expand)', 'Type'],
+                threshold: 1 // always show filters in search pane (default: 0.6)
             },
-            { // rule column
-                render(data, type, row) {
-                    // display only the file name (not full path), but use full
-                    // path for sorting and such
-                    if (type === "display")
-                        return "<a href='#rule-summary-" + data + "'>" + data + "</a>"
-                    else
-                        return data;
+            // scrollCollapse: true,
+            // paging: false,
+            columnDefs: [
+                { //file column
+                    render(data, type, row) {
+                        let filepath = pmd_report.file_index[data];
+                        // display only the file name (not full path), but use full
+                        // path for sorting and such
+                        if (type === "display") {
+                            let line = row[COLUMN_LOCATION];
+                            if (row[COLUMN_OLD_LOCATION] !== undefined) {
+                                line = row[COLUMN_OLD_LOCATION] + "→" + line;
+                            }
+                            //note : target='_blank' requires that the link open in a new tab
+                            return "<a href='" + makeCodeLink(row) + "' target='_blank' rel='noopener noreferrer'>" + extractFilename(filepath) + " @ line " + line + "</a>";
+                        } else if (type === "sort") {
+                            return filepath + "#" + row[COLUMN_LINE];
+                        } else if (type === 'shortFile') {
+                            return extractFilename(filepath);
+                        } else {
+                            return filepath;
+                        }
+                    },
+                    searchPanes :{
+                        orthogonal: {
+                            'display': 'shortFile',
+                            'search':  undefined
+                        }
+                    },
+                    targets: 0
                 },
-                searchPanes: {
-                    orthogonal: {
-                        'display' : 'sort' // do not use the display, which is an <a>
-                    }
+                { // rule column
+                    render(data, type, row) {
+                        let rulename = pmd_report.rule_index[data];
+                        if (type === "display")
+                            return "<a href='#rule-summary-" + rulename + "'>" + rulename + "</a>"
+                        else
+                            return rulename;
+                    },
+                    searchPanes: {
+                        orthogonal: {
+                            'display' : 'sort' // do not use the display, which is an <a>
+                        }
+                    },
+                    targets: 1
                 },
-                targets: 1
-            },
-            { // type column
-                visible: false,
-                render(data, type, row) {
-                    return type ==='display' ? typeDisplay[data] : cssClass[data]
+                { // type column
+                    visible: false,
+                    render(data, type, row) {
+                        return type ==='display' ? typeDisplay[data] : cssClass[data]
+                    },
+                    targets: 3
                 },
-                targets: 3
+            ],
+            displayLength: 25,
+            lengthMenu: [ [10, 20, 25, 50, 100, -1], [10, 20, 25, 50, 100, "All"] ],
+            rowCallback(row, data, index) {
+                $(row).addClass(cssClass[data[COLUMN_TYPE]]);
             },
-        ],
-        displayLength: 25,
-        lengthMenu: [ [10, 20, 25, 50, 100, -1], [10, 20, 25, 50, 100, "All"] ],
-        rowCallback(row, data, index) {
-            $(row).addClass(cssClass[data.t]);
-        },
-    });
-
-    $('#violationsTable tbody').on('click', 'tr', function() {
-        // the event handler might be executed on "tr" elements in sub tables, such as
-        // code snippets or it might be a child-row (a tr, whose previous sibling has class dt-hasChild)
-        if (!this.parentElement.parentElement.id  === 'violationsTable') {
-            return;
-        }
-        if (this.previousElementSibling !== null && this.previousElementSibling.classList.contains('dt-hasChild')) {
-            return;
-        }
+        });
+
+        $('#violationsTable tbody').on('click', 'tr', function() {
+            // the event handler might be executed on "tr" elements in sub tables, such as
+            // code snippets or it might be a child-row (a tr, whose previous sibling has class dt-hasChild)
+            if (this.parentElement.parentElement.id  !== 'violationsTable') {
+                return;
+            }
+            if (this.previousElementSibling !== null && this.previousElementSibling.classList.contains('dt-hasChild')) {
+                return;
+            }
+
+            var tr = $(this);
+            var row = table.row( tr );
+
+            if ( row.child.isShown() ) {
+                // This row is already open - close it
+                row.child.hide();
+                tr.removeClass('shown');
+            }
+            else {
+                // Open this row
+                row.child( renderCodeSnippet(row.data()) ).show();
+                tr.addClass('shown');
+            }
+        });
+    }
 
-        var tr = $(this);
-        var row = table.row( tr );
+    function renderDuplicationTable() {
+        const COLUMN_LOCATION = 0; // location array
+        const COLUMN_LOCATION_FILE = 0; // in the location array: reference to file name in cpd_report.file_index
+        const COLUMN_LOCATION_BEGIN_LINE = 1;
+        const COLUMN_LOCATION_END_LINE = 2;
+        const COLUMN_LOCATION_STRING = 3;
+        const COLUMN_LINES = 1;
+        const COLUMN_TOKENS = 2;
+        const COLUMN_CODEFRAGMENT = 3; // codefragment
+        const COLUMN_TYPE = 4; // type (+, -, ~)
+        const COLUMN_OLD_LINES = 5; // only for changed duplications
+        const COLUMN_OLD_TOKENS = 6; // only for changed duplications
+        const COLUMN_OLD_LOCATION = 7; // [array] only for changed duplications
 
-        if ( row.child.isShown() ) {
-            // This row is already open - close it
-            row.child.hide();
-            tr.removeClass('shown');
+        function makeCodeLinkDuplication(firstDuplication) {
+            let template = cpd_report.source_link_template;
+            template = template.replace('{file}', cpd_report.file_index[firstDuplication[COLUMN_LOCATION_FILE]]);
+            template = template.replace('{line}', `${firstDuplication[COLUMN_LOCATION_BEGIN_LINE]}-L${firstDuplication[COLUMN_LOCATION_END_LINE]}`);
+            return template;
         }
-        else {
-            // Open this row
-            row.child( renderCodeSnippet(row.data()) ).show();
-            tr.addClass('shown');
+        function renderCodeFragment(data) {
+            var node = document.createElement('p');
+            var innerHTML = `${data[COLUMN_LOCATION].length} locations:<br>`;
+            data[COLUMN_LOCATION].forEach(location => {
+                let url = makeCodeLinkDuplication(location);
+                innerHTML += `<a href="${url}" target="_blank" rel="noopener noreferrer">${url} @ line ${location[COLUMN_LOCATION_STRING]}</a><br>`;
+            });
+
+            if (data[COLUMN_OLD_LOCATION] !== undefined) {
+                innerHTML += `changed from ${data[COLUMN_OLD_LOCATION].length} previous locations:<br>`;
+                data[COLUMN_OLD_LOCATION].forEach(location => {
+                    let url = makeCodeLinkDuplication(location);
+                    innerHTML += `<a href="${url}" target="_blank" rel="noopener noreferrer">${url} @ line ${location[COLUMN_LOCATION_STRING]}</a><br>`;
+                });
+            }
+            if (data[COLUMN_OLD_LINES] !== undefined && data[COLUMN_OLD_TOKENS] !== undefined) {
+                innerHTML += `code fragment (lines: ${data[COLUMN_OLD_LINES]} → ${data[COLUMN_LINES]}, tokens: ${data[COLUMN_OLD_TOKENS]} → ${data[COLUMN_TOKENS]}):<br>`;
+            } else {
+                innerHTML += `code fragment (lines: ${data[COLUMN_LINES]}, tokens: ${data[COLUMN_TOKENS]}):<br>`;
+            }
+
+            let table = document.createElement('table');
+            table.classList.add('code-snippet');
+            let tableBody = document.createElement('tbody');
+            table.appendChild(tableBody);
+            // line number of first location
+            let lineNumber = data[COLUMN_LOCATION][0][COLUMN_LOCATION_BEGIN_LINE];
+            data[COLUMN_CODEFRAGMENT].split('\n').forEach(line => {
+                let tableRow = document.createElement('tr');
+                let lineNumberColumn = document.createElement('td');
+                lineNumberColumn.classList.add('line-number');
+                tableRow.appendChild(lineNumberColumn);
+                let lineNumberElement = document.createElement('code');
+                lineNumberColumn.appendChild(lineNumberElement);
+                lineNumberElement.setAttribute('data-line-number', lineNumber);
+
+                let codeColumn = document.createElement('td');
+                tableRow.appendChild(codeColumn);
+                let codeElement = document.createElement("code");
+                codeColumn.appendChild(codeElement);
+                // createTextNode escapes special chars
+                codeElement.appendChild(document.createTextNode(line));
+
+                tableBody.appendChild(tableRow); // append row to the table
+                lineNumber++; // increment line number for each line
+            });
+
+            node.innerHTML = innerHTML + table.outerHTML;
+            return node;
         }
-    });
+
+        var cpdTable = $('#duplicationsTable').DataTable({
+            data: cpd_report.duplications,
+            columns: [
+                {"data": COLUMN_LOCATION},
+                {"data": COLUMN_LINES},
+                {"data": COLUMN_TOKENS},
+                {"data": COLUMN_CODEFRAGMENT},
+                {"data": COLUMN_TYPE},
+            ],
+            deferRender: true,
+            dom: 'Pfrtipl', // Search Panes, filtering input, processing display element, table, table information summary, pagination control, length changing input control
+            searchPanes: {
+                viewTotal: true,
+                cascadePanes: true,
+                columns: [0, 4],
+                order: ['Location (click row to expand)', 'Type'],
+                threshold: 1 // always show filters in search pane (default: 0.6)
+            },
+            columnDefs: [
+                { // locations column
+                    render(data, type, row) {
+                        let first = data[0];
+                        let firstPath = cpd_report.file_index[first[COLUMN_LOCATION_FILE]];
+                        let firstLocation = first[COLUMN_LOCATION_STRING];
+                        let firstFilename = extractFilename(firstPath);
+                        if (type === "display") {
+                            return "<a href='" + makeCodeLinkDuplication(first) + "' target='_blank' rel='noopener noreferrer'>" + firstFilename + " @ line " + firstLocation + "</a>" + (data.length > 1 ? " (and " + (data.length - 1) + " more)" : "");
+                        } else if (type === "sort") {
+                            return firstPath + "#" + first[COLUMN_LOCATION_END_LINE];
+                        } else if (type === 'filter') {
+                            return firstFilename;
+                        } else if (type === 'shortFile') {
+                            return firstFilename;
+                        } else {
+                            return data;
+                        }
+                    },
+                    searchPanes :{
+                        orthogonal: {
+                            'display': 'shortFile',
+                            'search':  undefined
+                        }
+                    },
+                    targets: 0
+                },
+                { // codefragment column
+                    render(data, type, row) {
+                        if (type === "display") {
+                            data = data.replace(/\r\n|\n/g, "\\n"); // replace newlines with \n for better display in the table
+                            return data.length > 50 ? data.substring(0, 50) + "..." : data;
+                        }
+                        return data;
+                    },
+                    targets: 3
+                },
+                { // type column
+                    visible: false,
+                    render(data, type, row) {
+                        return type ==='display' ? typeDisplay[data] : cssClass[data]
+                    },
+                    targets: 4
+                },
+            ],
+            displayLength: 25,
+            lengthMenu: [ [10, 20, 25, 50, 100, -1], [10, 20, 25, 50, 100, "All"] ],
+            rowCallback(row, data, index) {
+                $(row).addClass(cssClass[data[4]]);
+            },
+        });
+        $('#duplicationsTable tbody').on('click', 'tr', function() {
+            // the event handler might be executed on "tr" elements in sub tables, such as
+            // a child-row (a tr, whose previous sibling has class dt-hasChild)
+            if (this.parentElement.parentElement.id  !== 'duplicationsTable') {
+                return;
+            }
+            if (this.previousElementSibling !== null && this.previousElementSibling.classList.contains('dt-hasChild')) {
+                return;
+            }
+
+            var tr = $(this);
+            var row = cpdTable.row( tr );
+
+            if ( row.child.isShown() ) {
+                // This row is already open - close it
+                row.child.hide();
+                tr.removeClass('shown');
+            }
+            else {
+                // Open this row
+                row.child( renderCodeFragment(row.data()) ).show();
+                tr.addClass('shown');
+            }
+        });
+    }
+
+    if ($('#violationsTable').length > 0) {
+        renderViolationsTable();
+    }
+    if ($('#duplicationsTable').length > 0) {
+        renderDuplicationTable();
+    }
 
 });

data/resources/project_cpd_report.html

@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>CPD Report for {{project_name}}</title>
+
+    <link rel="stylesheet" type="text/css" href="../css/bootstrap-5.3.0-alpha3.min.css"/>
+    <link rel="stylesheet" type="text/css" href="../css/datatables.min.css"/>
+    <link rel="stylesheet" type="text/css" href="../css/pmd-tester.css">
+
+    <script src="../js/jquery-3.6.4.slim.min.js"></script>
+    <script src="../js/popper-2.11.7.min.js"></script>
+    <script src="../js/bootstrap-5.3.0-alpha3.min.js"></script>
+    <script src="../js/datatables.min.js"></script>
+    <script src="../js/code-snippets.js"></script>
+    <!-- This is generated -->
+    <script src="./{{branch}}_cpd_data.js"></script>
+
+</head>
+<body>
+<div class="section">
+    <h1>CPD Report for {{project_name}}</h1>
+</div>
+<div class="section">
+    <h2>Summary</h2>
+    <div class="section-content">
+        <table id="table-summary" class="table">
+            <thead>
+            <tr>
+                <th></th>
+                <th>{{branch | capitalize}}</th>
+            </tr>
+            </thead>
+            <tbody>
+            <tr>
+                <td class="item"><a href="#section-duplications">Duplications</a></td>
+                <td class="{{branch}}">{{cpd_report.duplication_counts}}</td>
+            </tr>
+            <tr>
+                <td class="item"><a href="#section-cpd-errors">CPD Errors</a></td>
+                <td class="{{branch}}">{{cpd_report.error_counts}}</td>
+            </tr>
+            <tr>
+                <td class="item">Execution time</td>
+                <td class="{{branch}}">{{cpd_report.execution_time}}</td>
+            </tr>
+            <tr>
+                <td class="item">Timestamp</td>
+                <td class="{{branch}}">{{cpd_report.timestamp}}</td>
+            </tr>
+            <tr>
+                <td class="item">Exit Code</td>
+                <td class="{{branch}}">{{cpd_report.exit_code}} <a href="{{branch}}_cpd_stdout.txt">stdout</a> | <a href="{{branch}}_cpd_stderr.txt">stderr</a></td>
+            </tr>
+            <tr>
+                <td class="item">Full Report</td>
+                <td class="{{branch}}"><a href="{{branch}}_cpd_report.xml">{{branch}}_cpd_report.xml</a></td>
+            </tr>
+            <tr>
+                <td class="item">JFR Recording</td>
+                <td class="{{branch}}"><a href="{{branch}}_cpd_recording.jfr">{{branch}}_cpd_recording.jfr</a></td>
+            </tr>
+            <tr>
+                <td class="item">JFR Details</td>
+                <td class="{{branch}}">
+                    <details><summary>Details</summary>
+                    Execution Time: {{cpd_report.jfr_summary.execution_time}}<br>
+                    Max Heap Memory: {{cpd_report.jfr_summary.max_heap_memory}}<br>
+                    Max CPU Load: {{cpd_report.jfr_summary.max_cpu_load}}<br>
+                    Avg CPU Load: {{cpd_report.jfr_summary.avg_cpu_load}}<br>
+                    </details>
+                </td>
+            </tr>
+            </tbody>
+        </table>
+    </div>
+</div>
+
+
+<div class="section" id="section-duplications">
+
+    <h2>Duplications</h2>
+
+    <div class="section-content">
+
+        <table id="duplicationsTable" width="100%" class="table">
+            <thead>
+            <tr>
+                <th>Location (click row to expand)</th>
+                <th>Lines</th>
+                <th>Tokens</th>
+                <th>Code Fragment</th>
+                <th>Type</th>
+            </tr>
+            </thead>
+        </table>
+
+    </div>
+
+</div>
+
+<div class="section" id="section-cpd-errors">
+
+    <h2>CPD Errors</h2>
+
+    <div class="section-content">
+
+        <div class="table-responsive">
+            <table id="cpd-error-table" class="table">
+                <thead>
+                 <tr>
+                     <th>File</th>
+                     <th>Description (click to expand)</th>
+                 </tr>
+                </thead>
+                <tbody>
+                {% for error in cpd_report.errors %}
+                <tr id="cpd-error-{{forloop.index}}" data-bs-toggle="collapse" data-bs-target="#cpd-error-{{forloop.index}}-expanded">
+                    <td><a href="{{error.file_url}}"  target="_blank" rel="noopener noreferrer">{{error.short_filename}}</a></td>
+                    <td>{{error.short_message | escape | replace: error.filename, "<span class='meta-var'>$FILE</span>" }}</td>
+                </tr>
+                <tr>
+                    <td class="row-hidden" colspan="2">
+                        <div class="accordion-body collapse" id="cpd-error-{{forloop.index}}-expanded">
+                            <div class="collapsed-content-padder">
+                                <pre>
+{{ error.stack_trace_html }}
+                                </pre>
+                            </div>
+                        </div>
+                    </td>
+                </tr>
+                {% endfor %}
+                </tbody>
+            </table>
+        </div>
+
+    </div>
+</div>
+
+<script src="../js/project-report.js"></script>
+
+</body>
+</html>