Moved Check results to check namespace

bastianschwarz · bastianschwarz · commit 55cefe954411 · 2023-04-23T11:36:18.000+02:00
diff --git a/packages/async/src/Check/ParallelCheck.php b/packages/async/src/Check/ParallelCheck.php
@@ -15,14 +15,14 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\async;
+namespace de\codenamephp\deploymentchecks\async\Check;
 
 use de\codenamephp\deploymentchecks\async\ErrorHandler\ErrorHandlerInterface;
 use de\codenamephp\deploymentchecks\async\ErrorHandler\RethrowException;
 use de\codenamephp\deploymentchecks\async\SuccessHandler\AddToResultCollection;
 use de\codenamephp\deploymentchecks\async\SuccessHandler\SuccessHandlerInterface;
 use de\codenamephp\deploymentchecks\base\Check\CheckInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 final readonly class ParallelCheck implements ParallelCheckInterface, WithErrorHandlerInterface {
 
diff --git a/packages/async/src/Check/ParallelCheckInterface.php b/packages/async/src/Check/ParallelCheckInterface.php
@@ -15,10 +15,10 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\async;
+namespace de\codenamephp\deploymentchecks\async\Check;
 
 use de\codenamephp\deploymentchecks\async\SuccessHandler\SuccessHandlerInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * Interface for checks that can be used in parallel using the async pool
diff --git a/packages/async/src/Check/WithErrorHandlerInterface.php b/packages/async/src/Check/WithErrorHandlerInterface.php
@@ -15,7 +15,7 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\async;
+namespace de\codenamephp\deploymentchecks\async\Check;
 
 use de\codenamephp\deploymentchecks\async\ErrorHandler\ErrorHandlerInterface;
 
diff --git a/packages/async/src/Collection/AsyncCheckCollection.php b/packages/async/src/Collection/AsyncCheckCollection.php
@@ -16,11 +16,13 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\async;
+namespace de\codenamephp\deploymentchecks\async\Collection;
 
+use de\codenamephp\deploymentchecks\async\Check\ParallelCheck;
+use de\codenamephp\deploymentchecks\async\Check\WithErrorHandlerInterface;
 use de\codenamephp\deploymentchecks\base\Check\CheckInterface;
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollection;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollection;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 use Spatie\Async\Pool;
 use Throwable;
 
diff --git a/packages/async/src/ErrorHandler/ErrorHandlerInterface.php b/packages/async/src/ErrorHandler/ErrorHandlerInterface.php
@@ -17,7 +17,7 @@
 
 namespace de\codenamephp\deploymentchecks\async\ErrorHandler;
 
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollectionInterface;
 use Throwable;
 
 /**
diff --git a/packages/async/src/ErrorHandler/RethrowException.php b/packages/async/src/ErrorHandler/RethrowException.php
@@ -17,7 +17,7 @@
 
 namespace de\codenamephp\deploymentchecks\async\ErrorHandler;
 
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollectionInterface;
 use Throwable;
 
 /**
diff --git a/packages/async/src/SuccessHandler/AddToResultCollection.php b/packages/async/src/SuccessHandler/AddToResultCollection.php
@@ -17,8 +17,8 @@
 
 namespace de\codenamephp\deploymentchecks\async\SuccessHandler;
 
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * Just adds the result to the collection
diff --git a/packages/async/src/SuccessHandler/SuccessHandlerInterface.php b/packages/async/src/SuccessHandler/SuccessHandlerInterface.php
@@ -17,8 +17,8 @@
 
 namespace de\codenamephp\deploymentchecks\async\SuccessHandler;
 
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollectionInterface;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollectionInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * Interface for parallel checks that want to define a custom success handler
diff --git a/packages/http/src/Check/HttpCheck.php b/packages/http/src/Check/HttpCheck.php
@@ -18,9 +18,9 @@
 namespace de\codenamephp\deploymentchecks\http\Check;
 
 use de\codenamephp\deploymentchecks\base\Check\CheckInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollection;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 use de\codenamephp\deploymentchecks\base\Check\WithNameInterface;
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollection;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
 use de\codenamephp\deploymentchecks\http\Check\Test\TestInterface;
 use GuzzleHttp\Client;
 use Psr\Http\Message\RequestInterface;
diff --git a/packages/http/src/Check/Test/BodyEquals.php b/packages/http/src/Check/Test/BodyEquals.php
@@ -17,15 +17,15 @@
 
 namespace de\codenamephp\deploymentchecks\http\Check\Test;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
-use de\codenamephp\deploymentchecks\http\Result\HttpResult;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\http\Check\Test\Result\HttpTestResult;
 use Psr\Http\Message\ResponseInterface;
 
 final class BodyEquals implements TestInterface {
 
   public function __construct(public readonly string $expectedResponseText) {}
 
   public function test(ResponseInterface $response) : ResultInterface {
-    return new HttpResult((string) $response->getBody() === $this->expectedResponseText, sprintf("Expected response text '%s' got '%s'", $this->expectedResponseText, $response->getBody()));
+    return new HttpTestResult((string) $response->getBody() === $this->expectedResponseText, sprintf("Expected response text '%s' got '%s'", $this->expectedResponseText, $response->getBody()));
   }
 }
diff --git a/packages/http/src/Check/Test/Result/HttpTestResult.php b/packages/http/src/Check/Test/Result/HttpTestResult.php
@@ -15,12 +15,12 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\http\Result;
+namespace de\codenamephp\deploymentchecks\http\Check\Test\Result;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
-use de\codenamephp\deploymentchecks\base\Result\WithMessageInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\WithMessageInterface;
 
-final readonly class HttpResult implements ResultInterface, WithMessageInterface {
+final readonly class HttpTestResult implements ResultInterface, WithMessageInterface {
 
   public function __construct(public bool $successful, public string $message) {}
 
diff --git a/packages/http/src/Check/Test/StatusCode.php b/packages/http/src/Check/Test/StatusCode.php
@@ -17,16 +17,16 @@
 
 namespace de\codenamephp\deploymentchecks\http\Check\Test;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
-use de\codenamephp\deploymentchecks\http\Result\HttpResult;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\http\Check\Test\Result\HttpTestResult;
 use Psr\Http\Message\ResponseInterface;
 
 final class StatusCode implements TestInterface {
 
   public function __construct(public readonly int $expectedResponseCode) {}
 
   public function test(ResponseInterface $response) : ResultInterface {
-    return new HttpResult(
+    return new HttpTestResult(
       $response->getStatusCode() === $this->expectedResponseCode,
       sprintf("Expected response code '%d' got '%d'", $this->expectedResponseCode, $response->getStatusCode()),
     );
diff --git a/packages/http/src/Check/Test/TestInterface.php b/packages/http/src/Check/Test/TestInterface.php
@@ -17,7 +17,7 @@
 
 namespace de\codenamephp\deploymentchecks\http\Check\Test;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
diff --git a/packages/test/src/test.php b/packages/test/src/test.php
@@ -16,7 +16,7 @@
  *  limitations under the License.
  */
 
-use de\codenamephp\deploymentchecks\async\AsyncCheckCollection;
+use de\codenamephp\deploymentchecks\async\Collection\AsyncCheckCollection;
 use de\codenamephp\deploymentchecks\http\Check\HttpCheck;
 use de\codenamephp\deploymentchecks\http\Check\Test\StatusCode;
 use GuzzleHttp\Psr7\Request;
diff --git a/src/Check/CheckInterface.php b/src/Check/CheckInterface.php
@@ -17,7 +17,7 @@
 
 namespace de\codenamephp\deploymentchecks\base\Check;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * Describes a single check that is run by the deployment checks and returns a result
diff --git a/src/Check/Result/Collection/ResultCollection.php b/src/Check/Result/Collection/ResultCollection.php
@@ -15,9 +15,9 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\Result\Collection;
+namespace de\codenamephp\deploymentchecks\base\Check\Result\Collection;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * A collection of results. Can be used to aggregate results from multiple checks, e.g. run multiple http checks and treat them as a group
diff --git a/src/Check/Result/Collection/ResultCollectionInterface.php b/src/Check/Result/Collection/ResultCollectionInterface.php
@@ -15,9 +15,9 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\Result\Collection;
+namespace de\codenamephp\deploymentchecks\base\Check\Result\Collection;
 
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 
 /**
  * A collection of results. Can be used to aggregate results from multiple checks, e.g. run multiple http checks and treat them as a group
diff --git a/src/Check/Result/ResultInterface.php b/src/Check/Result/ResultInterface.php
@@ -1,35 +1,35 @@
-<?php
-/*
- *  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\base\Result;
-
-/**
- * Interface for results of deployment checks
- *
- * @psalm-api
- */
-interface ResultInterface {
-
-  /**
-   * indicates a successful check. Ture if successful, false otherwise
-   *
-   * Basically a shortcut for getting the status from the exit code
-   *
-   * @return bool
-   */
-  public function successful() : bool;
+<?php
+/*
+ *  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\base\Check\Result;
+
+/**
+ * Interface for results of deployment checks
+ *
+ * @psalm-api
+ */
+interface ResultInterface {
+
+  /**
+   * indicates a successful check. Ture if successful, false otherwise
+   *
+   * Basically a shortcut for getting the status from the exit code
+   *
+   * @return bool
+   */
+  public function successful() : bool;
 }
diff --git a/src/Check/Result/WasSuccessful.php b/src/Check/Result/WasSuccessful.php
@@ -15,7 +15,7 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\Result;
+namespace de\codenamephp\deploymentchecks\base\Check\Result;
 
 /**
  * A single result of a check with just the success state as immutable property
diff --git a/src/Check/Result/WithExitCodeInterface.php b/src/Check/Result/WithExitCodeInterface.php
@@ -1,30 +1,30 @@
-<?php
-/*
- *  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\base\Result;
-
-use de\codenamephp\deploymentchecks\base\ExitCode\ExitCodeInterface;
-
-/**
- * Interface for results that have an exit code
- *
- * @psalm-api
- */
-interface WithExitCodeInterface extends ResultInterface {
-
-  public function exitCode() : ExitCodeInterface;
+<?php
+/*
+ *  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\base\Check\Result;
+
+use de\codenamephp\deploymentchecks\base\ExitCode\ExitCodeInterface;
+
+/**
+ * Interface for results that have an exit code
+ *
+ * @psalm-api
+ */
+interface WithExitCodeInterface extends ResultInterface {
+
+  public function exitCode() : ExitCodeInterface;
 }
diff --git a/src/Check/Result/WithMessageInterface.php b/src/Check/Result/WithMessageInterface.php
@@ -15,7 +15,7 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\Result;
+namespace de\codenamephp\deploymentchecks\base\Check\Result;
 
 /**
  * Interface for results that have a message, e.g. an error or additional information
diff --git a/src/Check/Result/WithNameInterface.php b/src/Check/Result/WithNameInterface.php
@@ -15,7 +15,7 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\Result;
+namespace de\codenamephp\deploymentchecks\base\Check\Result;
 
 /**
  * Interface for results that have a name, usually used together with \de\codenamephp\deploymentchecks\base\Check\WithNameInterface in order to output
diff --git a/test/Unit/Check/Result/Collection/ResultCollectionTest.php b/test/Unit/Check/Result/Collection/ResultCollectionTest.php
@@ -15,10 +15,10 @@
  *  limitations under the License.
  */
 
-namespace de\codenamephp\deploymentchecks\base\test\Unit\Result\Collection;
+namespace de\codenamephp\deploymentchecks\base\test\Unit\Check\Result\Collection;
 
-use de\codenamephp\deploymentchecks\base\Result\Collection\ResultCollection;
-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;
+use de\codenamephp\deploymentchecks\base\Check\Result\Collection\ResultCollection;
+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;
 use PHPUnit\Framework\TestCase;
 
 final class ResultCollectionTest extends TestCase {
diff --git a/test/Unit/Check/Result/WasSuccessfulTest.php b/test/Unit/Check/Result/WasSuccessfulTest.php

Original file line number	Diff line number	Diff line change
`@@ -17,15 +17,15 @@`
`17`	`17`
`18`	`18`	`namespace de\codenamephp\deploymentchecks\http\Check\Test;`
`19`	`19`
`20`		`-use de\codenamephp\deploymentchecks\base\Result\ResultInterface;`
`21`		`-use de\codenamephp\deploymentchecks\http\Result\HttpResult;`
	`20`	`+use de\codenamephp\deploymentchecks\base\Check\Result\ResultInterface;`
	`21`	`+use de\codenamephp\deploymentchecks\http\Check\Test\Result\HttpTestResult;`
`22`	`22`	`use Psr\Http\Message\ResponseInterface;`
`23`	`23`
`24`	`24`	`final class BodyEquals implements TestInterface {`
`25`	`25`
`26`	`26`	`public function __construct(public readonly string $expectedResponseText) {}`
`27`	`27`
`28`	`28`	`public function test(ResponseInterface $response) : ResultInterface {`
`29`		`- return new HttpResult((string) $response->getBody() === $this->expectedResponseText, sprintf("Expected response text '%s' got '%s'", $this->expectedResponseText, $response->getBody()));`
	`29`	`+ return new HttpTestResult((string) $response->getBody() === $this->expectedResponseText, sprintf("Expected response text '%s' got '%s'", $this->expectedResponseText, $response->getBody()));`
`30`	`30`	`}`
`31`	`31`	`}`