This file is indexed.

/usr/lib/python2.7/dist-packages/jujubundlelib/changeset.py is in python-jujubundlelib 0.4.1-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
# Copyright 2015 Canonical Ltd.
# Licensed under the AGPLv3, see LICENCE file for details.

from __future__ import unicode_literals

import copy
import itertools

import models
import utils


class ChangeSet(object):
    """Hold the state for parser handlers.

    Also expose methods to send and receive changes (usually Python dicts).
    """
    services_added = {}
    machines_added = {}

    def __init__(self, bundle):
        self.bundle = bundle
        self._changeset = []
        self._counter = itertools.count()

    def send(self, change):
        """Store a change in this change set."""
        self._changeset.append(change)

    def recv(self):
        """Return all the collected changes.

        Changes are stored using self.send().
        """
        changeset = self._changeset
        self._changeset = []
        return changeset

    def next_action(self):
        """Return an incremental integer to be included in the changes ids."""
        return next(self._counter)

    def is_legacy_bundle(self):
        """Report whether the bundle uses the legacy (version 3) syntax."""
        return utils.is_legacy_bundle(self.bundle)


def handle_services(changeset):
    """Populate the change set with addCharm and deploy changes."""
    charms = {}
    for service_name, service in sorted(changeset.bundle['services'].items()):
        # Add the addCharm record if one hasn't been added yet.
        if service['charm'] not in charms:
            record_id = 'addCharm-{}'.format(changeset.next_action())
            changeset.send({
                'id': record_id,
                'method': 'addCharm',
                'args': [service['charm']],
                'requires': [],
            })
            charms[service['charm']] = record_id

        # Add the deploy record for this service.
        record_id = 'deploy-{}'.format(changeset.next_action())
        changeset.send({
            'id': record_id,
            'method': 'deploy',
            'args': [
                '${}'.format(charms[service['charm']]),
                service_name,
                service.get('options', {}),
                service.get('constraints', ''),
                service.get('storage', {}),
            ],
            'requires': [charms[service['charm']]],
        })
        changeset.services_added[service_name] = record_id

        # Expose this service if required.
        if service.get('expose'):
            changeset.send({
                'id': 'expose-{}'.format(changeset.next_action()),
                'method': 'expose',
                'args': ['${}'.format(record_id)],
                'requires': [record_id],
            })

        # Set the annotations for this service.
        if 'annotations' in service:
            changeset.send({
                'id': 'setAnnotations-{}'.format(changeset.next_action()),
                'method': 'setAnnotations',
                'args': [
                    '${}'.format(record_id),
                    'service',
                    service['annotations'],
                ],
                'requires': [record_id],
            })

    return handle_machines


def handle_machines(changeset):
    """Populate the change set with addMachines changes."""
    machines = sorted(changeset.bundle.get('machines', {}).items())
    for machine_name, machine in machines:
        if machine is None:
            # We allow the machine value to be unset in the YAML.
            machine = {}
        record_id = 'addMachines-{}'.format(changeset.next_action())
        changeset.send({
            'id': record_id,
            'method': 'addMachines',
            'args': [
                {
                    'series': machine.get('series', ''),
                    'constraints': machine.get('constraints', ''),
                },
            ],
            'requires': [],
        })
        changeset.machines_added[str(machine_name)] = record_id
        if 'annotations' in machine:
            changeset.send({
                'id': 'setAnnotations-{}'.format(changeset.next_action()),
                'method': 'setAnnotations',
                'args': [
                    '${}'.format(record_id),
                    'machine',
                    machine['annotations'],
                ],
                'requires': [record_id],
            })
    return handle_relations


def handle_relations(changeset):
    """Populate the change set with addRelation changes."""
    for relation in changeset.bundle.get('relations', []):
        relations = [models.Relation(*i.split(':')) if ':' in i
                     else models.Relation(i, '') for i in relation]
        changeset.send({
            'id': 'addRelation-{}'.format(changeset.next_action()),
            'method': 'addRelation',
            'args': [
                '${}'.format(
                    changeset.services_added[rel.name]) +
                (':{}'.format(rel.interface) if rel.interface else '')
                for rel in relations
            ],
            'requires': [changeset.services_added[rel.name] for
                         rel in relations],
        })
    return handle_units


def handle_units(changeset):
    """Populate the change set with addUnit changes."""
    units, records = {}, {}
    for service_name, service in sorted(changeset.bundle['services'].items()):
        for i in range(service.get('num_units', 0)):
            record_id = 'addUnit-{}'.format(changeset.next_action())
            unit_name = '{}/{}'.format(service_name, i)
            records[record_id] = {
                'id': record_id,
                'method': 'addUnit',
                'args': [
                    '${}'.format(changeset.services_added[service_name]),
                    None,
                ],
                'requires': [changeset.services_added[service_name]],
            }
            units[unit_name] = {
                'record': record_id,
                'service': service_name,
                'unit': i,
            }
    _handle_units_placement(changeset, units, records)


def _handle_units_placement(changeset, units, records):
    """Ensure that requires and placement directives are taken into account."""
    for service_name, service in sorted(changeset.bundle['services'].items()):
        num_units = service.get('num_units')
        if num_units is None:
            # This is a subordinate service.
            continue
        placement_directives = service.get('to', [])
        if not isinstance(placement_directives, (list, tuple)):
            placement_directives = [placement_directives]
        if placement_directives and not changeset.is_legacy_bundle():
            placement_directives += (
                placement_directives[-1:] *
                (num_units - len(placement_directives)))
        placed_in_services = {}
        for i in range(num_units):
            unit = units['{}/{}'.format(service_name, i)]
            record = records[unit['record']]
            if i < len(placement_directives):
                record = _handle_unit_placement(
                    changeset, units, unit, record, placement_directives[i],
                    placed_in_services)
            changeset.send(record)


def _handle_unit_placement(
        changeset, units, unit, record, placement_directive,
        placed_in_services):
    record = copy.deepcopy(record)
    if changeset.is_legacy_bundle():
        placement = models.parse_v3_unit_placement(placement_directive)
    else:
        placement = models.parse_v4_unit_placement(placement_directive)
    if placement.machine:
        # The unit is placed on a machine.
        if placement.machine == 'new':
            parent_record_id = 'addMachines-{}'.format(changeset.next_action())
            options = {}
            if placement.container_type:
                options = {'containerType': placement.container_type}
            changeset.send({
                'id': parent_record_id,
                'method': 'addMachines',
                'args': [options],
                'requires': [],
            })
        else:
            if changeset.is_legacy_bundle():
                record['args'][-1] = '0'
                return record
            parent_record_id = changeset.machines_added[placement.machine]
            if placement.container_type:
                parent_record_id = _handle_container_placement(
                    changeset, placement, parent_record_id)
    else:
        # The unit is placed to a unit or to a service.
        service = placement.service
        unit_number = placement.unit
        if unit_number is None:
            unit_number = _next_unit_in_service(service, placed_in_services)
        placement_unit = '{}/{}'.format(service, unit_number)
        parent_record_id = units[placement_unit]['record']
        if placement.container_type:
                parent_record_id = _handle_container_placement(
                    changeset, placement, parent_record_id)
    record['requires'].append(parent_record_id)
    record['args'][-1] = '${}'.format(parent_record_id)
    return record


def _next_unit_in_service(service, placed_in_services):
    """Return the unit number where to place a unit placed on a service.

    Receive the service name and a dict mapping service names to the current
    number of placed units in that service.
    """
    current = placed_in_services.get(service)
    number = 0 if current is None else current + 1
    placed_in_services[service] = number
    return number


def _handle_container_placement(changeset, placement, machine_record_id):
    container_record_id = 'addMachines-{}'.format(changeset.next_action())
    options = {
        'containerType': placement.container_type,
        'parentId': '${}'.format(machine_record_id),
    }
    changeset.send({
        'id': container_record_id,
        'method': 'addMachines',
        'args': [options],
        'requires': [machine_record_id],
    })
    return container_record_id


def parse(bundle, handler=handle_services):
    """Return a generator yielding changes required to deploy the given bundle.

    The bundle argument is a YAML decoded Python dict.
    """
    changeset = ChangeSet(bundle)
    while True:
        handler = handler(changeset)
        for change in changeset.recv():
            yield change
        if handler is None:
            break