Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move the content of ops.testing to ops._private.harness #1369

Merged
merged 7 commits into from
Sep 17, 2024
64 changes: 64 additions & 0 deletions ops/testing.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Copyright 2021 Canonical Ltd.
tonyandrewmeyer marked this conversation as resolved.
Show resolved Hide resolved
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Infrastructure to build unit tests for charms using the ops library."""

from ._private.harness import (
ActionFailed,
ActionOutput,
AppUnitOrName,
CharmBase,
CharmMeta,
CharmType,
Container,
ExecArgs,
ExecHandler,
ExecProcess,
ExecResult,
Harness,
ReadableBuffer,
RelationNotFoundError,
RelationRole,
YAMLStringOrFile,
charm,
framework,
model,
pebble,
storage,
)

# The Harness testing framework.
_ = ActionFailed
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference/advantage of doing this over __all__?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__all__ causes Sphinx to get very confused, and I couldn't figure out any way to keep __all__ and de-confuse it.

_ = ActionOutput
_ = AppUnitOrName
_ = CharmType
_ = ExecArgs
_ = ExecHandler
_ = ExecResult
_ = Harness
_ = ReadableBuffer
_ = YAMLStringOrFile

# Names exposed for backwards compatibility
_ = CharmBase
tonyandrewmeyer marked this conversation as resolved.
Show resolved Hide resolved
_ = CharmMeta
_ = Container
_ = ExecProcess
_ = RelationNotFoundError
_ = RelationRole
_ = charm
_ = framework
_ = model
_ = pebble
_ = storage
5 changes: 3 additions & 2 deletions test/test_testing.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@
import ops
import ops.testing
from ops import pebble
from ops._private.harness import _TestingPebbleClient
from ops.jujuversion import JujuVersion
from ops.model import _ModelBackend
from ops.pebble import FileType
from ops.testing import ExecResult, _TestingPebbleClient
from ops.testing import ExecResult

is_linux = platform.system() == 'Linux'

Expand Down Expand Up @@ -6888,7 +6889,7 @@ def get_change(_: ops.pebble.Client, change_id: str):
'spawn-time': '2021-02-10T04:36:22.118970777Z',
})

monkeypatch.setattr(ops.testing._TestingPebbleClient, 'get_change', get_change)
monkeypatch.setattr(_TestingPebbleClient, 'get_change', get_change)
harness.pebble_notify(
'foo',
'123',
Expand Down
Loading