Merge pull request #216 from DigitalTimK/env_files

Implement usage of DOTENV-files

Author: GhaziTriki

.env

@@ -0,0 +1,5 @@
+# Specify the value of your BigBlueButton secret
+BBB_SERVER_BASE_URL="https://test-install.blindsidenetworks.com/bigbluebutton/"
+
+# Specify the Server Base URL of your BigBlueButton
+BBB_SECRET="8cd8ef52e8e101574e400365b55e11a6"

.gitignore

@@ -3,6 +3,9 @@ composer.phar
 composer.lock
 .DS_Store
 
+## local environment variables
+.env.local
+
 ## Directory-based project format:
 .idea/
 /nbproject

README.md

@@ -56,15 +56,31 @@ $ ./vendor/bin/phpstan analyse
 For every implemented feature add unit tests and check all is green by running the command below.
 
 ```bash
+# using an alias
 $ composer test
+
+# or the same w/o alias
+./vendor/bin/phpunit
 ```
 
 To run a single test
 
 ```bash
-./vendor/bin/phpunit --filter "BigBlueButtonTest::testApiVersion"
+# using an alias
+$ composer test -- --filter BigBlueButtonTest::testApiVersion
+
+# or the same w/o alias
+./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
 ```
 
+**Remark:**
+
+Some test will connect to an existing BBB-server, which is specified in the `.env`-file. You 
+can specify your own BBB-server by copy that file into the same folder and name it `.env.local`.
+Exchange the credentials `BBB_SERVER_BASE_URL` and `BBB_SECRET` to your server's values.
+Since this new file (`.env.local`) takes precedence over the main file (`.env`), you will now test 
+with your own server.
+
 [bbb]: http://bigbluebutton.org
 [composer]: https://getcomposer.org
 [INSTALL]: samples/README.md

composer.json

@@ -41,7 +41,8 @@
     "phpmetrics/phpmetrics": "^v2.8.2",
     "wapmorgan/php-deprecation-detector": "^2.0.33",
     "phpstan/phpstan": "^1.10",
-    "tracy/tracy": "^2.10"
+    "tracy/tracy": "^2.10",
+    "vlucas/phpdotenv": "^5.6"
   },
   "scripts": {
     "code-check": "./vendor/bin/phpstan analyse",

phpunit.xml.dist

@@ -7,10 +7,6 @@
   </coverage>
   <php>
     <env name="XDEBUG_MODE" value="coverage"/>
-    <!-- Specify the value of your BigBlueButton secret -->
-    <env name="BBB_SECRET" value="8cd8ef52e8e101574e400365b55e11a6"/>
-    <!-- Specify the Server Base URL of your BigBlueButton -->
-    <env name="BBB_SERVER_BASE_URL" value="https://test-install.blindsidenetworks.com/bigbluebutton/"/>
   </php>
   <testsuites>
     <testsuite name="BigBlueButton test suite">

src/BigBlueButton.php

@@ -60,8 +60,8 @@
  */
 class BigBlueButton
 {
-    protected string $securitySecret;
-    protected string $bbbServerBaseUrl;
+    protected string $bbbSecret;
+    protected string $bbbBaseUrl;
     protected UrlBuilder $urlBuilder;
     protected string $jSessionId;
 
@@ -78,12 +78,27 @@ class BigBlueButton
      */
     public function __construct(?string $baseUrl = null, ?string $secret = null, ?array $opts = [])
     {
+        // Provide an early error message if configuration is wrong
+        if (is_null($secret) && false === getenv('BBB_SERVER_BASE_URL')) {
+            throw new \RuntimeException('No BBB-Server-Url found! Please provide it either in constructor ' .
+                "(1st argument) or by environment variable 'BBB_SERVER_BASE_URL'!");
+        }
+
+        if (is_null($secret) && false === getenv('BBB_SECRET') && false === getenv('BBB_SECURITY_SALT')) {
+            throw new \RuntimeException('No BBB-Secret (or BBB-Salt) found! Please provide it either in constructor ' .
+                "(2nd argument) or by environment variable 'BBB_SECRET' (or 'BBB_SECURITY_SALT')!");
+        }
+
         // Keeping backward compatibility with older deployed versions
         // BBB_SECRET is the new variable name and have higher priority against the old named BBB_SECURITY_SALT
-        $this->securitySecret   = $secret ?: getenv('BBB_SECRET') ?: getenv('BBB_SECURITY_SALT') ?: '';
-        $this->bbbServerBaseUrl = $baseUrl ?: getenv('BBB_SERVER_BASE_URL') ?: '';
+        // Reminder: getenv() will return FALSE if not set. But bool is not accepted by $this->bbbSecret
+        //           nor $this->bbbBaseUrl (only strings), thus FALSE will be converted automatically to an empty
+        //           string (''). Having a bool should be not possible due to the checks above and the automated
+        //           conversion, but PHPStan is still unhappy, so it's covered explicit by adding `?: ''`.
+        $this->bbbBaseUrl       = $baseUrl ?: getenv('BBB_SERVER_BASE_URL') ?: '';
+        $this->bbbSecret        = $secret ?: getenv('BBB_SECRET') ?: getenv('BBB_SECURITY_SALT') ?: '';
         $this->hashingAlgorithm = HashingAlgorithm::SHA_256;
-        $this->urlBuilder       = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl, $this->hashingAlgorithm);
+        $this->urlBuilder       = new UrlBuilder($this->bbbSecret, $this->bbbBaseUrl, $this->hashingAlgorithm);
         $this->curlOpts         = $opts['curl'] ?? [];
     }
 

tests/BigBlueButtonTest.php

@@ -29,6 +29,7 @@
 use BigBlueButton\Parameters\IsMeetingRunningParameters;
 use BigBlueButton\Parameters\PublishRecordingsParameters;
 use BigBlueButton\Util\ParamsIterator;
+use Dotenv\Dotenv;
 
 /**
  * Class BigBlueButtonTest.
@@ -48,12 +49,7 @@ public function setUp(): void
     {
         parent::setUp();
 
-        foreach (['BBB_SECRET', 'BBB_SERVER_BASE_URL'] as $key) {
-            if (!getenv($key)) {
-                $this->fail('$_SERVER[\'' . $key . '\'] not set in '
-                    . 'phpunit.xml');
-            }
-        }
+        $this->loadEnvironmentVariables();
 
         $this->bbb = new BigBlueButton();
     }
@@ -359,4 +355,26 @@ public function testUpdateRecordings(): void
         $this->assertEquals('FAILED', $result->getReturnCode());
         $this->assertTrue($result->failed());
     }
+
+    /**
+     * @see https://github.com/vlucas/phpdotenv
+     */
+    private function loadEnvironmentVariables(): void
+    {
+        $envPath      = __DIR__ . '/..';
+        $envFileMain  = '.env';
+        $envFileLocal = '.env.local';
+
+        if (file_exists("{$envPath}/{$envFileLocal}")) {
+            $envFile = $envFileLocal;
+        } elseif (file_exists("{$envPath}/{$envFileMain}")) {
+            $envFile = $envFileMain;
+        } else {
+            throw new \RuntimeException("Environment file ('{$envFileMain}' nor '{$envFileLocal}') not found!");
+        }
+
+        $dotenv = Dotenv::createUnsafeImmutable($envPath, $envFile);
+        $dotenv->load();
+        $dotenv->required(['BBB_SECRET', 'BBB_SERVER_BASE_URL']);
+    }
 }