Merge branch 'main' into cost_info

Author: ilyakharev

CHANGELOG.md

@@ -1,4 +1,5 @@
 * added query stats
+* added ReadTokenFromFile
 * added lambda on exception in retryTransaction
 
 ## 1.10.0

README.md

@@ -417,6 +417,36 @@ The following algorithm that is the same for YDB-PHP-SDK applies:
 4. Otherwise, if the value of the `YDB_ACCESS_TOKEN_CREDENTIALS` environment variable is set, the **Access token** authentication mode is used, where the this variable value is passed.
 5. Otherwise, the **Metadata** authentication mode is used.
 
+## Reading from text file
+
+```php
+<?php
+
+use YdbPlatform\Ydb\Ydb;
+use YdbPlatform\Ydb\Auth\ReadTokenFromFile;
+
+$config = [
+
+    // Database path
+    'database'    => '/local',
+
+    // Database endpoint
+    'endpoint'    => 'localhost:2136',
+
+    // Auto discovery (dedicated server only)
+    'discovery'   => false,
+
+    // IAM config
+    'iam_config'  => [
+        'insecure' => true,
+    ],
+    
+    'credentials' => new ReadTokenFromFile($tokenPath, $refreshTime)
+];
+
+$ydb = new Ydb($config);
+```
+
 # Usage
 
 You should initialize a session from the Table service to start querying with retry.

src/Auth/ReadTokenFromFile.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace YdbPlatform\Ydb\Auth;
+
+class ReadTokenFromFile extends Auth
+{
+
+    protected $fileName;
+    protected $readInterval;
+
+    /**
+     * @param string $fileName
+     * @param int $readInterval
+     */
+    public function __construct(string $fileName = "token.txt", int $readInterval = 60)
+    {
+        if(file_get_contents($fileName)===false){
+            throw new \Exception("Error reading the file '$fileName'");
+        }
+        $this->fileName = $fileName;
+        $this->readInterval = $readInterval;
+    }
+
+    public function getTokenInfo(): TokenInfo
+    {
+        $token = file_get_contents($this->fileName);
+        if($token===false){
+            throw new \Exception("Error reading the file '$this->fileName'");
+        }
+        $token = trim($token);
+        return new TokenInfo($token, $this->readInterval, 1);
+    }
+
+    public function getName(): string
+    {
+        return "from file";
+    }
+}

tests/CheckReadTokenFileTest.php

@@ -0,0 +1,30 @@
+<?php
+namespace YdbPlatform\Ydb\Test;
+
+use PHPUnit\Framework\TestCase;
+use YdbPlatform\Ydb\Auth\ReadTokenFromFile;
+use YdbPlatform\Ydb\Ydb;
+use YdbPlatform\Ydb\YdbTable;
+
+class CheckReadTokenFileTest extends TestCase{
+    public function testReadTokenFile(){
+        $config = [
+
+            // Database path
+            'database'    => '/local',
+
+            // Database endpoint
+            'endpoint'    => 'localhost:2136',
+
+            // Auto discovery (dedicated server only)
+            'discovery'   => false,
+
+            'credentials'  => new ReadTokenFromFile("./tests/token.txt")
+        ];
+
+        $ydb = new Ydb($config);
+        self::assertEquals('test-example-token',
+            $ydb->iam()->token()
+        );
+    }
+}

tests/token.txt

@@ -0,0 +1 @@
+test-example-token