Providing an error if tasks don't work for the given api (#2732)

pokemongo_bot/__init__.py

@@ -27,7 +27,7 @@
 from pokemongo_bot.socketio_server.runner import SocketIoRunner
 from pokemongo_bot.websocket_remote_control import WebsocketRemoteControl
 from worker_result import WorkerResult
-from tree_config_builder import ConfigException, TreeConfigBuilder
+from tree_config_builder import ConfigException, MismatchTaskApiVersion, TreeConfigBuilder
 
 
 class PokemonGoBot(object):

pokemongo_bot/base_task.py

@@ -2,6 +2,7 @@
 
 
 class BaseTask(object):
+  TASK_API_VERSION = 1
 
   def __init__(self, bot, config):
     self.bot = bot

pokemongo_bot/cell_workers/catch_lured_pokemon.py

@@ -7,6 +7,8 @@
 
 
 class CatchLuredPokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def work(self):
         lured_pokemon = self.get_lured_pokemon()
         if lured_pokemon:

pokemongo_bot/cell_workers/catch_visible_pokemon.py

@@ -6,6 +6,8 @@
 
 
 class CatchVisiblePokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def work(self):
         if 'catchable_pokemons' in self.bot.cell and len(self.bot.cell['catchable_pokemons']) > 0:
             # Sort all by distance from current pos- eventually this should

pokemongo_bot/cell_workers/collect_level_up_reward.py

@@ -2,6 +2,8 @@
 
 
 class CollectLevelUpReward(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     current_level = 0
     previous_level = 0
 

pokemongo_bot/cell_workers/evolve_pokemon.py

@@ -4,6 +4,7 @@
 
 
 class EvolvePokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
 
     def initialize(self):
         self.api = self.bot.api

pokemongo_bot/cell_workers/follow_cluster.py

@@ -4,6 +4,7 @@
 from pokemongo_bot.base_task import BaseTask
 
 class FollowCluster(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
 
     def initialize(self):
         self.is_at_destination = False

pokemongo_bot/cell_workers/follow_path.py

@@ -11,6 +11,8 @@
 
 
 class FollowPath(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def initialize(self):
         self.ptr = 0
         self._process_config()

pokemongo_bot/cell_workers/follow_spiral.py

@@ -8,6 +8,8 @@
 from pokemongo_bot.base_task import BaseTask
 
 class FollowSpiral(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def initialize(self):
         self.steplimit = self.config.get("diameter", 4)
         self.step_size = self.config.get("step_size", 70)

pokemongo_bot/cell_workers/handle_soft_ban.py

@@ -10,6 +10,8 @@
 
 
 class HandleSoftBan(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def work(self):
         if not self.should_run():
             return

pokemongo_bot/cell_workers/incubate_eggs.py

@@ -3,6 +3,8 @@
 
 
 class IncubateEggs(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     last_km_walked = 0
 
     def initialize(self):

pokemongo_bot/cell_workers/move_to_fort.py

@@ -9,6 +9,7 @@
 
 
 class MoveToFort(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
 
     def initialize(self):
         self.lure_distance = 0

pokemongo_bot/cell_workers/move_to_map_pokemon.py

@@ -14,6 +14,8 @@
 
 
 class MoveToMapPokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def initialize(self):
         self.last_map_update = 0
         self.pokemon_data = self.bot.pokemon_list

pokemongo_bot/cell_workers/nickname_pokemon.py

@@ -2,6 +2,8 @@
 from pokemongo_bot.base_task import BaseTask
 
 class NicknamePokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def initialize(self):
         self.template = self.config.get('nickname_template','').lower().strip()
         if self.template == "{name}":

pokemongo_bot/cell_workers/recycle_items.py

@@ -4,6 +4,8 @@
 from pokemongo_bot.tree_config_builder import ConfigException
 
 class RecycleItems(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def initialize(self):
         self.item_filter = self.config.get('item_filter', {})
         self._validate_item_filter()

pokemongo_bot/cell_workers/sleep_schedule.py

@@ -27,6 +27,7 @@ class SleepSchedule(BaseTask):
     duration_random_offset: (HH:MM) random offset of duration of sleep
                         for this example the possible duration is 5:00-6:00
     """
+    SUPPORTED_TASK_API_VERSION = 1
 
     LOG_INTERVAL_SECONDS = 600
     SCHEDULING_MARGIN = timedelta(minutes=10)    # Skip if next sleep is RESCHEDULING_MARGIN from now

pokemongo_bot/cell_workers/spin_fort.py

@@ -13,6 +13,8 @@
 
 
 class SpinFort(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def should_run(self):
         if not self.bot.has_space_for_loot():
             self.emit_event(

pokemongo_bot/cell_workers/transfer_pokemon.py

@@ -5,6 +5,8 @@
 
 
 class TransferPokemon(BaseTask):
+    SUPPORTED_TASK_API_VERSION = 1
+
     def work(self):
         pokemon_groups = self._release_pokemon_get_groups()
         for pokemon_id in pokemon_groups:

pokemongo_bot/cell_workers/update_title_stats.py

@@ -49,6 +49,7 @@ class UpdateTitleStats(BaseTask):
     stats : An array of stats to display and their display order (implicitly),
             see available stats above.
     """
+    SUPPORTED_TASK_API_VERSION = 1
 
     DEFAULT_MIN_INTERVAL = 10
     DEFAULT_DISPLAYED_STATS = []

pokemongo_bot/test/resources/plugin_fixture/__init__.py

@@ -1 +1,2 @@
 from fake_task import FakeTask
+from unsupported_api_task import UnsupportedApiTask

pokemongo_bot/test/resources/plugin_fixture/fake_task.py

@@ -1,5 +1,7 @@
 from pokemongo_bot.base_task import BaseTask
 
 class FakeTask(BaseTask):
+  SUPPORTED_TASK_API_VERSION = 1
+
   def work(self):
     return 'FakeTask'

pokemongo_bot/test/resources/plugin_fixture/unsupported_api_task.py

@@ -0,0 +1,7 @@
+from pokemongo_bot.base_task import BaseTask
+
+class UnsupportedApiTask(BaseTask):
+  SUPPORTED_TASK_API_VERSION = 2
+
+  def work():
+    return 2

pokemongo_bot/tree_config_builder.py

@@ -1,9 +1,13 @@
 import cell_workers
 from pokemongo_bot.plugin_loader import PluginLoader
+from pokemongo_bot.base_task import BaseTask
 
 class ConfigException(Exception):
     pass
 
+class MismatchTaskApiVersion(Exception):
+    pass
+
 class TreeConfigBuilder(object):
     def __init__(self, bot, tasks_raw):
         self.bot = bot
@@ -38,6 +42,24 @@ def build(self):
             else:
                 worker = self._get_worker_by_name(task_type)
 
+            error_string = ''
+            if BaseTask.TASK_API_VERSION < worker.SUPPORTED_TASK_API_VERSION:
+                error_string = 'Do you need to update the bot?'
+
+            elif BaseTask.TASK_API_VERSION > worker.SUPPORTED_TASK_API_VERSION:
+                error_string = 'Is there a new version of this task?'
+
+            if error_string != '':
+                raise MismatchTaskApiVersion(
+                    'Task {} only works with task api version {}, you are currently running version {}. {}'
+                    .format(
+                        task_type,
+                        worker.SUPPORTED_TASK_API_VERSION,
+                        BaseTask.TASK_API_VERSION,
+                        error_string
+                    )
+                )
+
             instance = worker(self.bot, task_config)
             workers.append(instance)
 

tests/tree_config_builder_test.py

@@ -1,9 +1,9 @@
 import unittest
 import json
 import os
-from pokemongo_bot import PokemonGoBot, ConfigException, TreeConfigBuilder, PluginLoader
+from pokemongo_bot import PokemonGoBot, ConfigException, MismatchTaskApiVersion, TreeConfigBuilder, PluginLoader, BaseTask
 from pokemongo_bot.cell_workers import HandleSoftBan, CatchLuredPokemon
-from pokemongo_bot.test.resources.plugin_fixture import FakeTask
+from pokemongo_bot.test.resources.plugin_fixture import FakeTask, UnsupportedApiTask
 
 def convert_from_json(str):
     return json.loads(str)
@@ -99,3 +99,40 @@ def test_load_plugin_task(self):
         tree = builder.build()
         result = tree[0].work()
         self.assertEqual(result, 'FakeTask')
+
+    def setupUnsupportedBuilder(self):
+        package_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), '..', 'pokemongo_bot', 'test', 'resources', 'plugin_fixture')
+        plugin_loader = PluginLoader()
+        plugin_loader.load_path(package_path)
+
+        obj = convert_from_json("""[{
+            "type": "plugin_fixture.UnsupportedApiTask"
+        }]""")
+
+        return TreeConfigBuilder(self.bot, obj)
+
+    def test_task_version_too_high(self):
+        builder = self.setupUnsupportedBuilder()
+
+        previous_version = BaseTask.TASK_API_VERSION
+        BaseTask.TASK_API_VERSION = 1
+
+        self.assertRaisesRegexp(
+            MismatchTaskApiVersion,
+            "Task plugin_fixture.UnsupportedApiTask only works with task api version 2, you are currently running version 1. Do you need to update the bot?",
+            builder.build)
+
+        BaseTask.TASK_API_VERSION = previous_version
+
+    def test_task_version_too_low(self):
+        builder = self.setupUnsupportedBuilder()
+
+        previous_version = BaseTask.TASK_API_VERSION
+        BaseTask.TASK_API_VERSION = 3
+
+        self.assertRaisesRegexp(
+            MismatchTaskApiVersion,
+            "Task plugin_fixture.UnsupportedApiTask only works with task api version 2, you are currently running version 3. Is there a new version of this task?",
+            builder.build)
+
+        BaseTask.TASK_API_VERSION = previous_version