-
Notifications
You must be signed in to change notification settings - Fork 119
/
model.py
2401 lines (1934 loc) · 93.5 KB
/
model.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2019-2021 Canonical Ltd.
#
# 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.
"""Representations of Juju's model, application, unit, and other entities."""
import datetime
import ipaddress
import json
import logging
import math
import os
import re
import shutil
import stat
import tempfile
import time
import typing
import weakref
from abc import ABC, abstractmethod
from pathlib import Path
from subprocess import PIPE, CalledProcessError, run
from typing import (
Any,
BinaryIO,
Callable,
Dict,
Generator,
Iterable,
List,
Mapping,
MutableMapping,
Optional,
Sequence,
Set,
TextIO,
Tuple,
Type,
TypeVar,
Union,
)
import ops
import ops.pebble as pebble
from ops._private import yaml
from ops.jujuversion import JujuVersion
if typing.TYPE_CHECKING:
from pebble import _LayerDict # pyright: reportMissingTypeStubs=false
from typing_extensions import TypedDict
_StorageDictType = Dict[str, Optional[List['Storage']]]
_BindingDictType = Dict[Union[str, 'Relation'], 'Binding']
Numerical = Union[int, float]
# all types that can be (de) serialized to json(/yaml) fom Python builtins
JsonObject = Union[Numerical, bool, str,
Dict[str, 'JsonObject'],
List['JsonObject'],
Tuple['JsonObject', ...]]
# a k8s spec is a mapping from names/"types" to json/yaml spec objects
_K8sSpec = Mapping[str, JsonObject]
_StatusDict = TypedDict('_StatusDict', {'status': str, 'message': str})
# the data structure we can use to initialize pebble layers with.
_Layer = Union[str, _LayerDict, pebble.Layer]
# mapping from relation name to a list of relation objects
_RelationMapping_Raw = Dict[str, Optional[List['Relation']]]
# mapping from relation name to relation metadata
_RelationsMeta_Raw = Dict[str, ops.charm.RelationMeta]
# mapping from container name to container metadata
_ContainerMeta_Raw = Dict[str, ops.charm.ContainerMeta]
_IPAddress = Union[ipaddress.IPv4Address, ipaddress.IPv6Address]
_Network = Union[ipaddress.IPv4Network, ipaddress.IPv6Network]
_ServiceInfoMapping = Mapping[str, pebble.ServiceInfo]
# relation data is a string key: string value mapping so far as the
# controller is concerned
_RelationDataContent_Raw = Dict[str, str]
UnitOrApplication = Union['Unit', 'Application']
UnitOrApplicationType = Union[Type['Unit'], Type['Application']]
_AddressDict = TypedDict('_AddressDict', {
'address': str, # Juju < 2.9
'value': str, # Juju >= 2.9
'cidr': str
})
_BindAddressDict = TypedDict('_BindAddressDict', {
'interface-name': str,
'addresses': List[_AddressDict]
})
_NetworkDict = TypedDict('_NetworkDict', {
'bind-addresses': List[_BindAddressDict],
'ingress-addresses': List[str],
'egress-subnets': List[str]
})
StrOrPath = typing.Union[str, Path]
logger = logging.getLogger(__name__)
MAX_LOG_LINE_LEN = 131071 # Max length of strings to pass to subshell.
class Model:
"""Represents the Juju Model as seen from this unit.
This should not be instantiated directly by Charmers, but can be accessed as `self.model`
from any class that derives from Object.
"""
def __init__(self, meta: 'ops.charm.CharmMeta', backend: '_ModelBackend'):
self._cache = _ModelCache(meta, backend)
self._backend = backend
self._unit = self.get_unit(self._backend.unit_name)
# fixme: remove cast after typing charm.py
relations = typing.cast('_RelationsMeta_Raw', meta.relations) # type: ignore
self._relations = RelationMapping(relations, self.unit, self._backend, self._cache)
self._config = ConfigData(self._backend)
# fixme: remove cast after typing charm.py
resources = typing.cast(Iterable[str], meta.resources) # type: ignore
self._resources = Resources(list(resources), self._backend)
self._pod = Pod(self._backend)
# fixme: remove cast after typing charm.py
storages = typing.cast(Iterable[str], meta.storages) # type: ignore
self._storages = StorageMapping(list(storages), self._backend)
self._bindings = BindingMapping(self._backend)
@property
def unit(self) -> 'Unit':
"""A :class:`Unit` that represents the unit that is running this code (eg yourself)."""
return self._unit
@property
def app(self) -> 'Application':
"""A :class:`Application` that represents the application this unit is a part of."""
return self._unit.app
@property
def relations(self) -> 'RelationMapping':
"""Mapping of endpoint to list of :class:`Relation`.
Answers the question "what am I currently related to".
See also :meth:`.get_relation`.
"""
return self._relations
@property
def config(self) -> 'ConfigData':
"""Return a mapping of config for the current application."""
return self._config
@property
def resources(self) -> 'Resources':
"""Access to resources for this charm.
Use ``model.resources.fetch(resource_name)`` to get the path on disk
where the resource can be found.
"""
return self._resources
@property
def storages(self) -> 'StorageMapping':
"""Mapping of storage_name to :class:`Storage` as defined in metadata.yaml."""
return self._storages
@property
def pod(self) -> 'Pod':
"""Use ``model.pod.set_spec`` to set the container specification for Kubernetes charms."""
return self._pod
@property
def name(self) -> str:
"""Return the name of the Model that this unit is running in.
This is read from the environment variable ``JUJU_MODEL_NAME``.
"""
return self._backend.model_name
@property
def uuid(self) -> str:
"""Return the identifier of the Model that this unit is running in.
This is read from the environment variable ``JUJU_MODEL_UUID``.
"""
return self._backend.model_uuid
def get_unit(self, unit_name: str) -> 'Unit':
"""Get an arbitrary unit by name.
Internally this uses a cache, so asking for the same unit two times will
return the same object.
"""
return self._cache.get(Unit, unit_name)
def get_app(self, app_name: str) -> 'Application':
"""Get an application by name.
Internally this uses a cache, so asking for the same application two times will
return the same object.
"""
return self._cache.get(Application, app_name)
def get_relation(
self, relation_name: str,
relation_id: Optional[int] = None) -> Optional['Relation']:
"""Get a specific Relation instance.
If relation_id is not given, this will return the Relation instance if the
relation is established only once or None if it is not established. If this
same relation is established multiple times the error TooManyRelatedAppsError is raised.
Args:
relation_name: The name of the endpoint for this charm
relation_id: An identifier for a specific relation. Used to disambiguate when a
given application has more than one relation on a given endpoint.
Raises:
TooManyRelatedAppsError: is raised if there is more than one relation to the
supplied relation_name and no relation_id was supplied
"""
return self.relations._get_unique(relation_name, relation_id)
def get_binding(self, binding_key: Union[str, 'Relation']) -> Optional['Binding']:
"""Get a network space binding.
Args:
binding_key: The relation name or instance to obtain bindings for.
Returns:
If ``binding_key`` is a relation name, the method returns the default binding
for that relation. If a relation instance is provided, the method first looks
up a more specific binding for that specific relation ID, and if none is found
falls back to the default binding for the relation name.
"""
return self._bindings.get(binding_key)
_T = TypeVar('_T', bound='UnitOrApplication')
class _ModelCache:
def __init__(self, meta: 'ops.charm.CharmMeta', backend: '_ModelBackend'):
if typing.TYPE_CHECKING:
# (entity type, name): instance.
_weakcachetype = weakref.WeakValueDictionary[
Tuple['UnitOrApplicationType', str],
Optional['UnitOrApplication']]
self._meta = meta
self._backend = backend
self._weakrefs = weakref.WeakValueDictionary() # type: _weakcachetype
@typing.overload
def get(self, entity_type: Type['Unit'], name: str) -> 'Unit': ... # noqa
@typing.overload
def get(self, entity_type: Type['Application'], name: str) -> 'Application': ... # noqa
def get(self, entity_type: 'UnitOrApplicationType', name: str):
"""Fetch the cached entity of type `entity_type` with name `name`."""
key = (entity_type, name)
entity = self._weakrefs.get(key)
if entity is not None:
return entity
new_entity = entity_type(name, meta=self._meta, backend=self._backend, cache=self)
self._weakrefs[key] = new_entity
return new_entity
class Application:
"""Represents a named application in the model.
This might be your application, or might be an application that you are related to.
Charmers should not instantiate Application objects directly, but should use
:meth:`Model.get_app` if they need a reference to a given application.
Attributes:
name: The name of this application (eg, 'mysql'). This name may differ from the name of
the charm, if the user has deployed it to a different name.
"""
def __init__(self, name: str, meta: 'ops.charm.CharmMeta',
backend: '_ModelBackend', cache: _ModelCache):
self.name = name
self._backend = backend
self._cache = cache
self._is_our_app = self.name == self._backend.app_name
self._status = None
def _invalidate(self):
self._status = None
@property
def status(self) -> 'StatusBase':
"""Used to report or read the status of the overall application.
Can only be read and set by the lead unit of the application.
The status of remote units is always Unknown.
Raises:
RuntimeError: if you try to set the status of another application, or if you try to
set the status of this application as a unit that is not the leader.
InvalidStatusError: if you try to set the status to something that is not a
:class:`StatusBase`
Example::
self.model.app.status = BlockedStatus('I need a human to come help me')
"""
if not self._is_our_app:
return UnknownStatus()
if not self._backend.is_leader():
raise RuntimeError('cannot get application status as a non-leader unit')
if self._status:
return self._status
s = self._backend.status_get(is_app=True)
self._status = StatusBase.from_name(s['status'], s['message'])
return self._status
@status.setter
def status(self, value: 'StatusBase'):
if not isinstance(value, StatusBase):
raise InvalidStatusError(
'invalid value provided for application {} status: {}'.format(self, value)
)
if not self._is_our_app:
raise RuntimeError('cannot to set status for a remote application {}'.format(self))
if not self._backend.is_leader():
raise RuntimeError('cannot set application status as a non-leader unit')
for _key in {'name', 'message'}:
assert isinstance(getattr(value, _key), str), 'status.%s must be a string' % _key
self._backend.status_set(value.name, value.message, is_app=True)
self._status = value
def planned_units(self) -> int:
"""Get the number of units that Juju has "planned" for this application.
E.g., if an operator runs "juju deploy foo", then "juju add-unit -n 2 foo", the
planned unit count for foo will be 3.
The data comes from the Juju agent, based on data it fetches from the
controller. Pending units are included in the count, and scale down events may
modify the count before some units have been fully torn down. The information in
planned_units is up-to-date as of the start of the current hook invocation.
This method only returns data for this charm's application -- the Juju agent isn't
able to see planned unit counts for other applications in the model.
"""
if not self._is_our_app:
raise RuntimeError(
'cannot get planned units for a remote application {}.'.format(self))
return self._backend.planned_units()
def __repr__(self):
return '<{}.{} {}>'.format(type(self).__module__, type(self).__name__, self.name)
class Unit:
"""Represents a named unit in the model.
This might be your unit, another unit of your application, or a unit of another application
that you are related to.
Attributes:
name: The name of the unit (eg, 'mysql/0')
app: The Application the unit is a part of.
"""
def __init__(self, name: str, meta: 'ops.charm.CharmMeta',
backend: '_ModelBackend', cache: '_ModelCache'):
self.name = name
app_name = name.split('/')[0]
self.app = cache.get(Application, app_name)
self._backend = backend
self._cache = cache
self._is_our_unit = self.name == self._backend.unit_name
self._status = None
if self._is_our_unit and hasattr(meta, "containers"):
# fixme: remove cast when charm.py is typed
containers = typing.cast('_ContainerMeta_Raw', meta.containers) # type: ignore
self._containers = ContainerMapping(iter(containers), backend)
def _invalidate(self):
self._status = None
@property
def status(self) -> 'StatusBase':
"""Used to report or read the status of a specific unit.
The status of any unit other than yourself is always Unknown.
Raises:
RuntimeError: if you try to set the status of a unit other than yourself.
InvalidStatusError: if you try to set the status to something other than
a :class:`StatusBase`
Example::
self.model.unit.status = MaintenanceStatus('reconfiguring the frobnicators')
"""
if not self._is_our_unit:
return UnknownStatus()
if self._status:
return self._status
s = self._backend.status_get(is_app=False)
self._status = StatusBase.from_name(s['status'], s['message'])
return self._status
@status.setter
def status(self, value: 'StatusBase'):
if not isinstance(value, StatusBase):
raise InvalidStatusError(
'invalid value provided for unit {} status: {}'.format(self, value)
)
if not self._is_our_unit:
raise RuntimeError('cannot set status for a remote unit {}'.format(self))
# fixme: if value.messages
self._backend.status_set(value.name, value.message, is_app=False)
self._status = value
def __repr__(self):
return '<{}.{} {}>'.format(type(self).__module__, type(self).__name__, self.name)
def is_leader(self) -> bool:
"""Return whether this unit is the leader of its application.
This can only be called for your own unit.
Returns:
True if you are the leader, False otherwise
Raises:
RuntimeError: if called for a unit that is not yourself
"""
if self._is_our_unit:
# This value is not cached as it is not guaranteed to persist for the whole duration
# of a hook execution.
return self._backend.is_leader()
else:
raise RuntimeError(
'leadership status of remote units ({}) is not visible to other'
' applications'.format(self)
)
def set_workload_version(self, version: str) -> None:
"""Record the version of the software running as the workload.
This shouldn't be confused with the revision of the charm. This is informative only;
shown in the output of 'juju status'.
"""
if not isinstance(version, str):
raise TypeError("workload version must be a str, not {}: {!r}".format(
type(version).__name__, version))
self._backend.application_version_set(version)
@property
def containers(self) -> Mapping[str, 'Container']:
"""Return a mapping of containers indexed by name."""
if not self._is_our_unit:
raise RuntimeError('cannot get container for a remote unit {}'.format(self))
return self._containers
def get_container(self, container_name: str) -> 'Container':
"""Get a single container by name.
Raises:
ModelError: if the named container doesn't exist
"""
try:
return self.containers[container_name]
except KeyError:
raise ModelError('container {!r} not found'.format(container_name))
class LazyMapping(Mapping[str, str], ABC):
"""Represents a dict that isn't populated until it is accessed.
Charm authors should generally never need to use this directly, but it forms
the basis for many of the dicts that the framework tracks.
"""
# key-value mapping
_lazy_data = None # type: Optional[Dict[str, str]]
@abstractmethod
def _load(self) -> Dict[str, str]:
raise NotImplementedError()
@property
def _data(self) -> Dict[str, str]:
data = self._lazy_data
if data is None:
data = self._lazy_data = self._load()
return data
def _invalidate(self):
self._lazy_data = None
def __contains__(self, key: str) -> bool:
return key in self._data
def __len__(self):
return len(self._data)
def __iter__(self):
return iter(self._data)
def __getitem__(self, key: str) -> str:
return self._data[key]
def __repr__(self):
return repr(self._data)
class RelationMapping(Mapping[str, List['Relation']]):
"""Map of relation names to lists of :class:`Relation` instances."""
def __init__(self, relations_meta: '_RelationsMeta_Raw', our_unit: 'Unit',
backend: '_ModelBackend', cache: '_ModelCache'):
self._peers = set() # type: Set[str]
for name, relation_meta in relations_meta.items():
if relation_meta.role.is_peer():
self._peers.add(name)
self._our_unit = our_unit
self._backend = backend
self._cache = cache
self._data = {r: None for r in relations_meta} # type: _RelationMapping_Raw
def __contains__(self, key: str):
return key in self._data
def __len__(self):
return len(self._data)
def __iter__(self) -> Iterable[str]:
return iter(self._data)
def __getitem__(self, relation_name: str) -> List['Relation']:
is_peer = relation_name in self._peers
relation_list = self._data[relation_name] # type: Optional[List[Relation]]
if not isinstance(relation_list, list):
relation_list = self._data[relation_name] = [] # type: ignore
for rid in self._backend.relation_ids(relation_name):
relation = Relation(relation_name, rid, is_peer,
self._our_unit, self._backend, self._cache)
relation_list.append(relation)
return relation_list
def _invalidate(self, relation_name: str):
"""Used to wipe the cache of a given relation_name.
Not meant to be used by Charm authors. The content of relation data is
static for the lifetime of a hook, so it is safe to cache in memory once
accessed.
"""
self._data[relation_name] = None
def _get_unique(self, relation_name: str, relation_id: Optional[int] = None):
if relation_id is not None:
if not isinstance(relation_id, int):
raise ModelError('relation id {} must be int or None not {}'.format(
relation_id,
type(relation_id).__name__))
for relation in self[relation_name]:
if relation.id == relation_id:
return relation
else:
# The relation may be dead, but it is not forgotten.
is_peer = relation_name in self._peers
return Relation(relation_name, relation_id, is_peer,
self._our_unit, self._backend, self._cache)
relations = self[relation_name]
num_related = len(relations)
self._backend._validate_relation_access( # pyright: reportPrivateUsage=false
relation_name, relations)
if num_related == 0:
return None
elif num_related == 1:
return self[relation_name][0]
else:
# TODO: We need something in the framework to catch and gracefully handle
# errors, ideally integrating the error catching with Juju's mechanisms.
raise TooManyRelatedAppsError(relation_name, num_related, 1)
class BindingMapping(Mapping[str, 'Binding']):
"""Mapping of endpoints to network bindings.
Charm authors should not instantiate this directly, but access it via
:meth:`Model.get_binding`
"""
def __init__(self, backend: '_ModelBackend'):
self._backend = backend
self._data = {} # type: _BindingDictType
def get(self, binding_key: Union[str, 'Relation']) -> 'Binding':
"""Get a specific Binding for an endpoint/relation.
Not used directly by Charm authors. See :meth:`Model.get_binding`
"""
if isinstance(binding_key, Relation):
binding_name = binding_key.name
relation_id = binding_key.id
elif isinstance(binding_key, str):
binding_name = binding_key
relation_id = None
else:
raise ModelError('binding key must be str or relation instance, not {}'
''.format(type(binding_key).__name__))
binding = self._data.get(binding_key)
if binding is None:
binding = Binding(binding_name, relation_id, self._backend)
self._data[binding_key] = binding
return binding
# implemented to satisfy the Mapping ABC, but not meant to be used.
def __getitem__(self, item: Union[str, 'Relation']) -> 'Binding':
raise NotImplementedError()
def __iter__(self) -> Iterable['Binding']:
raise NotImplementedError()
def __len__(self) -> int:
raise NotImplementedError()
class Binding:
"""Binding to a network space.
Attributes:
name: The name of the endpoint this binding represents (eg, 'db')
"""
def __init__(self, name: str, relation_id: Optional[int], backend: '_ModelBackend'):
self.name = name
self._relation_id = relation_id
self._backend = backend
self._network = None
def _network_get(self, name: str, relation_id: Optional[int] = None) -> 'Network':
return Network(self._backend.network_get(name, relation_id))
@property
def network(self) -> 'Network':
"""The network information for this binding."""
if self._network is None:
try:
self._network = self._network_get(self.name, self._relation_id)
except RelationNotFoundError:
if self._relation_id is None:
raise
# If a relation is dead, we can still get network info associated with an
# endpoint itself
self._network = self._network_get(self.name)
return self._network
class Network:
"""Network space details.
Charm authors should not instantiate this directly, but should get access to the Network
definition from :meth:`Model.get_binding` and its ``network`` attribute.
Attributes:
interfaces: A list of :class:`NetworkInterface` details. This includes the
information about how your application should be configured (eg, what
IP addresses should you bind to.)
Note that multiple addresses for a single interface are represented as multiple
interfaces. (eg, ``[NetworkInfo('ens1', '10.1.1.1/32'),
NetworkInfo('ens1', '10.1.2.1/32'])``)
ingress_addresses: A list of :class:`ipaddress.ip_address` objects representing the IP
addresses that other units should use to get in touch with you.
egress_subnets: A list of :class:`ipaddress.ip_network` representing the subnets that
other units will see you connecting from. Due to things like NAT it isn't always
possible to narrow it down to a single address, but when it is clear, the CIDRs
will be constrained to a single address. (eg, 10.0.0.1/32)
Args:
network_info: A dict of network information as returned by ``network-get``.
"""
def __init__(self, network_info: '_NetworkDict'):
self.interfaces = [] # type: List[NetworkInterface]
# Treat multiple addresses on an interface as multiple logical
# interfaces with the same name.
for interface_info in network_info.get('bind-addresses', []):
interface_name = interface_info.get('interface-name') # type: str
addrs = interface_info.get('addresses') # type: Optional[List[_AddressDict]]
if addrs is not None:
for address_info in addrs:
self.interfaces.append(NetworkInterface(interface_name, address_info))
self.ingress_addresses = [] # type: List[_IPAddress]
for address in network_info.get('ingress-addresses', []):
self.ingress_addresses.append(ipaddress.ip_address(address))
self.egress_subnets = [] # type: List[_Network]
for subnet in network_info.get('egress-subnets', []):
self.egress_subnets.append(ipaddress.ip_network(subnet))
@property
def bind_address(self) -> Optional['_IPAddress']:
"""A single address that your application should bind() to.
For the common case where there is a single answer. This represents a single
address from :attr:`.interfaces` that can be used to configure where your
application should bind() and listen().
"""
if self.interfaces:
return self.interfaces[0].address
else:
return None
@property
def ingress_address(self):
"""The address other applications should use to connect to your unit.
Due to things like public/private addresses, NAT and tunneling, the address you bind()
to is not always the address other people can use to connect() to you.
This is just the first address from :attr:`.ingress_addresses`.
"""
if self.ingress_addresses:
return self.ingress_addresses[0]
else:
return None
class NetworkInterface:
"""Represents a single network interface that the charm needs to know about.
Charmers should not instantiate this type directly. Instead use :meth:`Model.get_binding`
to get the network information for a given endpoint.
Attributes:
name: The name of the interface (eg. 'eth0', or 'ens1')
subnet: An :class:`ipaddress.ip_network` representation of the IP for the network
interface. This may be a single address (eg '10.0.1.2/32')
"""
def __init__(self, name: str, address_info: '_AddressDict'):
self.name = name
# TODO: expose a hardware address here, see LP: #1864070.
address = address_info.get('value')
if address is None:
# Compatibility with Juju <2.9: legacy address_info only had
# an 'address' field instead of 'value'.
address = address_info.get('address')
# The value field may be empty.
address_ = ipaddress.ip_address(address) if address else None
self.address = address_ # type: Optional[_IPAddress]
cidr = address_info.get('cidr') # type: str
# The cidr field may be empty, see LP: #1864102.
if cidr:
subnet = ipaddress.ip_network(cidr)
elif address:
# If we have an address, convert it to a /32 or /128 IP network.
subnet = ipaddress.ip_network(address)
else:
subnet = None
self.subnet = subnet # type: Optional[_Network]
# TODO: expose a hostname/canonical name for the address here, see LP: #1864086.
class Relation:
"""Represents an established relation between this application and another application.
This class should not be instantiated directly, instead use :meth:`Model.get_relation`
or :attr:`ops.charm.RelationEvent.relation`. This is principally used by
:class:`ops.charm.RelationMeta` to represent the relationships between charms.
Attributes:
name: The name of the local endpoint of the relation (eg 'db')
id: The identifier for a particular relation (integer)
app: An :class:`Application` representing the remote application of this relation.
For peer relations this will be the local application.
units: A set of :class:`Unit` for units that have started and joined this relation.
data: A :class:`RelationData` holding the data buckets for each entity
of a relation. Accessed via eg Relation.data[unit]['foo']
"""
def __init__(
self, relation_name: str, relation_id: int, is_peer: bool, our_unit: Unit,
backend: '_ModelBackend', cache: '_ModelCache'):
self.name = relation_name
self.id = relation_id
self.app = None # type: Optional[Application]
self.units = set() # type: Set[Unit]
if is_peer:
# For peer relations, both the remote and the local app are the same.
self.app = our_unit.app
try:
for unit_name in backend.relation_list(self.id):
unit = cache.get(Unit, unit_name)
self.units.add(unit)
if self.app is None:
# Use the app of one of the units if available.
self.app = unit.app
except RelationNotFoundError:
# If the relation is dead, just treat it as if it has no remote units.
pass
# If we didn't get the remote app via our_unit.app or the units list,
# look it up via JUJU_REMOTE_APP or "relation-list --app".
if self.app is None:
app_name = backend.relation_remote_app_name(relation_id)
if app_name is not None:
self.app = cache.get(Application, app_name)
self.data = RelationData(self, our_unit, backend)
def __repr__(self):
return '<{}.{} {}:{}>'.format(type(self).__module__,
type(self).__name__,
self.name,
self.id)
class RelationData(Mapping['UnitOrApplication', 'RelationDataContent']):
"""Represents the various data buckets of a given relation.
Each unit and application involved in a relation has their own data bucket.
Eg: ``{entity: RelationDataContent}``
where entity can be either a :class:`Unit` or a :class:`Application`.
Units can read and write their own data, and if they are the leader,
they can read and write their application data. They are allowed to read
remote unit and application data.
This class should not be created directly. It should be accessed via
:attr:`Relation.data`
"""
def __init__(self, relation: Relation, our_unit: Unit, backend: '_ModelBackend'):
self.relation = weakref.proxy(relation)
self._data = {
our_unit: RelationDataContent(self.relation, our_unit, backend),
our_unit.app: RelationDataContent(self.relation, our_unit.app, backend),
} # type: Dict[UnitOrApplication, RelationDataContent]
self._data.update({
unit: RelationDataContent(self.relation, unit, backend)
for unit in self.relation.units})
# The relation might be dead so avoid a None key here.
if self.relation.app is not None:
self._data.update({
self.relation.app: RelationDataContent(self.relation, self.relation.app, backend),
})
def __contains__(self, key: 'UnitOrApplication'):
return key in self._data
def __len__(self):
return len(self._data)
def __iter__(self):
return iter(self._data)
def __getitem__(self, key: 'UnitOrApplication'):
if key is None and self.relation.app is None:
# NOTE: if juju gets fixed to set JUJU_REMOTE_APP for relation-broken events, then that
# should fix the only case in which we expect key to be None - potentially removing the
# need for this error in future ops versions (i.e. if relation.app is guaranteed to not
# be None. See https://bugs.launchpad.net/juju/+bug/1960934.
raise KeyError(
'Cannot index relation data with "None".'
' Are you trying to access remote app data during a relation-broken event?'
' This is not allowed.')
return self._data[key]
def __repr__(self):
return repr(self._data)
# We mix in MutableMapping here to get some convenience implementations, but whether it's actually
# mutable or not is controlled by the flag.
class RelationDataContent(LazyMapping, MutableMapping[str, str]):
"""Data content of a unit or application in a relation."""
def __init__(self, relation: 'Relation', entity: 'UnitOrApplication',
backend: '_ModelBackend'):
self.relation = relation
self._entity = entity
self._backend = backend
self._is_app = isinstance(entity, Application) # type: bool
def _load(self) -> '_RelationDataContent_Raw':
"""Load the data from the current entity / relation."""
try:
return self._backend.relation_get(self.relation.id, self._entity.name, self._is_app)
except RelationNotFoundError:
# Dead relations tell no tales (and have no data).
return {}
def _is_mutable(self):
"""Return if the data content can be modified."""
if self._is_app:
is_our_app = self._backend.app_name == self._entity.name # type: bool
if not is_our_app:
return False
# Whether the application data bag is mutable or not depends on
# whether this unit is a leader or not, but this is not guaranteed
# to be always true during the same hook execution.
return self._backend.is_leader()
else:
is_our_unit = self._backend.unit_name == self._entity.name
if is_our_unit:
return True
return False
def __setitem__(self, key: str, value: str):
if not self._is_mutable():
raise RelationDataError(
'cannot set relation data for {}'.format(self._entity.name))
if not isinstance(key, str):
raise RelationDataError(
'relation data keys must be strings, not {}'.format(type(key)))
if not isinstance(value, str):
raise RelationDataError(
'relation data values must be strings, not {}'.format(type(value)))
self._backend.relation_set(self.relation.id, key, value, self._is_app)
# Don't load data unnecessarily if we're only updating.
if self._lazy_data is not None:
if value == '':
# Match the behavior of Juju, which is that setting the value to an
# empty string will remove the key entirely from the relation data.
self._data.pop(key, None)
else:
self._data[key] = value
def __delitem__(self, key: str):
# Match the behavior of Juju, which is that setting the value to an empty
# string will remove the key entirely from the relation data.
self.__setitem__(key, '')
class ConfigData(LazyMapping):
"""Configuration data.
This class should not be created directly. It should be accessed via :attr:`Model.config`.
"""
def __init__(self, backend: '_ModelBackend'):
self._backend = backend
def _load(self):
return self._backend.config_get()
class StatusBase:
"""Status values specific to applications and units.
To access a status by name, see :meth:`StatusBase.from_name`, most use cases will just
directly use the child class to indicate their status.
"""
_statuses = {} # type: Dict[str, Type[StatusBase]]
# Subclasses should override this attribute and make it a string.
name = NotImplemented
def __init__(self, message: str = ''):
self.message = message
def __new__(cls, *args: Any, **kwargs: Dict[Any, Any]):
"""Forbid the usage of StatusBase directly."""
if cls is StatusBase:
raise TypeError("cannot instantiate a base class")
return super().__new__(cls)