👌 Snake case for tests

PHP Monitor.xcodeproj/xcshareddata/xcschemes/PHP Monitor DEV.xcscheme

@@ -80,7 +80,7 @@
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--configuration:/tmp/pmc_working.json"
-            isEnabled = "NO">
+            isEnabled = "YES">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--configuration:/tmp/pmc_broken.json"

tests/ui/StartupTest.swift

@@ -16,7 +16,7 @@ final class StartupTest: UITestCase {
 
     override func tearDownWithError() throws {}
 
-    final func testApplicationCanLaunchWithTestConfigurationAndThrowsAlert() throws {
+    final func test_launch_halts_due_to_system_configuration_issue() throws {
         var configuration = TestableConfigurations.working
         configuration.filesystem["/opt/homebrew/bin/php"] = nil // PHP binary must be missing
 
@@ -48,7 +48,7 @@ final class StartupTest: UITestCase {
         app.terminate()
     }
 
-    final func testApplicationCanWarnAboutPhpFpmIssue() throws {
+    final func test_get_warning_about_missing_fpm_symlink() throws {
         var configuration = TestableConfigurations.working
         configuration.filesystem["/opt/homebrew/etc/php/8.1/php-fpm.d/valet-fpm.conf"] = nil
 
@@ -60,7 +60,7 @@ final class StartupTest: UITestCase {
         click(app.buttons["generic.ok".localized])
     }
 
-    final func testPhpMonitorLaunchesCorrectlyAndIdles() throws {
+    final func test_can_open_status_menu_item() throws {
         let app = XCPMApplication()
         app.withConfiguration(TestableConfigurations.working)
         app.launch()

tests/unit/Commands/CommandTest.swift

@@ -10,7 +10,7 @@ import XCTest
 
 class CommandTest: XCTestCase {
 
-    func testDeterminePhpVersion() {
+    func test_determine_php_version() {
         let version = Command.execute(
             path: Paths.php,
             arguments: ["-v"],

tests/unit/Parsers/HomebrewPackageTest.swift

@@ -17,7 +17,7 @@ class HomebrewPackageTest: XCTestCase {
             .url(forResource: "brew-formula", withExtension: "json")!
     }
 
-    func testCanLoadExtensionJson() throws {
+    func test_can_load_extension_json() throws {
         let json = try! String(contentsOf: Self.jsonBrewFile, encoding: .utf8)
         let package = try! JSONDecoder().decode(
             [HomebrewPackage].self, from: json.data(using: .utf8)!
@@ -36,7 +36,7 @@ class HomebrewPackageTest: XCTestCase {
             .url(forResource: "brew-services", withExtension: "json")!
     }
 
-    func testCanParseServicesJson() throws {
+    func test_can_parse_services_json() throws {
         let json = try! String(contentsOf: Self.jsonBrewServicesFile, encoding: .utf8)
         let services = try! JSONDecoder().decode(
             [HomebrewService].self, from: json.data(using: .utf8)!
@@ -49,11 +49,12 @@ class HomebrewPackageTest: XCTestCase {
 
     // - MARK: LIVE TESTS
 
+    /// TODO: Use fake data or make this an integration test
     /// This test requires that you have a valid Homebrew installation set up,
     /// and requires the Valet services to be installed: php, nginx and dnsmasq.
     /// If this test fails, there is an issue with your Homebrew installation
     /// or the JSON API of the Homebrew output may have changed.
-    func testCanParseServicesJsonFromCliOutput() async throws {
+    func test_can_parse_services_json_from_cli_output() async throws {
         ActiveShell.useSystem()
 
         let services = try! JSONDecoder().decode(
@@ -71,11 +72,12 @@ class HomebrewPackageTest: XCTestCase {
         XCTAssertEqual(services.count, 3)
     }
 
+    /// TODO: Use fake data or make this an integration test
     /// This test requires that you have a valid Homebrew installation set up,
     /// and requires the `php` formula to be installed.
     /// If this test fails, there is an issue with your Homebrew installation
     /// or the JSON API of the Homebrew output may have changed.
-    func testCanLoadExtensionJsonFromCliOutput() async throws {
+    func test_can_load_extension_json_from_cli_output() async throws {
         ActiveShell.useSystem()
 
         let package = try! JSONDecoder().decode(

tests/unit/Parsers/NginxConfigurationTest.swift

@@ -34,7 +34,7 @@ class NginxConfigurationTest: XCTestCase {
 
     // MARK: - Tests
 
-    func testCanDetermineSiteNameAndTld() throws {
+    func test_can_determine_site_name_and_tld() throws {
         XCTAssertEqual(
             "nginx-site",
             NginxConfigurationFile.from(filePath: NginxConfigurationTest.regularUrl.path)?.domain
@@ -45,7 +45,7 @@ class NginxConfigurationTest: XCTestCase {
         )
     }
 
-    func testCanDetermineIsolation() throws {
+    func test_can_determine_isolation() throws {
         XCTAssertNil(
             NginxConfigurationFile.from(filePath: NginxConfigurationTest.regularUrl.path)?.isolatedVersion
         )
@@ -56,7 +56,7 @@ class NginxConfigurationTest: XCTestCase {
         )
     }
 
-    func testCanDetermineProxy() throws {
+    func test_can_determine_proxy() throws {
         let proxied = NginxConfigurationFile.from(filePath: NginxConfigurationTest.proxyUrl.path)!
         XCTAssertTrue(proxied.contents.contains("# valet stub: proxy.valet.conf"))
         XCTAssertEqual("http://127.0.0.1:90", proxied.proxy)
@@ -66,13 +66,13 @@ class NginxConfigurationTest: XCTestCase {
         XCTAssertEqual(nil, normal.proxy)
     }
 
-    func testCanDetermineSecuredProxy() throws {
+    func test_can_determine_secured_proxy() throws {
         let proxied = NginxConfigurationFile.from(filePath: NginxConfigurationTest.secureProxyUrl.path)!
         XCTAssertTrue(proxied.contents.contains("# valet stub: secure.proxy.valet.conf"))
         XCTAssertEqual("http://127.0.0.1:90", proxied.proxy)
     }
 
-    func testCanDetermineProxyWithCustomTld() throws {
+    func test_can_determine_proxy_with_custom_tld() throws {
         let proxied = NginxConfigurationFile.from(filePath: NginxConfigurationTest.customTldProxyUrl.path)!
         XCTAssertTrue(proxied.contents.contains("# valet stub: secure.proxy.valet.conf"))
         XCTAssertEqual("http://localhost:8080", proxied.proxy)

tests/unit/Parsers/PhpConfigurationTest.swift

@@ -14,7 +14,7 @@ class PhpConfigurationTest: XCTestCase {
         return Bundle(for: Self.self).url(forResource: "php", withExtension: "ini")!
     }
 
-    func testCanLoadExtension() throws {
+    func test_can_load_extension() throws {
         let iniFile = PhpConfigurationFile.from(filePath: Self.phpIniFileUrl.path)!
 
         XCTAssertNotNil(iniFile)
@@ -22,7 +22,7 @@ class PhpConfigurationTest: XCTestCase {
         XCTAssertGreaterThan(iniFile.extensions.count, 0)
     }
 
-    func testCanCheckKeyExistence() throws {
+    func test_can_check_key_existence() throws {
         let iniFile = PhpConfigurationFile.from(filePath: Self.phpIniFileUrl.path)!
 
         XCTAssertTrue(iniFile.has(key: "error_reporting"))
@@ -30,7 +30,7 @@ class PhpConfigurationTest: XCTestCase {
         XCTAssertFalse(iniFile.has(key: "my_unknown_key"))
     }
 
-    func testCanCheckKeyValue() throws {
+    func test_can_check_key_value() throws {
         let iniFile = PhpConfigurationFile.from(filePath: Self.phpIniFileUrl.path)!
 
         XCTAssertNotNil(iniFile.get(for: "error_reporting"))
@@ -40,7 +40,7 @@ class PhpConfigurationTest: XCTestCase {
         XCTAssert(iniFile.get(for: "display_errors") == "On")
     }
 
-    func testCanCustomizeConfigurationValue() throws {
+    func test_can_customize_configuration_value() throws {
         let destination = Utility
             .copyToTemporaryFile(resourceName: "php", fileExtension: "ini")!
 

tests/unit/Parsers/PhpExtensionTest.swift

@@ -14,13 +14,13 @@ class PhpExtensionTest: XCTestCase {
         return Bundle(for: Self.self).url(forResource: "php", withExtension: "ini")!
     }
 
-    func testCanLoadExtension() throws {
+    func test_can_load_extension() throws {
         let extensions = PhpExtension.from(filePath: Self.phpIniFileUrl.path)
 
         XCTAssertGreaterThan(extensions.count, 0)
     }
 
-    func testExtensionNameIsCorrect() throws {
+    func test_extension_name_is_correct() throws {
         let extensions = PhpExtension.from(filePath: Self.phpIniFileUrl.path)
 
         let extensionNames = extensions.map { (ext) -> String in
@@ -39,7 +39,7 @@ class PhpExtensionTest: XCTestCase {
         XCTAssertFalse(extensionNames.contains("nice"))
     }
 
-    func testExtensionStatusIsCorrect() throws {
+    func test_extension_status_is_correct() throws {
         let extensions = PhpExtension.from(filePath: Self.phpIniFileUrl.path)
 
         // xdebug should be enabled
@@ -49,7 +49,7 @@ class PhpExtensionTest: XCTestCase {
         XCTAssertEqual(extensions[1].enabled, false)
     }
 
-    func testToggleWorksAsExpected() async throws {
+    func test_toggle_works_as_expected() async throws {
         let destination = Utility.copyToTemporaryFile(resourceName: "php", fileExtension: "ini")!
         let extensions = PhpExtension.from(filePath: destination.path)
         XCTAssertEqual(extensions.count, 6)

tests/unit/Parsers/ValetConfigurationTest.swift

@@ -17,7 +17,7 @@ class ValetConfigurationTest: XCTestCase {
         )!
     }
 
-    func testCanLoadConfigFile() throws {
+    func test_can_load_config_file() throws {
         let json = try? String(
             contentsOf: Self.jsonConfigFileUrl,
             encoding: .utf8

tests/unit/Testables/TestableConfigurationTest.swift

@@ -12,8 +12,9 @@ class TestableConfigurationTest: XCTestCase {
     func test_configuration_can_be_saved_as_json() async {
         var configuration = TestableConfigurations.working
         configuration.filesystem["/opt/homebrew/bin/php"] = nil
-        print(configuration.filesystem.keys)
+
         let json = configuration.toJson()
+
         try! json.write(toFile: "/tmp/pmc_working.json", atomically: true, encoding: .utf8)
         try! json.write(toFile: "/tmp/pmc_broken.json", atomically: true, encoding: .utf8)
     }

tests/unit/Versions/AppUpdaterCheckTest.swift

@@ -10,7 +10,7 @@ import XCTest
 
 class AppUpdaterCheckTest: XCTestCase {
 
-    func testCanRetrieveVersionFromCask() async {
+    func test_can_retrieve_version_from_cask() async {
         let caskVersion = await AppUpdateChecker.retrieveVersionFromCask()
 
         let version = VersionExtractor.from(caskVersion)
@@ -18,21 +18,21 @@ class AppUpdaterCheckTest: XCTestCase {
         XCTAssertNotNil(version)
     }
 
-    func testTaggedReleaseOmitsZeroPatch() {
+    func test_tagged_release_omits_zero_patch() {
         let version = AppVersion.from("3.5.0_333")!
 
         XCTAssertEqual(version.tagged, "3.5")
         XCTAssertEqual(version.version, "3.5.0")
     }
 
-    func testTaggedReleaseDoesntOmitNonZeroPatch() {
+    func test_tagged_release_doesnt_omit_non_zero_patch() {
         let version = AppVersion.from("3.5.1_333")!
 
         XCTAssertEqual(version.tagged, "3.5.1")
         XCTAssertEqual(version.version, "3.5.1")
     }
 
-    func testTagTruncationDoesntAffectMajorVersions() {
+    func test_tag_truncation_does_not_affect_major_versions() {
         var version = AppVersion.from("5.0_333")!
 
         XCTAssertEqual(version.tagged, "5.0")

tests/unit/Versions/AppVersionTest.swift

@@ -10,11 +10,11 @@ import XCTest
 
 class AppVersionTest: XCTestCase {
 
-    func testCanRetrieveInternalAppVersion() {
+    func test_can_retrieve_internal_app_version() {
         XCTAssertNotNil(AppVersion.fromCurrentVersion())
     }
 
-    func testCanParseNormalVersionString() {
+    func test_can_parse_normal_version_string() {
         let version = AppVersion.from("1.0.0")
 
         XCTAssertNotNil(version)
@@ -23,7 +23,7 @@ class AppVersionTest: XCTestCase {
         XCTAssertEqual(nil, version?.suffix)
     }
 
-    func testCanParseCaskVersionString() {
+    func test_can_parse_cask_version_string() {
         let version = AppVersion.from("1.0.0_600")
 
         XCTAssertNotNil(version)
@@ -32,7 +32,7 @@ class AppVersionTest: XCTestCase {
         XCTAssertEqual(nil, version?.suffix)
     }
 
-    func testCanParseDevVersionStringWithoutBuildNumber() {
+    func test_can_parse_dev_version_string_without_build_number() {
         let version = AppVersion.from("1.0.0-dev")
 
         XCTAssertNotNil(version)
@@ -41,7 +41,7 @@ class AppVersionTest: XCTestCase {
         XCTAssertEqual("dev", version?.suffix)
     }
 
-    func testCanParseDevVersionStringWithBuildNumber() {
+    func test_can_parse_dev_version_string_with_build_number() {
         let version = AppVersion.from("1.0.0-dev,870")
 
         XCTAssertNotNil(version)
@@ -50,7 +50,7 @@ class AppVersionTest: XCTestCase {
         XCTAssertEqual("dev", version?.suffix)
     }
 
-    func testCanParseUnderscoresAsBuildSeparatorToo() {
+    func test_can_parse_underscores_as_build_separator() {
         let version = AppVersion.from("1.0.0-dev_870")
 
         XCTAssertNotNil(version)

tests/unit/Versions/PhpVersionDetectionTest.swift

@@ -10,7 +10,7 @@ import XCTest
 
 class PhpVersionDetectionTest: XCTestCase {
 
-    func testCanDetectValidPhpVersions() async throws {
+    func test_can_detect_valid_php_versions() async throws {
         let outcome = await PhpEnv.shared.extractPhpVersions(from: [
             "", // empty lines should be omitted
             "php@8.0",

tests/unit/Versions/PhpVersionNumberTest.swift

@@ -11,7 +11,7 @@ import XCTest
 // swiftlint:disable type_body_length
 class PhpVersionNumberTest: XCTestCase {
 
-    func testCanDeconstructPhpVersion() throws {
+    func test_can_deconstruct_php_version() throws {
         XCTAssertEqual(
             try! PhpVersionNumber.parse("PHP 8.2.0-dev"),
             PhpVersionNumber(major: 8, minor: 2, patch: 0)
@@ -38,13 +38,13 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testPhpVersionNumberParse() throws {
+    func test_php_version_number_parse() throws {
         XCTAssertThrowsError(try PhpVersionNumber.parse("OOF")) { error in
             XCTAssertTrue(error is VersionParseError)
         }
     }
 
-    func testCanCheckFixedConstraints() throws {
+    func test_can_check_fixed_constraints() throws {
         XCTAssertEqual(
             PhpVersionNumberCollection
                 .make(from: ["7.4", "7.3", "7.2", "7.1", "7.0"])
@@ -78,7 +78,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckCaretConstraints() throws {
+    func test_can_check_caret_constraints() throws {
         // 1. Imprecise checks
         XCTAssertEqual(
             PhpVersionNumberCollection
@@ -138,7 +138,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckTildeConstraints() throws {
+    func test_can_check_tilde_constraints() throws {
         // 1. Imprecise checks
         XCTAssertEqual(
             PhpVersionNumberCollection
@@ -207,7 +207,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckGreaterThanOrEqualConstraints() throws {
+    func test_can_check_greater_than_or_equal_constraints() throws {
         XCTAssertEqual(
             PhpVersionNumberCollection
                 .make(from: ["7.4", "7.3", "7.2", "7.1", "7.0"])
@@ -243,7 +243,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckGreaterThanConstraints() throws {
+    func test_can_check_greater_than_constraints() throws {
         XCTAssertEqual(
             PhpVersionNumberCollection
                 .make(from: ["7.4", "7.3", "7.2", "7.1", "7.0"])
@@ -289,7 +289,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckLessThanOrEqualConstraints() throws {
+    func test_can_check_less_than_or_equal_constraints() throws {
         XCTAssertEqual(
             PhpVersionNumberCollection
                 .make(from: ["7.4", "7.3", "7.2", "7.1", "7.0"])
@@ -325,7 +325,7 @@ class PhpVersionNumberTest: XCTestCase {
         )
     }
 
-    func testCanCheckLessThanConstraints() throws {
+    func test_can_check_less_than_constraints() throws {
         XCTAssertEqual(
             PhpVersionNumberCollection
                 .make(from: ["7.4", "7.3", "7.2", "7.1", "7.0"])

tests/unit/Versions/ValetVersionExtractorTest.swift

@@ -10,7 +10,7 @@ import XCTest
 
 class ValetVersionExtractorTest: XCTestCase {
 
-    func testDetermineValetVersion() async {
+    func test_can_determine_valet_version() async {
         let version = await valet("--version", sudo: false)
         XCTAssert(version.contains("Laravel Valet 2") || version.contains("Laravel Valet 3"))
     }

tests/unit/Versions/VersionExtractorTest.swift

@@ -10,12 +10,12 @@ import XCTest
 
 class VersionExtractorTest: XCTestCase {
 
-    func testExtractVersion() {
+    func test_extract_version() {
         XCTAssertEqual(VersionExtractor.from("Laravel Valet 2.17.1"), "2.17.1")
         XCTAssertEqual(VersionExtractor.from("Laravel Valet 2.0"), "2.0")
     }
 
-    func testVersionComparison() {
+    func test_version_comparison() {
         XCTAssertEqual("2.0".versionCompare("2.1"), .orderedAscending)
         XCTAssertEqual("2.1".versionCompare("2.0"), .orderedDescending)
         XCTAssertEqual("2.0".versionCompare("2.0"), .orderedSame)