SwiftLint/Tests/BuiltInRulesTests/XCTSpecificMatcherRuleTests.swift

@testable import SwiftLintBuiltInRules
import TestHelpers
import XCTest

final class XCTSpecificMatcherRuleTests: SwiftLintTestCase {
    func testEqualTrue() {
        let example = Example("XCTAssertEqual(a, true)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertTrue' instead")
    }

    func testEqualFalse() {
        let example = Example("XCTAssertEqual(a, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertFalse' instead")
    }

    func testEqualNil() {
        let example = Example("XCTAssertEqual(a, nil)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNil' instead")
    }

    func testNotEqualTrue() {
        let example = Example("XCTAssertNotEqual(a, true)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertFalse' instead")
    }

    func testNotEqualFalse() {
        let example = Example("XCTAssertNotEqual(a, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertTrue' instead")
    }

    func testNotEqualNil() {
        let example = Example("XCTAssertNotEqual(a, nil)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotNil' instead")
    }

    // MARK: - Additional Tests

    func testEqualOptionalFalse() {
        let example = Example("XCTAssertEqual(a?.b, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 0)
    }

    func testEqualUnwrappedOptionalFalse() {
        let example = Example("XCTAssertEqual(a!.b, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertFalse' instead")
    }

    func testEqualNilNil() {
        let example = Example("XCTAssertEqual(nil, nil)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNil' instead")
    }

    func testEqualTrueTrue() {
        let example = Example("XCTAssertEqual(true, true)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertTrue' instead")
    }

    func testEqualFalseFalse() {
        let example = Example("XCTAssertEqual(false, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertFalse' instead")
    }

    func testNotEqualNilNil() {
        let example = Example("XCTAssertNotEqual(nil, nil)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotNil' instead")
    }

    func testNotEqualTrueTrue() {
        let example = Example("XCTAssertNotEqual(true, true)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertFalse' instead")
    }

    func testNotEqualFalseFalse() {
        let example = Example("XCTAssertNotEqual(false, false)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertTrue' instead")
    }

    func testAssertEqual() {
        let example = Example("XCTAssert(foo == bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertEqual' instead")
    }

    func testAssertFalseNotEqual() {
        let example = Example("XCTAssertFalse(bar != foo)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertEqual' instead")
    }

    func testAssertTrueEqual() {
        let example = Example("XCTAssertTrue(foo == 1)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertEqual' instead")
    }

    func testAssertNotEqual() {
        let example = Example("XCTAssert(foo != bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotEqual' instead")
    }

    func testAssertFalseEqual() {
        let example = Example("XCTAssertFalse(bar == foo)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotEqual' instead")
    }

    func testAssertTrueNotEqual() {
        let example = Example("XCTAssertTrue(foo != 1)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotEqual' instead")
    }

    func testMultipleComparisons() {
        let example = Example("XCTAssert(foo == (bar == baz))")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertEqual' instead")
    }

    func testEqualInCommentNotConsidered() {
        XCTAssert(noViolation(in: "XCTAssert(foo, \"a == b\")"))
    }

    func testEqualInFunctionCall() {
        XCTAssert(noViolation(in: "XCTAssert(foo(bar == baz))"))
        XCTAssert(noViolation(in: "XCTAssertTrue(foo(bar == baz), \"toto\")"))
    }

    // MARK: - Identity Operator Tests

    func testAssertIdentical() {
        let example = Example("XCTAssert(foo === bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertIdentical' instead")
    }

    func testAssertNotIdentical() {
        let example = Example("XCTAssert(foo !== bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotIdentical' instead")
    }

    func testAssertTrueIdentical() {
        let example = Example("XCTAssertTrue(foo === bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertIdentical' instead")
    }

    func testAssertTrueNotIdentical() {
        let example = Example("XCTAssertTrue(foo !== bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotIdentical' instead")
    }

    func testAssertFalseIdentical() {
        let example = Example("XCTAssertFalse(foo === bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertNotIdentical' instead")
    }

    func testAssertFalseNotIdentical() {
        let example = Example("XCTAssertFalse(foo !== bar)")
        let violations = violations(example)

        XCTAssertEqual(violations.count, 1)
        XCTAssertEqual(violations.first?.reason, "Prefer the specific matcher 'XCTAssertIdentical' instead")
    }

    private func violations(_ example: Example) -> [StyleViolation] {
        guard let config = makeConfig(nil, XCTSpecificMatcherRule.identifier) else { return [] }
        return TestHelpers.violations(example, config: config)
    }

    private func noViolation(in example: String) -> Bool {
        violations(Example(example)).isEmpty
    }
}