Merge pull request #224 from elecena/use/httpbin

httpbin: use a local instance for tests and in CI
elecena · Apr 18, 2023 · 212b68d · 212b68d
2 parents 0004dd4 + 3215dc0
commit 212b68d
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 24 deletions.
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -32,6 +32,13 @@ jobs:
         - "3306:3306"
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
 
+      # https://github.com/postmanlabs/httpbin
+      # https://httpbin.org/
+      httpbin:
+        image: kennethreitz/httpbin
+        ports:
+        - "5555:80"
+
     steps:
     - name: Checkout
       uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -7,7 +7,8 @@ nano
 ## Testing
 
 ```
-docker run -d -p 6379:6379 redis:5.0.9-alpine redis-server --requirepass qwerty --port 6379
+docker run -d -p 6379:6379 --name redis-test redis:5.0.9-alpine redis-server --requirepass qwerty --port 6379
+docker run -d -p 5555:80 --name httpin kennethreitz/httpbin
 composer run test
 ```
 

diff --git a/classes/NanoBaseTest.class.php b/classes/NanoBaseTest.class.php
@@ -15,6 +15,9 @@ class NanoBaseTest extends TestCase
     /* @var $app \NanoApp */
     protected $app;
 
+    /* @see https://github.com/postmanlabs/httpbin */
+    const HTTPBIN_HOST = 'http://0.0.0.0:5555';
+
     protected function setUp(): void
     {
         // use the current working directory where "./composer.phar test" is run

diff --git a/classes/utils/HttpClient.class.php b/classes/utils/HttpClient.class.php
@@ -123,7 +123,7 @@ public function setProxy(string $proxy, int $type = CURLPROXY_HTTP)
     /**
      * Set user agent identification used by HTTP client
      */
-    public function setUserAgent(string $userAgent)
+    public function setUserAgent(string $userAgent): void
     {
         $this->userAgent = $userAgent;
 
@@ -143,7 +143,7 @@ public function getUserAgent()
     /**
      * Set request headers
      */
-    public function setRequestHeader(string $header, string $value)
+    public function setRequestHeader(string $header, string $value): void
     {
         $this->reqHeaders[] = "$header: $value";
 
@@ -153,7 +153,7 @@ public function setRequestHeader(string $header, string $value)
     /**
      * Set timeout for a single request
      */
-    public function setTimeout(int $timeout)
+    public function setTimeout(int $timeout): void
     {
         $this->timeout = $timeout;
 
@@ -163,7 +163,7 @@ public function setTimeout(int $timeout)
     /**
      * Use given cookie jar file
      */
-    public function useCookieJar(string $jarFile)
+    public function useCookieJar(string $jarFile): void
     {
         $this->logger->debug(__METHOD__, ['jar' => $jarFile]);
 
@@ -176,7 +176,7 @@ public function useCookieJar(string $jarFile)
     /**
      * Manually sets request cookie
      */
-    public function setCookie(string $name, string $value)
+    public function setCookie(string $name, string $value): void
     {
         $this->cookies[$name] = $value;
 

diff --git a/tests/HttpClientTest.php b/tests/HttpClientTest.php
@@ -37,20 +37,19 @@ public function testCookiesJar()
         $client->setCookie('another-one', 'tasty');
 
         // set a cookie via HTTP response header
-        $resp = $client->get('https://httpbin.org/cookies/set', ['cookie' => 'yummy']);
+        $resp = $client->get(self::HTTPBIN_HOST . '/cookies/set/the_cookie/is_yummy');
         $this->assertEquals(200, $resp->getResponseCode());
-        $this->assertStringContainsString('cookie=yummy', $resp->getHeader('set-cookie'), 'Cookie is set');
 
         // check cookies
         $this->assertFileExists($this->jarFile, 'Jar file is created');
 
         // are cookies kept within the session?
-        $resp = $client->get('https://httpbin.org/cookies');
+        $resp = $client->get(self::HTTPBIN_HOST . '/cookies');
 
         $body = json_decode($resp->getContent(), true);
         $this->assertCount(2, $body['cookies'], 'Two cookies are set');
         $this->assertEquals('tasty', $body['cookies']['another-one']);
-        $this->assertEquals('yummy', $body['cookies']['cookie']);
+        $this->assertEquals('is_yummy', $body['cookies']['the_cookie']);
 
         // close HTTP session
         $client->close();

diff --git a/tests/HttpTest.php b/tests/HttpTest.php
@@ -18,14 +18,12 @@ class HttpTest extends NanoBaseTest
      */
     public function testGet()
     {
-        $url = 'https://httpbin.org/get';
+        $url = self::HTTPBIN_HOST . '/get';
 
         $resp = Http::get($url);
 
         $this->assertEquals(200, $resp->getResponseCode());
         $this->assertEquals($url, $resp->getLocation());
-        $this->assertEquals('application/json', $resp->getHeader('content-type'));
-        $this->assertNull($resp->getHeader('Content-Type'), 'Headers are case sensitive!');
 
         $json = json_decode($resp->getContent(), true);
         $this->assertEquals($url, $json['url']);
@@ -42,7 +40,7 @@ public function testGet()
      */
     public function testGetWithParams()
     {
-        $url = 'https://httpbin.org/get';
+        $url = self::HTTPBIN_HOST . '/get';
 
         $resp = Http::get($url, ['foo' => 42]);
         $this->assertEquals(200, $resp->getResponseCode());
@@ -56,11 +54,10 @@ public function testGetWithParams()
      */
     public function testPost()
     {
-        $resp = Http::post('https://httpbin.org/post', ['foo' => 'bar']);
+        $resp = Http::post(self::HTTPBIN_HOST . '/post', ['foo' => 'bar']);
 
         $this->assertEquals(200, $resp->getResponseCode());
-        $this->assertEquals('https://httpbin.org/post', $resp->getLocation());
-        $this->assertEquals('application/json', $resp->getHeader('content-type'));
+        $this->assertEquals(self::HTTPBIN_HOST . '/post', $resp->getLocation());
 
         $json = json_decode($resp->getContent(), true);
         $this->assertEquals(['foo' => 'bar'], $json['form']);
@@ -72,7 +69,7 @@ public function testPost()
      */
     public function testHead()
     {
-        $resp = Http::head('https://httpbin.org');
+        $resp = Http::head(self::HTTPBIN_HOST);
         $this->assertEquals(200, $resp->getResponseCode());
         $this->assertEquals('', $resp->getContent(), 'No content is returned');
     }
@@ -91,7 +88,7 @@ public function testFailingRequest()
      */
     public function testResponseWithCode(int $responseCode)
     {
-        $resp = Http::head("https://httpbin.org/status/${responseCode}");
+        $resp = Http::head(self::HTTPBIN_HOST . "/status/{$responseCode}");
         $this->assertEquals($responseCode, $resp->getResponseCode());
     }
 

diff --git a/tests/ImageTestBase.php b/tests/ImageTestBase.php
@@ -9,9 +9,8 @@
 
 abstract class ImageTestBase extends NanoBaseTest
 {
-    /* @var string $file */
-    private $file;
-    private $url;
+    private string $file;
+    private string $url;
 
     const DEBUG = false;
 
@@ -20,8 +19,8 @@ public function setUp(): void
         // 578x406
         $this->file = __DIR__ . '/app/statics/php-logo.jpg';
 
-        /* @see https://httpbin.org/image/jpeg */
-        $this->url = 'https://httpbin.org/image/jpeg';
+        /* @see http://0.0.0.0:5555/image/jpeg */
+        $this->url = self::HTTPBIN_HOST . '/image/jpeg';
     }
 
     public function testNewFromFile()