test: Extend the type checking of the ops-scenario tests

pyproject.toml

@@ -254,8 +254,28 @@ convention = "google"
 builtins-ignorelist = ["id", "min", "map", "range", "type", "TimeoutError", "ConnectionError", "Warning", "input", "format"]
 
 [tool.pyright]
-include = ["ops/*.py", "ops/_private/*.py", "test/*.py", "test/charms/*/src/*.py", "testing/src/*.py"]
-exclude = ["tracing/*"]
+include = ["ops/*.py", "ops/_private/*.py", "test/*.py", "test/charms/*/src/*.py", "testing/src/*.py", "testing/tests/*.py", "testing/tests/test_e2e/*.py"]
+exclude = [
+    "tracing/*",
+    "testing/tests/helpers.py",
+    "testing/tests/test_charm_spec_autoload.py",
+    "testing/tests/test_consistency_checker.py",
+    "testing/tests/test_context_on.py",
+    "testing/tests/test_context.py",
+    "testing/tests/test_emitted_events_util.py",
+    "testing/tests/test_plugin.py",
+    "testing/tests/test_runtime.py",
+    "testing/tests/test_e2e/test_secrets.py",
+    "testing/tests/test_e2e/test_relations.py",
+    "testing/tests/test_e2e/test_trace_data.py",
+    "testing/tests/test_e2e/test_juju_log.py",
+    "testing/tests/test_e2e/test_status.py",
+    "testing/tests/test_e2e/test_storage.py",
+    "testing/tests/test_e2e/test_manager.py",
+    "testing/tests/test_e2e/test_ports.py",
+    "testing/tests/test_e2e/test_rubbish_events.py",
+    "testing/tests/test_e2e/test_pebble.py",
+]
 extraPaths = ["testing", "tracing"]
 pythonVersion = "3.10" # check no python > 3.10 features are used
 pythonPlatform = "All"

testing/tests/helpers.py

@@ -60,7 +60,7 @@ def trigger(
     return state_out
 
 
-def jsonpatch_delta(self, other: State):
+def jsonpatch_delta(self: State, other: State) -> list[dict[str, Any]]:
     dict_other = dataclasses.asdict(other)
     dict_self = dataclasses.asdict(self)
     for attr in (
@@ -79,5 +79,8 @@ def jsonpatch_delta(self, other: State):
     return sort_patch(patch)
 
 
-def sort_patch(patch: list[dict], key=lambda obj: obj['path'] + obj['op']):
+def sort_patch(
+    patch: list[dict[str, Any]],
+    key: Callable[[dict[str, Any]], str] = lambda obj: obj['path'] + obj['op'],
+) -> list[dict[str, Any]]:
     return sorted(patch, key=key)

testing/tests/test_e2e/test_actions.py

@@ -3,6 +3,8 @@
 
 from __future__ import annotations
 
+from typing import Any
+
 import pytest
 from scenario import Context
 from scenario.state import State, _Action, _next_action_id
@@ -13,7 +15,7 @@
 
 
 @pytest.fixture(scope='function')
-def mycharm():
+def mycharm() -> type[CharmBase]:
     class MyCharm(CharmBase):
         _evt_handler = None
 
@@ -22,16 +24,16 @@ def __init__(self, framework: Framework):
             for evt in self.on.events().values():
                 self.framework.observe(evt, self._on_event)
 
-        def _on_event(self, event):
+        def _on_event(self, event: ActionEvent):
             if handler := self._evt_handler:
                 handler(event)
 
     return MyCharm
 
 
 @pytest.mark.parametrize('baz_value', (True, False))
-def test_action_event(mycharm, baz_value):
-    ctx = Context(
+def test_action_event(mycharm: type[CharmBase], baz_value: bool):
+    ctx: Context[CharmBase] = Context(
         mycharm,
         meta={'name': 'foo'},
         actions={'foo': {'params': {'bar': {'type': 'number'}, 'baz': {'type': 'boolean'}}}},
@@ -47,11 +49,11 @@ def test_action_event(mycharm, baz_value):
 
 def test_action_no_results():
     class MyCharm(CharmBase):
-        def __init__(self, framework):
+        def __init__(self, framework: Framework):
             super().__init__(framework)
             framework.observe(self.on.act_action, self._on_act_action)
 
-        def _on_act_action(self, _):
+        def _on_act_action(self, _: ActionEvent):
             pass
 
     ctx = Context(MyCharm, meta={'name': 'foo'}, actions={'act': {}})
@@ -61,27 +63,27 @@ def _on_act_action(self, _):
 
 
 @pytest.mark.parametrize('res_value', ('one', 1, [2], ['bar'], (1,), {1, 2}))
-def test_action_event_results_invalid(mycharm, res_value):
+def test_action_event_results_invalid(mycharm: type[CharmBase], res_value: object):
     def handle_evt(charm: CharmBase, evt: ActionEvent):
         with pytest.raises((TypeError, AttributeError)):
-            evt.set_results(res_value)
+            evt.set_results(res_value)  # type: ignore
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     ctx.run(ctx.on.action('foo'), State())
 
 
 @pytest.mark.parametrize('res_value', ({'a': {'b': {'c'}}}, {'d': 'e'}))
-def test_action_event_results_valid(mycharm, res_value):
-    def handle_evt(_: CharmBase, evt):
+def test_action_event_results_valid(mycharm: type[CharmBase], res_value: dict[str, Any]):
+    def handle_evt(_: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
         evt.set_results(res_value)
         evt.log('foo')
         evt.log('bar')
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
 
@@ -91,7 +93,7 @@ def handle_evt(_: CharmBase, evt):
 
 
 @pytest.mark.parametrize('res_value', ({'a': {'b': {'c'}}}, {'d': 'e'}))
-def test_action_event_outputs(mycharm, res_value):
+def test_action_event_outputs(mycharm: type[CharmBase], res_value: dict[str, Any]):
     def handle_evt(_: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
@@ -101,7 +103,7 @@ def handle_evt(_: CharmBase, evt: ActionEvent):
         evt.log('log2')
         evt.fail('failed becozz')
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     with pytest.raises(ActionFailed) as exc_info:
@@ -111,27 +113,27 @@ def handle_evt(_: CharmBase, evt: ActionEvent):
     assert ctx.action_logs == ['log1', 'log2']
 
 
-def test_action_event_fail(mycharm):
+def test_action_event_fail(mycharm: type[CharmBase]):
     def handle_evt(_: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
         evt.fail('action failed!')
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     with pytest.raises(ActionFailed) as exc_info:
         ctx.run(ctx.on.action('foo'), State())
     assert exc_info.value.message == 'action failed!'
 
 
-def test_action_event_fail_context_manager(mycharm):
+def test_action_event_fail_context_manager(mycharm: type[CharmBase]):
     def handle_evt(_: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
         evt.fail('action failed!')
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     with pytest.raises(ActionFailed) as exc_info:
@@ -142,11 +144,11 @@ def handle_evt(_: CharmBase, evt: ActionEvent):
 
 def test_action_continues_after_fail():
     class MyCharm(CharmBase):
-        def __init__(self, framework):
+        def __init__(self, framework: Framework):
             super().__init__(framework)
             framework.observe(self.on.foo_action, self._on_foo_action)
 
-        def _on_foo_action(self, event):
+        def _on_foo_action(self, event: ActionEvent):
             event.log('starting')
             event.set_results({'initial': 'result'})
             event.fail('oh no!')
@@ -160,44 +162,44 @@ def _on_foo_action(self, event):
     assert ctx.action_results == {'initial': 'result', 'final': 'result'}
 
 
-def test_action_event_has_id(mycharm):
+def test_action_event_has_id(mycharm: type[CharmBase]):
     def handle_evt(_: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
         assert isinstance(evt.id, str) and evt.id != ''
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     ctx.run(ctx.on.action('foo'), State())
 
 
-def test_action_event_has_override_id(mycharm):
+def test_action_event_has_override_id(mycharm: type[CharmBase]):
     uuid = '0ddba11-cafe-ba1d-5a1e-dec0debad'
 
     def handle_evt(charm: CharmBase, evt: ActionEvent):
         if not isinstance(evt, ActionEvent):
             return
         assert evt.id == uuid
 
-    mycharm._evt_handler = handle_evt
+    mycharm._evt_handler = handle_evt  # type: ignore
 
     ctx = Context(mycharm, meta={'name': 'foo'}, actions={'foo': {}})
     ctx.run(ctx.on.action('foo', id=uuid), State())
 
 
 def test_two_actions_same_context():
     class MyCharm(CharmBase):
-        def __init__(self, framework):
+        def __init__(self, framework: Framework):
             super().__init__(framework)
             framework.observe(self.on.foo_action, self._on_foo_action)
             framework.observe(self.on.bar_action, self._on_bar_action)
 
-        def _on_foo_action(self, event):
+        def _on_foo_action(self, event: ActionEvent):
             event.log('foo')
             event.set_results({'foo': 'result'})
 
-        def _on_bar_action(self, event):
+        def _on_bar_action(self, event: ActionEvent):
             event.log('bar')
             event.set_results({'bar': 'result'})
 
@@ -213,7 +215,7 @@ def _on_bar_action(self, event):
 
 def test_positional_arguments():
     with pytest.raises(TypeError):
-        _Action('foo', {})
+        _Action('foo', {})  # type: ignore
 
 
 def test_default_arguments():

testing/tests/test_e2e/test_cloud_spec.py

@@ -15,7 +15,7 @@ def __init__(self, framework: ops.Framework):
         for evt in self.on.events().values():
             self.framework.observe(evt, self._on_event)
 
-    def _on_event(self, event):
+    def _on_event(self, event: ops.EventBase):
         pass
 
 

testing/tests/test_e2e/test_config.py

@@ -3,31 +3,32 @@
 
 from __future__ import annotations
 
+from typing import Any
+
 import pytest
 from scenario.state import State
 
-from ops.charm import CharmBase
-from ops.framework import Framework
+import ops
 
 from ..helpers import trigger
 
 
 @pytest.fixture(scope='function')
-def mycharm():
-    class MyCharm(CharmBase):
-        def __init__(self, framework: Framework):
+def mycharm() -> type[ops.CharmBase]:
+    class MyCharm(ops.CharmBase):
+        def __init__(self, framework: ops.Framework):
             super().__init__(framework)
             for evt in self.on.events().values():
                 self.framework.observe(evt, self._on_event)
 
-        def _on_event(self, event):
+        def _on_event(self, event: ops.EventBase):
             pass
 
     return MyCharm
 
 
-def test_config_get(mycharm):
-    def check_cfg(charm: CharmBase):
+def test_config_get(mycharm: type[ops.CharmBase]):
+    def check_cfg(charm: ops.CharmBase):
         assert charm.config['foo'] == 'bar'
         assert charm.config['baz'] == 1
 
@@ -43,8 +44,8 @@ def check_cfg(charm: CharmBase):
     )
 
 
-def test_config_get_default_from_meta(mycharm):
-    def check_cfg(charm: CharmBase):
+def test_config_get_default_from_meta(mycharm: type[ops.CharmBase]):
+    def check_cfg(charm: ops.CharmBase):
         assert charm.config['foo'] == 'bar'
         assert charm.config['baz'] == 2
         assert charm.config['qux'] is False
@@ -75,18 +76,18 @@ def check_cfg(charm: CharmBase):
         {'baz': 4, 'foo': 'bar', 'qux': True},
     ),
 )
-def test_config_in_not_mutated(mycharm, cfg_in):
-    class MyCharm(CharmBase):
-        def __init__(self, framework: Framework):
+def test_config_in_not_mutated(mycharm: type[ops.CharmBase], cfg_in: dict[str, Any]):
+    class MyCharm(ops.CharmBase):
+        def __init__(self, framework: ops.Framework):
             super().__init__(framework)
             for evt in self.on.events().values():
                 self.framework.observe(evt, self._on_event)
 
-        def _on_event(self, event):
+        def _on_event(self, event: ops.EventBase):
             # access the config to trigger a config-get
-            foo_cfg = self.config['foo']  # noqa: F841
-            baz_cfg = self.config['baz']  # noqa: F841
-            qux_cfg = self.config['qux']  # noqa: F841
+            _foo_cfg = self.config['foo']
+            _baz_cfg = self.config['baz']
+            _qux_cfg = self.config['qux']
 
     state_out = trigger(
         State(