fix(responsetranslator): to return empty description case also as invalid template; patched tests

Author: KaiSchwarz-cnic

.github/workflows/test.yml

@@ -63,6 +63,6 @@ jobs:
         env:
           TESTS_USER_HEXONET: ${{ secrets.TESTS_USER_HEXONET }}
           TESTS_USERPASSWORD_HEXONET: ${{ secrets.TESTS_USERPASSWORD_HEXONET }}
-          TESTS_USER_CNR: ${{ secrets.TESTS_USER_RRPPROXY }}
-          TESTS_USERPASSWORD_CNR: ${{ secrets.TESTS_USERPASSWORD_RRPPROXY }}
+          TESTS_USER_CNR: ${{ secrets.TESTS_USER_CNR }}
+          TESTS_USERPASSWORD_CNR: ${{ secrets.TESTS_USERPASSWORD_CNR }}
         run: composer run-script test

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" stopOnFailure="false" bootstrap="./vendor/autoload.php" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" stopOnFailure="true" bootstrap="./vendor/autoload.php" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <coverage processUncoveredFiles="true">
     <include>
       <directory suffix=".php">src</directory>

src/HEXONET/ResponseTranslator.php

@@ -23,15 +23,15 @@ class ResponseTranslator
      * @var array
      */
     private static $descriptionRegexMap = [
-       "Authorization failed; Operation forbidden by ACL" => "Authorization failed; Used Command `{COMMAND}` not white-listed by your Access Control List",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (clientTransferProhibited)/WRONG AUTH" => "This Domain is locked and the given Authorization Code is wrong. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (clientTransferProhibited)" => "This Domain is locked. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requested)" => "Registration of this Domain Name has not yet completed. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requestedcreate)" => "Registration of this Domain Name has not yet completed. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requesteddelete)" => "Deletion of this Domain Name has been requested. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (pendingdelete)" => "Deletion of this Domain Name is pending. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY WRONG AUTH" => "The given Authorization Code is wrong. Initiating a Transfer is therefore impossible.",
-       "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY AGE OF THE DOMAIN" => "This Domain Name is within 60 days of initial registration. Initiating a Transfer is therefore impossible."
+        "Authorization failed; Operation forbidden by ACL" => "Authorization failed; Used Command `{COMMAND}` not white-listed by your Access Control List",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (clientTransferProhibited)/WRONG AUTH" => "This Domain is locked and the given Authorization Code is wrong. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (clientTransferProhibited)" => "This Domain is locked. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requested)" => "Registration of this Domain Name has not yet completed. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requestedcreate)" => "Registration of this Domain Name has not yet completed. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (requesteddelete)" => "Deletion of this Domain Name has been requested. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY STATUS (pendingdelete)" => "Deletion of this Domain Name is pending. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY WRONG AUTH" => "The given Authorization Code is wrong. Initiating a Transfer is therefore impossible.",
+        "Request is not available; DOMAIN TRANSFER IS PROHIBITED BY AGE OF THE DOMAIN" => "This Domain Name is within 60 days of initial registration. Initiating a Transfer is therefore impossible."
     ];
 
     /**
@@ -55,9 +55,9 @@ public static function translate($raw, $cmd, $ph = [])
 
         // Missing CODE or DESCRIPTION in API Response
         if (
-            (
-                !preg_match("/description[\s]*=/i", $newraw)
-                || !preg_match("/code[\s]*=/i", $newraw)
+            (!preg_match("/description[\s]*=/i", $newraw) // missing description
+                || preg_match("/description[\s]*=\r\n/i", $newraw) // empty description
+                || !preg_match("/code[\s]*=/i", $newraw) // missing code
             )
             && RTM::hasTemplate("invalid")
         ) {

tests/HEXONET/ClientTest.php

@@ -41,11 +41,14 @@ public function testGetPOSTDataSecured(): void
             "SUBUSER" => self::$user,
             "PASSWORD" => self::$pw
         ], true);
-        $pwenc = urlencode(self::$pw);
         self::$cl->setCredentials();
         $this->assertEquals(
-            "s_entity=54cd&s_login=" . self::$user . "&s_pw=" . $pwenc .
-            "&s_command=COMMAND%3DCheckAuthentication%0ASUBUSER%3D" . self::$user . "%0APASSWORD%3D" . $pwenc,
+            http_build_query([
+                "s_entity" => "54cd",
+                "s_login" => self::$user,
+                "s_pw" => "***",
+                "s_command" => "COMMAND=CheckAuthentication\nSUBUSER=" . self::$user . "\nPASSWORD=***"
+            ]),
             $enc
         );
     }
@@ -148,7 +151,7 @@ public function testSetOTPSet(): void
         self::$cl->settings["parameters"]["otp"] = "s_otp";
         self::$cl->setOTP("12345678");
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_otp=12345678&s_command=COMMAND%3DStatusAccount");
     }
@@ -157,7 +160,7 @@ public function testSetOTPReset(): void
     {
         self::$cl->setOTP();
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_command=COMMAND%3DStatusAccount");
     }
@@ -166,7 +169,7 @@ public function testSetSessionSet(): void
     {
         self::$cl->setSession("12345678");
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_session=12345678&s_command=COMMAND%3DStatusAccount");
     }
@@ -175,8 +178,8 @@ public function testSetSessionCredentials(): void
     {
         // credentials and otp code have to be unset when session id is set
         self::$cl->setRoleCredentials("myaccountid", "myrole", "mypassword")
-                ->setOTP("12345678")
-                ->setSession("12345678");
+            ->setOTP("12345678")
+            ->setSession("12345678");
         $tmp = self::$cl->getPOSTData([
             "COMMAND" => "StatusAccount"
         ]);
@@ -187,15 +190,15 @@ public function testSetSessionReset(): void
     {
         self::$cl->setSession();
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_command=COMMAND%3DStatusAccount");
     }
 
     public function testSaveReuseSession(): void
     {
         self::$cl->setSession("12345678")
-                ->saveSession($_SESSION);
+            ->saveSession($_SESSION);
         $cl2 = CF::getClient([
             "registrar" => "HEXONET"
         ]);
@@ -221,7 +224,7 @@ public function testSetRemoteIPAddressSet(): void
         self::$cl->settings["parameters"]["ipfilter"] = "s_remoteaddr";
         self::$cl->setRemoteIPAddress("10.10.10.10");
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_remoteaddr=10.10.10.10&s_command=COMMAND%3DStatusAccount");
     }
@@ -239,7 +242,7 @@ public function testSetCredentialsSet(): void
     {
         self::$cl->setCredentials("myaccountid", "mypassword");
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_login=myaccountid&s_pw=mypassword&s_command=COMMAND%3DStatusAccount");
     }
@@ -257,7 +260,7 @@ public function testSetRoleCredentialsSet(): void
     {
         self::$cl->setRoleCredentials("myaccountid", "myroleid", "mypassword");
         $tmp = self::$cl->getPOSTData([
-          "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertEquals($tmp, "s_entity=54cd&s_login=myaccountid%21myroleid&s_pw=mypassword&s_command=COMMAND%3DStatusAccount");
     }
@@ -274,7 +277,7 @@ public function testSetRoleCredentialsReset(): void
     public function testLoginCredsOK(): void
     {
         self::$cl->useOTESystem()
-                ->setCredentials(self::$user, self::$pw);
+            ->setCredentials(self::$user, self::$pw);
         $r = self::$cl->login();
         $this->assertInstanceOf(R::class, $r);
         $this->assertEquals($r->isSuccess(), true);
@@ -310,7 +313,7 @@ public function testLoginCredsFAIL(): void
     public function testLoginExtendedCredsOK(): void
     {
         self::$cl->useOTESystem()
-                ->setCredentials(self::$user, self::$pw);
+            ->setCredentials(self::$user, self::$pw);
         $r = self::$cl->loginExtended([
             "TIMEOUT" => 60
         ]);
@@ -358,9 +361,9 @@ public function testRequestCurlExecFail2(): void
     {
         self::$cl->settings["env"]["ote"]["url"] = "http://gregeragregaegaegag.com/geragaerg/call.cgi";
         self::$cl->setCredentials(self::$user, self::$pw)
-               ->useOTESystem();
+            ->useOTESystem();
         $r = self::$cl->request([
-           "COMMAND" => "StatusAccount"
+            "COMMAND" => "StatusAccount"
         ]);
         $this->assertInstanceOf(R::class, $r);
         $this->assertEquals($r->isSuccess(), false);
@@ -370,10 +373,12 @@ public function testRequestCurlExecFail2(): void
 
     public function testRequestFlattenCommand(): void
     {
+        $cfgpath = implode(DIRECTORY_SEPARATOR, ["src", "HEXONET", "config.json"]);
+        $orgsettings = json_decode(file_get_contents($cfgpath), true);
         // restore
-        self::$cl->settings["env"]["ote"]["url"] = "https://api.ispapi.net/api/call.cgi";
+        self::$cl->settings["env"]["ote"]["url"] = $orgsettings["env"]["ote"]["url"];
         self::$cl->setCredentials(self::$user, self::$pw)
-                ->useOTESystem();
+            ->useOTESystem();
         $r = self::$cl->request([
             "COMMAND" => "CheckDomains",
             "DOMAIN" => ["example.com", "example.net"]
@@ -394,7 +399,7 @@ public function testRequestFlattenCommand(): void
     public function testRequestAUTOIdnConvert(): void
     {
         self::$cl->setCredentials(self::$user, self::$pw)
-                ->useOTESystem();
+            ->useOTESystem();
         $r = self::$cl->request([
             "COMMAND" => "CheckDomains",
             "DOMAIN" => ["example.com", "dömäin.example", "example.net"]
@@ -417,7 +422,7 @@ public function testRequestAUTOIdnConvert(): void
     public function testRequestAUTOIdnConvert2(): void
     {
         self::$cl->setCredentials(self::$user, self::$pw)
-                ->useOTESystem();
+            ->useOTESystem();
         $r = self::$cl->request([
             "COMMAND" => "QueryObjectlogList",
             "OBJECTID" => "dömäin.example",
@@ -440,7 +445,7 @@ public function testRequestAUTOIdnConvert2(): void
     public function testRequestAUTOIdnConvert3(): void
     {
         self::$cl->setCredentials(self::$user, self::$pw)
-                ->useOTESystem();
+            ->useOTESystem();
         $r = self::$cl->request([
             "COMMAND" => "QueryObjectlogList",
             "OBJECTID" => "dömäin.example",
@@ -463,8 +468,8 @@ public function testRequestAUTOIdnConvert3(): void
     public function testRequestCodeTmpErrorDbg(): void
     {
         self::$cl->enableDebugMode()
-                ->setCredentials(self::$user, self::$pw)
-                ->useOTESystem();
+            ->setCredentials(self::$user, self::$pw)
+            ->useOTESystem();
         $r = self::$cl->request(["COMMAND" => "GetUserIndex"]);
         $this->assertInstanceOf(R::class, $r);
         $this->assertEquals($r->isSuccess(), true);
@@ -476,7 +481,7 @@ public function testRequestCodeTmpErrorDbg(): void
     public function testRequestCodeTmpErrorNoDbg(): void
     {
         self::$cl->disableDebugMode();
-        $r = self::$cl->request([ "COMMAND" => "GetUserIndex" ]);
+        $r = self::$cl->request(["COMMAND" => "GetUserIndex"]);
         $this->assertInstanceOf(R::class, $r);
         $this->assertEquals($r->isSuccess(), true);
         $this->assertEquals($r->getCode(), 200);