Created more tests

Bastian Schwarz · Bastian Schwarz · commit e78fca99bbab · 2023-05-13T12:13:27.000+02:00
Signed-off-by: Bastian Schwarz &lt;bastian@repareo.de&gt;
diff --git a/.gitattributes b/.gitattributes
@@ -14,4 +14,6 @@
 /phive.xml export-ignore
 /psalm.xml export-ignore
 
-*.php text=auto eol=lf
+*.php text=auto eol=lf
+*.sh text=auto eol=lf
+/run text=auto eol=lf
diff --git a/.idea/deploymentchecks.http.iml b/.idea/deploymentchecks.http.iml
diff --git a/.idea/php.xml b/.idea/php.xml
diff --git a/.idea/phpunit.xml b/.idea/phpunit.xml
diff --git a/composer.json b/composer.json
@@ -11,10 +11,12 @@
   ],
   "require": {
     "php": "^8.2",
+    "codenamephp/deploymentchecks.base": "*",
     "guzzlehttp/guzzle": "^7.5",
-    "psr/http-message": "1 - 2",
     "psr/http-client": "^1.0",
-    "codenamephp/deploymentchecks.base": "*"
+    "psr/http-message": "1 - 2",
+    "symfony/css-selector": "^6.2",
+    "symfony/dom-crawler": "^6.2"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,
diff --git a/run b/run
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+#
+#  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+
+docker compose exec -it -u application application bash -c "$*"
diff --git a/src/CssSelector/CssSelectorInterface.php b/src/CssSelector/CssSelectorInterface.php
@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\CssSelector;
+
+/**
+ * Interface to run a CSS selector and check if it exists
+ */
+interface CssSelectorInterface {
+
+  /**
+   * Runs the selector and returns true if it matches at least one element, false otherwise
+   *
+   * @param string $selector The selector to run
+   * @return bool True if the selector matches at least one element, false otherwise
+   */
+  public function exists(string $selector) : bool;
+}
diff --git a/src/CssSelector/Factory/FromResponse/CssSelectorFromResponseInterface.php b/src/CssSelector/Factory/FromResponse/CssSelectorFromResponseInterface.php
@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\CssSelector\Factory\FromResponse;
+
+use de\codenamephp\deploymentchecks\http\CssSelector\CssSelectorInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Interface to create a CssSelectorInterface from a http response
+ */
+interface CssSelectorFromResponseInterface {
+
+  /**
+   * Creates the selector from the response, e.g. by passing the body to a parser and creating the selector from that
+   *
+   * @param ResponseInterface $response The response to create the selector from
+   * @return CssSelectorInterface
+   */
+  public function build(ResponseInterface $response) : CssSelectorInterface;
+}
diff --git a/src/CssSelector/Factory/FromResponse/SymfonyAdapterFromResponseBody.php b/src/CssSelector/Factory/FromResponse/SymfonyAdapterFromResponseBody.php
@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\CssSelector\Factory\FromResponse;
+
+use de\codenamephp\deploymentchecks\http\CssSelector\CssSelectorInterface;
+use de\codenamephp\deploymentchecks\http\CssSelector\SymfonyDomCrawlerAdapter;
+use Psr\Http\Message\ResponseInterface;
+use Symfony\Component\DomCrawler\Crawler;
+
+/**
+ * Just uses the string of the response body to create a new Crawler to pass to a new SymfonyDomCrawlerAdapter
+ */
+final class SymfonyAdapterFromResponseBody implements CssSelectorFromResponseInterface {
+
+  public function build(ResponseInterface $response) : CssSelectorInterface {
+    return new SymfonyDomCrawlerAdapter(new Crawler($response->getBody()->__toString()));
+  }
+}
diff --git a/src/CssSelector/SymfonyDomCrawlerAdapter.php b/src/CssSelector/SymfonyDomCrawlerAdapter.php
@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\CssSelector;
+
+use Symfony\Component\DomCrawler\Crawler;
+
+/**
+ * Adapter for the Symfony DomCrawler to run a CSS selector and check if it exists
+ */
+final readonly class SymfonyDomCrawlerAdapter implements CssSelectorInterface {
+
+  public function __construct(public Crawler $crawler) {}
+
+  public function exists(string $selector) : bool {
+    return $this->crawler->filter($selector)->count() > 0;
+  }
+}
diff --git a/src/Test/CssSelectorExists.php b/src/Test/CssSelectorExists.php
@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\Test;
+
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\http\CssSelector\Factory\FromResponse\CssSelectorFromResponseInterface;
+use de\codenamephp\deploymentchecks\http\CssSelector\Factory\FromResponse\SymfonyAdapterFromResponseBody;
+use de\codenamephp\deploymentchecks\http\Test\Result\HttpTestResult;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Checks if a css selector exists in the response body
+ *
+ * @psalm-api
+ */
+final readonly class CssSelectorExists implements TestInterface {
+
+  public function __construct(
+    public string $selector,
+    public CssSelectorFromResponseInterface $cssSelectorFromResponseFactory = new SymfonyAdapterFromResponseBody(),
+  ) {}
+
+  public function test(ResponseInterface $response) : ResultInterface {
+    return new HttpTestResult(
+      $this->cssSelectorFromResponseFactory->build($response)->exists($this->selector),
+      "Expected to that selector '{$this->selector}' exists in the response body.",
+    );
+  }
+}
diff --git a/test/integration/RunTestsOnHttpResponseTest.php b/test/integration/RunTestsOnHttpResponseTest.php
@@ -21,6 +21,7 @@
 use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollection;
 use de\codenamephp\deploymentchecks\http\HttpCheckResult;
 use de\codenamephp\deploymentchecks\http\RunTestsOnHttpResponse;
+use de\codenamephp\deploymentchecks\http\Test\CssSelectorExists;
 use de\codenamephp\deploymentchecks\http\Test\Result\HttpTestResult;
 use de\codenamephp\deploymentchecks\http\Test\StatusCode;
 use de\codenamephp\deploymentchecks\http\testHelper\BaseUri;
@@ -34,6 +35,7 @@ public function testCanRunSuccessfulTest() : void {
       new Request('GET', new BaseUri() . '/test.html'),
       'Test',
       new StatusCode(200),
+      new CssSelectorExists('body > h1'),
     );
 
     $result = $check->run();
diff --git a/test/unit/CssSelector/Factory/FromResponse/SymfonyAdapterFromResponseBodyTest.php b/test/unit/CssSelector/Factory/FromResponse/SymfonyAdapterFromResponseBodyTest.php
@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\test\unit\CssSelector\Factory\FromResponse;
+
+use de\codenamephp\deploymentchecks\http\CssSelector\Factory\FromResponse\SymfonyAdapterFromResponseBody;
+use de\codenamephp\deploymentchecks\http\CssSelector\SymfonyDomCrawlerAdapter;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+use Symfony\Component\DomCrawler\Crawler;
+
+final class SymfonyAdapterFromResponseBodyTest extends TestCase {
+
+  public function testBuild() : void {
+    $body = $this->createMock(StreamInterface::class);
+    $body->method('__toString')->willReturn('<html lang=""><body><div>test</div></body></html>');
+
+    $response = $this->createMock(ResponseInterface::class);
+    $response->method('getBody')->willReturn($body);
+
+    self::assertEquals(new SymfonyDomCrawlerAdapter(new Crawler('<html lang=""><body><div>test</div></body></html>')), (new SymfonyAdapterFromResponseBody())->build($response));
+  }
+}
diff --git a/test/unit/CssSelector/SymfonyDomCrawlerAdapterTest.php b/test/unit/CssSelector/SymfonyDomCrawlerAdapterTest.php
@@ -0,0 +1,53 @@
+<?php declare(strict_types=1);
+/*
+ *  Copyright 2023 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+namespace de\codenamephp\deploymentchecks\http\test\unit\CssSelector;
+
+use de\codenamephp\deploymentchecks\http\CssSelector\SymfonyDomCrawlerAdapter;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DomCrawler\Crawler;
+
+final class SymfonyDomCrawlerAdapterTest extends TestCase {
+
+  public function testExists() : void {
+    $crawler = $this->createMock(Crawler::class);
+    $crawler->expects(self::once())->method('filter')->with('selector')->willReturnSelf();
+    $crawler->expects(self::once())->method('count')->willReturn(1);
+
+    $sut = new SymfonyDomCrawlerAdapter($crawler);
+
+    self::assertTrue($sut->exists('selector'));
+  }
+
+  public function testExists_canReturnFalse_for0() : void {
+    $crawler = $this->createMock(Crawler::class);
+    $crawler->expects(self::once())->method('filter')->with('selector')->willReturnSelf();
+    $crawler->expects(self::once())->method('count')->willReturn(0);
+
+    $sut = new SymfonyDomCrawlerAdapter($crawler);
+
+    self::assertFalse($sut->exists('selector'));
+  }
+
+  public function test__construct() : void {
+    $crawler = $this->createMock(Crawler::class);
+
+    $sut = new SymfonyDomCrawlerAdapter($crawler);
+
+    self::assertSame($crawler, $sut->crawler);
+  }
+}
diff --git a/test/unit/Test/CssSelectorExistsTest.php b/test/unit/Test/CssSelectorExistsTest.php
