npm-groovy-lint 8.2.0 → 9.3.0

package/lib/test/lint-build-format.test.js

@@ -1,43 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-let assert = require("assert");
-const util = require("util");
-const fse = require("fs-extra");
-const rimraf = require("rimraf");
-const childProcess = require("child_process");
-const exec = util.promisify(childProcess.exec);
-const { beforeEachTestCase, copyFilesInTmpDir, SAMPLE_FILE_SMALL, SAMPLE_FILE_SMALL_FORMAT, NPM_GROOVY_LINT } = require("./helpers/common");
-
-describe("Lint & format with EXE", function() {
-    beforeEach(beforeEachTestCase);
-
-    it("(API:file) should lint and format a file in one shot", async function() {
-        const tmpDir = await copyFilesInTmpDir();
-        const prevFileContent = fse.readFileSync(tmpDir + "/" + SAMPLE_FILE_SMALL).toString();
-        const params = [
-            "--output",
-            '"npm-groovy-fix-log.json"',
-            "--path",
-            '"' + tmpDir + '"',
-            "--files",
-            "**/" + SAMPLE_FILE_SMALL,
-            "--format",
-            "--no-insight",
-            "--verbose"
-        ];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-
-        assert(fse.existsSync("npm-groovy-fix-log.json"), "Output json file has been produced");
-
-        const newFileContent = fse.readFileSync(tmpDir + "/" + SAMPLE_FILE_SMALL).toString();
-        assert(prevFileContent !== newFileContent, "Groovy file has been updated");
-        const expectedFileContent = fse.readFileSync(tmpDir + "/" + SAMPLE_FILE_SMALL_FORMAT).toString();
-        assert.strictEqual(newFileContent, expectedFileContent, "Formatted file is corresponding to expected result");
-        fse.removeSync("npm-groovy-fix-log.json");
-        rimraf.sync(tmpDir);
-    }).timeout(120000);
-});

package/lib/test/lint-build.test.js

@@ -1,168 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-const util = require("util");
-const c = require("ansi-colors");
-let assert = require("assert");
-const fse = require("fs-extra");
-const path = require("path");
-const childProcess = require("child_process");
-const exec = util.promisify(childProcess.exec);
-const spawn = childProcess.spawnSync;
-
-const { SAMPLE_FILE_SMALL, NPM_GROOVY_LINT } = require("./helpers/common");
-
-describe("Lint with executable", () => {
-    it("(EXE:file) should generate text console output", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--loglevel", "warning", "--no-insight", "--verbose"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(stdout.includes("warning"), 'stdout should contain word "warning"');
-    });
-    it("(EXE:file) should generate json console output", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--no-insight", "--output", "json"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(stdout.includes(`"totalFoundWarningNumber":`), "Property totalFoundWarningNumber is in result");
-    });
-
-    it("(EXE:file) should ignore fake_node_modules pattern", async () => {
-        const params = ["--ignorepattern", "**/fake_node_modules/**", "--no-insight", "--output", "txt"];
-        const { stdout, stderr } = await exec("cd lib/example && " + NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(!stdout.includes(`ToIgnore.groovy`), `ToIgnore.groovy has been ignored \n${stdout}`);
-        assert(
-            stdout.includes(`npm-groovy-lint results in ${c.bold(10)} linted files`),
-            `Number of linted files is displayed in summary \n${stdout}`
-        );
-    });
-
-    it("(EXE:file) should generate codenarc HTML file report", async () => {
-        const reportFileName = path.resolve("ReportTestCodenarc.html");
-        const params = [
-            "--codenarcargs",
-            '-basedir="lib/example"',
-            '-title="TestTitleCodenarc"',
-            "-maxPriority1Violations=0",
-            `-report="html:${reportFileName}"`
-        ];
-        await exec(NPM_GROOVY_LINT + params.join(" "));
-        assert(fse.existsSync(reportFileName), "html CodeNarc report has been generated at " + reportFileName);
-        fse.removeSync(reportFileName);
-    });
-
-    it("(EXE:file) should generate codenarc XML file report", async () => {
-        const reportFileName = path.resolve("ReportTestCodenarc.xml");
-        const params = [
-            "--codenarcargs",
-            '-basedir="lib/example"',
-            '-title="TestTitleCodenarc"',
-            "-maxPriority1Violations=0",
-            `-report="xml:${reportFileName}"`
-        ];
-        await exec(NPM_GROOVY_LINT + params.join(" "));
-        assert(fse.existsSync(reportFileName), "xml CodeNarc report has been generated at " + reportFileName);
-        fse.removeSync(reportFileName);
-    });
-
-    it("(EXE:file) should run on a Jenkinsfile", async () => {
-        const params = ["--path", ' "lib/example"', "--files", "**/Jenkinsfile", "-c", "recommended-jenkinsfile", "--no-insight", "--verbose"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(stdout.includes("warning"), 'stdout should contain word "warning"');
-    });
-
-    it("(EXE:help) should show npm-groovy-lint help", async () => {
-        const params = ["-h"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(stdout.includes("--verbose"), 'stdout should contain word "--verbose"');
-    });
-
-    it("(EXE:help) should show npm-groovy-lint version", async () => {
-        const params = ["-v"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(stdout.includes("npm-groovy-lint v"), "Version is returned");
-    });
-
-    it("(EXE:help) should show codenarc help", async () => {
-        const params = ["--codenarcargs", "-help"];
-        const { stdout, stderr } = await exec(NPM_GROOVY_LINT + params.join(" "));
-        if (stderr) {
-            console.error(stderr);
-        }
-        assert(stdout, "stdout is set");
-        assert(
-            stdout.includes("where OPTIONS are zero or more command-line options"),
-            'stdout should contain word "where OPTIONS are zero or more command-line options"'
-        );
-    });
-
-    it("(EXE:file) failonerror", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--failonerror", "--no-insight", "--output", "txt"];
-        const { stderr, status } = spawn(NPM_GROOVY_LINT + params.join(" "), [], { shell: true });
-        if (stderr) {
-            console.error(stderr.toString());
-        }
-        assert(status === 1, `Status code is 1 (returned: ${status})`);
-    });
-
-    it("(EXE:file) failonwarning", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--failonwarning", "--no-insight", "--output", "txt"];
-        const { stderr, status } = spawn(NPM_GROOVY_LINT + params.join(" "), [], { shell: true });
-        if (stderr) {
-            console.error(stderr.toString());
-        }
-        assert(status === 1, `Status code is 1 (returned: ${status})`);
-    });
-
-    it("(EXE:file) failoninfo", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--failoninfo", "--no-insight", "--output", "txt"];
-        const { stderr, status } = spawn(NPM_GROOVY_LINT + params.join(" "), [], { shell: true });
-        if (stderr) {
-            console.error(stderr.toString());
-        }
-        assert(status === 1, `Status code is 1 (returned: ${status})`);
-    });
-
-    it("(EXE:file) failon info", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--failon", "info", "--no-insight", "--output", "txt"];
-        const { stderr, status } = spawn(NPM_GROOVY_LINT + params.join(" "), [], { shell: true });
-        if (stderr) {
-            console.error(stderr.toString());
-        }
-        assert(status === 1, `Status code is 1 (returned: ${status})`);
-    });
-
-    it("(EXE:file) Send anonymous usage stats", async () => {
-        const params = ["--path", '"lib/example"', "--files", "**/" + SAMPLE_FILE_SMALL, "--output", "txt"];
-        const { stdout, stderr, status } = spawn(NPM_GROOVY_LINT + params.join(" "), [], { shell: true });
-        if (stdout) {
-            console.log("STDOUT:\n");
-            console.log(stdout.toString());
-        }
-        if (stderr) {
-            console.log("STDERR:\n");
-            console.error(stderr.toString());
-        }
-        assert(status === 0, `Status code is 0 (returned: ${status})`);
-    });
-});

package/lib/test/lint-comments.test.js

@@ -1,197 +0,0 @@
-#! /usr/bin / env node
-"use strict";
-const NpmGroovyLint = require("../groovy-lint.js");
-let assert = require("assert");
-const { beforeEachTestCase, checkCodeNarcCallsCounter } = require("./helpers/common");
-
-describe("Check disabled rules", function() {
-    beforeEach(beforeEachTestCase);
-
-    for (const [key, val] of getSamplesMap()) {
-        it("(API:source)" + key, async () => {
-            await checkRule(key, val);
-        }).timeout(30000);
-    }
-});
-
-async function checkRule(key, check) {
-    const npmGroovyLintConfig = {
-        source: check.source,
-        output: "txt",
-        insight: false,
-        verbose: true
-    };
-    const linter = await new NpmGroovyLint(npmGroovyLintConfig, {}).run();
-
-    assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-    assert(
-        linter.lintResult.summary.totalFoundNumber === check.totalFound,
-        `${linter.lintResult.summary.totalFoundNumber} errors found (expected: ${check.totalFound})`
-    );
-    checkCodeNarcCallsCounter(1);
-}
-
-function getSamplesMap() {
-    return new Map([
-        [
-            "GroovyDisableFileAll/*",
-            {
-                totalFound: 0,
-                source: `
-/* groovylint-disable */
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableFileAll//",
-            {
-                totalFound: 0,
-                source: `
-// groovylint-disable
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableFileIndentation/*",
-            {
-                totalFound: 3,
-                source: `
-/* groovylint-disable Indentation */
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableFileIndentation//",
-            {
-                totalFound: 3,
-                source: `
-// groovylint-disable Indentation
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableFileIndentationUnnecessarySemicolon",
-            {
-                totalFound: 2,
-                source: `
-// groovylint-disable Indentation,UnnecessarySemicolon
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableLineAll",
-            {
-                totalFound: 4,
-                source: `
-private void doSomething(){
-            if (a == 2) 
-                doSomething(); // groovylint-disable-line
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableLineUnnecessarySemicolon",
-            {
-                totalFound: 3,
-                source: `
-private void doSomething(){
-            if (a == 2)
-                doSomething(); // groovylint-disable-line UnnecessarySemicolon
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableNextLineUnnecessarySemicolon",
-            {
-                totalFound: 3,
-                source: `
-private void doSomething(){
-            if (a == 2)
-                // groovylint-disable-next-line UnnecessarySemicolon
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableNextLineToIgnore",
-            {
-                totalFound: 4,
-                source: `
-private void doSomething(){
-            if (a == 2)
-                // groovylint-disable-next-line DummyRule
-                doSomething();
-   }
-`
-            }
-        ],
-        [
-            "GroovyDisableEnableAll",
-            {
-                totalFound: 3,
-                source: `
-private void doSomething(){
-    // groovylint-disable
-            if (a == 2)
-                doSomething();
-    // groovylint-enable 
-    def a = 1;
-}
-`
-            }
-        ],
-        [
-            "GroovyDisableEnableIndentation",
-            {
-                totalFound: 6,
-                source: `
-private void doSomething(){
-    /* groovylint-disable Indentation */
-            if (a == 2)
-                doSomething();
-    /* groovylint-enable Indentation */
-         def a = 1;
-}
-`
-            }
-        ],
-        [
-            "GroovyDisableEnableIndentationUnnecessarySemicolon",
-            {
-                totalFound: 5,
-                source: `
-private void doSomething(){
-    /* groovylint-disable Indentation, UnnecessarySemicolon */
-            if (a == 2)
-                doSomething();
-    /* groovylint-enable Indentation, UnnecessarySemicolon */
-         def a = 1;
-}
-`
-            }
-        ]
-    ]);
-}

package/lib/test/lint-fix.rules.test.js

@@ -1,71 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-const NpmGroovyLint = require("../groovy-lint.js");
-const { getNpmGroovyLintRules } = require("../groovy-lint-rules.js");
-const { normalizeNewLines } = require("../utils.js");
-let assert = require("assert");
-
-const { beforeEachTestCase, checkCodeNarcCallsCounter, getDiff } = require("./helpers/common");
-const npmGroovyLintRules = getNpmGroovyLintRules({ loadTests: true });
-
-// Read rules file and test all fixes
-describe("Check rules auto-fixes", () => {
-    beforeEach(beforeEachTestCase);
-
-    // Iterate all rules
-    for (const ruleName of Object.keys(npmGroovyLintRules)) {
-        let pos = 1;
-        // Process only the rules with a fix defined
-        if (npmGroovyLintRules[ruleName].fix && npmGroovyLintRules[ruleName]) {
-            if (npmGroovyLintRules[ruleName].tests && npmGroovyLintRules[ruleName].tests.length > 0) {
-                // Process rule tests
-                for (const testRule of npmGroovyLintRules[ruleName].tests) {
-                    // Do not test non-codenarc rules, as they can't be returned by CodeNarc Linter
-                    if (npmGroovyLintRules[ruleName].isCodeNarcRule == null || npmGroovyLintRules[ruleName].isCodeNarcRule === true)
-                        it(`${ruleName} (${pos})`, async () => {
-                            await checkRuleFix(ruleName, testRule);
-                        }).timeout(60000);
-                    pos = pos + 1;
-                }
-            } else {
-                // At least one rule should be defined
-                it(`${ruleName} fix tests has not been defined: please do it !`, async () => {
-                    assert(0 === 1, `${ruleName} fix tests has not been defined: please do it !`);
-                });
-            }
-        }
-    }
-});
-
-// Check rule fix result
-async function checkRuleFix(ruleName, testRule) {
-    let fixRules = ruleName;
-    // Call linter & fixer
-    const source = normalizeNewLines(testRule.sourceBefore);
-    const npmGroovyLintConfig = {
-        source: source,
-        rulesets: fixRules,
-        fix: true,
-        fixrules: fixRules,
-        nolintafter: true,
-        insight: false,
-        output: "none",
-        verbose: true
-    };
-    let err = null;
-    let linter;
-    try {
-        linter = await new NpmGroovyLint(npmGroovyLintConfig, {}).run();
-    } catch (e) {
-        console.error("NpmGroovyLint fatal error: " + e.message);
-        console.error(e.stack);
-        err = e;
-    }
-    // Check results
-    assert(err == null, "No crash during NpmGroovyLint run");
-    assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-    const updatedSource = linter.lintResult.files[0].updatedSource;
-    const effectiveDiffs = getDiff(normalizeNewLines(testRule.sourceAfter), updatedSource, source);
-    assert(effectiveDiffs.length === 0, `Fix result is not the one expected.\n Diff: \n${JSON.stringify(effectiveDiffs, null, 2)}`);
-    checkCodeNarcCallsCounter(testRule.codeNarcCallsNumber || 1);
-}