From befc1683c2e8e9cfa9db0924099f114c12aa872e Mon Sep 17 00:00:00 2001 From: Zan Baldwin Date: Fri, 7 Jun 2024 12:10:21 +0200 Subject: [PATCH] Initial Commit Split from original project, `darsyn/ip`. Co-authored-by: Anthony --- .gitattributes | 4 + .github/workflows/static-analysis.yaml | 32 +++++ .github/workflows/testing.yaml | 59 ++++++++ .gitignore | 4 + CODE_OF_CONDUCT.md | 132 ++++++++++++++++++ LICENSE.md | 21 +++ README.md | 36 +++++ composer.json | 46 +++++++ phpstan.neon | 13 ++ src/AbstractType.php | 151 ++++++++++++++++++++ src/IPv4Type.php | 29 ++++ src/IPv6Type.php | 27 ++++ src/MultiType.php | 27 ++++ tests/IPv4TypeTest.php | 183 +++++++++++++++++++++++++ tests/IPv6TypeTest.php | 183 +++++++++++++++++++++++++ tests/MultiTypeTest.php | 183 +++++++++++++++++++++++++ tests/TestPlatform.php | 13 ++ tests/bootstrap.php | 10 ++ 18 files changed, 1153 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/workflows/static-analysis.yaml create mode 100644 .github/workflows/testing.yaml create mode 100644 .gitignore create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpstan.neon create mode 100644 src/AbstractType.php create mode 100644 src/IPv4Type.php create mode 100644 src/IPv6Type.php create mode 100644 src/MultiType.php create mode 100644 tests/IPv4TypeTest.php create mode 100644 tests/IPv6TypeTest.php create mode 100644 tests/MultiTypeTest.php create mode 100644 tests/TestPlatform.php create mode 100644 tests/bootstrap.php diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6d083de --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +* text=auto + +/.github/ export-ignore +/tests/ export-ignore diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml new file mode 100644 index 0000000..518cce5 --- /dev/null +++ b/.github/workflows/static-analysis.yaml @@ -0,0 +1,32 @@ +name: "Static Analysis" + +on: + pull_request: + branches: + - 'develop' + push: + branches: + - 'develop' + - 'main' + +jobs: + + phpstan: + runs-on: 'ubuntu-22.04' + strategy: + matrix: + php: + - '8.3' + steps: + - uses: 'actions/checkout@v2' + - uses: 'shivammathur/setup-php@v2' + with: + php-version: '${{ matrix.php }}' + - uses: 'ramsey/composer-install@v2' + with: + dependency-versions: 'highest' + # Require PHPStan via command-line instead of adding to Composer's + # "require-dev"; we only want to run static analysis once on the highest + # version of PHP available. + - run: 'composer require --dev phpstan/phpstan phpstan/phpstan-deprecation-rules' + - run: './vendor/bin/phpstan analyze --no-progress --error-format="github"' diff --git a/.github/workflows/testing.yaml b/.github/workflows/testing.yaml new file mode 100644 index 0000000..d875a6f --- /dev/null +++ b/.github/workflows/testing.yaml @@ -0,0 +1,59 @@ +name: "Linting and Unit Tests" + +on: + pull_request: + branches: + - 'develop' + push: + branches: + - 'develop' + - 'main' + +jobs: + + syntax-linting: + runs-on: 'ubuntu-20.04' + strategy: + matrix: + php: + - '5.6' + - '7.0' + - '7.1' + - '7.2' + - '7.3' + - '7.4' + - '8.0' + - '8.1' + - '8.2' + - '8.3' + steps: + - uses: 'actions/checkout@v2' + - uses: 'shivammathur/setup-php@v2' + with: + php-version: '${{ matrix.php }}' + - run: 'find src/ -type f -name "*.php" -print0 | xargs -0 -n1 -P4 php -l -n | (! grep -v "No syntax errors detected" )' + + unit-testing: + runs-on: 'ubuntu-20.04' + strategy: + matrix: + php: + - '5.6' + - '7.0' + - '7.1' + - '7.2' + - '7.3' + - '7.4' + - '8.0' + - '8.1' + - '8.2' + - '8.3' + steps: + - uses: 'actions/checkout@v2' + - uses: 'shivammathur/setup-php@v2' + with: + php-version: '${{ matrix.php }}' + - uses: 'ramsey/composer-install@v2' + with: + dependency-versions: 'highest' + - run: './vendor/bin/phpunit --bootstrap="tests/bootstrap.php" --test-suffix="Test.php" tests' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0684a12 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/.idea/ +/vendor/ +# Because this library will never be the root package, don't commit Composer's lock file. +/composer.lock diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ec1bbcb --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +`hello@zanbaldwin.com`. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..06c30b5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The [MIT License](http://j.mp/mit-license) +========================================== + +Copyright (c) 2015 [Zan Baldwin](https://github.com/zanbaldwin) + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..16b28e8 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +This library provides Doctrine types for [`darsyn/ip`][ip]. + +# Documentation + +Please refer to the [`darsyn/ip`][ip] project for complete documentation. + +## Compatibility + +This library has extensive test coverage using PHPUnit on PHP versions: `5.6`, +`7.0`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`, `8.2`, and `8.3`. + +Static analysis is performed with PHPStan at `max` level on PHP `8.3`, using +core, bleeding edge, and deprecation rules. + +The Doctrine features are compatible with Doctrine DBAL `^2.3 || ^3.0`. Types +are provided for `Ipv4`, `IPv6`, and `Multi` IP types from the parent +[`darsyn/ip`][ip] project. + +## Code of Conduct + +This project includes and adheres to the [Contributor Covenant as a Code of +Conduct](CODE_OF_CONDUCT.md). + +# License + +Please see the [separate licence file](LICENSE.md) included in this repository +for a full copy of the MIT licence, which this project is licensed under. + +# Authors + +- [Zan Baldwin](https://zanbaldwin.com) + +If you make a contribution (submit a pull request), don't forget to add your +name here! + +[ip]: https://packagist.org/packages/darsyn/ip diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..da3dff7 --- /dev/null +++ b/composer.json @@ -0,0 +1,46 @@ +{ + "name": "darsyn/ip-doctrine", + "description": "Doctrine types for darsyn/ip", + "license": "MIT", + "keywords": ["doctrine", "ip"], + "type": "library", + "homepage": "https://github.com/darsyn/ip-doctrine", + "authors": [ + { + "name": "Zan Baldwin", + "email": "hello@zanbaldwin.com", + "homepage": "https://zanbaldwin.com" + } + ], + "autoload": { + "psr-4": { + "Darsyn\\IP\\Doctrine\\": "src/" + } + }, + "require": { + "php": ">=5.6", + "ext-pdo": "*", + "darsyn/ip": "^5.0", + "doctrine/dbal": "^2.3 || ^3" + }, + "autoload-dev": { + "psr-4": { + "Darsyn\\IP\\Tests\\Doctrine\\": "tests/" + } + }, + "require-dev": { + "phpstan/phpstan": "^1.11", + "phpstan/phpstan-deprecation-rules": "^1.2", + "phpunit/phpunit": "*" + }, + "conflict": { + "doctrine/dbal": ">=4" + }, + "prefer-stable": true, + "config": { + "sort-packages": true + }, + "suggest": { + "doctrine/dbal": "to use IP as a column type" + } +} diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..3c2830b --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,13 @@ +parameters: + level: 'max' + paths: [ 'src', 'tests' ] + checkFunctionNameCase: true + checkGenericClassInNonGenericObjectType: true + reportUnmatchedIgnoredErrors: true + treatPhpDocTypesAsCertain: false + parallel: + maximumNumberOfProcesses: 4 + +includes: + - 'vendor/phpstan/phpstan-deprecation-rules/rules.neon' + - 'vendor/phpstan/phpstan/conf/bleedingEdge.neon' diff --git a/src/AbstractType.php b/src/AbstractType.php new file mode 100644 index 0000000..90b89e9 --- /dev/null +++ b/src/AbstractType.php @@ -0,0 +1,151 @@ +getBinaryTypeDeclarationSQL(['length' => static::IP_LENGTH]); + } + + /** + * {@inheritdoc} + * @throws \Doctrine\DBAL\Types\ConversionException + * @return \Darsyn\IP\IpInterface|null + */ + public function convertToPHPValue($value, AbstractPlatform $platform) + { + /** @var string|resource|\Darsyn\IP\IpInterface|null $value */ + // PostgreSQL will return the binary data as a resource instead of a string (like MySQL). + if (\is_resource($value)) { + if (\get_resource_type($value) !== 'stream' || false === $value = \stream_get_contents($value)) { + throw new ConversionException(sprintf( + 'Could not convert database value to Doctrine Type "%s" (could not convert non-stream resource to a string).', + self::NAME + )); + } + } + /** @var string|\Darsyn\IP\IpInterface|null $value */ + if (empty($value)) { + return null; + } + if (\is_object($value) && \is_a($value, $this->getIpClass(), false)) { + /** @var \Darsyn\IP\IpInterface $value */ + return $value; + } + try { + return $this->createIpObject($value); + } catch (IpException $e) { + throw ConversionException::conversionFailed($value, static::NAME); + } + } + + /** + * {@inheritdoc} + * @throws \Doctrine\DBAL\Types\ConversionException + * @return string|null + */ + public function convertToDatabaseValue($value, AbstractPlatform $platform) + { + if (empty($value)) { + return null; + } + if (\is_string($value)) { + try { + $value = $this->createIpObject($value); + } catch (IpException $e) { + throw new ConversionException(sprintf( + 'Could not convert PHP value "%s" to valid IP address ready for database insertion.', + (string) $value + ), 0, $e); + } + } + + if (!\is_object($value)) { + throw new ConversionException(sprintf( + 'Could not convert PHP value of type "%s" to valid IP address ready for database insertion.', + gettype($value) + )); + } + + if (!\is_a($value, IpInterface::class, false)) { + throw new ConversionException(sprintf( + 'Could not convert PHP object "%s" to a valid IP instance ready for database insertion.', + \get_class($value) + )); + } + + if (static::IP_LENGTH !== $valueLength = MbString::getLength($value->getBinary())) { + throw new ConversionException(sprintf( + 'Cannot fit IPv%d address (%d bytes) into database column (%d bytes). Reconfigure Doctrine types to use a different IP class.', + $value->getVersion(), + $valueLength, + static::IP_LENGTH + )); + } + + return $value->getBinary(); + } + + /** + * {@inheritdoc} + * @return string + */ + public function getName() + { + return self::NAME; + } + + /** + * {@inheritdoc} + * @return int + */ + public function getBindingType() + { + return \PDO::PARAM_LOB; + } + + /** + * {@inheritdoc} + * @return bool + */ + public function requiresSQLCommentHint(AbstractPlatform $platform) + { + return true; + } +} diff --git a/src/IPv4Type.php b/src/IPv4Type.php new file mode 100644 index 0000000..a93b121 --- /dev/null +++ b/src/IPv4Type.php @@ -0,0 +1,29 @@ +markTestSkipped('Skipping test that requires "doctrine/dbal".'); + } + + $this->platform = new TestPlatform; + $type = Type::getType('ipv4'); + $this->assertInstanceOf(IPv4Type::class, $type); + $this->type = $type; + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToDatabaseValue() + { + $ip = IP::factory('12.34.56.78'); + + $expected = $ip->getBinary(); + $actual = $this->type->convertToDatabaseValue($ip, $this->platform); + + $this->assertEquals($expected, $actual); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForDatabaseValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToDatabaseValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForDatabaseValue() + { + $this->assertNull($this->type->convertToDatabaseValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip->getBinary(), $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('12.34.56.78', $dbIp->getDotAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpObjectConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertSame($ip, $dbIp); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testStreamConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + $stream = fopen('php://memory','r+'); + // assertIsResource() isn't available for PHP 5.6 and 7.0 (PHPUnit < 7.0). + $this->assertTrue(is_resource($stream)); + fwrite($stream, $ip->getBinary()); + rewind($stream); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($stream, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('12.34.56.78', $dbIp->getDotAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForPHPValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToPHPValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForPHPValue() + { + $this->assertNull($this->type->convertToPHPValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testGetBinaryTypeDeclarationSQL() + { + $this->assertEquals('DUMMYBINARY()', $this->type->getSQLDeclaration(['length' => 4], $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testBindingTypeIsAValidPDOTypeConstant() + { + // Get all constants of the PDO class. + $constants = (new \ReflectionClass(PDO::class))->getConstants(); + // Now filter out any constants that don't begin with "PARAM_". + $paramConstants = array_intersect_key( + $constants, + array_flip(array_filter(array_keys($constants), function ($key) { + return strpos($key, 'PARAM_') === 0; + })) + ); + // Check that the return value of the Type's binding value is a valid + // PDO PARAM constant. + $this->assertContains($this->type->getBindingType(), $paramConstants); + } +} diff --git a/tests/IPv6TypeTest.php b/tests/IPv6TypeTest.php new file mode 100644 index 0000000..9c4f85b --- /dev/null +++ b/tests/IPv6TypeTest.php @@ -0,0 +1,183 @@ +markTestSkipped('Skipping test that requires "doctrine/dbal".'); + } + + $this->platform = new TestPlatform; + $type = Type::getType('ipv6'); + $this->assertInstanceOf(IPv6Type::class, $type); + $this->type = $type; + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToDatabaseValue() + { + $ip = IP::factory('::1'); + + $expected = $ip->getBinary(); + $actual = $this->type->convertToDatabaseValue($ip, $this->platform); + + $this->assertEquals($expected, $actual); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForDatabaseValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToDatabaseValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForDatabaseValue() + { + $this->assertNull($this->type->convertToDatabaseValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToPHPValue() + { + $ip = IP::factory('::1'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip->getBinary(), $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('::1', $dbIp->getCompactedAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpObjectConvertsToPHPValue() + { + $ip = IP::factory('::1'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertSame($ip, $dbIp); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testStreamConvertsToPHPValue() + { + $ip = IP::factory('::1'); + $stream = fopen('php://memory','r+'); + // assertIsResource() isn't available for PHP 5.6 and 7.0 (PHPUnit < 7.0). + $this->assertTrue(is_resource($stream)); + fwrite($stream, $ip->getBinary()); + rewind($stream); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($stream, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('::1', $dbIp->getCompactedAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForPHPValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToPHPValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForPHPValue() + { + $this->assertNull($this->type->convertToPHPValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testGetBinaryTypeDeclarationSQL() + { + $this->assertEquals('DUMMYBINARY()', $this->type->getSQLDeclaration(['length' => 16], $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testBindingTypeIsAValidPDOTypeConstant() + { + // Get all constants of the PDO class. + $constants = (new \ReflectionClass(PDO::class))->getConstants(); + // Now filter out any constants that don't begin with "PARAM_". + $paramConstants = array_intersect_key( + $constants, + array_flip(array_filter(array_keys($constants), function ($key) { + return strpos($key, 'PARAM_') === 0; + })) + ); + // Check that the return value of the Type's binding value is a valid + // PDO PARAM constant. + $this->assertContains($this->type->getBindingType(), $paramConstants); + } +} diff --git a/tests/MultiTypeTest.php b/tests/MultiTypeTest.php new file mode 100644 index 0000000..81bf5c0 --- /dev/null +++ b/tests/MultiTypeTest.php @@ -0,0 +1,183 @@ +markTestSkipped('Skipping test that requires "doctrine/dbal".'); + } + + $this->platform = new TestPlatform; + $type = Type::getType('ip_multi'); + $this->assertInstanceOf(MultiType::class, $type); + $this->type = $type; + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToDatabaseValue() + { + $ip = IP::factory('12.34.56.78'); + + $expected = $ip->getBinary(); + $actual = $this->type->convertToDatabaseValue($ip, $this->platform); + + $this->assertEquals($expected, $actual); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForDatabaseValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToDatabaseValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForDatabaseValue() + { + $this->assertNull($this->type->convertToDatabaseValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip->getBinary(), $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('12.34.56.78', $dbIp->getDotAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testIpObjectConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($ip, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertSame($ip, $dbIp); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testStreamConvertsToPHPValue() + { + $ip = IP::factory('12.34.56.78'); + $stream = fopen('php://memory','r+'); + // assertIsResource() isn't available for PHP 5.6 and 7.0 (PHPUnit < 7.0). + $this->assertTrue(is_resource($stream)); + fwrite($stream, $ip->getBinary()); + rewind($stream); + /** @var IP $dbIp */ + $dbIp = $this->type->convertToPHPValue($stream, $this->platform); + $this->assertInstanceOf(IP::class, $dbIp); + $this->assertEquals('12.34.56.78', $dbIp->getDotAddress()); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testInvalidIpConversionForPHPValue() + { + $this->expectException(\Doctrine\DBAL\Types\ConversionException::class); + $this->type->convertToPHPValue('abcdefg', $this->platform); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testNullConversionForPHPValue() + { + $this->assertNull($this->type->convertToPHPValue(null, $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testGetBinaryTypeDeclarationSQL() + { + $this->assertEquals('DUMMYBINARY()', $this->type->getSQLDeclaration(['length' => 16], $this->platform)); + } + + /** + * @test + * @return void + */ + #[PHPUnit\Test] + public function testBindingTypeIsAValidPDOTypeConstant() + { + // Get all constants of the PDO class. + $constants = (new \ReflectionClass(PDO::class))->getConstants(); + // Now filter out any constants that don't begin with "PARAM_". + $paramConstants = array_intersect_key( + $constants, + array_flip(array_filter(array_keys($constants), function ($key) { + return strpos($key, 'PARAM_') === 0; + })) + ); + // Check that the return value of the Type's binding value is a valid + // PDO PARAM constant. + $this->assertContains($this->type->getBindingType(), $paramConstants); + } +} diff --git a/tests/TestPlatform.php b/tests/TestPlatform.php new file mode 100644 index 0000000..11da815 --- /dev/null +++ b/tests/TestPlatform.php @@ -0,0 +1,13 @@ +