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

pyproject.toml

@@ -254,8 +254,31 @@ 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_network.py",
+    "testing/tests/test_e2e/test_cloud_spec.py",
+    "testing/tests/test_e2e/test_play_assertions.py",
+    "testing/tests/test_e2e/test_vroot.py",
+    "testing/tests/test_e2e/__init__.py",
+    "testing/tests/test_e2e/test_resource.py",
+    "testing/tests/test_e2e/test_state.py",
+    "testing/tests/test_e2e/test_actions.py",
+    "testing/tests/test_e2e/test_config.py",
+    "testing/tests/test_e2e/test_event.py",
+    "testing/tests/test_e2e/test_deferred.py",
+    "testing/tests/test_e2e/test_stored_state.py",
+    "testing/tests/test_e2e/conftest.py",
+]
 extraPaths = ["testing", "tracing"]
 pythonVersion = "3.10" # check no python > 3.10 features are used
 pythonPlatform = "All"

testing/src/scenario/state.py

@@ -1139,7 +1139,7 @@ def services(self) -> dict[str, pebble.ServiceInfo]:
             infos[name] = info
         return infos
 
-    def get_filesystem(self, ctx: Context) -> pathlib.Path:
+    def get_filesystem(self, ctx: Context[CharmBase]) -> pathlib.Path:
         """Simulated Pebble filesystem in this context.
 
         Returns:

testing/tests/test_e2e/test_juju_log.py

@@ -11,31 +11,31 @@
 from scenario import Context
 from scenario.state import JujuLogLine, State
 
-from ops.charm import CharmBase, CollectStatusEvent
+import ops
 
 logger = logging.getLogger('testing logger')
 
 
 @pytest.fixture(scope='function')
 def mycharm():
-    class MyCharm(CharmBase):
+    class MyCharm(ops.CharmBase):
         META: Mapping[str, Any] = {'name': 'mycharm'}
 
-        def __init__(self, framework):
+        def __init__(self, framework: ops.Framework):
             super().__init__(framework)
             for evt in self.on.events().values():
-                self.framework.observe(evt, self._on_event)
+                framework.observe(evt, self._on_event)
 
-        def _on_event(self, event):
-            if isinstance(event, CollectStatusEvent):
+        def _on_event(self, event: ops.EventBase):
+            if isinstance(event, ops.CollectStatusEvent):
                 return
             print('foo!')
             logger.warning('bar!')
 
     return MyCharm
 
 
-def test_juju_log(mycharm):
+def test_juju_log(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META)
     ctx.run(ctx.on.start(), State())
     assert JujuLogLine(level='DEBUG', message='Emitting Juju event start.') in ctx.juju_log

testing/tests/test_e2e/test_manager.py

@@ -8,33 +8,33 @@
 
 import pytest
 from scenario import Context, State
-from scenario.context import AlreadyEmittedError, Manager
+from scenario.context import Manager
+from scenario.errors import AlreadyEmittedError
 
-from ops import ActiveStatus
-from ops.charm import CharmBase, CollectStatusEvent
+import ops
 
 
 @pytest.fixture(scope='function')
 def mycharm():
-    class MyCharm(CharmBase):
+    class MyCharm(ops.CharmBase):
         META: Mapping[str, Any] = {'name': 'mycharm'}
         ACTIONS: Mapping[str, Any] = {'do-x': {}}
 
-        def __init__(self, framework):
+        def __init__(self, framework: ops.Framework):
             super().__init__(framework)
             for evt in self.on.events().values():
-                self.framework.observe(evt, self._on_event)
+                framework.observe(evt, self._on_event)
 
-        def _on_event(self, e):
-            if isinstance(e, CollectStatusEvent):
+        def _on_event(self, e: ops.EventBase):
+            if isinstance(e, ops.CollectStatusEvent):
                 return
 
-            self.unit.status = ActiveStatus(e.handle.kind)
+            self.unit.status = ops.ActiveStatus(e.handle.kind)
 
     return MyCharm
 
 
-def test_manager(mycharm):
+def test_manager(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META)
     with Manager(ctx, ctx.on.start(), State()) as manager:
         assert isinstance(manager.charm, mycharm)
@@ -43,7 +43,7 @@ def test_manager(mycharm):
     assert isinstance(state_out, State)
 
 
-def test_manager_implicit(mycharm):
+def test_manager_implicit(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META)
     with Manager(ctx, ctx.on.start(), State()) as manager:
         assert isinstance(manager.charm, mycharm)
@@ -53,23 +53,23 @@ def test_manager_implicit(mycharm):
     assert manager._emitted
 
 
-def test_manager_reemit_fails(mycharm):
+def test_manager_reemit_fails(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META)
     with Manager(ctx, ctx.on.start(), State()) as manager:
         manager.run()
         with pytest.raises(AlreadyEmittedError):
             manager.run()
 
 
-def test_context_manager(mycharm):
+def test_context_manager(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META)
     with ctx(ctx.on.start(), State()) as manager:
         state_out = manager.run()
         assert isinstance(state_out, State)
     assert ctx.emitted_events[0].handle.kind == 'start'
 
 
-def test_context_action_manager(mycharm):
+def test_context_action_manager(mycharm: Any):
     ctx = Context(mycharm, meta=mycharm.META, actions=mycharm.ACTIONS)
     with ctx(ctx.on.action('do-x'), State()) as manager:
         state_out = manager.run()