5506e69e71ee27ece06654b1b6e2f69ebdef9ab3
11 from concurrent
.futures
import CancelledError
12 from functools
import partial
13 from pathlib
import Path
16 from theblues
import charmstore
18 from .client
import client
19 from .client
import watcher
20 from .client
import connection
21 from .constraints
import parse
as parse_constraints
, normalize_key
22 from .delta
import get_entity_delta
23 from .delta
import get_entity_class
24 from .exceptions
import DeadEntityException
25 from .errors
import JujuError
, JujuAPIError
26 from .placement
import parse
as parse_placement
28 log
= logging
.getLogger(__name__
)
31 class _Observer(object):
32 """Wrapper around an observer callable.
34 This wrapper allows filter criteria to be associated with the
35 callable so that it's only called for changes that meet the criteria.
38 def __init__(self
, callable_
, entity_type
, action
, entity_id
, predicate
):
39 self
.callable_
= callable_
40 self
.entity_type
= entity_type
42 self
.entity_id
= entity_id
43 self
.predicate
= predicate
45 self
.entity_id
= str(self
.entity_id
)
46 if not self
.entity_id
.startswith('^'):
47 self
.entity_id
= '^' + self
.entity_id
48 if not self
.entity_id
.endswith('$'):
51 async def __call__(self
, delta
, old
, new
, model
):
52 await self
.callable_(delta
, old
, new
, model
)
54 def cares_about(self
, delta
):
55 """Return True if this observer "cares about" (i.e. wants to be
56 called) for a this delta.
59 if (self
.entity_id
and delta
.get_id() and
60 not re
.match(self
.entity_id
, str(delta
.get_id()))):
63 if self
.entity_type
and self
.entity_type
!= delta
.entity
:
66 if self
.action
and self
.action
!= delta
.type:
69 if self
.predicate
and not self
.predicate(delta
):
75 class ModelObserver(object):
76 async def __call__(self
, delta
, old
, new
, model
):
77 handler_name
= 'on_{}_{}'.format(delta
.entity
, delta
.type)
78 method
= getattr(self
, handler_name
, self
.on_change
)
79 await method(delta
, old
, new
, model
)
81 async def on_change(self
, delta
, old
, new
, model
):
82 """Generic model-change handler.
84 :param delta: :class:`juju.client.overrides.Delta`
85 :param old: :class:`juju.model.ModelEntity`
86 :param new: :class:`juju.model.ModelEntity`
87 :param model: :class:`juju.model.Model`
93 class ModelState(object):
94 """Holds the state of the model, including the delta history of all
95 entities in the model.
98 def __init__(self
, model
):
102 def _live_entity_map(self
, entity_type
):
103 """Return an id:Entity map of all the living entities of
104 type ``entity_type``.
108 entity_id
: self
.get_entity(entity_type
, entity_id
)
109 for entity_id
, history
in self
.state
.get(entity_type
, {}).items()
110 if history
[-1] is not None
114 def applications(self
):
115 """Return a map of application-name:Application for all applications
116 currently in the model.
119 return self
._live
_entity
_map
('application')
123 """Return a map of machine-id:Machine for all machines currently in
127 return self
._live
_entity
_map
('machine')
131 """Return a map of unit-id:Unit for all units currently in
135 return self
._live
_entity
_map
('unit')
137 def entity_history(self
, entity_type
, entity_id
):
138 """Return the history deque for an entity.
141 return self
.state
[entity_type
][entity_id
]
143 def entity_data(self
, entity_type
, entity_id
, history_index
):
144 """Return the data dict for an entity at a specific index of its
148 return self
.entity_history(entity_type
, entity_id
)[history_index
]
150 def apply_delta(self
, delta
):
151 """Apply delta to our state and return a copy of the
152 affected object as it was before and after the update, e.g.:
154 old_obj, new_obj = self.apply_delta(delta)
156 old_obj may be None if the delta is for the creation of a new object,
157 e.g. a new application or unit is deployed.
159 new_obj will never be None, but may be dead (new_obj.dead == True)
160 if the object was deleted as a result of the delta being applied.
165 .setdefault(delta
.entity
, {})
166 .setdefault(delta
.get_id(), collections
.deque())
169 history
.append(delta
.data
)
170 if delta
.type == 'remove':
173 entity
= self
.get_entity(delta
.entity
, delta
.get_id())
174 return entity
.previous(), entity
177 self
, entity_type
, entity_id
, history_index
=-1, connected
=True):
178 """Return an object instance for the given entity_type and id.
180 By default the object state matches the most recent state from
181 Juju. To get an instance of the object in an older state, pass
182 history_index, an index into the history deque for the entity.
186 if history_index
< 0 and history_index
!= -1:
187 history_index
+= len(self
.entity_history(entity_type
, entity_id
))
188 if history_index
< 0:
192 self
.entity_data(entity_type
, entity_id
, history_index
)
196 entity_class
= get_entity_class(entity_type
)
198 entity_id
, self
.model
, history_index
=history_index
,
202 class ModelEntity(object):
203 """An object in the Model tree"""
205 def __init__(self
, entity_id
, model
, history_index
=-1, connected
=True):
206 """Initialize a new entity
208 :param entity_id str: The unique id of the object in the model
209 :param model: The model instance in whose object tree this
211 :history_index int: The index of this object's state in the model's
212 history deque for this entity
213 :connected bool: Flag indicating whether this object gets live updates
217 self
.entity_id
= entity_id
219 self
._history
_index
= history_index
220 self
.connected
= connected
221 self
.connection
= model
.connection
224 return '<{} entity_id="{}">'.format(type(self
).__name
__,
227 def __getattr__(self
, name
):
228 """Fetch object attributes from the underlying data dict held in the
232 return self
.safe_data
[name
]
235 return bool(self
.data
)
237 def on_change(self
, callable_
):
238 """Add a change observer to this entity.
241 self
.model
.add_observer(
242 callable_
, self
.entity_type
, 'change', self
.entity_id
)
244 def on_remove(self
, callable_
):
245 """Add a remove observer to this entity.
248 self
.model
.add_observer(
249 callable_
, self
.entity_type
, 'remove', self
.entity_id
)
252 def entity_type(self
):
253 """A string identifying the entity type of this object, e.g.
254 'application' or 'unit', etc.
257 return self
.__class
__.__name
__.lower()
261 """Return True if this object represents the current state of the
262 entity in the underlying model.
264 This will be True except when the object represents an entity at a
265 non-latest state in history, e.g. if the object was obtained by calling
266 .previous() on another object.
269 return self
._history
_index
== -1
273 """Returns True if this entity no longer exists in the underlying
279 self
.model
.state
.entity_data(
280 self
.entity_type
, self
.entity_id
, -1) is None
285 """Returns True if this entity still exists in the underlying
293 """The data dictionary for this entity.
296 return self
.model
.state
.entity_data(
297 self
.entity_type
, self
.entity_id
, self
._history
_index
)
301 """The data dictionary for this entity.
303 If this `ModelEntity` points to the dead state, it will
304 raise `DeadEntityException`.
307 if self
.data
is None:
308 raise DeadEntityException(
309 "Entity {}:{} is dead - its attributes can no longer be "
310 "accessed. Use the .previous() method on this object to get "
311 "a copy of the object at its previous state.".format(
312 self
.entity_type
, self
.entity_id
))
316 """Return a copy of this object as was at its previous state in
319 Returns None if this object is new (and therefore has no history).
321 The returned object is always "disconnected", i.e. does not receive
325 return self
.model
.state
.get_entity(
326 self
.entity_type
, self
.entity_id
, self
._history
_index
- 1,
330 """Return a copy of this object at its next state in
333 Returns None if this object is already the latest.
335 The returned object is "disconnected", i.e. does not receive
336 live updates, unless it is current (latest).
339 if self
._history
_index
== -1:
342 new_index
= self
._history
_index
+ 1
344 new_index
== len(self
.model
.state
.entity_history(
345 self
.entity_type
, self
.entity_id
)) - 1
347 return self
.model
.state
.get_entity(
348 self
.entity_type
, self
.entity_id
, self
._history
_index
- 1,
352 """Return a copy of this object at its current state in the model.
354 Returns self if this object is already the latest.
356 The returned object is always "connected", i.e. receives
357 live updates from the model.
360 if self
._history
_index
== -1:
363 return self
.model
.state
.get_entity(self
.entity_type
, self
.entity_id
)
367 def __init__(self
, loop
=None):
368 """Instantiate a new connected Model.
370 :param loop: an asyncio event loop
373 self
.loop
= loop
or asyncio
.get_event_loop()
374 self
.connection
= None
375 self
.observers
= weakref
.WeakValueDictionary()
376 self
.state
= ModelState(self
)
378 self
._watcher
_task
= None
379 self
._watch
_shutdown
= asyncio
.Event(loop
=self
.loop
)
380 self
._watch
_received
= asyncio
.Event(loop
=self
.loop
)
381 self
._charmstore
= CharmStore(self
.loop
)
383 async def connect(self
, *args
, **kw
):
384 """Connect to an arbitrary Juju model.
386 args and kw are passed through to Connection.connect()
390 kw
['loop'] = self
.loop
391 self
.connection
= await connection
.Connection
.connect(*args
, **kw
)
392 await self
._after
_connect
()
394 async def connect_current(self
):
395 """Connect to the current Juju model.
398 self
.connection
= await connection
.Connection
.connect_current(
400 await self
._after
_connect
()
402 async def connect_model(self
, model_name
):
403 """Connect to a specific Juju model by name.
405 :param model_name: Format [controller:][user/]model
408 self
.connection
= await connection
.Connection
.connect_model(model_name
,
410 await self
._after
_connect
()
412 async def _after_connect(self
):
413 """Run initialization steps after connecting to websocket.
417 await self
._watch
_received
.wait()
418 await self
.get_info()
420 async def disconnect(self
):
421 """Shut down the watcher task and close websockets.
424 self
._stop
_watching
()
425 if self
.connection
and self
.connection
.is_open
:
426 await self
._watch
_shutdown
.wait()
427 log
.debug('Closing model connection')
428 await self
.connection
.close()
429 self
.connection
= None
431 async def add_local_charm_dir(self
, charm_dir
, series
):
432 """Upload a local charm to the model.
434 This will automatically generate an archive from
437 :param charm_dir: Path to the charm directory
438 :param series: Charm series
441 fh
= tempfile
.NamedTemporaryFile()
442 CharmArchiveGenerator(charm_dir
).make_archive(fh
.name
)
445 self
.add_local_charm
, fh
, series
, os
.stat(fh
.name
).st_size
)
446 charm_url
= await self
.loop
.run_in_executor(None, func
)
448 log
.debug('Uploaded local charm: %s -> %s', charm_dir
, charm_url
)
451 def add_local_charm(self
, charm_file
, series
, size
=None):
452 """Upload a local charm archive to the model.
454 Returns the 'local:...' url that should be used to deploy the charm.
456 :param charm_file: Path to charm zip archive
457 :param series: Charm series
458 :param size: Size of the archive, in bytes
459 :return str: 'local:...' url for deploying the charm
460 :raises: :class:`JujuError` if the upload fails
462 Uses an https endpoint at the same host:port as the wss.
463 Supports large file uploads.
467 This method will block. Consider using :meth:`add_local_charm_dir`
471 conn
, headers
, path_prefix
= self
.connection
.https_connection()
472 path
= "%s/charms?series=%s" % (path_prefix
, series
)
473 headers
['Content-Type'] = 'application/zip'
475 headers
['Content-Length'] = size
476 conn
.request("POST", path
, charm_file
, headers
)
477 response
= conn
.getresponse()
478 result
= response
.read().decode()
479 if not response
.status
== 200:
480 raise JujuError(result
)
481 result
= json
.loads(result
)
482 return result
['charm-url']
484 def all_units_idle(self
):
485 """Return True if all units are idle.
488 for unit
in self
.units
.values():
489 unit_status
= unit
.data
['agent-status']['current']
490 if unit_status
!= 'idle':
494 async def reset(self
, force
=False):
495 """Reset the model to a clean state.
497 :param bool force: Force-terminate machines.
499 This returns only after the model has reached a clean state. "Clean"
500 means no applications or machines exist in the model.
503 log
.debug('Resetting model')
504 for app
in self
.applications
.values():
506 for machine
in self
.machines
.values():
507 await machine
.destroy(force
=force
)
508 await self
.block_until(
509 lambda: len(self
.machines
) == 0
512 async def block_until(self
, *conditions
, timeout
=None, wait_period
=0.5):
513 """Return only after all conditions are true.
517 while not all(c() for c
in conditions
):
518 await asyncio
.sleep(wait_period
, loop
=self
.loop
)
519 await asyncio
.wait_for(_block(), timeout
, loop
=self
.loop
)
522 def applications(self
):
523 """Return a map of application-name:Application for all applications
524 currently in the model.
527 return self
.state
.applications
531 """Return a map of machine-id:Machine for all machines currently in
535 return self
.state
.machines
539 """Return a map of unit-id:Unit for all units currently in
543 return self
.state
.units
545 async def get_info(self
):
546 """Return a client.ModelInfo object for this Model.
548 Retrieves latest info for this Model from the api server. The
549 return value is cached on the Model.info attribute so that the
550 valued may be accessed again without another api call, if
553 This method is called automatically when the Model is connected,
554 resulting in Model.info being initialized without requiring an
555 explicit call to this method.
558 facade
= client
.ClientFacade()
559 facade
.connect(self
.connection
)
561 self
.info
= await facade
.ModelInfo()
562 log
.debug('Got ModelInfo: %s', vars(self
.info
))
567 self
, callable_
, entity_type
=None, action
=None, entity_id
=None,
569 """Register an "on-model-change" callback
571 Once the model is connected, ``callable_``
572 will be called each time the model changes. ``callable_`` should
573 be Awaitable and accept the following positional arguments:
575 delta - An instance of :class:`juju.delta.EntityDelta`
576 containing the raw delta data recv'd from the Juju
579 old_obj - If the delta modifies an existing object in the model,
580 old_obj will be a copy of that object, as it was before the
581 delta was applied. Will be None if the delta creates a new
584 new_obj - A copy of the new or updated object, after the delta
585 is applied. Will be None if the delta removes an entity
588 model - The :class:`Model` itself.
590 Events for which ``callable_`` is called can be specified by passing
591 entity_type, action, and/or entitiy_id filter criteria, e.g.::
595 entity_type='application', action='add', entity_id='ubuntu')
597 For more complex filtering conditions, pass a predicate function. It
598 will be called with a delta as its only argument. If the predicate
599 function returns True, the ``callable_`` will be called.
602 observer
= _Observer(
603 callable_
, entity_type
, action
, entity_id
, predicate
)
604 self
.observers
[observer
] = callable_
607 """Start an asynchronous watch against this model.
609 See :meth:`add_observer` to register an onchange callback.
612 async def _start_watch():
613 self
._watch
_shutdown
.clear()
615 allwatcher
= watcher
.AllWatcher()
616 self
._watch
_conn
= await self
.connection
.clone()
617 allwatcher
.connect(self
._watch
_conn
)
619 results
= await allwatcher
.Next()
620 for delta
in results
.deltas
:
621 delta
= get_entity_delta(delta
)
622 old_obj
, new_obj
= self
.state
.apply_delta(delta
)
623 # XXX: Might not want to shield at this level
624 # We are shielding because when the watcher is
625 # canceled (on disconnect()), we don't want all of
626 # its children (every observer callback) to be
627 # canceled with it. So we shield them. But this means
628 # they can *never* be canceled.
629 await asyncio
.shield(
630 self
._notify
_observers
(delta
, old_obj
, new_obj
),
632 self
._watch
_received
.set()
633 except CancelledError
:
634 log
.debug('Closing watcher connection')
635 await self
._watch
_conn
.close()
636 self
._watch
_shutdown
.set()
637 self
._watch
_conn
= None
639 log
.debug('Starting watcher task')
640 self
._watcher
_task
= self
.loop
.create_task(_start_watch())
642 def _stop_watching(self
):
643 """Stop the asynchronous watch against this model.
646 log
.debug('Stopping watcher task')
647 if self
._watcher
_task
:
648 self
._watcher
_task
.cancel()
650 async def _notify_observers(self
, delta
, old_obj
, new_obj
):
651 """Call observing callbacks, notifying them of a change in model state
653 :param delta: The raw change from the watcher
654 (:class:`juju.client.overrides.Delta`)
655 :param old_obj: The object in the model that this delta updates.
657 :param new_obj: The object in the model that is created or updated
658 by applying this delta.
661 if new_obj
and not old_obj
:
665 'Model changed: %s %s %s',
666 delta
.entity
, delta
.type, delta
.get_id())
668 for o
in self
.observers
:
669 if o
.cares_about(delta
):
670 asyncio
.ensure_future(o(delta
, old_obj
, new_obj
, self
),
673 async def _wait(self
, entity_type
, entity_id
, action
, predicate
=None):
675 Block the calling routine until a given action has happened to the
678 :param entity_type: The entity's type.
679 :param entity_id: The entity's id.
680 :param action: the type of action (e.g., 'add', 'change', or 'remove')
681 :param predicate: optional callable that must take as an
682 argument a delta, and must return a boolean, indicating
683 whether the delta contains the specific action we're looking
684 for. For example, you might check to see whether a 'change'
685 has a 'completed' status. See the _Observer class for details.
688 q
= asyncio
.Queue(loop
=self
.loop
)
690 async def callback(delta
, old
, new
, model
):
691 await q
.put(delta
.get_id())
693 self
.add_observer(callback
, entity_type
, action
, entity_id
, predicate
)
694 entity_id
= await q
.get()
695 # object might not be in the entity_map if we were waiting for a
697 return self
.state
._live
_entity
_map
(entity_type
).get(entity_id
)
699 async def _wait_for_new(self
, entity_type
, entity_id
=None, predicate
=None):
700 """Wait for a new object to appear in the Model and return it.
702 Waits for an object of type ``entity_type`` with id ``entity_id``.
703 If ``entity_id`` is ``None``, it will wait for the first new entity
706 This coroutine blocks until the new object appears in the model.
709 # if the entity is already in the model, just return it
710 if entity_id
in self
.state
._live
_entity
_map
(entity_type
):
711 return self
.state
._live
_entity
_map
(entity_type
)[entity_id
]
712 # if we know the entity_id, we can trigger on any action that puts
713 # the enitty into the model; otherwise, we have to watch for the
714 # next "add" action on that entity_type
715 action
= 'add' if entity_id
is None else None
716 return await self
._wait
(entity_type
, entity_id
, action
, predicate
)
718 async def wait_for_action(self
, action_id
):
719 """Given an action, wait for it to complete."""
721 if action_id
.startswith("action-"):
722 # if we've been passed action.tag, transform it into the
723 # id that the api deltas will use.
724 action_id
= action_id
[7:]
726 def predicate(delta
):
727 return delta
.data
['status'] in ('completed', 'failed')
729 return await self
._wait
('action', action_id
, 'change', predicate
)
731 async def add_machine(
732 self
, spec
=None, constraints
=None, disks
=None, series
=None):
733 """Start a new, empty machine and optionally a container, or add a
734 container to a machine.
736 :param str spec: Machine specification
739 (None) - starts a new machine
740 'lxd' - starts a new machine with one lxd container
741 'lxd:4' - starts a new lxd container on machine 4
742 'ssh:user@10.10.0.3' - manually provisions a machine with ssh
743 'zone=us-east-1a' - starts a machine in zone us-east-1s on AWS
744 'maas2.name' - acquire machine maas2.name on MAAS
746 :param dict constraints: Machine constraints
753 :param list disks: List of disk constraint dictionaries
762 :param str series: Series, e.g. 'xenial'
764 Supported container types are: lxd, kvm
766 When deploying a container to an existing machine, constraints cannot
770 params
= client
.AddMachineParams()
771 params
.jobs
= ['JobHostUnits']
774 placement
= parse_placement(spec
)
776 params
.placement
= placement
[0]
779 params
.constraints
= client
.Value
.from_json(constraints
)
783 client
.Constraints
.from_json(o
) for o
in disks
]
786 params
.series
= series
788 # Submit the request.
789 client_facade
= client
.ClientFacade()
790 client_facade
.connect(self
.connection
)
791 results
= await client_facade
.AddMachines([params
])
792 error
= results
.machines
[0].error
794 raise ValueError("Error adding machine: %s", error
.message
)
795 machine_id
= results
.machines
[0].machine
796 log
.debug('Added new machine %s', machine_id
)
797 return await self
._wait
_for
_new
('machine', machine_id
)
799 async def add_relation(self
, relation1
, relation2
):
800 """Add a relation between two applications.
802 :param str relation1: '<application>[:<relation_name>]'
803 :param str relation2: '<application>[:<relation_name>]'
806 app_facade
= client
.ApplicationFacade()
807 app_facade
.connect(self
.connection
)
810 'Adding relation %s <-> %s', relation1
, relation2
)
813 result
= await app_facade
.AddRelation([relation1
, relation2
])
814 except JujuAPIError
as e
:
815 if 'relation already exists' not in e
.message
:
818 'Relation %s <-> %s already exists', relation1
, relation2
)
819 # TODO: if relation already exists we should return the
820 # Relation ModelEntity here
823 def predicate(delta
):
825 for endpoint
in delta
.data
['endpoints']:
826 endpoints
[endpoint
['application-name']] = endpoint
['relation']
827 return endpoints
== result
.endpoints
829 return await self
._wait
_for
_new
('relation', None, predicate
)
831 def add_space(self
, name
, *cidrs
):
832 """Add a new network space.
834 Adds a new space with the given name and associates the given
835 (optional) list of existing subnet CIDRs with it.
837 :param str name: Name of the space
838 :param \*cidrs: Optional list of existing subnet CIDRs
841 raise NotImplementedError()
843 def add_ssh_key(self
, key
):
844 """Add a public SSH key to this model.
846 :param str key: The public ssh key
849 raise NotImplementedError()
850 add_ssh_keys
= add_ssh_key
852 def add_subnet(self
, cidr_or_id
, space
, *zones
):
853 """Add an existing subnet to this model.
855 :param str cidr_or_id: CIDR or provider ID of the existing subnet
856 :param str space: Network space with which to associate
857 :param str \*zones: Zone(s) in which the subnet resides
860 raise NotImplementedError()
862 def get_backups(self
):
863 """Retrieve metadata for backups in this model.
866 raise NotImplementedError()
868 def block(self
, *commands
):
869 """Add a new block to this model.
871 :param str \*commands: The commands to block. Valid values are
872 'all-changes', 'destroy-model', 'remove-object'
875 raise NotImplementedError()
877 def get_blocks(self
):
878 """List blocks for this model.
881 raise NotImplementedError()
883 def get_cached_images(self
, arch
=None, kind
=None, series
=None):
884 """Return a list of cached OS images.
886 :param str arch: Filter by image architecture
887 :param str kind: Filter by image kind, e.g. 'lxd'
888 :param str series: Filter by image series, e.g. 'xenial'
891 raise NotImplementedError()
893 def create_backup(self
, note
=None, no_download
=False):
894 """Create a backup of this model.
896 :param str note: A note to store with the backup
897 :param bool no_download: Do not download the backup archive
898 :return str: Path to downloaded archive
901 raise NotImplementedError()
903 def create_storage_pool(self
, name
, provider_type
, **pool_config
):
904 """Create or define a storage pool.
906 :param str name: Name to give the storage pool
907 :param str provider_type: Pool provider type
908 :param \*\*pool_config: key/value pool configuration pairs
911 raise NotImplementedError()
914 self
, no_tail
=False, exclude_module
=None, include_module
=None,
915 include
=None, level
=None, limit
=0, lines
=10, replay
=False,
917 """Get log messages for this model.
919 :param bool no_tail: Stop after returning existing log messages
920 :param list exclude_module: Do not show log messages for these logging
922 :param list include_module: Only show log messages for these logging
924 :param list include: Only show log messages for these entities
925 :param str level: Log level to show, valid options are 'TRACE',
926 'DEBUG', 'INFO', 'WARNING', 'ERROR,
927 :param int limit: Return this many of the most recent (possibly
928 filtered) lines are shown
929 :param int lines: Yield this many of the most recent lines, and keep
931 :param bool replay: Yield the entire log, and keep yielding
932 :param list exclude: Do not show log messages for these entities
935 raise NotImplementedError()
938 self
, entity_url
, application_name
=None, bind
=None, budget
=None,
939 channel
=None, config
=None, constraints
=None, force
=False,
940 num_units
=1, plan
=None, resources
=None, series
=None, storage
=None,
942 """Deploy a new service or bundle.
944 :param str entity_url: Charm or bundle url
945 :param str application_name: Name to give the service
946 :param dict bind: <charm endpoint>:<network space> pairs
947 :param dict budget: <budget name>:<limit> pairs
948 :param str channel: Charm store channel from which to retrieve
949 the charm or bundle, e.g. 'development'
950 :param dict config: Charm configuration dictionary
951 :param constraints: Service constraints
952 :type constraints: :class:`juju.Constraints`
953 :param bool force: Allow charm to be deployed to a machine running
954 an unsupported series
955 :param int num_units: Number of units to deploy
956 :param str plan: Plan under which to deploy charm
957 :param dict resources: <resource name>:<file path> pairs
958 :param str series: Series on which to deploy
959 :param dict storage: Storage constraints TODO how do these look?
960 :param to: Placement directive as a string. For example:
962 '23' - place on machine 23
963 'lxd:7' - place in new lxd container on machine 7
964 '24/lxd/3' - place in container 3 on machine 24
966 If None, a new machine is provisioned.
971 - application_name is required; fill this in automatically if not
973 - series is required; how do we pick a default?
977 placement
= parse_placement(to
)
983 k
: client
.Constraints(**v
)
984 for k
, v
in storage
.items()
988 entity_url
.startswith('local:') or
989 os
.path
.isdir(entity_url
)
991 entity_id
= await self
.charmstore
.entityId(entity_url
) \
992 if not is_local
else entity_url
994 app_facade
= client
.ApplicationFacade()
995 client_facade
= client
.ClientFacade()
996 app_facade
.connect(self
.connection
)
997 client_facade
.connect(self
.connection
)
999 is_bundle
= ((is_local
and
1000 (Path(entity_id
) / 'bundle.yaml').exists()) or
1001 (not is_local
and 'bundle/' in entity_id
))
1004 handler
= BundleHandler(self
)
1005 await handler
.fetch_plan(entity_id
)
1006 await handler
.execute_plan()
1007 extant_apps
= {app
for app
in self
.applications
}
1008 pending_apps
= set(handler
.applications
) - extant_apps
1010 # new apps will usually be in the model by now, but if some
1011 # haven't made it yet we'll need to wait on them to be added
1012 await asyncio
.gather(*[
1013 asyncio
.ensure_future(
1014 self
._wait
_for
_new
('application', app_name
),
1016 for app_name
in pending_apps
1018 return [app
for name
, app
in self
.applications
.items()
1019 if name
in handler
.applications
]
1022 'Deploying %s', entity_id
)
1025 await client_facade
.AddCharm(channel
, entity_id
)
1026 elif not entity_id
.startswith('local:'):
1027 # We have a local charm dir that needs to be uploaded
1028 charm_dir
= os
.path
.abspath(
1029 os
.path
.expanduser(entity_id
))
1030 series
= series
or get_charm_series(charm_dir
)
1033 "Couldn't determine series for charm at {}. "
1034 "Pass a 'series' kwarg to Model.deploy().".format(
1036 entity_id
= await self
.add_local_charm_dir(charm_dir
, series
)
1038 app
= client
.ApplicationDeploy(
1039 application
=application_name
,
1041 charm_url
=entity_id
,
1043 constraints
=parse_constraints(constraints
),
1044 endpoint_bindings
=bind
,
1045 num_units
=num_units
,
1046 resources
=resources
,
1050 app
.placement
= placement
1052 result
= await app_facade
.Deploy([app
])
1053 errors
= [r
.error
.message
for r
in result
.results
if r
.error
]
1055 raise JujuError('\n'.join(errors
))
1056 return await self
._wait
_for
_new
('application', application_name
)
1059 """Terminate all machines and resources for this model.
1062 raise NotImplementedError()
1064 async def destroy_unit(self
, *unit_names
):
1065 """Destroy units by name.
1068 app_facade
= client
.ApplicationFacade()
1069 app_facade
.connect(self
.connection
)
1072 'Destroying unit%s %s',
1073 's' if len(unit_names
) == 1 else '',
1074 ' '.join(unit_names
))
1076 return await app_facade
.DestroyUnits(list(unit_names
))
1077 destroy_units
= destroy_unit
1079 def get_backup(self
, archive_id
):
1080 """Download a backup archive file.
1082 :param str archive_id: The id of the archive to download
1083 :return str: Path to the archive file
1086 raise NotImplementedError()
1089 self
, num_controllers
=0, constraints
=None, series
=None, to
=None):
1090 """Ensure sufficient controllers exist to provide redundancy.
1092 :param int num_controllers: Number of controllers to make available
1093 :param constraints: Constraints to apply to the controller machines
1094 :type constraints: :class:`juju.Constraints`
1095 :param str series: Series of the controller machines
1096 :param list to: Placement directives for controller machines, e.g.::
1099 'lxc:7' - new lxc container on machine 7
1100 '24/lxc/3' - lxc container 3 or machine 24
1102 If None, a new machine is provisioned.
1105 raise NotImplementedError()
1107 def get_config(self
):
1108 """Return the configuration settings for this model.
1111 raise NotImplementedError()
1113 def get_constraints(self
):
1114 """Return the machine constraints for this model.
1117 raise NotImplementedError()
1119 def grant(self
, username
, acl
='read'):
1120 """Grant a user access to this model.
1122 :param str username: Username
1123 :param str acl: Access control ('read' or 'write')
1126 raise NotImplementedError()
1128 def import_ssh_key(self
, identity
):
1129 """Add a public SSH key from a trusted indentity source to this model.
1131 :param str identity: User identity in the form <lp|gh>:<username>
1134 raise NotImplementedError()
1135 import_ssh_keys
= import_ssh_key
1137 def get_machines(self
, machine
, utc
=False):
1138 """Return list of machines in this model.
1140 :param str machine: Machine id, e.g. '0'
1141 :param bool utc: Display time as UTC in RFC3339 format
1144 raise NotImplementedError()
1146 def get_shares(self
):
1147 """Return list of all users with access to this model.
1150 raise NotImplementedError()
1152 def get_spaces(self
):
1153 """Return list of all known spaces, including associated subnets.
1156 raise NotImplementedError()
1158 def get_ssh_key(self
):
1159 """Return known SSH keys for this model.
1162 raise NotImplementedError()
1163 get_ssh_keys
= get_ssh_key
1165 def get_storage(self
, filesystem
=False, volume
=False):
1166 """Return details of storage instances.
1168 :param bool filesystem: Include filesystem storage
1169 :param bool volume: Include volume storage
1172 raise NotImplementedError()
1174 def get_storage_pools(self
, names
=None, providers
=None):
1175 """Return list of storage pools.
1177 :param list names: Only include pools with these names
1178 :param list providers: Only include pools for these providers
1181 raise NotImplementedError()
1183 def get_subnets(self
, space
=None, zone
=None):
1184 """Return list of known subnets.
1186 :param str space: Only include subnets in this space
1187 :param str zone: Only include subnets in this zone
1190 raise NotImplementedError()
1192 def remove_blocks(self
):
1193 """Remove all blocks from this model.
1196 raise NotImplementedError()
1198 def remove_backup(self
, backup_id
):
1201 :param str backup_id: The id of the backup to remove
1204 raise NotImplementedError()
1206 def remove_cached_images(self
, arch
=None, kind
=None, series
=None):
1207 """Remove cached OS images.
1209 :param str arch: Architecture of the images to remove
1210 :param str kind: Image kind to remove, e.g. 'lxd'
1211 :param str series: Image series to remove, e.g. 'xenial'
1214 raise NotImplementedError()
1216 def remove_machine(self
, *machine_ids
):
1217 """Remove a machine from this model.
1219 :param str \*machine_ids: Ids of the machines to remove
1222 raise NotImplementedError()
1223 remove_machines
= remove_machine
1225 def remove_ssh_key(self
, *keys
):
1226 """Remove a public SSH key(s) from this model.
1228 :param str \*keys: Keys to remove
1231 raise NotImplementedError()
1232 remove_ssh_keys
= remove_ssh_key
1235 self
, bootstrap
=False, constraints
=None, archive
=None,
1236 backup_id
=None, upload_tools
=False):
1237 """Restore a backup archive to a new controller.
1239 :param bool bootstrap: Bootstrap a new state machine
1240 :param constraints: Model constraints
1241 :type constraints: :class:`juju.Constraints`
1242 :param str archive: Path to backup archive to restore
1243 :param str backup_id: Id of backup to restore
1244 :param bool upload_tools: Upload tools if bootstrapping a new machine
1247 raise NotImplementedError()
1249 def retry_provisioning(self
):
1250 """Retry provisioning for failed machines.
1253 raise NotImplementedError()
1255 def revoke(self
, username
, acl
='read'):
1256 """Revoke a user's access to this model.
1258 :param str username: Username to revoke
1259 :param str acl: Access control ('read' or 'write')
1262 raise NotImplementedError()
1264 def run(self
, command
, timeout
=None):
1265 """Run command on all machines in this model.
1267 :param str command: The command to run
1268 :param int timeout: Time to wait before command is considered failed
1271 raise NotImplementedError()
1273 def set_config(self
, **config
):
1274 """Set configuration keys on this model.
1276 :param \*\*config: Config key/values
1279 raise NotImplementedError()
1281 def set_constraints(self
, constraints
):
1282 """Set machine constraints on this model.
1284 :param :class:`juju.Constraints` constraints: Machine constraints
1287 raise NotImplementedError()
1289 def get_action_output(self
, action_uuid
, wait
=-1):
1290 """Get the results of an action by ID.
1292 :param str action_uuid: Id of the action
1293 :param int wait: Time in seconds to wait for action to complete
1296 raise NotImplementedError()
1298 def get_action_status(self
, uuid_or_prefix
=None, name
=None):
1299 """Get the status of all actions, filtered by ID, ID prefix, or action name.
1301 :param str uuid_or_prefix: Filter by action uuid or prefix
1302 :param str name: Filter by action name
1305 raise NotImplementedError()
1307 def get_budget(self
, budget_name
):
1308 """Get budget usage info.
1310 :param str budget_name: Name of budget
1313 raise NotImplementedError()
1315 async def get_status(self
, filters
=None, utc
=False):
1316 """Return the status of the model.
1318 :param str filters: Optional list of applications, units, or machines
1319 to include, which can use wildcards ('*').
1320 :param bool utc: Display time as UTC in RFC3339 format
1323 client_facade
= client
.ClientFacade()
1324 client_facade
.connect(self
.connection
)
1325 return await client_facade
.FullStatus(filters
)
1328 self
, all_
=False, destination
=None, dry_run
=False, public
=False,
1329 source
=None, stream
=None, version
=None):
1330 """Copy Juju tools into this model.
1332 :param bool all_: Copy all versions, not just the latest
1333 :param str destination: Path to local destination directory
1334 :param bool dry_run: Don't do the actual copy
1335 :param bool public: Tools are for a public cloud, so generate mirrors
1337 :param str source: Path to local source directory
1338 :param str stream: Simplestreams stream for which to sync metadata
1339 :param str version: Copy a specific major.minor version
1342 raise NotImplementedError()
1344 def unblock(self
, *commands
):
1345 """Unblock an operation that would alter this model.
1347 :param str \*commands: The commands to unblock. Valid values are
1348 'all-changes', 'destroy-model', 'remove-object'
1351 raise NotImplementedError()
1353 def unset_config(self
, *keys
):
1354 """Unset configuration on this model.
1356 :param str \*keys: The keys to unset
1359 raise NotImplementedError()
1361 def upgrade_gui(self
):
1362 """Upgrade the Juju GUI for this model.
1365 raise NotImplementedError()
1368 self
, dry_run
=False, reset_previous_upgrade
=False,
1369 upload_tools
=False, version
=None):
1370 """Upgrade Juju on all machines in a model.
1372 :param bool dry_run: Don't do the actual upgrade
1373 :param bool reset_previous_upgrade: Clear the previous (incomplete)
1375 :param bool upload_tools: Upload local version of tools
1376 :param str version: Upgrade to a specific version
1379 raise NotImplementedError()
1381 def upload_backup(self
, archive_path
):
1382 """Store a backup archive remotely in Juju.
1384 :param str archive_path: Path to local archive
1387 raise NotImplementedError()
1390 def charmstore(self
):
1391 return self
._charmstore
1393 async def get_metrics(self
, *tags
):
1394 """Retrieve metrics.
1396 :param str \*tags: Tags of entities from which to retrieve metrics.
1397 No tags retrieves the metrics of all units in the model.
1398 :return: Dictionary of unit_name:metrics
1401 log
.debug("Retrieving metrics for %s",
1402 ', '.join(tags
) if tags
else "all units")
1404 metrics_facade
= client
.MetricsDebugFacade()
1405 metrics_facade
.connect(self
.connection
)
1407 entities
= [client
.Entity(tag
) for tag
in tags
]
1408 metrics_result
= await metrics_facade
.GetMetrics(entities
)
1410 metrics
= collections
.defaultdict(list)
1412 for entity_metrics
in metrics_result
.results
:
1413 error
= entity_metrics
.error
1415 if "is not a valid tag" in error
:
1416 raise ValueError(error
.message
)
1418 raise Exception(error
.message
)
1420 for metric
in entity_metrics
.metrics
:
1421 metrics
[metric
.unit
].append(vars(metric
))
1426 def get_charm_series(path
):
1427 """Inspects the charm directory at ``path`` and returns a default
1428 series from its metadata.yaml (the first item in the 'series' list).
1430 Returns None if no series can be determined.
1433 md
= Path(path
) / "metadata.yaml"
1436 data
= yaml
.load(md
.open())
1437 series
= data
.get('series')
1438 return series
[0] if series
else None
1441 class BundleHandler(object):
1443 Handle bundles by using the API to translate bundle YAML into a plan of
1444 steps and then dispatching each of those using the API.
1446 def __init__(self
, model
):
1448 self
.charmstore
= model
.charmstore
1450 self
.references
= {}
1451 self
._units
_by
_app
= {}
1452 for unit_name
, unit
in model
.units
.items():
1453 app_units
= self
._units
_by
_app
.setdefault(unit
.application
, [])
1454 app_units
.append(unit_name
)
1455 self
.client_facade
= client
.ClientFacade()
1456 self
.client_facade
.connect(model
.connection
)
1457 self
.app_facade
= client
.ApplicationFacade()
1458 self
.app_facade
.connect(model
.connection
)
1459 self
.ann_facade
= client
.AnnotationsFacade()
1460 self
.ann_facade
.connect(model
.connection
)
1462 async def _handle_local_charms(self
, bundle
):
1463 """Search for references to local charms (i.e. filesystem paths)
1464 in the bundle. Upload the local charms to the model, and replace
1465 the filesystem paths with appropriate 'local:' paths in the bundle.
1467 Return the modified bundle.
1469 :param dict bundle: Bundle dictionary
1470 :return: Modified bundle dictionary
1475 default_series
= bundle
.get('series')
1476 for app_name
in self
.applications
:
1477 app_dict
= bundle
['services'][app_name
]
1478 charm_dir
= os
.path
.abspath(os
.path
.expanduser(app_dict
['charm']))
1479 if not os
.path
.isdir(charm_dir
):
1482 app_dict
.get('series') or
1484 get_charm_series(charm_dir
)
1488 "Couldn't determine series for charm at {}. "
1489 "Add a 'series' key to the bundle.".format(charm_dir
))
1491 # Keep track of what we need to update. We keep a list of apps
1492 # that need to be updated, and a corresponding list of args
1493 # needed to update those apps.
1494 apps
.append(app_name
)
1495 args
.append((charm_dir
, series
))
1498 # If we have apps to update, spawn all the coroutines concurrently
1499 # and wait for them to finish.
1500 charm_urls
= await asyncio
.gather(*[
1501 self
.model
.add_local_charm_dir(*params
)
1503 ], loop
=self
.model
.loop
)
1504 # Update the 'charm:' entry for each app with the new 'local:' url.
1505 for app_name
, charm_url
in zip(apps
, charm_urls
):
1506 bundle
['services'][app_name
]['charm'] = charm_url
1510 async def fetch_plan(self
, entity_id
):
1511 is_local
= not entity_id
.startswith('cs:') and os
.path
.isdir(entity_id
)
1513 bundle_yaml
= (Path(entity_id
) / "bundle.yaml").read_text()
1515 bundle_yaml
= await self
.charmstore
.files(entity_id
,
1516 filename
='bundle.yaml',
1518 self
.bundle
= yaml
.safe_load(bundle_yaml
)
1519 self
.bundle
= await self
._handle
_local
_charms
(self
.bundle
)
1521 self
.plan
= await self
.client_facade
.GetBundleChanges(
1522 yaml
.dump(self
.bundle
))
1524 if self
.plan
.errors
:
1525 raise JujuError('\n'.join(self
.plan
.errors
))
1527 async def execute_plan(self
):
1528 for step
in self
.plan
.changes
:
1529 method
= getattr(self
, step
.method
)
1530 result
= await method(*step
.args
)
1531 self
.references
[step
.id_
] = result
1534 def applications(self
):
1535 return list(self
.bundle
['services'].keys())
1537 def resolve(self
, reference
):
1538 if reference
and reference
.startswith('$'):
1539 reference
= self
.references
[reference
[1:]]
1542 async def addCharm(self
, charm
, series
):
1544 :param charm string:
1545 Charm holds the URL of the charm to be added.
1547 :param series string:
1548 Series holds the series of the charm to be added
1549 if the charm default is not sufficient.
1551 # We don't add local charms because they've already been added
1552 # by self._handle_local_charms
1553 if charm
.startswith('local:'):
1556 entity_id
= await self
.charmstore
.entityId(charm
)
1557 log
.debug('Adding %s', entity_id
)
1558 await self
.client_facade
.AddCharm(None, entity_id
)
1561 async def addMachines(self
, params
=None):
1564 Dictionary specifying the machine to add. All keys are optional.
1567 series: string specifying the machine OS series.
1569 constraints: string holding machine constraints, if any. We'll
1570 parse this into the json friendly dict that the juju api
1573 container_type: string holding the type of the container (for
1574 instance ""lxd" or kvm"). It is not specified for top level
1577 parent_id: string holding a placeholder pointing to another
1578 machine change or to a unit change. This value is only
1579 specified in the case this machine is a container, in
1580 which case also ContainerType is set.
1583 params
= params
or {}
1586 params
= {normalize_key(k
): params
[k
] for k
in params
.keys()}
1588 # Fix up values, as necessary.
1589 if 'parent_id' in params
:
1590 params
['parent_id'] = self
.resolve(params
['parent_id'])
1592 params
['constraints'] = parse_constraints(
1593 params
.get('constraints'))
1594 params
['jobs'] = params
.get('jobs', ['JobHostUnits'])
1596 if params
.get('container_type') == 'lxc':
1597 log
.warning('Juju 2.0 does not support lxc containers. '
1598 'Converting containers to lxd.')
1599 params
['container_type'] = 'lxd'
1601 # Submit the request.
1602 params
= client
.AddMachineParams(**params
)
1603 results
= await self
.client_facade
.AddMachines([params
])
1604 error
= results
.machines
[0].error
1606 raise ValueError("Error adding machine: %s", error
.message
)
1607 machine
= results
.machines
[0].machine
1608 log
.debug('Added new machine %s', machine
)
1611 async def addRelation(self
, endpoint1
, endpoint2
):
1613 :param endpoint1 string:
1614 :param endpoint2 string:
1615 Endpoint1 and Endpoint2 hold relation endpoints in the
1616 "application:interface" form, where the application is always a
1617 placeholder pointing to an application change, and the interface is
1618 optional. Examples are "$deploy-42:web" or just "$deploy-42".
1620 endpoints
= [endpoint1
, endpoint2
]
1621 # resolve indirect references
1622 for i
in range(len(endpoints
)):
1623 parts
= endpoints
[i
].split(':')
1624 parts
[0] = self
.resolve(parts
[0])
1625 endpoints
[i
] = ':'.join(parts
)
1627 log
.info('Relating %s <-> %s', *endpoints
)
1628 return await self
.model
.add_relation(*endpoints
)
1630 async def deploy(self
, charm
, series
, application
, options
, constraints
,
1631 storage
, endpoint_bindings
, resources
):
1633 :param charm string:
1634 Charm holds the URL of the charm to be used to deploy this
1637 :param series string:
1638 Series holds the series of the application to be deployed
1639 if the charm default is not sufficient.
1641 :param application string:
1642 Application holds the application name.
1644 :param options map[string]interface{}:
1645 Options holds application options.
1647 :param constraints string:
1648 Constraints holds the optional application constraints.
1650 :param storage map[string]string:
1651 Storage holds the optional storage constraints.
1653 :param endpoint_bindings map[string]string:
1654 EndpointBindings holds the optional endpoint bindings
1656 :param resources map[string]int:
1657 Resources identifies the revision to use for each resource
1658 of the application's charm.
1660 # resolve indirect references
1661 charm
= self
.resolve(charm
)
1662 # stringify all config values for API, and convert to YAML
1663 options
= {k
: str(v
) for k
, v
in options
.items()}
1664 options
= yaml
.dump({application
: options
}, default_flow_style
=False)
1665 # build param object
1666 app
= client
.ApplicationDeploy(
1669 application
=application
,
1670 # Pass options to config-yaml rather than config, as
1671 # config-yaml invokes a newer codepath that better handles
1672 # empty strings in the options values.
1673 config_yaml
=options
,
1674 constraints
=parse_constraints(constraints
),
1676 endpoint_bindings
=endpoint_bindings
,
1677 resources
=resources
,
1680 log
.info('Deploying %s', charm
)
1681 await self
.app_facade
.Deploy([app
])
1682 # ensure the app is in the model for future operations
1683 await self
.model
._wait
_for
_new
('application', application
)
1686 async def addUnit(self
, application
, to
):
1688 :param application string:
1689 Application holds the application placeholder name for which a unit
1693 To holds the optional location where to add the unit, as a
1694 placeholder pointing to another unit change or to a machine change.
1696 application
= self
.resolve(application
)
1697 placement
= self
.resolve(to
)
1698 if self
._units
_by
_app
.get(application
):
1699 # enough units for this application already exist;
1700 # claim one, and carry on
1701 # NB: this should probably honor placement, but the juju client
1702 # doesn't, so we're not bothering, either
1703 unit_name
= self
._units
_by
_app
[application
].pop()
1704 log
.debug('Reusing unit %s for %s', unit_name
, application
)
1705 return self
.model
.units
[unit_name
]
1707 log
.debug('Adding new unit for %s%s', application
,
1708 ' to %s' % placement
if placement
else '')
1709 return await self
.model
.applications
[application
].add_unit(
1714 async def expose(self
, application
):
1716 :param application string:
1717 Application holds the placeholder name of the application that must
1720 application
= self
.resolve(application
)
1721 log
.info('Exposing %s', application
)
1722 return await self
.model
.applications
[application
].expose()
1724 async def setAnnotations(self
, id_
, entity_type
, annotations
):
1727 Id is the placeholder for the application or machine change
1728 corresponding to the entity to be annotated.
1730 :param entity_type EntityType:
1731 EntityType holds the type of the entity, "application" or
1734 :param annotations map[string]string:
1735 Annotations holds the annotations as key/value pairs.
1737 entity_id
= self
.resolve(id_
)
1739 entity
= self
.model
.state
.get_entity(entity_type
, entity_id
)
1741 entity
= await self
.model
._wait
_for
_new
(entity_type
, entity_id
)
1742 return await entity
.set_annotations(annotations
)
1745 class CharmStore(object):
1747 Async wrapper around theblues.charmstore.CharmStore
1749 def __init__(self
, loop
):
1751 self
._cs
= charmstore
.CharmStore()
1753 def __getattr__(self
, name
):
1755 Wrap method calls in coroutines that use run_in_executor to make them
1758 attr
= getattr(self
._cs
, name
)
1759 if not callable(attr
):
1760 wrapper
= partial(getattr, self
._cs
, name
)
1761 setattr(self
, name
, wrapper
)
1763 async def coro(*args
, **kwargs
):
1764 method
= partial(attr
, *args
, **kwargs
)
1765 return await self
.loop
.run_in_executor(None, method
)
1766 setattr(self
, name
, coro
)
1771 class CharmArchiveGenerator(object):
1772 def __init__(self
, path
):
1773 self
.path
= os
.path
.abspath(os
.path
.expanduser(path
))
1775 def make_archive(self
, path
):
1776 """Create archive of directory and write to ``path``.
1778 :param path: Path to archive
1782 * build/\* - This is used for packing the charm itself and any
1784 * \*/.\* - Hidden files are all ignored for now. This will most
1785 likely be changed into a specific ignore list
1789 zf
= zipfile
.ZipFile(path
, 'w', zipfile
.ZIP_DEFLATED
)
1790 for dirpath
, dirnames
, filenames
in os
.walk(self
.path
):
1791 relative_path
= dirpath
[len(self
.path
) + 1:]
1792 if relative_path
and not self
._ignore
(relative_path
):
1793 zf
.write(dirpath
, relative_path
)
1794 for name
in filenames
:
1795 archive_name
= os
.path
.join(relative_path
, name
)
1796 if not self
._ignore
(archive_name
):
1797 real_path
= os
.path
.join(dirpath
, name
)
1798 self
._check
_type
(real_path
)
1799 if os
.path
.islink(real_path
):
1800 self
._check
_link
(real_path
)
1801 self
._write
_symlink
(
1802 zf
, os
.readlink(real_path
), archive_name
)
1804 zf
.write(real_path
, archive_name
)
1808 def _check_type(self
, path
):
1812 if stat
.S_ISDIR(s
.st_mode
) or stat
.S_ISREG(s
.st_mode
):
1814 raise ValueError("Invalid Charm at % %s" % (
1815 path
, "Invalid file type for a charm"))
1817 def _check_link(self
, path
):
1818 link_path
= os
.readlink(path
)
1819 if link_path
[0] == "/":
1821 "Invalid Charm at %s: %s" % (
1822 path
, "Absolute links are invalid"))
1823 path_dir
= os
.path
.dirname(path
)
1824 link_path
= os
.path
.join(path_dir
, link_path
)
1825 if not link_path
.startswith(os
.path
.abspath(self
.path
)):
1827 "Invalid charm at %s %s" % (
1828 path
, "Only internal symlinks are allowed"))
1830 def _write_symlink(self
, zf
, link_target
, link_path
):
1831 """Package symlinks with appropriate zipfile metadata."""
1832 info
= zipfile
.ZipInfo()
1833 info
.filename
= link_path
1834 info
.create_system
= 3
1835 # Magic code for symlinks / py2/3 compat
1836 # 27166663808 = (stat.S_IFLNK | 0755) << 16
1837 info
.external_attr
= 2716663808
1838 zf
.writestr(info
, link_target
)
1840 def _ignore(self
, path
):
1841 if path
== "build" or path
.startswith("build/"):
1843 if path
.startswith('.'):