Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stat Can Be Enum #13

Merged
merged 18 commits into from
Jul 21, 2024
Prev Previous commit
Next Next commit
tests for enums
cosmastech committed Jul 20, 2024

Verified

This commit was signed with the committer’s verified signature.
freya022 freya02
commit a07f9a793270f90f86f176dead97e12ae82ba4de
18 changes: 18 additions & 0 deletions tests/Adapters/InMemory/InMemoryGaugeTest.php
Original file line number Diff line number Diff line change
@@ -6,10 +6,13 @@
use Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord;
use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
use Cosmastech\StatsDClientAdapter\Tests\BaseTestCase;
use Cosmastech\StatsDClientAdapter\Tests\DataProviders\EnumProvider;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\ClockStub;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\TagNormalizerSpy;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;
use UnitEnum;

class InMemoryGaugeTest extends BaseTestCase
{
@@ -76,4 +79,19 @@ public function withDefaultTags_mergesTags(): void
$gaugeStat = $inMemoryClient->getStats()->getGauges()[0];
self::assertEqualsCanonicalizing(["hello" => "world", "abc" => 123], $gaugeStat->tags);
}

#[Test]
#[DataProviderExternal(EnumProvider::class, 'differentEnumTypesAndExpectedStringDataProvider')]
public function enumAsStat_recordsStatAsString(UnitEnum $case, string $converted): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->gauge($case, value: 12.4);

// Then
$gaugeRecord = $inMemoryClient->getStats()->getGauges()[0];
self::assertEqualsCanonicalizing($converted, $gaugeRecord->stat);
}
}
18 changes: 18 additions & 0 deletions tests/Adapters/InMemory/InMemoryHistogramTest.php
Original file line number Diff line number Diff line change
@@ -6,10 +6,13 @@
use Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord;
use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
use Cosmastech\StatsDClientAdapter\Tests\BaseTestCase;
use Cosmastech\StatsDClientAdapter\Tests\DataProviders\EnumProvider;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\ClockStub;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\TagNormalizerSpy;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;
use UnitEnum;

class InMemoryHistogramTest extends BaseTestCase
{
@@ -75,4 +78,19 @@ public function withDefaultTags_mergesTags(): void
$histogramStat = $inMemoryClient->getStats()->getHistograms()[0];
self::assertEqualsCanonicalizing(["hello" => "world", "abc" => 123], $histogramStat->tags);
}

#[Test]
#[DataProviderExternal(EnumProvider::class, 'differentEnumTypesAndExpectedStringDataProvider')]
public function enumAsStat_recordsStatAsString(UnitEnum $case, string $converted): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->histogram($case, value: 12.4);

// Then
$histogramRecord = $inMemoryClient->getStats()->getHistograms()[0];
self::assertEqualsCanonicalizing($converted, $histogramRecord->stat);
}
}
46 changes: 46 additions & 0 deletions tests/Adapters/InMemory/InMemoryIncrementTest.php
Original file line number Diff line number Diff line change
@@ -7,10 +7,16 @@
use Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord;
use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
use Cosmastech\StatsDClientAdapter\Tests\BaseTestCase;
use Cosmastech\StatsDClientAdapter\Tests\DataProviders\EnumProvider;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\ClockStub;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\TagNormalizerSpy;
use Cosmastech\StatsDClientAdapter\Tests\Enums\IntBackedEnum;
use Cosmastech\StatsDClientAdapter\Tests\Enums\PlainUnitEnum;
use Cosmastech\StatsDClientAdapter\Tests\Enums\StringBackedEnum;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;
use UnitEnum;

class InMemoryIncrementTest extends BaseTestCase
{
@@ -102,4 +108,44 @@ public function withDefaultTags_mergesTags(): void
$countStat = $inMemoryClient->getStats()->getCounts()[0];
self::assertEqualsCanonicalizing(["hello" => "world", "abc" => 123], $countStat->tags);
}

#[Test]
#[DataProviderExternal(EnumProvider::class, 'differentEnumTypesAndExpectedStringDataProvider')]
public function enumAsStat_recordsStatAsString(UnitEnum $case, string $converted): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->increment($case);

// Then
$countStat = $inMemoryClient->getStats()->getCounts()[0];
self::assertEqualsCanonicalizing($converted, $countStat->stat);
}

#[Test]
public function arrayOfEnumsAsStat_recordsStatsAsStrings(): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->increment([IntBackedEnum::TWO, StringBackedEnum::A, PlainUnitEnum::FIRST, "hello"], value: 1994);

// Then
self::assertCount(
4,
/** @var array<int, InMemoryCountRecord> $countStats */
$countStats = $inMemoryClient->getStats()->getCounts()
);
self::assertEquals("2", $countStats[0]->stat);
self::assertEquals(1994, $countStats[0]->count);
self::assertEquals("a", $countStats[1]->stat);
self::assertEquals(1994, $countStats[1]->count);
self::assertEquals("FIRST", $countStats[2]->stat);
self::assertEquals(1994, $countStats[2]->count);
self::assertEquals("hello", $countStats[3]->stat);
self::assertEquals(1994, $countStats[3]->count);
}
}
18 changes: 18 additions & 0 deletions tests/Adapters/InMemory/InMemorySetTest.php
Original file line number Diff line number Diff line change
@@ -6,10 +6,13 @@
use Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord;
use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
use Cosmastech\StatsDClientAdapter\Tests\BaseTestCase;
use Cosmastech\StatsDClientAdapter\Tests\DataProviders\EnumProvider;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\ClockStub;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\TagNormalizerSpy;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;
use UnitEnum;

class InMemorySetTest extends BaseTestCase
{
@@ -81,4 +84,19 @@ public function withDefaultTags_mergesTags(): void
$setStat = $inMemoryClient->getStats()->getSets()[0];
self::assertEqualsCanonicalizing(["hello" => "world", "abc" => 123], $setStat->tags);
}

#[Test]
#[DataProviderExternal(EnumProvider::class, 'differentEnumTypesAndExpectedStringDataProvider')]
public function enumAsStat_recordsStatAsString(UnitEnum $case, string $converted): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->set($case, 3);

// Then
$setRecord = $inMemoryClient->getStats()->getSets()[0];
self::assertEqualsCanonicalizing($converted, $setRecord->stat);
}
}
17 changes: 17 additions & 0 deletions tests/Adapters/InMemory/InMemoryTimingTest.php
Original file line number Diff line number Diff line change
@@ -6,9 +6,11 @@
use Cosmastech\StatsDClientAdapter\Adapters\InMemory\Models\InMemoryStatsRecord;
use Cosmastech\StatsDClientAdapter\TagNormalizers\NoopTagNormalizer;
use Cosmastech\StatsDClientAdapter\Tests\BaseTestCase;
use Cosmastech\StatsDClientAdapter\Tests\DataProviders\EnumProvider;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\ClockStub;
use Cosmastech\StatsDClientAdapter\Tests\Doubles\TagNormalizerSpy;
use DateTimeImmutable;
use PHPUnit\Framework\Attributes\DataProviderExternal;
use PHPUnit\Framework\Attributes\Test;

class InMemoryTimingTest extends BaseTestCase
@@ -102,4 +104,19 @@ public function time_storesDurationOfClosure(): void
$timingRecord = $inMemoryClient->getStats()->getTimings()[0];
self::assertEquals(1000, $timingRecord->durationMilliseconds);
}

#[Test]
#[DataProviderExternal(EnumProvider::class, 'differentEnumTypesAndExpectedStringDataProvider')]
public function enumAsStat_recordsStatAsString(\UnitEnum $case, string $converted): void
{
// Given
$inMemoryClient = new InMemoryClientAdapter();

// When
$inMemoryClient->time(fn () => "irrelevant", $case);

// Then
$countStat = $inMemoryClient->getStats()->getTimings()[0];
self::assertEqualsCanonicalizing($converted, $countStat->stat);
}
}