chore: solve and remove the testing/tests linting ignores

pyproject.toml

@@ -226,21 +226,6 @@ exclude = ["tracing/ops_tracing/vendor/*"]
 "testing/tests/*" = [
     # All documentation linting.
     "D",
-    # TODO: the below ignores should be fixed
-    "CPY",  # flake8-copyright
-    "I001",  # isort
-    "B017",  # Do not assert blind exception
-    "B018",  # Useless attribute access
-    "E501",  # Line too long
-    "N999",  # Invalid module name
-    "N813",  # CamelCase imported as lowercase
-    "S105",  # Possible hardcoded password
-    "S108",  # Probably insecure usage of /tmp
-    "W291",  # Trailing whitespace
-    "UP037",  # Remove quotes from type annotation
-    "RUF012",  # Mutable class attributes should be annotated with `typing.ClassVar`
-    "RUF015",  # Prefer `next` over single element slice
-    "SIM115",  # Use a context manager for opening files
 ]
 "ops/_private/timeconv.py" = [
     "RUF001",  # String contains ambiguous `µ` (MICRO SIGN). Did you mean `μ` (GREEK SMALL LETTER MU)?

testing/tests/__init__.py

@@ -0,0 +1,2 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.

testing/tests/helpers.py

@@ -1,13 +1,15 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import dataclasses
 import logging
+from collections.abc import Callable
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, TypeVar
-from collections.abc import Callable
 
 import jsonpatch
-
 from scenario.context import _DEFAULT_JUJU_VERSION, Context
 from scenario.state import _Event
 
@@ -20,17 +22,17 @@
 
 
 def trigger(
-    state: 'State',
-    event: str | '_Event',
-    charm_type: type['CharmType'],
-    pre_event: Callable[['CharmType'], None] | None = None,
-    post_event: Callable[['CharmType'], None] | None = None,
+    state: State,
+    event: str | _Event,
+    charm_type: type[CharmType],
+    pre_event: Callable[[CharmType], None] | None = None,
+    post_event: Callable[[CharmType], None] | None = None,
     meta: dict[str, Any] | None = None,
     actions: dict[str, Any] | None = None,
     config: dict[str, Any] | None = None,
     charm_root: str | Path | None = None,
     juju_version: str = _DEFAULT_JUJU_VERSION,
-) -> 'State':
+) -> State:
     ctx = Context(
         charm_type=charm_type,
         meta=meta,
@@ -42,10 +44,10 @@ def trigger(
     if isinstance(event, str):
         if event.startswith('relation_'):
             assert len(tuple(state.relations)) == 1, 'shortcut only works with one relation'
-            event = getattr(ctx.on, event)(tuple(state.relations)[0])
+            event = getattr(ctx.on, event)(next(iter(state.relations)))
         elif event.startswith('pebble_'):
             assert len(tuple(state.containers)) == 1, 'shortcut only works with one container'
-            event = getattr(ctx.on, event)(tuple(state.containers)[0])
+            event = getattr(ctx.on, event)(next(iter(state.containers)))
         else:
             event = getattr(ctx.on, event)()
     assert isinstance(event, _Event)
@@ -58,7 +60,7 @@ def trigger(
     return state_out
 
 
-def jsonpatch_delta(self, other: 'State'):
+def jsonpatch_delta(self, other: State):
     dict_other = dataclasses.asdict(other)
     dict_self = dataclasses.asdict(self)
     for attr in (

testing/tests/test_charm_spec_autoload.py

@@ -1,3 +1,6 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import importlib
@@ -7,7 +10,6 @@
 
 import pytest
 import yaml
-
 from scenario import Context, Relation, State
 from scenario.context import ContextSetupError
 from scenario.state import CharmType, MetadataNotFoundError, _CharmSpec

testing/tests/test_consistency_checker.py

@@ -1,10 +1,11 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import dataclasses
 
 import pytest
-import ops
-
 from scenario._consistency_checker import check_consistency
 from scenario.context import Context
 from scenario.errors import InconsistentScenarioError
@@ -29,15 +30,17 @@
     _Event,
 )
 
+import ops
+
 
 class MyCharm(ops.CharmBase):
     pass
 
 
 def assert_inconsistent(
-    state: 'State',
-    event: '_Event',
-    charm_spec: '_CharmSpec',
+    state: State,
+    event: _Event,
+    charm_spec: _CharmSpec,
     juju_version='3.0',
     unit_id=0,
 ):
@@ -46,9 +49,9 @@ def assert_inconsistent(
 
 
 def assert_consistent(
-    state: 'State',
-    event: '_Event',
-    charm_spec: '_CharmSpec',
+    state: State,
+    event: _Event,
+    charm_spec: _CharmSpec,
     juju_version='3.0',
     unit_id=0,
 ):

testing/tests/test_context.py

@@ -1,15 +1,18 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import os
 from unittest.mock import patch
 
 import pytest
-from ops import CharmBase
-
 from scenario import Context, State
 from scenario.errors import UncaughtCharmError
 from scenario.state import _Event, _next_action_id
 
+from ops import CharmBase
+
 
 class MyCharm(CharmBase):
     pass

testing/tests/test_context_on.py

@@ -1,14 +1,16 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import copy
 import datetime
 import typing
 
-import ops
 import pytest
-
 import scenario
 
+import ops
 
 META = {
     'name': 'context-charm',
@@ -333,7 +335,7 @@ def test_relation_departed_event():
     relation = scenario.Relation('baz')
     state_in = scenario.State(relations=[relation])
     # These look like:
-    #   ctx.run(ctx.on.baz_relation_departed(unit=unit_ordinal, departing_unit=unit_ordinal), state)
+    #   ctx.run(ctx.on.baz_relation_departed(unit=unit_num, departing_unit=unit_num), state)
     with ctx(ctx.on.relation_departed(relation, remote_unit=2, departing_unit=1), state_in) as mgr:
         mgr.run()
         relation_event, collect_status = mgr.charm.observed

testing/tests/test_e2e/__init__.py

@@ -0,0 +1,2 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.

testing/tests/test_e2e/conftest.py

@@ -1,12 +1,15 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
-from typing import Any
 from collections.abc import Generator
+from typing import Any
 
 import pytest
 import yaml
-
 from scenario import Context
+
 from test.charms.test_secrets.src.charm import SecretsCharm
 
 

testing/tests/test_e2e/test_actions.py

@@ -1,13 +1,16 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import pytest
+from scenario import Context
+from scenario.state import State, _Action, _next_action_id
+
 from ops import __version__ as ops_version
+from ops._private.harness import ActionFailed
 from ops.charm import ActionEvent, CharmBase
 from ops.framework import Framework
-from ops._private.harness import ActionFailed
-
-from scenario import Context
-from scenario.state import State, _Action, _next_action_id
 
 
 @pytest.fixture(scope='function')

testing/tests/test_e2e/test_cloud_spec.py

@@ -1,10 +1,13 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
-import ops
 import pytest
-
 import scenario
 
+import ops
+
 
 class MyCharm(ops.CharmBase):
     def __init__(self, framework: ops.Framework):

testing/tests/test_e2e/test_config.py

@@ -1,10 +1,14 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import pytest
+from scenario.state import State
+
 from ops.charm import CharmBase
 from ops.framework import Framework
 
-from scenario.state import State
 from ..helpers import trigger
 
 

testing/tests/test_e2e/test_deferred.py

@@ -1,13 +1,18 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
 import typing
+from collections.abc import Mapping
 
-import ops
 import pytest
-from ops.framework import LifecycleEvent
-
 from scenario import Context
 from scenario.state import Container, Relation, State, _Event
+
+import ops
+from ops.framework import LifecycleEvent
+
 from ..helpers import trigger
 
 CHARM_CALLED = 0
@@ -16,13 +21,13 @@
 @pytest.fixture(scope='function')
 def mycharm():
     class MyCharm(ops.CharmBase):
-        META: dict[str, typing.Any] = {
+        META: Mapping[str, typing.Any] = {
             'name': 'mycharm',
             'requires': {'foo': {'interface': 'bar'}},
             'containers': {'foo': {'type': 'oci-image'}},
         }
         defer_next = 0
-        captured: list[ops.EventBase] = []
+        captured: typing.ClassVar[list[ops.EventBase]] = []
 
         def __init__(self, framework: ops.Framework):
             super().__init__(framework)

testing/tests/test_e2e/test_event.py

@@ -1,12 +1,14 @@
+# Copyright 2023 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 from __future__ import annotations
 
-import ops
 import pytest
-from ops import CharmBase
-
 from scenario import Context
 from scenario.state import State, _CharmSpec, _Event, _EventType
 
+import ops
+
 
 @pytest.mark.parametrize(
     'evt, expected_type',
@@ -40,7 +42,7 @@ def test_event_type(evt, expected_type):
     assert event._is_secret_event is (expected_type is _EventType.SECRET)
     assert event._is_action_event is (expected_type is _EventType.ACTION)
 
-    class MyCharm(CharmBase):
+    class MyCharm(ops.CharmBase):
         pass
 
     spec = _CharmSpec(
@@ -61,10 +63,7 @@ class MyCharm(CharmBase):
 
 
 def test_emitted_framework():
-    class MyCharm(CharmBase):
-        META = {'name': 'joop'}
-
-    ctx = Context(MyCharm, meta=MyCharm.META, capture_framework_events=True)
+    ctx = Context(ops.CharmBase, meta={'name': 'joop'}, capture_framework_events=True)
     ctx.run(ctx.on.update_status(), State())
     assert len(ctx.emitted_events) == 4
     assert list(map(type, ctx.emitted_events)) == [
@@ -76,9 +75,7 @@ class MyCharm(CharmBase):
 
 
 def test_emitted_deferred():
-    class MyCharm(CharmBase):
-        META = {'name': 'joop'}
-
+    class MyCharm(ops.CharmBase):
         def __init__(self, framework: ops.Framework):
             super().__init__(framework)
             framework.observe(self.on.update_status, self._on_update_status)
@@ -88,7 +85,7 @@ def _on_update_status(self, _: ops.UpdateStatusEvent):
 
     ctx = Context(
         MyCharm,
-        meta=MyCharm.META,
+        meta={'name': 'joop'},
         capture_deferred_events=True,
         capture_framework_events=True,
     )