Give the possibility to disable a task without removing it (#3417)

* Give the possiblity to disable a task in config without removing it from the config file

* Put exmple only in nickname task

* Add Unit testing

* typo

* Use enabled false as exemple

configs/config.json.example

@@ -21,6 +21,13 @@
       {
         "type": "TransferPokemon"
       },
+      {
+        "type": "NicknamePokemon",
+        "config": {
+          "enabled": false,
+          "nickname_template": "{iv_pct}_{iv_ads}"
+        }
+      },
       {
         "type": "EvolvePokemon",
         "config": {

pokemongo_bot/base_task.py

@@ -9,6 +9,7 @@ def __init__(self, bot, config):
     self.config = config
     self._validate_work_exists()
     self.logger = logging.getLogger(type(self).__name__)
+    self.enabled = config.get('enabled', True)
     self.initialize()
 
   def _validate_work_exists(self):

pokemongo_bot/tree_config_builder.py

@@ -61,7 +61,8 @@ def build(self):
                 )
 
             instance = worker(self.bot, task_config)
-            workers.append(instance)
+            if instance.enabled:
+                workers.append(instance)
 
         return workers
 

tests/tree_config_builder_test.py

@@ -86,6 +86,25 @@ def test_task_with_config(self):
         tree = builder.build()
         self.assertTrue(tree[0].config.get('longer_eggs_first', False))
 
+    def test_disabling_task(self):
+        obj = convert_from_json("""[{
+                "type": "HandleSoftBan",
+                "config": {
+                    "enabled": false
+                }
+            }, {
+                "type": "CatchLuredPokemon",
+                "config": {
+                    "enabled": true
+                }
+            }]""")
+
+        builder = TreeConfigBuilder(self.bot, obj)
+        tree = builder.build()
+
+        self.assertTrue(len(tree) == 1)
+        self.assertIsInstance(tree[0], CatchLuredPokemon)
+
     def test_load_plugin_task(self):
         package_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'resources', 'plugin_fixture')
         plugin_loader = PluginLoader()