Merge pull request #10 from julienloizelet/fix/no-scenarios-should-th…

…row-exception

fix(watcher): Missing scenarios key in config should throw an exception

CHANGELOG.md

@@ -5,6 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+
+## [0.2.0](https://github.com/crowdsecurity/php-capi-client/releases/tag/v0.2.0) - 2022-10-28
+[_Compare with previous release_](https://github.com/crowdsecurity/php-capi-client/compare/v0.1.0...v0.2.0)
+
+### Changed
+- *Breaking change*: Missing `scenarios` key in `configs` will throw an exception
+
+---
+
 ## [0.1.0](https://github.com/crowdsecurity/php-capi-client/releases/tag/v0.1.0) - 2022-10-21
 [_Compare with previous release_](https://github.com/crowdsecurity/php-capi-client/compare/v0.0.1...v0.1.0)
 

src/Configuration.php

@@ -59,7 +59,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->thenInvalid('Invalid user agent suffix. Length must be <= 16. Allowed chars are A-Za-z0-9')
                 ->end()
             ->end()
-            ->arrayNode('scenarios')->cannotBeEmpty()
+            ->arrayNode('scenarios')->isRequired()->cannotBeEmpty()
                 ->validate()
                 ->ifArray()
                 ->then(function (array $value) {

src/Constants.php

@@ -39,5 +39,5 @@ class Constants
     /**
      * @var string The current version of this library
      */
-    public const VERSION = 'v0.1.0';
+    public const VERSION = 'v0.2.0';
 }

tests/Unit/CurlTest.php

@@ -222,7 +222,7 @@ public function testOptions()
         $url = Constants::URL_DEV . 'watchers';
         $method = 'POST';
         $parameters = ['machine_id' => 'test', 'password' => 'test'];
-        $configs = [];
+        $configs = ['scenarios' => TestConstants::SCENARIOS];
 
         $client = new Watcher($configs, new FileStorage());
         $curlRequester = $client->getRequestHandler();

tests/Unit/WatcherTest.php

@@ -356,6 +356,20 @@ public function testConfigure()
             'Scenarios should be indexed array'
         );
 
+        $error = '';
+        try {
+            new Watcher([], new FileStorage());
+        } catch (Exception $e) {
+            $error = $e->getMessage();
+        }
+
+        PHPUnitUtil::assertRegExp(
+            $this,
+            '/The child config "scenarios" under "config" must be configured./',
+            $error,
+            'Scenarios key must be in configs'
+        );
+
         $error = '';
         try {
             new Watcher(['scenarios' => []], new FileStorage());
@@ -412,7 +426,7 @@ public function testConfigure()
             'machine_id_prefix should contain allowed chars'
         );
 
-        $client = new Watcher(['machine_id_prefix' => ''], new FileStorage());
+        $client = new Watcher(['scenarios' => TestConstants::SCENARIOS, 'machine_id_prefix' => ''], new FileStorage());
 
         $this->assertEquals(
             '',
@@ -448,7 +462,7 @@ public function testConfigure()
             'user_agent_suffix should contain allowed chars'
         );
 
-        $client = new Watcher(['user_agent_suffix' => ''], new FileStorage());
+        $client = new Watcher(['scenarios' => TestConstants::SCENARIOS, 'user_agent_suffix' => ''], new FileStorage());
 
         $this->assertEquals(
             '',