From 275a30cf17b7fcef1a8369d6a688a7e4b7690f7e Mon Sep 17 00:00:00 2001
From: Aranya Sen <sen.aranya@gmail.com>
Date: Thu, 30 Apr 2020 11:43:07 +0530
Subject: [PATCH] Refactor test strcuture to PSR-4

* Added PSR-4 mapping in composer
* Updated namespaces in tests
* Rename any files that do not conform to PSR-4
* Updated tests to "use" classes instead of requiring those
---
 composer.json                                  |  9 +++++++--
 test/AgileBoardSettingTest.php                 |  8 ++++----
 test/AttachmentTest.php                        | 18 +++++++++---------
 test/AutoloadingTest.php                       |  3 ++-
 test/BaseObjectTest.php                        |  6 +++---
 test/ConnectionTest.php                        | 10 ++++------
 test/CurrentUserTest.php                       |  7 ++++---
 test/EnumFieldTest.php                         |  7 +++++--
 test/ExceptionTest.php                         |  9 ++++-----
 test/IssueTest.php                             |  8 +++++---
 test/OwnedFieldBundleTest.php                  |  7 +++++--
 test/RoleTest.php                              |  9 +++++----
 .../{testconnection.php => TestConnection.php} |  4 +++-
 test/VersionTest.php                           |  7 ++++---
 test/WorkitemTest.php                          |  8 +++++---
 test/requirements.php                          |  6 ------
 16 files changed, 69 insertions(+), 57 deletions(-)
 rename test/{testconnection.php => TestConnection.php} (85%)
 delete mode 100644 test/requirements.php

diff --git a/composer.json b/composer.json
index 72d3276..ea9474f 100644
--- a/composer.json
+++ b/composer.json
@@ -13,8 +13,13 @@
     }
   ],
   "autoload": {
-    "psr-0": {
-      "YouTrack\\": "./"
+    "psr-4": {
+      "YouTrack\\": "YouTrack/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "YouTrack\\Test\\": "test/"
     }
   },
   "require": {
diff --git a/test/AgileBoardSettingTest.php b/test/AgileBoardSettingTest.php
index 9b58ad5..21abb39 100644
--- a/test/AgileBoardSettingTest.php
+++ b/test/AgileBoardSettingTest.php
@@ -1,8 +1,8 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
-require_once 'testconnection.php';
 
+namespace YouTrack\Test;
+
+use YouTrack\AgileSetting;
 
 /**
  * Unit test for the youtrack agile board settings class.
@@ -12,7 +12,7 @@
 class AgileBoardSettingTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $singleAgileSettingFile = 'test/testdata/agile-boards.xml';
+    private $singleAgileSettingFile = __DIR__ . '/testdata/agile-boards.xml';
 
     public function testCanCreateSimpleAgileSetting()
     {
diff --git a/test/AttachmentTest.php b/test/AttachmentTest.php
index e496dcf..79ba6a9 100644
--- a/test/AttachmentTest.php
+++ b/test/AttachmentTest.php
@@ -1,18 +1,18 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
-require_once 'testconnection.php';
 
+namespace YouTrack\Test;
+
+use YouTrack\Attachment;
 
 /**
  * Unit test for the youtrack attachment class.
  *
  * @author Nepomuk Fraedrich <info@nepda.eu>
  */
-class AttachmentsTest extends \PHPUnit_Framework_TestCase
+class AttachmentTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $singleAttachmentFile = 'test/testdata/attachment.xml';
+    private $singleAttachmentFile = __DIR__ . '/testdata/attachment.xml';
 
     public function testCanCreateSimpleAttachment()
     {
@@ -99,12 +99,12 @@ public function testCreateAttachmentFromAttachment()
     {
         $attachment = $this->createAttachment();
 
-        $expectedResult = unserialize(file_get_contents('test/testdata/request-response-create-attachment-serialized.txt'));
+        $expectedResult = unserialize(file_get_contents(__DIR__ . '/testdata/request-response-create-attachment-serialized.txt'));
 
         /**
          * @var \YouTrack\Connection $youtrack
          */
-        $youtrackBuilder = $this->getMockBuilder('\\YouTrack\\TestConnection');
+        $youtrackBuilder = $this->getMockBuilder('YouTrack\\Test\\TestConnection');
         $youtrackBuilder->setMethods(['request']);
         $youtrack = $youtrackBuilder->getMock();
 
@@ -141,7 +141,7 @@ public function testCreateAttachment($name, $authorLogin, $created, $group, $par
         $expectedUrl = '/issue/' . rawurlencode($issueId) . '/attachment?' . http_build_query($params);
         $expectedResult = 'myResponseValue';
 
-        $youtrackBuilder = $this->getMockBuilder('\\YouTrack\\TestConnection');
+        $youtrackBuilder = $this->getMockBuilder('YouTrack\\Test\\TestConnection');
         $youtrackBuilder->setMethods(['request']);
         $youtrack = $youtrackBuilder->getMock();
 
@@ -158,7 +158,7 @@ public function testCreateAttachment($name, $authorLogin, $created, $group, $par
 
     public function testCreateAttachmentThrowsExceptionOnNonExistingFile()
     {
-        $youtrackBuilder = $this->getMockBuilder('\\YouTrack\\TestConnection');
+        $youtrackBuilder = $this->getMockBuilder('YouTrack\\Test\\TestConnection');
         $youtrackBuilder->setMethods(['request']);
         $youtrack = $youtrackBuilder->getMock();
 
diff --git a/test/AutoloadingTest.php b/test/AutoloadingTest.php
index 6196edc..fffc3b7 100644
--- a/test/AutoloadingTest.php
+++ b/test/AutoloadingTest.php
@@ -1,5 +1,6 @@
 <?php
-namespace YouTrack;
+
+namespace YouTrack\Test;
 
 class AutoloadingTest extends \PHPUnit_Framework_TestCase
 {
diff --git a/test/BaseObjectTest.php b/test/BaseObjectTest.php
index b9ac25a..9297727 100644
--- a/test/BaseObjectTest.php
+++ b/test/BaseObjectTest.php
@@ -1,7 +1,7 @@
 <?php
-namespace YouTrack;
+namespace YouTrack\Test;
 
-require_once 'requirements.php';
+use YouTrack\BaseObject;
 
 /**
  * Unit test for the youtrack object class.
@@ -12,7 +12,7 @@
 class BaseObjectTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $filename = 'test/testdata/issue.xml';
+    private $filename = __DIR__ . '/testdata/issue.xml';
 
     public function testConstruct01()
     {
diff --git a/test/ConnectionTest.php b/test/ConnectionTest.php
index a97ffdc..30b497c 100644
--- a/test/ConnectionTest.php
+++ b/test/ConnectionTest.php
@@ -1,8 +1,6 @@
 <?php
 
-namespace YouTrack;
-require_once 'requirements.php';
-require_once 'testconnection.php';
+namespace YouTrack\Test;
 
 /**
  * Unit test for the connection class.
@@ -16,16 +14,16 @@ class ConnectionTest extends \PHPUnit_Framework_TestCase
     public function testCreateConnection()
     {
         $con = new TestConnection();
-        $this->assertInstanceOf('\YouTrack\TestConnection', $con);
+        $this->assertInstanceOf('YouTrack\Test\TestConnection', $con);
     }
 
     public function testIncorrectLoginThrowsException()
     {
         $con = new TestConnection();
-        $refl = new \ReflectionClass('\YouTrack\TestConnection');
+        $refl = new \ReflectionClass('YouTrack\Test\TestConnection');
         $method = $refl->getMethod('handleLoginResponse');
         $method->setAccessible(true);
-        $content = file_get_contents('test/testdata/incorrect-login.http');
+        $content = file_get_contents(__DIR__ . '/testdata/incorrect-login.http');
         $response = [
             'http_code' => 403
         ];
diff --git a/test/CurrentUserTest.php b/test/CurrentUserTest.php
index 4c7cadc..754ad5e 100644
--- a/test/CurrentUserTest.php
+++ b/test/CurrentUserTest.php
@@ -1,6 +1,7 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
+namespace YouTrack\Test;
+
+use YouTrack\CurrentUser;
 
 /**
  * Unit test for fetching current user.
@@ -9,7 +10,7 @@
  */
 class CurrentUserTest extends \PHPUnit_Framework_TestCase
 {
-    private $filename = 'test/testdata/currentuser.xml';
+    private $filename = __DIR__  . '/testdata/currentuser.xml';
 
     public function testConstruct()
     {
diff --git a/test/EnumFieldTest.php b/test/EnumFieldTest.php
index aaeed36..2b24e3b 100644
--- a/test/EnumFieldTest.php
+++ b/test/EnumFieldTest.php
@@ -1,10 +1,13 @@
 <?php
-namespace YouTrack;
+namespace YouTrack\Test;
+
+use YouTrack\EnumBundle;
+use YouTrack\EnumField;
 
 class EnumFieldTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $filename = 'test/testdata/enum_bundle.xml';
+    private $filename = __DIR__  . '/testdata/enum_bundle.xml';
 
     public function testGetOwnedFieldBundleElements()
     {
diff --git a/test/ExceptionTest.php b/test/ExceptionTest.php
index b2cba31..c51dc9f 100644
--- a/test/ExceptionTest.php
+++ b/test/ExceptionTest.php
@@ -1,6 +1,5 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
+namespace YouTrack\Test;
 
 use YouTrack\Exception as YouTrackException;
 
@@ -19,7 +18,7 @@ public function testConstruct01()
             'http_code' => 200,
         ];
         $content = '';
-        $e = new Exception($url, $response, $content);
+        $e = new YouTrackException($url, $response, $content);
         $this->assertEquals("Error for 'http://example.com': 200", $e->getMessage());
     }
 
@@ -30,7 +29,7 @@ public function testConstruct02()
             'http_code' => 404,
         ];
         $content = '';
-        $e = new Exception($url, $response, $content);
+        $e = new YouTrackException($url, $response, $content);
         $this->assertEquals("Error for 'http://example.com': 404", $e->getMessage());
     }
 
@@ -42,7 +41,7 @@ public function testConstruct03()
             'content_type' => 'text/html; charset=utf8',
         ];
         $content = '';
-        $e = new Exception($url, $response, $content);
+        $e = new YouTrackException($url, $response, $content);
         $this->assertEquals("Error for 'http://example.com': 500", $e->getMessage());
     }
 
diff --git a/test/IssueTest.php b/test/IssueTest.php
index 0d10743..b4a603f 100644
--- a/test/IssueTest.php
+++ b/test/IssueTest.php
@@ -1,6 +1,8 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
+namespace YouTrack\Test;
+
+
+use YouTrack\Issue;
 
 /**
  * Unit test for the youtrack issue class.
@@ -11,7 +13,7 @@
 class IssueTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $filename = 'test/testdata/issue.xml';
+    private $filename = __DIR__  . '/testdata/issue.xml';
 
     public function testConstruct01()
     {
diff --git a/test/OwnedFieldBundleTest.php b/test/OwnedFieldBundleTest.php
index 4bfb9ef..bb30516 100644
--- a/test/OwnedFieldBundleTest.php
+++ b/test/OwnedFieldBundleTest.php
@@ -1,10 +1,13 @@
 <?php
-namespace YouTrack;
+namespace YouTrack\Test;
+
+use YouTrack\OwnedField;
+use YouTrack\OwnedFieldBundle;
 
 class OwnedFieldBundleTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $filename = 'test/testdata/owned_field_bundle.xml';
+    private $filename = __DIR__  . '/testdata/owned_field_bundle.xml';
 
     public function testGetOwnedFieldBundleElements()
     {
diff --git a/test/RoleTest.php b/test/RoleTest.php
index 9aeac75..a214171 100644
--- a/test/RoleTest.php
+++ b/test/RoleTest.php
@@ -1,7 +1,8 @@
 <?php
-namespace YouTrack;
+namespace YouTrack\Test;
 
-require_once 'requirements.php';
+
+use YouTrack\Role;
 
 /**
  * Class RoleTest
@@ -11,8 +12,8 @@
 class RoleTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $rolePlainFile = 'test/testdata/role-plain.xml';
-    private $roleProjectFile = 'test/testdata/role-project-ref.xml';
+    private $rolePlainFile = __DIR__  . '/testdata/role-plain.xml';
+    private $roleProjectFile = __DIR__  . '/testdata/role-project-ref.xml';
 
     public function testCreatePlainRole()
     {
diff --git a/test/testconnection.php b/test/TestConnection.php
similarity index 85%
rename from test/testconnection.php
rename to test/TestConnection.php
index 83e8957..99bc309 100644
--- a/test/testconnection.php
+++ b/test/TestConnection.php
@@ -1,6 +1,8 @@
 <?php
 
-namespace YouTrack;
+namespace YouTrack\Test;
+
+use YouTrack\Connection;
 
 /**
  * A helper class for connection testing.
diff --git a/test/VersionTest.php b/test/VersionTest.php
index 5823d7f..956d06f 100644
--- a/test/VersionTest.php
+++ b/test/VersionTest.php
@@ -1,6 +1,7 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
+namespace YouTrack\Test;
+
+use YouTrack\Version;
 
 /**
  * Unit test for the YouTrack Version class.
@@ -11,7 +12,7 @@
 class VersionTest extends \PHPUnit_Framework_TestCase
 {
 
-    private $filename = 'test/testdata/version.xml';
+    private $filename = __DIR__  . '/testdata/version.xml';
 
     public function testName()
     {
diff --git a/test/WorkitemTest.php b/test/WorkitemTest.php
index 60fec88..f24e66a 100644
--- a/test/WorkitemTest.php
+++ b/test/WorkitemTest.php
@@ -1,6 +1,8 @@
 <?php
-namespace YouTrack;
-require_once 'requirements.php';
+namespace YouTrack\Test;
+
+use YouTrack\User;
+use YouTrack\Workitem;
 
 /**
  * Unit test for the youtrack workitem class.
@@ -9,7 +11,7 @@
  */
 class WorkitemTest extends \PHPUnit_Framework_TestCase
 {
-    private $filename = 'test/testdata/workitem.xml';
+    private $filename = __DIR__  . '/testdata/workitem.xml';
 
     public function testConstruct01()
     {
diff --git a/test/requirements.php b/test/requirements.php
deleted file mode 100644
index 79aa147..0000000
--- a/test/requirements.php
+++ /dev/null
@@ -1,6 +0,0 @@
-<?php
-/**
- * Include the requirements for testing.
- */
-
-require_once './vendor/autoload.php';