SwiftLint/Tests/SwiftLintFrameworkTests/CommandTests.swift

import Foundation
import SourceKittenFramework
@testable import SwiftLintFramework
import XCTest

// swiftlint:disable type_body_length - Disable the rule and self-test commenting a command

private extension Command {
    init?(string: String) {
        let nsString = string.bridge()
        self.init(string: nsString, range: NSRange(location: 3, length: nsString.length - 4))
    }
}

class CommandTests: XCTestCase {
    // MARK: Command Creation

    func testNoCommandsInEmptyFile() {
        let file = SwiftLintFile(contents: "")
        XCTAssertEqual(file.commands(), [])
    }

    func testEmptyString() {
        XCTAssertNil(Command(string: "", range: NSRange(location: 0, length: 0)))
    }

    func testDisable() {
        let input = "// swiftlint:disable rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 29, modifier: nil)
        XCTAssertEqual(file.commands(), [expected])
        XCTAssertEqual(Command(string: input), expected)
    }

    func testDisablePrevious() {
        let input = "// swiftlint:disable:previous rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                               modifier: .previous)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testDisableThis() {
        let input = "// swiftlint:disable:this rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 34, modifier: .this)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testDisableNext() {
        let input = "// swiftlint:disable:next rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 34, modifier: .next)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testEnable() {
        let input = "// swiftlint:enable rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 28, modifier: nil)
        XCTAssertEqual(file.commands(), [expected])
        XCTAssertEqual(Command(string: input), expected)
    }

    func testEnablePrevious() {
        let input = "// swiftlint:enable:previous rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 37,
                               modifier: .previous)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testEnableThis() {
        let input = "// swiftlint:enable:this rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 33, modifier: .this)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testEnableNext() {
        let input = "// swiftlint:enable:next rule_id\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 33, modifier: .next)
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    func testTrailingCOmment() {
        let input = "// swiftlint:enable:next rule_id - Comment\n"
        let file = SwiftLintFile(contents: input)
        let expected = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 43, modifier: .next,
                               trailingComment: "Comment")
        XCTAssertEqual(file.commands(), expected.expand())
        XCTAssertEqual(Command(string: input), expected)
    }

    // MARK: Action

    func testActionInverse() {
        XCTAssertEqual(Command.Action.enable.inverse(), .disable)
        XCTAssertEqual(Command.Action.disable.inverse(), .enable)
    }

    // MARK: Command Expansion

    func testNoModifierCommandExpandsToItself() {
        do {
            let command = Command(action: .disable, ruleIdentifiers: ["rule_id"])
            XCTAssertEqual(command.expand(), [command])
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["rule_id"])
            XCTAssertEqual(command.expand(), [command])
        }
        do {
            let command = Command(action: .disable, ruleIdentifiers: ["1", "2"])
            XCTAssertEqual(command.expand(), [command])
        }
    }

    func testExpandPreviousCommand() {
        do {
            let command = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .previous)
            let expanded = [
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 0, character: nil),
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 0, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .previous)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 0, character: nil),
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 0, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 1, character: 38,
                                  modifier: .previous)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 0, character: nil),
                Command(action: .disable, ruleIdentifiers: ["1", "2"], line: 0, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
    }

    func testExpandThisCommand() {
        do {
            let command = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .this)
            let expanded = [
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: nil),
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .this)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: nil),
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 1, character: 38,
                                  modifier: .this)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 1, character: nil),
                Command(action: .disable, ruleIdentifiers: ["1", "2"], line: 1, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
    }

    func testExpandNextCommand() {
        do {
            let command = Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .next)
            let expanded = [
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 2, character: nil),
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 2, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 1, character: 38,
                                  modifier: .next)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["rule_id"], line: 2, character: nil),
                Command(action: .disable, ruleIdentifiers: ["rule_id"], line: 2, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
        do {
            let command = Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 1, character: 38,
                                  modifier: .next)
            let expanded = [
                Command(action: .enable, ruleIdentifiers: ["1", "2"], line: 2, character: nil),
                Command(action: .disable, ruleIdentifiers: ["1", "2"], line: 2, character: .max)
            ]
            XCTAssertEqual(command.expand(), expanded)
        }
    }

    // MARK: Superfluous Disable Command Detection

    func testSuperfluousDisableCommands() {
        XCTAssertEqual(
            violations("// swiftlint:disable nesting\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("// swiftlint:disable:next nesting\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123) // swiftlint:disable:this nesting\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
    }

    func testDisableAllOverridesSuperfluousDisableCommand() {
        XCTAssert(
            violations(
                "//swiftlint:disable all\n// swiftlint:disable nesting\nprint(123)\n"
            ).isEmpty
        )
        XCTAssert(
            violations(
                "//swiftlint:disable all\n// swiftlint:disable:next nesting\nprint(123)\n"
            ).isEmpty
        )
        XCTAssert(
            violations(
                "//swiftlint:disable all\n// swiftlint:disable:this nesting\nprint(123)\n"
            ).isEmpty
        )
        XCTAssert(
            violations(
                "//swiftlint:disable all\n// swiftlint:disable:previous nesting\nprint(123)\n"
            ).isEmpty
        )
    }

    func testSuperfluousDisableCommandsIgnoreDelimiter() {
        let longComment = "Comment with a large number of words that shouldn't register as superfluous"
        XCTAssertEqual(
            violations("// swiftlint:disable nesting - \(longComment)\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("// swiftlint:disable:next nesting - Comment\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123) // swiftlint:disable:this nesting - Comment\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting - Comment\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
    }

    func testInvalidDisableCommands() {
        XCTAssertEqual(
            violations("// swiftlint:disable nesting_foo\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("// swiftlint:disable:next nesting_foo\nprint(123)\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123) // swiftlint:disable:this nesting_foo\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )
        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting_foo\n")[0].ruleDescription.identifier,
            "superfluous_disable_command"
        )

        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting_foo \n").count,
            1
        )

        let multipleViolations = violations("// swiftlint:disable nesting this is a comment\n")
        XCTAssertEqual(multipleViolations.count, 5)
        XCTAssertTrue(multipleViolations.allSatisfy { $0.ruleDescription.identifier == "superfluous_disable_command" })

        let onlyNonExistentRulesViolations = violations("// swiftlint:disable this is a comment\n")
        XCTAssertEqual(onlyNonExistentRulesViolations.count, 4)
        XCTAssertTrue(onlyNonExistentRulesViolations.allSatisfy {
            $0.ruleDescription.identifier == "superfluous_disable_command"
        })

        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting_foo\n")[0].reason,
            "'nesting_foo' is not a valid SwiftLint rule. Please remove it from the disable command."
        )

        XCTAssertEqual(violations("/* swiftlint:disable nesting */\n").count, 1)
    }

    func testSuperfluousDisableCommandsDisabled() {
        XCTAssertEqual(
            violations("// swiftlint:disable superfluous_disable_command nesting\nprint(123)\n"),
            []
        )
        XCTAssertEqual(
            violations("// swiftlint:disable superfluous_disable_command\n" +
                       "// swiftlint:disable nesting\n" +
                       "print(123)\n"),
            []
        )
        XCTAssertEqual(
            violations("// swiftlint:disable:next superfluous_disable_command nesting\nprint(123)\n"),
            []
        )
        XCTAssertEqual(
            violations("print(123) // swiftlint:disable:this superfluous_disable_command nesting\n"),
            []
        )
        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous superfluous_disable_command nesting\n"),
            []
        )
    }

    func testSuperfluousDisableCommandsDisabledOnConfiguration() {
        let rulesMode = Configuration.RulesMode.default(disabled: ["superfluous_disable_command"], optIn: [])
        guard let configuration = Configuration(rulesMode: rulesMode) else {
            XCTFail("Failed to create configuration.")
            return
        }

        XCTAssertEqual(
            violations("// swiftlint:disable nesting\nprint(123)\n", config: configuration),
            []
        )
        XCTAssertEqual(
            violations("// swiftlint:disable:next nesting\nprint(123)\n", config: configuration),
            []
        )
        XCTAssertEqual(
            violations("print(123) // swiftlint:disable:this nesting\n", config: configuration),
            []
        )
        XCTAssertEqual(
            violations("print(123)\n// swiftlint:disable:previous nesting\n", config: configuration),
            []
        )
    }
}