adding tests for YOURLS functionality

2022-10-23 13:09:54 +02:00
parent 4bd5ef9cda
commit 78e915e049
6 changed files with 135 additions and 22 deletions
--- a/tst/YourlsProxyTest.php
+++ b/tst/YourlsProxyTest.php
@@ -0,0 +1,75 @@
+<?php
+
+use PrivateBin\Configuration;
+use PrivateBin\YourlsProxy;
+
+class YourlsProxyTest extends PHPUnit_Framework_TestCase
+{
+    private $_conf;
+
+    private $_path;
+
+    private $_mock_yourls_service;
+
+    public function setUp()
+    {
+        /* Setup Routine */
+        $this->_path = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'privatebin_data';
+        if (!is_dir($this->_path)) {
+            mkdir($this->_path);
+        }
+        $this->_mock_yourls_service         = $this->_path . DIRECTORY_SEPARATOR . 'yourls.json';
+        $options                            = parse_ini_file(CONF_SAMPLE, true);
+        $options['main']['basepath']        = 'https://example.com';
+        $options['main']['urlshortener']    = 'https://example.com/shortenviayourls?link=';
+        $options['yourls']['apiurl']        = $this->_mock_yourls_service;
+        Helper::confBackup();
+        Helper::createIniFile(CONF, $options);
+        $this->_conf = new Configuration;
+    }
+
+    public function tearDown()
+    {
+        /* Tear Down Routine */
+        unlink(CONF);
+        Helper::confRestore();
+        Helper::rmDir($this->_path);
+    }
+
+    public function testYourlsProxy()
+    {
+        // the real service answer is more complex, but we only look for the shorturl & statusCode
+        file_put_contents($this->_mock_yourls_service, '{"shorturl":"https:\/\/example.com\/1","statusCode":200}');
+
+        $yourls = new YourlsProxy($this->_conf, 'https://example.com/?foo#bar');
+        $this->assertFalse($yourls->isError());
+        $this->assertEquals($yourls->getUrl(), 'https://example.com/1');
+    }
+
+    public function testForeignUrl()
+    {
+        $yourls = new YourlsProxy($this->_conf, 'https://other.example.com/?foo#bar');
+        $this->assertTrue($yourls->isError());
+        $this->assertEquals($yourls->getError(), 'Trying to shorten a URL that isn\'t pointing at our instance.');
+    }
+
+    public function testYourlsError()
+    {
+        // when statusCode is not 200, shorturl may not have been set
+        file_put_contents($this->_mock_yourls_service, '{"statusCode":403}');
+
+        $yourls = new YourlsProxy($this->_conf, 'https://example.com/?foo#bar');
+        $this->assertTrue($yourls->isError());
+        $this->assertEquals($yourls->getError(), 'Error parsing YOURLS response.');
+    }
+
+    public function testServerError()
+    {
+        // simulate some other server error that results in a non-JSON reply
+        file_put_contents($this->_mock_yourls_service, '');
+
+        $yourls = new YourlsProxy($this->_conf, 'https://example.com/?foo#bar');
+        $this->assertTrue($yourls->isError());
+        $this->assertEquals($yourls->getError(), 'Error calling YOURLS. Probably a configuration issue, like wrong or missing "apiurl" or "signature".');
+    }
+}