npm-groovy-lint 8.2.0 → 9.3.0

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

@@ -1,224 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-const NpmGroovyLint = require("../groovy-lint.js");
-let assert = require("assert");
-const fse = require("fs-extra");
-const rimraf = require("rimraf");
-const {
-    beforeEachTestCase,
-    copyFilesInTmpDir,
-    checkCodeNarcCallsCounter,
-    SAMPLE_FILE_BIG_PATH,
-    SAMPLE_FILE_SMALL_PATH
-} = require("./helpers/common");
-
-describe("Lint & fix with API", function() {
-    beforeEach(beforeEachTestCase);
-
-    it("(API:source) should lint then fix only a list of errors", async () => {
-        const sampleFilePath = SAMPLE_FILE_BIG_PATH;
-        const prevFileContent = fse.readFileSync(sampleFilePath).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            sourcefilepath: sampleFilePath,
-            nolintafter: true,
-            output: "none",
-            insight: false,
-            verbose: true
-        };
-        const linter = await new NpmGroovyLint(npmGroovyLintConfig, {}).run();
-
-        let errIdList = linter.lintResult.files[0].errors.filter(error => error.fixable === true).map(err => err.id);
-        errIdList = errIdList.slice(0, 500);
-        await linter.fixErrors(errIdList);
-
-        assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-        assert(linter.lintResult.summary.totalFixedNumber >= 100, "Errors have been fixed"); // can be more than the five sent errors, as there are other triggered fixes
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(2);
-    });
-
-    it("(API:source) should lint and fix (one shot)", async () => {
-        const sampleFilePath = SAMPLE_FILE_BIG_PATH;
-        const expectedFixedErrs = 995;
-        const prevFileContent = fse.readFileSync(sampleFilePath).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            sourcefilepath: sampleFilePath,
-            fix: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(3);
-    }).timeout(200000);
-
-    it("(API:source) should lint and fix (no lintagainafterfix)", async () => {
-        const sampleFilePath = SAMPLE_FILE_BIG_PATH;
-        const expectedFixedErrs = 995;
-        const prevFileContent = fse.readFileSync(sampleFilePath).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            sourcefilepath: sampleFilePath,
-            fix: true,
-            nolintafter: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(2);
-    }).timeout(200000);
-
-    it("(API:source) should lint and fix (no lintagainafterfix) 2", async () => {
-        const sampleFilePath = SAMPLE_FILE_SMALL_PATH;
-        const expectedFixedErrs = 14;
-        const prevFileContent = fse.readFileSync(sampleFilePath).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            sourcefilepath: sampleFilePath,
-            fix: true,
-            nolintafter: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(1);
-    }).timeout(200000);
-
-    it("(API:file) should lint and fix a Jenkinsfile in one shot", async function() {
-        const tmpDir = await copyFilesInTmpDir();
-        const prevFileContent = fse.readFileSync(tmpDir + "/Jenkinsfile").toString();
-        const linter = await new NpmGroovyLint(
-            [
-                process.execPath,
-                "",
-                "--output",
-                '"npm-groovy-fix-log.json"',
-                "--path",
-                '"' + tmpDir + '"',
-                "--files",
-                "**/Jenkinsfile",
-                "--nolintafter",
-                "--fix",
-                "--no-insight",
-                "--verbose"
-            ],
-            {}
-        ).run();
-
-        assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-        assert(linter.lintResult.summary.totalFixedNumber > 0, "Error have been fixed");
-        assert(linter.lintResult.files[Object.keys(linter.lintResult.files)[0]].updatedSource !== prevFileContent, "File content has been updated");
-        assert(fse.existsSync("npm-groovy-fix-log.json"), "Output json file has been produced");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-
-        fse.removeSync("npm-groovy-fix-log.json");
-        rimraf.sync(tmpDir);
-        checkCodeNarcCallsCounter(2);
-    }).timeout(120000);
-
-    it("(API:file) should fix only some errors", async function() {
-        const fixRules = [
-            // Line rules or not changing line rules
-
-            "Indentation", // ok
-            // "UnnecessaryGString",
-            // "SpaceBeforeOpeningBrace",
-            // "SpaceAfterOpeningBrace",
-            // "SpaceAfterCatch",
-            // "SpaceAroundOperator",
-            // "SpaceAfterComma",
-            // "UnnecessaryDefInFieldDeclaration",
-            "UnnecessarySemicolon"
-            // "IfStatementBraces",
-            // "ElseStatementBraces",
-            // "ConsecutiveBlankLines",
-            // "IndentationClosingBraces",
-            // "IndentationComments",
-            // "FileEndsWithoutNewline" // ok
-        ];
-        const tmpDir = await copyFilesInTmpDir();
-        const linter = await new NpmGroovyLint(
-            [
-                process.execPath,
-                "",
-                "--path",
-                '"' + tmpDir + '"',
-                "--fix",
-                "--fixrules",
-                fixRules.join(","),
-                "--nolintafter",
-                "--output",
-                '"npm-groovy-fix-log-should-fix-only-some-errors.txt"',
-                "--no-insight",
-                "--verbose"
-            ],
-            {}
-        ).run();
-
-        assert(linter.status === 0);
-        assert(linter.lintResult.summary.totalFixedNumber > 0, "Errors have been fixed");
-        assert(fse.existsSync("npm-groovy-fix-log-should-fix-only-some-errors.txt"), "Output txt file produced");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-
-        fse.removeSync("npm-groovy-fix-log-should-fix-only-some-errors.txt");
-        rimraf.sync(tmpDir);
-        checkCodeNarcCallsCounter(1);
-    }).timeout(120000);
-
-    it("(API:file) should fix groovy files", async function() {
-        const tmpDir = await copyFilesInTmpDir();
-        const linter = await new NpmGroovyLint(
-            [
-                process.execPath,
-                "",
-                "--path",
-                '"' + tmpDir + '"',
-                "--output",
-                '"npm-groovy-fix-log-should-fix-groovy-files.txt"',
-                "--fix",
-                "--nolintafter",
-                "--no-insight",
-                "--verbose"
-            ],
-            {}
-        ).run();
-
-        assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-        assert(linter.lintResult.summary.totalFixedNumber > 0, "Errors have been fixed");
-        assert(fse.existsSync("npm-groovy-fix-log-should-fix-groovy-files.txt"), "Output txt file produced");
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-
-        fse.removeSync("npm-groovy-fix-log-should-fix-groovy-files.txt");
-        rimraf.sync(tmpDir);
-        checkCodeNarcCallsCounter(2);
-    }).timeout(120000);
-});

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

@@ -1,293 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-const NpmGroovyLint = require("../groovy-lint.js");
-let assert = require("assert");
-const fse = require("fs-extra");
-const { normalizeNewLines } = require("../utils.js");
-const rimraf = require("rimraf");
-const {
-    beforeEachTestCase,
-    checkCodeNarcCallsCounter,
-    getDiff,
-    copyFilesInTmpDir,
-    SAMPLE_FILE_BIG,
-    SAMPLE_FILE_BIG_PATH,
-    SAMPLE_FILE_SMALL_PATH
-} = require("./helpers/common");
-
-describe("Format with API", function() {
-    beforeEach(beforeEachTestCase);
-
-    it("(API:source) should format code", async () => {
-        const expectedFixedErrs = 1096;
-        const prevFileContent = fse.readFileSync(SAMPLE_FILE_BIG_PATH).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            format: true,
-            nolintafter: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        const fixedNbInLogs = (linter.outputString.match(/fixed/g) || []).length;
-        assert(fixedNbInLogs >= expectedFixedErrs, `Result log contains ${expectedFixedErrs} fixed errors (${fixedNbInLogs} returned)`);
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(2);
-    }).timeout(100000);
-
-    it("(API:source) should format code with custom config", async () => {
-        const expectedFixedErrs = 34;
-        const prevFileContent = fse.readFileSync(SAMPLE_FILE_SMALL_PATH).toString();
-        const npmGroovyLintConfig = {
-            source: prevFileContent,
-            sourcefilepath: SAMPLE_FILE_SMALL_PATH,
-            config: "custom",
-            format: true,
-            nolintafter: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        assert(linter.lintResult.files[0].updatedSource && linter.lintResult.files[0].updatedSource !== prevFileContent, "Source has been updated");
-        const fixedNbInLogs = (linter.outputString.match(/fixed/g) || []).length;
-        assert(fixedNbInLogs >= expectedFixedErrs, `Result log contains ${expectedFixedErrs} fixed errors (${fixedNbInLogs} returned)`);
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        const rules = linter.options.rules || {};
-        assert(rules["Indentation"]["spacesPerIndentLevel"] === 2, "Indentation rule override has been taken in account");
-        checkCodeNarcCallsCounter(1);
-    }).timeout(100000);
-
-    it("(API:file) should format code", async () => {
-        const expectedFixedErrs = 1096;
-        const tmpDir = await copyFilesInTmpDir();
-        const prevFileContent = fse.readFileSync(SAMPLE_FILE_BIG_PATH).toString();
-        const npmGroovyLintConfig = {
-            path: tmpDir,
-            files: `**/${SAMPLE_FILE_BIG}`,
-            format: true,
-            nolintafter: true,
-            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.totalFixedNumber >= expectedFixedErrs,
-            `${expectedFixedErrs} errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-        );
-        const newFileContent = fse.readFileSync(tmpDir + "/" + SAMPLE_FILE_BIG).toString();
-        assert(newFileContent !== prevFileContent, "File has been updated");
-        rimraf.sync(tmpDir);
-        const fixedNbInLogs = (linter.outputString.match(/fixed/g) || []).length;
-        assert(fixedNbInLogs >= expectedFixedErrs, `Result log contains ${expectedFixedErrs} fixed errors (${fixedNbInLogs} returned)`);
-        assert(!linter.outputString.includes("NaN"), "Results does not contain NaN");
-        checkCodeNarcCallsCounter(2);
-
-        rimraf.sync(tmpDir);
-    }).timeout(100000);
-
-    for (const [key, val] of getSamplesMap()) {
-        it("(API:source) " + key + " --format", async () => {
-            await checkRule(key, val, "format");
-        }).timeout(30000);
-        it("(API:source) " + key + " --fix", async () => {
-            await checkRule(key, val, "fix");
-        }).timeout(30000);
-    }
-});
-
-async function checkRule(key, check, checkType) {
-    const source = normalizeNewLines(check.before);
-    const moreOptions = check.moreOptions ? check.moreOptions : {};
-    const npmGroovyLintConfig = Object.assign(
-        {
-            source: source,
-            nolintafter: true,
-            output: "none",
-            insight: false,
-            verbose: true
-        },
-        moreOptions
-    );
-    if (checkType == "format") {
-        npmGroovyLintConfig.format = true;
-    } else if (checkType == "fix") {
-        npmGroovyLintConfig.fix = true;
-    }
-    const linter = await new NpmGroovyLint(npmGroovyLintConfig, {}).run();
-
-    assert(
-        linter.lintResult.summary.totalFixedNumber >= check.totalFixed,
-        `${check.totalFixed} Errors have been fixed (${linter.lintResult.summary.totalFixedNumber} returned)`
-    );
-    const result = linter.lintResult.files[0].updatedSource;
-    const expectedResult = normalizeNewLines(check.after);
-    const effectiveDiff = getDiff(expectedResult, result, source);
-    assert(linter.status === 0, `Linter status is 0 (${linter.status} returned)`);
-    assert(effectiveDiff.length === 0, "Code has been formatted correctly");
-    checkCodeNarcCallsCounter(check.codeNarcCallsCounter);
-}
-
-function getSamplesMap() {
-    return new Map([
-        [
-            "SourceWithIfElseBracesToFormat",
-            {
-                totalFixed: 4,
-                codeNarcCallsCounter: 2,
-                before: `
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-}
-`,
-                after: `
-private void doSomething() {
-    if (a == 2) {
-        doSomething()
-    }
-}
-`
-            }
-        ],
-        [
-            "OnlyNonCodeNarcFormatRules",
-            {
-                totalFixed: 0,
-                codeNarcCallsCounter: 1,
-                before: `
-    // There is a comment badly aligned here
-if (a == 2) {
-            // And here too
-    x = 1
-    }
-`,
-                after: `
-// There is a comment badly aligned here
-if (a == 2) {
-    // And here too
-    x = 1
-}
-`
-            }
-        ],
-        [
-            "OverrideIndentation",
-            {
-                moreOptions: {
-                    rulesets:
-                        'Indentation{"spacesPerIndentLevel":2,"severity": "warning"},UnnecessarySemicolon,UnnecessaryGString,ConsecutiveBlankLines{"severity":"warning"},NoTabCharacter',
-                    rulesetsoverridetype: "appendConfig"
-                },
-                totalFixed: 4,
-                codeNarcCallsCounter: 2,
-                before: `
-private void doSomething(){
-            if (a == 2)
-                doSomething();
-}
-`,
-                after: `
-private void doSomething() {
-  if (a == 2) {
-    doSomething()
-  }
-}
-`
-            }
-        ],
-        [
-            "ElseIfMustRemainSeparated",
-            {
-                totalFixed: 1,
-                codeNarcCallsCounter: 1,
-                before: `
-boolean foo(boolean a, boolean b) {
-    if (a) {
-        return true
-    } else if(b) {
-        return true
-    }
-}
-`,
-                after: `
-boolean foo(boolean a, boolean b) {
-    if (a) {
-        return true
-    } else if (b) {
-        return true
-    }
-}
-`
-            }
-        ],
-        // https://github.com/nvuillam/npm-groovy-lint/issues/121
-        [
-            "Issue121",
-            {
-                totalFixed: 1,
-                codeNarcCallsCounter: 1,
-                before: `
-pipeline {
-agent any
-        stages {
-            stage('Intall JQ') {
-            steps {
-            script {
-                sh 'apt update; apt install jq=1.5+dfsg-2+b1 -y'
-            }
-            }
-            }
-        }
-    }
-`,
-                after: `
-pipeline {
-    agent any
-        stages {
-            stage('Intall JQ') {
-            steps {
-                script {
-                    sh 'apt update; apt install jq=1.5+dfsg-2+b1 -y'
-                }
-            }
-            }
-        }
-}
-`
-                /* TODO: update CodeNarc or Groovy so that the good "after" can be uncommented !
-                after: `
-                pipeline {
-                    agent any
-                    stages {
-                        stage('Intall JQ') {
-                            steps {
-                                script {
-                                    sh 'apt update; apt install jq=1.5+dfsg-2+b1 -y'
-                                }
-                            }
-                        }
-                    }
-                }
-                ` */
-            }
-        ]
-    ]);
-}