Merge pull request #14438 from marcusmoore/chore/sc-25071

Removed the need to add `InteractsWithSettings` to each test case

tests/Feature/Api/Accessories/AccessoryCheckoutTest.php

@@ -7,13 +7,10 @@ use App\Models\Actionlog;
 use App\Models\User;
 use App\Notifications\CheckoutAccessoryNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AccessoryCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingOutAccessoryRequiresCorrectPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Assets/AssetCheckinTest.php

@@ -11,13 +11,10 @@ use App\Models\Statuslabel;
 use App\Models\User;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Event;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetCheckinTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingInAssetRequiresCorrectPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Assets/AssetIndexTest.php

@@ -6,13 +6,10 @@ use App\Models\Asset;
 use App\Models\Company;
 use App\Models\User;
 use Illuminate\Testing\Fluent\AssertableJson;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetIndexTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testAssetIndexReturnsExpectedAssets()
     {
         Asset::factory()->count(3)->create();

tests/Feature/Api/Assets/AssetStoreTest.php

@@ -9,15 +9,11 @@ use App\Models\Location;
 use App\Models\Statuslabel;
 use App\Models\Supplier;
 use App\Models\User;
-use Carbon\Carbon;
 use Illuminate\Testing\Fluent\AssertableJson;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetStoreTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testRequiresPermissionToCreateAsset()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Assets/AssetsForSelectListTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Assets;
 use App\Models\Asset;
 use App\Models\Company;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetsForSelectListTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testAssetsCanBeSearchedForByAssetTag()
     {
         Asset::factory()->create(['asset_tag' => '0001']);

tests/Feature/Api/Assets/RequestableAssetsTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Assets;
 use App\Models\Asset;
 use App\Models\Company;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class RequestableAssetsTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testViewingRequestableAssetsRequiresCorrectPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Components/ComponentIndexTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Components;
 use App\Models\Company;
 use App\Models\Component;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class ComponentIndexTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testComponentIndexAdheresToCompanyScoping()
     {
         [$companyA, $companyB] = Company::factory()->count(2)->create();

tests/Feature/Api/Consumables/ConsumableCheckoutTest.php

@@ -7,13 +7,10 @@ use App\Models\Consumable;
 use App\Models\User;
 use App\Notifications\CheckoutConsumableNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class ConsumableCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingOutConsumableRequiresCorrectPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Consumables/ConsumablesIndexTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Consumables;
 use App\Models\Company;
 use App\Models\Consumable;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class ConsumablesIndexTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testConsumableIndexAdheresToCompanyScoping()
     {
         [$companyA, $companyB] = Company::factory()->count(2)->create();

tests/Feature/Api/Departments/DepartmentIndexTest.php

@@ -5,15 +5,11 @@ namespace Tests\Feature\Api\Departments;
 use App\Models\Company;
 use App\Models\Department;
 use App\Models\User;
-use Illuminate\Routing\Route;
 use Illuminate\Testing\Fluent\AssertableJson;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class DepartmentIndexTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testViewingDepartmentIndexRequiresAuthentication()
     {
         $this->getJson(route('api.departments.index'))->assertRedirect();

tests/Feature/Api/Groups/GroupStoreTest.php

@@ -4,13 +4,10 @@ namespace Tests\Feature\Api\Groups;
 
 use App\Models\Group;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class GroupStoreTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testStoringGroupRequiresSuperAdminPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Licenses/LicensesIndexTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Licenses;
 use App\Models\Company;
 use App\Models\License;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class LicensesIndexTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testLicensesIndexAdheresToCompanyScoping()
     {
         [$companyA, $companyB] = Company::factory()->count(2)->create();

tests/Feature/Api/Locations/LocationsForSelectListTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Locations;
 use App\Models\Location;
 use App\Models\User;
 use Illuminate\Testing\Fluent\AssertableJson;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class LocationsForSelectListTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testGettingLocationListRequiresProperPermission()
     {
         $this->actingAsForApi(User::factory()->create())

tests/Feature/Api/Users/UpdateUserApiTest.php

@@ -3,13 +3,10 @@
 namespace Tests\Feature\Api\Users;
 
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class UpdateUserApiTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testApiUsersCanBeActivatedWithNumber()
     {
         $admin = User::factory()->superuser()->create();

tests/Feature/Api/Users/UsersForSelectListTest.php

@@ -6,13 +6,10 @@ use App\Models\Company;
 use App\Models\User;
 use Illuminate\Testing\Fluent\AssertableJson;
 use Laravel\Passport\Passport;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class UsersForSelectListTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testUsersAreReturned()
     {
         $users = User::factory()->superuser()->count(3)->create();

tests/Feature/Api/Users/UsersSearchTest.php

@@ -5,13 +5,10 @@ namespace Tests\Feature\Api\Users;
 use App\Models\Company;
 use App\Models\User;
 use Laravel\Passport\Passport;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class UsersSearchTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCanSearchByUserFirstAndLastName()
     {
         User::factory()->create(['first_name' => 'Luke', 'last_name' => 'Skywalker']);

tests/Feature/Api/Users/UsersUpdateTest.php

@@ -8,13 +8,10 @@ use App\Models\Group;
 use App\Models\Location;
 use App\Models\User;
 use Illuminate\Support\Facades\Hash;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class UsersUpdateTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCanUpdateUserViaPatch()
     {
         $admin = User::factory()->superuser()->create();

tests/Feature/Checkins/AccessoryCheckinTest.php

@@ -8,13 +8,10 @@ use App\Models\User;
 use App\Notifications\CheckinAccessoryNotification;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AccessoryCheckinTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingInAccessoryRequiresCorrectPermission()
     {
         $accessory = Accessory::factory()->checkedOutToUser()->create();

tests/Feature/Checkins/AssetCheckinTest.php

@@ -11,13 +11,10 @@ use App\Models\Statuslabel;
 use App\Models\User;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Event;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetCheckinTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingInAssetRequiresCorrectPermission()
     {
         $this->actingAs(User::factory()->create())

tests/Feature/CheckoutAcceptances/AccessoryAcceptanceTest.php

@@ -7,13 +7,10 @@ use App\Models\CheckoutAcceptance;
 use App\Notifications\AcceptanceAssetAcceptedNotification;
 use App\Notifications\AcceptanceAssetDeclinedNotification;
 use Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AccessoryAcceptanceTest extends TestCase
 {
-    use InteractsWithSettings;
-
     /**
      * This can be absorbed into a bigger test
      */

tests/Feature/Checkouts/AccessoryCheckoutTest.php

@@ -7,13 +7,10 @@ use App\Models\Actionlog;
 use App\Models\User;
 use App\Notifications\CheckoutAccessoryNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AccessoryCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingOutAccessoryRequiresCorrectPermission()
     {
         $this->actingAs(User::factory()->create())

tests/Feature/Checkouts/ConsumableCheckoutTest.php

@@ -7,13 +7,10 @@ use App\Models\Consumable;
 use App\Models\User;
 use App\Notifications\CheckoutConsumableNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class ConsumableCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testCheckingOutConsumableRequiresCorrectPermission()
     {
         $this->actingAs(User::factory()->create())

tests/Feature/Checkouts/LicenseCheckoutTest.php

@@ -6,13 +6,10 @@ use App\Models\Asset;
 use App\Models\License;
 use App\Models\LicenseSeat;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class LicenseCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testNotesAreStoredInActionLogOnCheckoutToAsset()
     {
         $admin = User::factory()->superuser()->create();

tests/Feature/DashboardTest.php

@@ -3,13 +3,10 @@
 namespace Tests\Feature;
 
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class DashboardTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testUsersWithoutAdminAccessAreRedirected()
     {
         $this->actingAs(User::factory()->create())

tests/Feature/Notifications/Email/EmailNotificationsUponCheckinTest.php

@@ -7,7 +7,6 @@ use App\Models\Asset;
 use App\Models\User;
 use App\Notifications\CheckinAssetNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 /**
@@ -15,8 +14,6 @@ use Tests\TestCase;
  */
 class EmailNotificationsUponCheckinTest extends TestCase
 {
-    use InteractsWithSettings;
-
     protected function setUp(): void
     {
         parent::setUp();

tests/Feature/Notifications/Webhooks/SlackNotificationsUponCheckinTest.php

@@ -14,7 +14,6 @@ use App\Notifications\CheckinAssetNotification;
 use App\Notifications\CheckinLicenseSeatNotification;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 /**
@@ -22,8 +21,6 @@ use Tests\TestCase;
  */
 class SlackNotificationsUponCheckinTest extends TestCase
 {
-    use InteractsWithSettings;
-
     protected function setUp(): void
     {
         parent::setUp();

tests/Feature/Notifications/Webhooks/SlackNotificationsUponCheckoutTest.php

@@ -16,7 +16,6 @@ use App\Notifications\CheckoutConsumableNotification;
 use App\Notifications\CheckoutLicenseSeatNotification;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 /**
@@ -24,8 +23,6 @@ use Tests\TestCase;
  */
 class SlackNotificationsUponCheckoutTest extends TestCase
 {
-    use InteractsWithSettings;
-
     protected function setUp(): void
     {
         parent::setUp();

tests/Feature/Reports/CustomReportTest.php

@@ -8,14 +8,10 @@ use App\Models\User;
 use Illuminate\Testing\TestResponse;
 use League\Csv\Reader;
 use PHPUnit\Framework\Assert;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
-
 class CustomReportTest extends TestCase
 {
-    use InteractsWithSettings;
-
     protected function setUp(): void
     {
         parent::setUp();

tests/Feature/Users/UpdateUserTest.php

@@ -3,13 +3,10 @@
 namespace Tests\Feature\Users;
 
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class UpdateUserTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testUsersCanBeActivatedWithNumber()
     {
         $admin = User::factory()->superuser()->create();

tests/Support/InitializesSettings.php

@@ -4,7 +4,7 @@ namespace Tests\Support;
 
 use App\Models\Setting;
 
-trait InteractsWithSettings
+trait InitializesSettings
 {
     protected Settings $settings;
 

tests/TestCase.php

@@ -9,7 +9,7 @@ use RuntimeException;
 use Tests\Support\AssertsAgainstSlackNotifications;
 use Tests\Support\CustomTestMacros;
 use Tests\Support\InteractsWithAuthentication;
-use Tests\Support\InteractsWithSettings;
+use Tests\Support\InitializesSettings;
 
 abstract class TestCase extends BaseTestCase
 {
@@ -17,6 +17,7 @@ abstract class TestCase extends BaseTestCase
     use CreatesApplication;
     use CustomTestMacros;
     use InteractsWithAuthentication;
+    use InitializesSettings;
     use LazilyRefreshDatabase;
 
     private array $globallyDisabledMiddleware = [
@@ -25,20 +26,23 @@ abstract class TestCase extends BaseTestCase
 
     protected function setUp(): void
     {
-        if (!file_exists(realpath(__DIR__ . '/../') . '/.env.testing')) {
-            throw new RuntimeException(
-                '.env.testing file does not exist. Aborting to avoid wiping your local database'
-            );
-        }
+        $this->guardAgainstMissingEnv();
 
         parent::setUp();
 
+        $this->registerCustomMacros();
+
         $this->withoutMiddleware($this->globallyDisabledMiddleware);
 
-        if (collect(class_uses_recursive($this))->contains(InteractsWithSettings::class)) {
-            $this->initializeSettings();
-        }
+        $this->initializeSettings();
+    }
 
-        $this->registerCustomMacros();
+    private function guardAgainstMissingEnv(): void
+    {
+        if (!file_exists(realpath(__DIR__ . '/../') . '/.env.testing')) {
+            throw new RuntimeException(
+                '.env.testing file does not exist. Aborting to avoid wiping your local database.'
+            );
+        }
     }
 }

tests/Unit/AssetMaintenanceTest.php

@@ -2,14 +2,10 @@
 namespace Tests\Unit;
 
 use App\Models\AssetMaintenance;
-use Carbon\Carbon;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetMaintenanceTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testZerosOutWarrantyIfBlank()
     {
         $c = new AssetMaintenance;

tests/Unit/AssetModelTest.php

@@ -4,13 +4,10 @@ namespace Tests\Unit;
 use App\Models\Asset;
 use App\Models\Category;
 use App\Models\AssetModel;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetModelTest extends TestCase
 {
-    use InteractsWithSettings;
-    
     public function testAnAssetModelContainsAssets()
     {
         $category = Category::factory()->create([

tests/Unit/AssetTest.php

@@ -5,13 +5,10 @@ use App\Models\Asset;
 use App\Models\AssetModel;
 use App\Models\Category;
 use Carbon\Carbon;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class AssetTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testAutoIncrement()
     {
         $this->settings->enableAutoIncrement();

tests/Unit/CategoryTest.php

@@ -4,13 +4,10 @@ namespace Tests\Unit;
 use App\Models\Category;
 use App\Models\AssetModel;
 use App\Models\Asset;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class CategoryTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testFailsEmptyValidation()
     {
         // An Asset requires a name, a qty, and a category_id.

tests/Unit/CompanyScopingTest.php

@@ -12,13 +12,10 @@ use App\Models\License;
 use App\Models\LicenseSeat;
 use App\Models\User;
 use Illuminate\Database\Eloquent\Model;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class CompanyScopingTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function models(): array
     {
         return [

tests/Unit/ComponentTest.php

@@ -5,13 +5,10 @@ use App\Models\Category;
 use App\Models\Company;
 use App\Models\Component;
 use App\Models\Location;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class ComponentTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testAComponentBelongsToACompany()
     {
         $component = Component::factory()

tests/Unit/DepreciationTest.php

@@ -5,13 +5,10 @@ use App\Models\Depreciation;
 use App\Models\Category;
 use App\Models\License;
 use App\Models\AssetModel;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class DepreciationTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testADepreciationHasModels()
     {
         $depreciation = Depreciation::factory()->create();

tests/Unit/LdapTest.php

@@ -3,8 +3,6 @@
 namespace Tests\Unit;
 
 use App\Models\Ldap;
-use Exception;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 /**
@@ -12,7 +10,6 @@ use Tests\TestCase;
  */
 class LdapTest extends TestCase
 {
-    use InteractsWithSettings;
     use \phpmock\phpunit\PHPMock;
 
     public function testConnect()

tests/Unit/Models/Company/GetIdForCurrentUserTest.php

@@ -4,13 +4,10 @@ namespace Tests\Unit\Models\Company;
 
 use App\Models\Company;
 use App\Models\User;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class GetIdForCurrentUserTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testReturnsProvidedValueWhenFullCompanySupportDisabled()
     {
         $this->settings->disableMultipleFullCompanySupport();

tests/Unit/NotificationTest.php

@@ -8,13 +8,10 @@ use App\Models\Category;
 use Carbon\Carbon;
 use App\Notifications\CheckoutAssetNotification;
 use Illuminate\Support\Facades\Notification;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class NotificationTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testAUserIsEmailedIfTheyCheckoutAnAssetWithEULA()
     {
         $admin = User::factory()->superuser()->create();

tests/Unit/SnipeModelTest.php

@@ -2,13 +2,10 @@
 namespace Tests\Unit;
 
 use App\Models\SnipeModel;
-use Tests\Support\InteractsWithSettings;
 use Tests\TestCase;
 
 class SnipeModelTest extends TestCase
 {
-    use InteractsWithSettings;
-
     public function testSetsPurchaseDatesAppropriately()
     {
         $c = new SnipeModel;