3
0
mirror of https://github.com/snipe/snipe-it.git synced 2026-08-18 11:15:42 +00:00
Files
snipe-it/tests/Unit/AssetModelTest.php
2026-07-14 12:13:30 +01:00

249 lines
8.9 KiB
PHP

<?php
namespace Tests\Unit;
use App\Models\Asset;
use App\Models\AssetModel;
use App\Models\Category;
use Illuminate\Support\Facades\DB;
use Tests\TestCase;
class AssetModelTest extends TestCase
{
public function test_an_asset_model_contains_assets()
{
$category = Category::factory()->create([
'category_type' => 'asset',
]);
$model = AssetModel::factory()->create([
'category_id' => $category->id,
]);
$asset = Asset::factory()->create([
'model_id' => $model->id,
]);
$this->assertEquals(1, $model->assets()->count());
}
public function test_percent_remaining_returns_zero_when_no_assets_are_available()
{
$model = new class extends AssetModel
{
public function availableAssets()
{
return new class
{
public function count()
{
return 0;
}
};
}
public function assets()
{
return new class
{
public function count()
{
return 10;
}
};
}
};
$this->assertEquals(0, $model->percentRemaining());
}
public function test_percent_remaining_returns_expected_ratio_for_mixed_availability()
{
$model = new class extends AssetModel
{
public function availableAssets()
{
return new class
{
public function count()
{
return 2;
}
};
}
public function assets()
{
return new class
{
public function count()
{
return 5;
}
};
}
};
$this->assertEquals(40.0, $model->percentRemaining());
}
public function test_percent_remaining_skips_queries_when_counts_were_eager_loaded(): void
{
// Api\AssetModelsController::index loads `remaining` and `assets_count`
// on every model via withCount. percentRemaining() must read those
// attributes instead of re-running the same counts — otherwise the
// transformer loop turns into per-model N+1 (visible as duplicated
// `count(*) … assets where model_id = ?` rows in /api/v1/models).
$category = Category::factory()->create(['category_type' => 'asset']);
$model = AssetModel::factory()->create(['category_id' => $category->id]);
Asset::factory()->count(4)->create(['model_id' => $model->id]);
// Simulate the withCount load by setting the raw attributes directly,
// matching exactly what Api\AssetModelsController::index does.
$model->forceFill(['remaining' => 3, 'assets_count' => 4]);
$queryCount = 0;
DB::listen(function () use (&$queryCount) {
$queryCount++;
});
$result = $model->percentRemaining();
$this->assertSame(0, $queryCount, 'No queries should fire when the counts were eager-loaded');
$this->assertSame(75.0, $result);
}
public function test_percent_remaining_only_calls_available_assets_count_once(): void
{
// Regression: the old implementation called $this->availableAssets()
// ->count() twice — once for the zero guard, once for the ratio.
// Under the API transformer loop in /api/v1/models that doubled the
// status-label pluck + count(*) queries for every row. Pin the
// single-call contract so a future cleanup doesn't reintroduce it.
$category = Category::factory()->create(['category_type' => 'asset']);
$model = AssetModel::factory()->create(['category_id' => $category->id]);
Asset::factory()->count(2)->create(['model_id' => $model->id]);
$availableCountQueries = 0;
DB::listen(function ($query) use (&$availableCountQueries, $model) {
// The availableAssets() relation generates a count(*) on assets
// filtered by model_id AND assigned_to IS NULL.
//
// Strip identifier quotes so the matcher works regardless of
// driver — sqlite emits `"assets"`, MySQL/MariaDB emits backticks.
// Without this normalization the test passes on the sqlite CI
// run and fails on the mysql one.
$normalized = str_replace(['`', '"'], '', $query->sql);
if (str_contains($normalized, 'count(*)')
&& str_contains($normalized, 'from assets')
&& str_contains($normalized, 'assigned_to is null')
&& in_array($model->id, $query->bindings, true)
) {
$availableCountQueries++;
}
});
$model->percentRemaining();
$this->assertSame(1, $availableCountQueries, 'availableAssets()->count() must be called exactly once per percentRemaining()');
}
public function test_percent_remaining_returns_one_hundred_when_all_assets_are_available()
{
$model = new class extends AssetModel
{
public function availableAssets()
{
return new class
{
public function count()
{
return 4;
}
};
}
public function assets()
{
return new class
{
public function count()
{
return 4;
}
};
}
};
$this->assertEquals(100.0, $model->percentRemaining());
}
public function test_percent_remaining_returns_zero_when_eager_loaded_total_is_zero_but_available_is_not(): void
{
// Regression for a production DivisionByZeroError at
// AssetModel::percentRemaining. In principle
// availableAssets ⊆ assets
// so `remaining > 0 && assets_count === 0` shouldn't happen, but a race
// between the two correlated withCount subqueries — or a data anomaly
// where an asset row is visible to one count but not the other — has
// produced exactly that shape in the wild. percentRemaining must
// absorb it, not throw.
$category = Category::factory()->create(['category_type' => 'asset']);
$model = AssetModel::factory()->create(['category_id' => $category->id]);
$model->forceFill(['remaining' => 3, 'assets_count' => 0]);
$this->assertSame(0, $model->percentRemaining());
}
public function test_percent_remaining_returns_zero_when_eager_loaded_counts_are_string_zero(): void
{
// PDO with MySQL/MariaDB in the default (emulated-prepares) mode
// returns COUNT() as PHP string, not int. Eloquent doesn't cast
// withCount aliases (no $casts entry for `remaining` / `assets_count`),
// so the value lands on the model as-is. A strict `=== 0` guard misses
// string "0" — and PHP 8's arithmetic operators auto-convert numeric
// strings, so the ratio below still throws DivisionByZeroError. The
// fix is to cast to int at read time before the guard fires.
//
// Real trace from the reporting production instance targeted the
// ratio line even with a === 0 guard sitting above it, which is only
// possible if $total was "0" (string), not 0 (int).
$category = Category::factory()->create(['category_type' => 'asset']);
$model = AssetModel::factory()->create(['category_id' => $category->id]);
$model->forceFill(['remaining' => '3', 'assets_count' => '0']);
$this->assertSame(0, $model->percentRemaining());
}
public function test_percent_remaining_returns_zero_when_runtime_total_is_zero_but_available_is_not(): void
{
// Same guard, exercised through the non-eager-loaded fallback path
// (Api\AssetModelsController::show and any callers that render a
// single model without the index endpoint's withCount).
$model = new class extends AssetModel
{
public function availableAssets()
{
return new class
{
public function count()
{
return 3;
}
};
}
public function assets()
{
return new class
{
public function count()
{
return 0;
}
};
}
};
$this->assertSame(0, $model->percentRemaining());
}
}