Fixed bug in ClientBuilder where basic authentication is overridden b…

…y connection params (#160)

* feat: test basic authentication is not overridden

Signed-off-by: Salih Candir <salih@live.at>

CHANGELOG.md

@@ -24,6 +24,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Updated backport helper version and add fix to backport workflow when tag is applied before closing PR ([#131](https://github.com/opensearch-project/opensearch-php/pull/131))
 - Fixed host urls with trailing slash in the url ([#130](https://github.com/opensearch-project/opensearch-php/pull/140))
 - Fixed point-in-time APIs ([#142](https://github.com/opensearch-project/opensearch-php/pull/142))
+- Fixed bug in ClientBuilder where basic authentication is overridden by connection params ([#160](https://github.com/opensearch-project/opensearch-php/pull/160))
 
 ### Security
 

src/OpenSearch/ClientBuilder.php

@@ -161,6 +161,11 @@ class ClientBuilder
      */
     private $includePortInHostHeader = false;
 
+    /**
+     * @var string|null
+     */
+    private $basicAuthentication = null;
+
     /**
      * Create an instance of ClientBuilder
      */
@@ -427,14 +432,7 @@ public function setHosts(array $hosts): ClientBuilder
      */
     public function setBasicAuthentication(string $username, string $password): ClientBuilder
     {
-        if (isset($this->connectionParams['client']['curl']) === false) {
-            $this->connectionParams['client']['curl'] = [];
-        }
-
-        $this->connectionParams['client']['curl'] += [
-            CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
-            CURLOPT_USERPWD  => $username.':'.$password
-        ];
+        $this->basicAuthentication = $username.':'.$password;
 
         return $this;
     }
@@ -634,6 +632,17 @@ public function build(): Client
 
         $this->connectionParams['client']['port_in_header'] = $this->includePortInHostHeader;
 
+        if (! is_null($this->basicAuthentication)) {
+            if (isset($this->connectionParams['client']['curl']) === false) {
+                $this->connectionParams['client']['curl'] = [];
+            }
+
+            $this->connectionParams['client']['curl'] += [
+                CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
+                CURLOPT_USERPWD  => $this->basicAuthentication
+            ];
+        }
+
         if (is_null($this->connectionFactory)) {
             // Make sure we are setting Content-Type and Accept (unless the user has explicitly
             // overridden it

tests/ClientBuilderTest.php

@@ -161,6 +161,17 @@ public function testFromConfigQuiteFalseWithUnknownKey()
         );
     }
 
+    public function testFromConfigUsingBasicAuthentication()
+    {
+        $config = [
+            'basicAuthentication' => ["foo", "bar"],
+            'connectionParams' => [],
+        ];
+        $client = ClientBuilder::fromConfig($config);
+
+        $this->assertEquals('foo:bar', $client->transport->getConnection()->getUserPass());
+    }
+
     public function testCompatibilityHeaderDefaultIsOff()
     {
         $client = ClientBuilder::create()