GeneratorPluginSystemTest.php 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <?php
  2. namespace Knuckles\Scribe\Tests\Unit;
  3. use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
  4. use Illuminate\Routing\Route;
  5. use Knuckles\Scribe\Extracting\Generator;
  6. use Knuckles\Scribe\Extracting\Strategies\Strategy;
  7. use Knuckles\Scribe\ScribeServiceProvider;
  8. use Knuckles\Scribe\Tests\Fixtures\TestController;
  9. use Knuckles\Scribe\Tools\DocumentationConfig;
  10. use PHPUnit\Framework\TestCase;
  11. use ReflectionClass;
  12. use ReflectionFunctionAbstract;
  13. class GeneratorPluginSystemTest extends TestCase
  14. {
  15. use ArraySubsetAsserts;
  16. /**
  17. * @var \Knuckles\Scribe\Extracting\Generator
  18. */
  19. protected $generator;
  20. protected function getPackageProviders($app)
  21. {
  22. $providers = [
  23. ScribeServiceProvider::class,
  24. ];
  25. if (class_exists(\Dingo\Api\Provider\LaravelServiceProvider::class)) {
  26. $providers[] = \Dingo\Api\Provider\LaravelServiceProvider::class;
  27. }
  28. return $providers;
  29. }
  30. protected function tearDown(): void
  31. {
  32. EmptyStrategy1::$called = false;
  33. EmptyStrategy2::$called = false;
  34. NotDummyMetadataStrategy::$called = false;
  35. parent::tearDown();
  36. }
  37. /** @test */
  38. public function only_specified_strategies_are_loaded()
  39. {
  40. $config = [
  41. 'strategies' => [
  42. 'metadata' => [NotDummyMetadataStrategy::class],
  43. 'bodyParameters' => [
  44. EmptyStrategy1::class,
  45. ],
  46. ],
  47. ];
  48. $route = $this->createRoute('GET', '/api/test', 'dummy', true, TestController::class);
  49. $generator = new Generator(new DocumentationConfig($config));
  50. $generator->processRoute($route);
  51. $this->assertTrue(EmptyStrategy1::$called);
  52. $this->assertTrue(NotDummyMetadataStrategy::$called);
  53. $this->assertFalse(EmptyStrategy2::$called);
  54. }
  55. /** @test */
  56. public function responses_from_different_strategies_get_added()
  57. {
  58. $config = [
  59. 'strategies' => [
  60. 'responses' => [DummyResponseStrategy200::class, DummyResponseStrategy400::class],
  61. ],
  62. ];
  63. $route = $this->createRoute('GET', '/api/test', 'dummy', true, TestController::class);
  64. $generator = new Generator(new DocumentationConfig($config));
  65. $parsed = $generator->processRoute($route);
  66. $this->assertTrue($parsed['showresponse']);
  67. $this->assertCount(2, $parsed['responses']);
  68. $first = array_shift($parsed['responses']);
  69. $this->assertTrue(is_array($first));
  70. $this->assertEquals(200, $first['status']);
  71. $this->assertEquals('dummy', $first['content']);
  72. $second = array_shift($parsed['responses']);
  73. $this->assertTrue(is_array($second));
  74. $this->assertEquals(400, $second['status']);
  75. $this->assertEquals('dummy2', $second['content']);
  76. }
  77. /**
  78. * @test
  79. * This is a generalized test, as opposed to the one above for responses only
  80. */
  81. public function combines_results_from_different_strategies_in_same_stage()
  82. {
  83. $config = [
  84. 'strategies' => [
  85. 'metadata' => [PartialDummyMetadataStrategy1::class, PartialDummyMetadataStrategy2::class],
  86. ],
  87. ];
  88. $route = $this->createRoute('GET', '/api/test', 'dummy', true, TestController::class);
  89. $generator = new Generator(new DocumentationConfig($config));
  90. $parsed = $generator->processRoute($route);
  91. $expectedMetadata = [
  92. 'groupName' => 'dummy',
  93. 'groupDescription' => 'dummy',
  94. 'title' => 'dummy',
  95. 'description' => 'dummy',
  96. 'authenticated' => false,
  97. ];
  98. $this->assertArraySubset($expectedMetadata, $parsed['metadata']);
  99. }
  100. /** @test */
  101. public function missing_metadata_is_filled_in()
  102. {
  103. $config = [
  104. 'strategies' => [
  105. 'metadata' => [PartialDummyMetadataStrategy2::class],
  106. ],
  107. ];
  108. $route = $this->createRoute('GET', '/api/test', 'dummy', true, TestController::class);
  109. $generator = new Generator(new DocumentationConfig($config));
  110. $parsed = $generator->processRoute($route);
  111. $expectedMetadata = [
  112. 'groupName' => '',
  113. 'groupDescription' => 'dummy',
  114. 'title' => '',
  115. 'description' => 'dummy',
  116. 'authenticated' => false,
  117. ];
  118. $this->assertArraySubset($expectedMetadata, $parsed['metadata']);
  119. }
  120. /** @test */
  121. public function overwrites_metadata_from_previous_strategies_in_same_stage()
  122. {
  123. $config = [
  124. 'strategies' => [
  125. 'metadata' => [NotDummyMetadataStrategy::class, PartialDummyMetadataStrategy1::class],
  126. ],
  127. ];
  128. $route = $this->createRoute('GET', '/api/test', 'dummy', true, TestController::class);
  129. $generator = new Generator(new DocumentationConfig($config));
  130. $parsed = $generator->processRoute($route);
  131. $expectedMetadata = [
  132. 'groupName' => 'dummy',
  133. 'groupDescription' => 'notdummy',
  134. 'title' => 'dummy',
  135. 'description' => 'dummy',
  136. 'authenticated' => false,
  137. ];
  138. $this->assertArraySubset($expectedMetadata, $parsed['metadata']);
  139. }
  140. public function createRoute(string $httpMethod, string $path, string $controllerMethod, $register = false, $class = TestController::class)
  141. {
  142. return new Route([$httpMethod], $path, ['uses' => $class . "@$controllerMethod"]);
  143. }
  144. }
  145. class EmptyStrategy1 extends Strategy
  146. {
  147. public static $called = false;
  148. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  149. {
  150. static::$called = true;
  151. }
  152. }
  153. class EmptyStrategy2 extends Strategy
  154. {
  155. public static $called = false;
  156. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  157. {
  158. static::$called = true;
  159. }
  160. }
  161. class NotDummyMetadataStrategy extends Strategy
  162. {
  163. public static $called = false;
  164. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  165. {
  166. static::$called = true;
  167. return [
  168. 'groupName' => 'notdummy',
  169. 'groupDescription' => 'notdummy',
  170. 'title' => 'notdummy',
  171. 'description' => 'notdummy',
  172. 'authenticated' => true,
  173. ];
  174. }
  175. }
  176. class PartialDummyMetadataStrategy1 extends Strategy
  177. {
  178. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  179. {
  180. return [
  181. 'groupName' => 'dummy',
  182. 'title' => 'dummy',
  183. 'description' => 'dummy',
  184. 'authenticated' => false,
  185. ];
  186. }
  187. }
  188. class PartialDummyMetadataStrategy2 extends Strategy
  189. {
  190. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  191. {
  192. return [
  193. 'description' => 'dummy',
  194. 'groupDescription' => 'dummy',
  195. ];
  196. }
  197. }
  198. class DummyResponseStrategy200 extends Strategy
  199. {
  200. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  201. {
  202. return [['status' => 200, 'content' => 'dummy']];
  203. }
  204. }
  205. class DummyResponseStrategy400 extends Strategy
  206. {
  207. public function __invoke(Route $route, ReflectionClass $controller, ReflectionFunctionAbstract $method, array $routeRules, array $alreadyExtractedData = [])
  208. {
  209. return [['status' => 400, 'content' => 'dummy2']];
  210. }
  211. }