test cleanup

Author: codemasher

composer.json

@@ -30,13 +30,15 @@
 		"ext-curl": "*",
 		"ext-json":"*",
 		"ext-simplexml":"*",
-		"chillerlan/php-oauth-core": "dev-main#1522c62b715fe1300d3774c00be155565d83ace8",
+		"chillerlan/php-oauth-core": "dev-main#9f6de524f16f332cdb4d8b6d16e079085145091b",
 		"psr/http-client":"^1.0",
 		"psr/http-message": "^1.0"
 	},
 	"require-dev": {
 		"chillerlan/php-dotenv": "^2.1",
 		"chillerlan/php-prototype-dom": "^3.0.1",
+		"guzzlehttp/guzzle": "^7.3",
+		"guzzlehttp/psr7": "2.0.0-beta1",
 		"phpunit/phpunit": "^9.5",
 		"phan/phan": "^4.0"
 	},

phpunit.xml.dist

@@ -24,8 +24,15 @@
 		<junit outputFile=".build/logs/junit.xml"/>
 	</logging>
 	<php>
+		<!-- whether the test runs on CI or not - set to false to allow live API tests to run -->
 		<const name="TEST_IS_CI" value="true"/>
+		<!-- the config directory, where .env, cacert.pem and test oauth tokens reside, relative from project root -->
+		<const name="TEST_CFGDIR" value="./config"/>
+		<!-- the filename of your .env file -->
+		<const name="TEST_ENVFILE" value=".env_example"/>
+		<!-- the http client factory for live api tests -->
 		<const name="TEST_CLIENT_FACTORY" value="chillerlan\OAuthTest\ChillerlanHttpClientFactory"/>
+		<!-- PSR-17 factories to use in tests -->
 		<const name="REQUEST_FACTORY" value="chillerlan\HTTP\Psr17\RequestFactory"/>
 		<const name="RESPONSE_FACTORY" value="chillerlan\HTTP\Psr17\ResponseFactory"/>
 		<const name="STREAM_FACTORY" value="chillerlan\HTTP\Psr17\StreamFactory"/>

tests/APITestTrait.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Trait APITestTrait
+ *
+ * @created      12.04.2021
+ * @author       smiley <smiley@chillerlan.net>
+ * @copyright    2021 smiley
+ * @license      MIT
+ */
+
+namespace chillerlan\OAuthTest\Providers;
+
+use chillerlan\DotEnv\DotEnv;
+use chillerlan\OAuth\OAuthOptions;
+use chillerlan\Settings\SettingsContainerInterface;
+use Exception;
+use function constant, defined, realpath;
+
+trait APITestTrait{
+
+	protected DotEnv $dotEnv;
+	protected string $ENV;
+
+	protected function setUp():void{
+
+		foreach(['TEST_CFGDIR', 'TEST_ENVFILE'] as $constant){
+			if(!defined($constant)){
+				throw new Exception($constant.' not set -> see phpunit.xml');
+			}
+		}
+
+		// get the .env config
+		$this->CFG      = realpath(__DIR__.'/../'.constant('TEST_CFGDIR'));
+		$this->dotEnv   = (new DotEnv($this->CFG, constant('TEST_ENVFILE')))->load();
+		$this->testuser = (string)$this->dotEnv->get($this->ENV.'_TESTUSER');
+
+		parent::setUp();
+	}
+
+	protected function initOptions():SettingsContainerInterface{
+		return new OAuthOptions([
+			'key'              => $this->dotEnv->get($this->ENV.'_KEY'),
+			'secret'           => $this->dotEnv->get($this->ENV.'_SECRET'),
+			'tokenAutoRefresh' => true,
+		]);
+	}
+
+}

tests/OAuth1APITest.php

@@ -16,7 +16,5 @@
  * @property \chillerlan\OAuth\Core\OAuth1Interface $provider
  */
 abstract class OAuth1APITest extends OAuth1APITestAbstract{
-
-	protected string $CFG = __DIR__.'/../config';
-
+	use APITestTrait;
 }

tests/OAuth1ProviderTest.php

@@ -15,6 +15,4 @@
  */
 abstract class OAuth1ProviderTest extends OAuth1ProviderTestAbstract{
 
-	protected string $CFG = __DIR__.'/../config';
-
 }

tests/OAuth2APITest.php

@@ -16,7 +16,5 @@
  * @property \chillerlan\OAuth\Core\OAuth2Interface $provider
  */
 abstract class OAuth2APITest extends OAuth2APITestAbstract{
-
-	protected string $CFG = __DIR__.'/../config';
-
+	use APITestTrait;
 }

tests/OAuth2ProviderTest.php

@@ -15,6 +15,4 @@
  */
 abstract class OAuth2ProviderTest extends OAuth2ProviderTestAbstract{
 
-	protected string $CFG = __DIR__.'/../config';
-
 }

tests/OAuthAPITest.php

@@ -16,7 +16,5 @@
  * @property \chillerlan\OAuth\Core\OAuthInterface $provider
  */
 abstract class OAuthAPITest extends OAuthAPITestAbstract{
-
-	protected string $CFG = __DIR__.'/../config';
-
+	use APITestTrait;
 }

tests/OAuthProviderTest.php

@@ -15,6 +15,4 @@
  */
 abstract class OAuthProviderTest extends OAuthProviderTestAbstract{
 
-	protected string $CFG = __DIR__.'/../config';
-
 }