Merge pull request #49 from creative-commoners/pulls/5.0/test-dynamodb2

MNT Test dynamodb integration works
silverstripe · Feb 16, 2023 · a3b1750 · a3b1750
2 parents 6129014 + 2ecf1c9
commit a3b1750
Show file tree

Hide file tree

Showing 3 changed files with 92 additions and 1 deletion.
diff --git a/code/Model/DynamoDbSession.php b/code/Model/DynamoDbSession.php
@@ -25,6 +25,11 @@ public function getHandler(): SessionHandler
         return $this->handler;
     }
 
+    public function getClient(): DynamoDbClient
+    {
+        return $this->client;
+    }
+
     /**
      * Get an instance of DynamoDbSession configured from the environment if available.
      */

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -3,7 +3,7 @@
 Standard module phpunit configuration.
 Requires PHPUnit ^5.7
 -->
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
+<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true" stderr="true">
 	<testsuite name="Default">
 		<directory>tests/</directory>
     </testsuite>

diff --git a/tests/DynamoDbSessionTest.php b/tests/DynamoDbSessionTest.php
@@ -6,6 +6,11 @@
 use SilverStripe\Core\Environment;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\DynamoDb\Model\DynamoDbSession;
+use Aws\DynamoDb\DynamoDbClient;
+use SilverStripe\Control\Session;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Control\Cookie;
+use Exception;
 
 class DynamoDbSessionTest extends SapphireTest
 {
@@ -61,4 +66,85 @@ public function testGetSessionHandler()
         $handler = $sess->getHandler();
         $this->assertInstanceOf('\\Aws\\DynamoDb\\SessionHandler', $handler);
     }
+
+    private function getSessions(DynamoDbClient $client, string $tableName): array
+    {
+        return $client->scan([
+            'TableName' => $tableName,
+        ])->get('Items');
+    }
+
+    /**
+     * This test requires the strerr="true" attribute in phpunit.xml.dist to be set otherwise
+     * you'll get a failure because of
+     * "session_set_save_handler(): Session save handler cannot be changed after headers have already been sent"
+     */
+    public function testSessionsAreStoredInDynamoDB()
+    {
+        $tableName = 'unit-test-mysession';
+
+        $dynamoDbSession = new DynamoDbSession([
+            'endpoint' =>  Environment::getEnv('AWS_DYNAMODB_ENDPOINT'),
+            'region' => Environment::getEnv('AWS_REGION_NAME'),
+            'credentials' => [
+                'key' => Environment::getEnv('AWS_ACCESS_KEY'),
+                'secret' => Environment::getEnv('AWS_SECRET_KEY')
+            ]
+        ], $tableName);
+        $dynamoDbSession->register();
+        $client = $dynamoDbSession->getClient();
+
+        $result = $client->listTables();
+        // Delete any pre-existing session table (may still be there from failed unit test)
+        foreach ($result['TableNames'] ?? [] as $resultTableName) {
+            if ($resultTableName === $tableName) {
+                $client->deleteTable([
+                    'TableName' => $tableName,
+                ]);
+            }
+        }
+
+        // Create new session table
+        $client->createTable([
+            'TableName' => $tableName,
+            'AttributeDefinitions' => [
+                [
+                    'AttributeName' => 'id',
+                    'AttributeType' => 'S'
+                ],
+            ],
+            'KeySchema' => [
+                [
+                    'AttributeName' => 'id',
+                    'KeyType' => 'HASH'
+                ]
+            ],
+            'ProvisionedThroughput' => [
+                'ReadCapacityUnits' => 1,
+                'WriteCapacityUnits' => 1
+            ],
+        ]);
+
+        $sessions = $this->getSessions($client, $tableName);
+        $this->assertSame(0, count($sessions));
+
+        // Start a new session in Silverstripe
+        Session::config()->set('strict_user_agent_check', false);
+        $req = new HTTPRequest('GET', '/');
+        Cookie::set(session_name(), '1234');
+        $session = new Session(null);
+        $session->init($req);
+        $sessionID = session_id();
+        // Session has to close for the data to be written to dynamodb
+        session_write_close();
+
+        $sessions = $this->getSessions($client, $tableName);
+        $this->assertSame(1, count($sessions));
+        $this->assertStringContainsString($sessionID, $sessions[0]['id']['S']);
+
+        // Delete the dynamodb table
+        $client->deleteTable([
+            'TableName' => $tableName,
+        ]);
+    }
 }