EcsTaskDefinition.role_arn() - Code Metrics - Inspection of "Task role support" - fabfuel/ecs-deploy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#10)

by Fabian

created 2016-11-15 12:48 UTC

EcsTaskDefinition.role_arn() A

↳ Parent: EcsTaskDefinition

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
crap	1

from datetime import datetime
from json import dumps

import boto3
from botocore.exceptions import ClientError, NoCredentialsError


class EcsClient(object):
    def __init__(self, access_key_id=None, secret_access_key=None, region=None, profile=None):
        session = boto3.session.Session(aws_access_key_id=access_key_id,
                                        aws_secret_access_key=secret_access_key,
                                        region_name=region,
                                        profile_name=profile)
        self.boto = session.client(u'ecs')

    def describe_services(self, cluster_name, service_name):
        return self.boto.describe_services(cluster=cluster_name, services=[service_name])

    def describe_task_definition(self, task_definition_arn):
        return self.boto.describe_task_definition(taskDefinition=task_definition_arn)

    def list_tasks(self, cluster_name, service_name):
        return self.boto.list_tasks(cluster=cluster_name, serviceName=service_name)

    def describe_tasks(self, cluster_name, task_arns):
        return self.boto.describe_tasks(cluster=cluster_name, tasks=task_arns)

    def register_task_definition(self, family, containers, volumes, role_arn):
        return self.boto.register_task_definition(
            family=family,
            containerDefinitions=containers,
            volumes=volumes,
            taskRoleArn=role_arn or ''
        )

    def deregister_task_definition(self, task_definition_arn):
        return self.boto.deregister_task_definition(taskDefinition=task_definition_arn)

    def update_service(self, cluster, service, desired_count, task_definition):
        return self.boto.update_service(
            cluster=cluster,
            service=service,
            desiredCount=desired_count,
            taskDefinition=task_definition
        )

    def run_task(self, cluster, task_definition, count, started_by, overrides):
        return self.boto.run_task(
            cluster=cluster,
            taskDefinition=task_definition,
            count=count,
            startedBy=started_by,
            overrides=overrides
        )


class EcsService(dict):
    def __init__(self, cluster, iterable=None, **kwargs):
        self._cluster = cluster
        super(EcsService, self).__init__(iterable, **kwargs)

    def set_desired_count(self, desired_count):
        self[u'desiredCount'] = desired_count

    def set_task_definition(self, task_definition):
        self[u'taskDefinition'] = task_definition.arn

    @property
    def cluster(self):
        return self._cluster

    @property
    def name(self):
        return self.get(u'serviceName')

    @property
    def task_definition(self):
        return self.get(u'taskDefinition')

    @property
    def desired_count(self):
        return self.get(u'desiredCount')

    @property
    def deployment_created_at(self):
        for deployment in self.get(u'deployments'):
            if deployment.get(u'status') == u'PRIMARY':
                return deployment.get(u'createdAt')
        return datetime.now()

    @property
    def deployment_updated_at(self):
        for deployment in self.get(u'deployments'):
            if deployment.get(u'status') == u'PRIMARY':
                return deployment.get(u'updatedAt')
        return datetime.now()

    @property
    def errors(self):
        errors = {}
        for event in self.get('events'):
            if u'unable' in event[u'message'] and event[u'createdAt'] >= self.deployment_updated_at:
                errors[event[u'createdAt'].isoformat()] = 'ERROR: %s' % event[u'message']
        return errors

    @property
    def older_errors(self):
        errors = {}
        for event in self.get('events'):
            if u'unable' in event[u'message'] and \
                                    self.deployment_created_at <= event[u'createdAt'] <= self.deployment_updated_at:
                errors[event[u'createdAt'].isoformat()] = 'ERROR: %s' % event[u'message']
        return errors


class EcsTaskDefinition(dict):
    def __init__(self, iterable=None, **kwargs):
        super(EcsTaskDefinition, self).__init__(iterable, **kwargs)
        self._diff = []

    @property
    def containers(self):
        return self.get(u'containerDefinitions')

    @property
    def container_names(self):
        for container in self.get(u'containerDefinitions'):
            yield container[u'name']

    @property
    def volumes(self):
        return self.get(u'volumes')

    @property
    def arn(self):
        return self.get(u'taskDefinitionArn')

    @property
    def family(self):
        return self.get(u'family')

    @property
    def role_arn(self):
        return self.get(u'taskRoleArn')

    @property
    def revision(self):
        return self.get(u'revision')

    @property
    def family_revision(self):
        return '%s:%d' % (self.get(u'family'), self.get(u'revision'))

    @property
    def diff(self):
        return self._diff

    def get_overrides(self):
        override = dict()
        overrides = []
        for diff in self.diff:
            if override.get('name') != diff.container:
                override = dict(name=diff.container)
                overrides.append(override)
            if diff.field == 'command':
                override['command'] = self.get_overrides_command(diff.value)
            elif diff.field == 'environment':
                override['environment'] = self.get_overrides_environment(diff.value)
        return overrides

    def get_overrides_command(self, command):
        return command.split(' ')

    def get_overrides_environment(self, environment_dict):
        return [{"name": e, "value": environment_dict[e]} for e in environment_dict]

    def set_images(self, tag=None, **images):
        self.validate_container_options(**images)
        for container in self.containers:
            if container[u'name'] in images:
                new_image = images[container[u'name']]
                diff = EcsTaskDefinitionDiff(container[u'name'], u'image', new_image, container[u'image'])
                self._diff.append(diff)
                container[u'image'] = new_image
            elif tag:
                image_definition = container[u'image'].rsplit(u':', 1)
                new_image = u'%s:%s' % (image_definition[0], tag.strip())
                diff = EcsTaskDefinitionDiff(container[u'name'], u'image', new_image, container[u'image'])
                self._diff.append(diff)
                container[u'image'] = new_image

    def set_commands(self, **commands):
        self.validate_container_options(**commands)
        for container in self.containers:
            if container[u'name'] in commands:
                new_command = commands[container[u'name']]
                diff = EcsTaskDefinitionDiff(container[u'name'], u'command', new_command, container.get(u'command'))
                self._diff.append(diff)
                container[u'command'] = [new_command]

    def set_environment(self, environment_list):
        environment = {}

        for env in environment_list:
            environment.setdefault(env[0], {})
            environment[env[0]][env[1]] = env[2]

        self.validate_container_options(**environment)
        for container in self.containers:
            if container[u'name'] in environment:
                self.apply_container_environment(container, environment[container[u'name']])

    def apply_container_environment(self, container, new_environment):
        old_environment = {env['name']: env['value'] for env in container.get('environment', {})}
        merged_environment = old_environment.copy()
        merged_environment.update(new_environment)

        diff = EcsTaskDefinitionDiff(container[u'name'], u'environment', merged_environment, old_environment)
        self._diff.append(diff)

        container[u'environment'] = [{"name": e, "value": merged_environment[e]} for e in merged_environment]

    def validate_container_options(self, **container_options):
        for container_name in container_options:
            if container_name not in self.container_names:
                raise UnknownContainerError(u'Unknown container: %s' % container_name)

    def set_role_arn(self, role_arn):
        if role_arn:
            diff = EcsTaskDefinitionDiff(None, u'role_arn', role_arn, self[u'taskRoleArn'])
            self[u'taskRoleArn'] = role_arn
            self._diff.append(diff)


class EcsTaskDefinitionDiff(object):
    def __init__(self, container, field, value, old_value):
        self.container = container
        self.field = field
        self.value = value
        self.old_value = old_value

    def __repr__(self):
        if self.container:
            return u"Changed %s of container '%s' to: %s (was: %s)" % (
                self.field,
                self.container,
                dumps(self.value),
                dumps(self.old_value)
            )
        else:
            return u"Changed %s to: %s (was: %s)" % (
                self.field,
                dumps(self.value),
                dumps(self.old_value)
            )



class EcsAction(object):
    def __init__(self, client, cluster_name, service_name):
        self._client = client
        self._cluster_name = cluster_name
        self._service_name = service_name

        try:
            self._service = self.get_service()
        except IndexError:
            raise ConnectionError(u'An error occurred when calling the DescribeServices operation: Service not found.')
        except ClientError as e:
            raise ConnectionError(str(e))
        except NoCredentialsError:
            raise ConnectionError(u'Unable to locate credentials. Configure credentials by running "aws configure".')

    def get_service(self):
        services_definition = self._client.describe_services(self._cluster_name, self._service_name)
        return EcsService(self._cluster_name, services_definition[u'services'][0])

    def get_current_task_definition(self, service):
        task_definition_payload = self._client.describe_task_definition(service.task_definition)
        task_definition = EcsTaskDefinition(task_definition_payload[u'taskDefinition'])
        return task_definition

    def get_task_definition(self, task_definition):
        task_definition_payload = self._client.describe_task_definition(task_definition)
        task_definition = EcsTaskDefinition(task_definition_payload[u'taskDefinition'])
        return task_definition

    def update_task_definition(self, task_definition):
        response = self._client.register_task_definition(
            task_definition.family,
            task_definition.containers,
            task_definition.volumes,
            task_definition.role_arn
        )
        new_task_definition = EcsTaskDefinition(response[u'taskDefinition'])
        self._client.deregister_task_definition(task_definition.arn)
        return new_task_definition

    def update_service(self, service):
        response = self._client.update_service(service.cluster, service.name, service.desired_count,
                                               service.task_definition)
        return EcsService(self._cluster_name, response[u'service'])

    def is_deployed(self, service):
        if len(service[u'deployments']) != 1:
            return False
        running_tasks = self._client.list_tasks(service.cluster, service.name)
        if not running_tasks[u'taskArns']:
            return service.desired_count == 0
        return service.desired_count == self.get_running_tasks_count(service, running_tasks[u'taskArns'])

    def get_running_tasks_count(self, service, task_arns):
        running_count = 0
        tasks_details = self._client.describe_tasks(self._cluster_name, task_arns)
        for task in tasks_details[u'tasks']:
            if task[u'taskDefinitionArn'] == service.task_definition and task[u'lastStatus'] == u'RUNNING':
                running_count += 1
        return running_count

    @property
    def client(self):
        return self._client

    @property
    def service(self):
        return self._service

    @property
    def cluster_name(self):
        return self._cluster_name

    @property
    def service_name(self):
        return self._service_name


class DeployAction(EcsAction):
    def deploy(self, task_definition):
        self._service.set_task_definition(task_definition)
        return self.update_service(self._service)


class ScaleAction(EcsAction):
    def scale(self, desired_count):
        self._service.set_desired_count(desired_count)
        return self.update_service(self._service)


class RunAction(EcsAction):
    def __init__(self, client, cluster_name):
        self._client = client
        self._cluster_name = cluster_name
        self.started_tasks = []

    def run(self, task_definition, count, started_by):
        result = self._client.run_task(
            cluster=self._cluster_name,
            task_definition=task_definition.family_revision,
            count=count,
            started_by=started_by,
            overrides=dict(containerOverrides=task_definition.get_overrides())
        )
        self.started_tasks = result['tasks']
        return True


class EcsError(Exception):
    pass


class ConnectionError(EcsError):
    pass


class UnknownContainerError(EcsError):
    pass


1	1	from datetime import datetime
2	1	from json import dumps
3
4	1	import boto3
5	1	from botocore.exceptions import ClientError, NoCredentialsError
6
7
8	1	class EcsClient(object):
9	1	def __init__(self, access_key_id=None, secret_access_key=None, region=None, profile=None):
10	1	session = boto3.session.Session(aws_access_key_id=access_key_id,
11		aws_secret_access_key=secret_access_key,
12		region_name=region,
13		profile_name=profile)
14	1	self.boto = session.client(u'ecs')
15
16	1	def describe_services(self, cluster_name, service_name):
17	1	return self.boto.describe_services(cluster=cluster_name, services=[service_name])
18
19	1	def describe_task_definition(self, task_definition_arn):
20	1	return self.boto.describe_task_definition(taskDefinition=task_definition_arn)
21
22	1	def list_tasks(self, cluster_name, service_name):
23	1	return self.boto.list_tasks(cluster=cluster_name, serviceName=service_name)
24
25	1	def describe_tasks(self, cluster_name, task_arns):
26	1	return self.boto.describe_tasks(cluster=cluster_name, tasks=task_arns)
27
28	1	def register_task_definition(self, family, containers, volumes, role_arn):
29	1	return self.boto.register_task_definition(
30		family=family,
31		containerDefinitions=containers,
32		volumes=volumes,
33		taskRoleArn=role_arn or ''
34		)
35
36	1	def deregister_task_definition(self, task_definition_arn):
37	1	return self.boto.deregister_task_definition(taskDefinition=task_definition_arn)
38
39	1	def update_service(self, cluster, service, desired_count, task_definition):
40	1	return self.boto.update_service(
41		cluster=cluster,
42		service=service,
43		desiredCount=desired_count,
44		taskDefinition=task_definition
45		)
46
47	1	def run_task(self, cluster, task_definition, count, started_by, overrides):
48	1	return self.boto.run_task(
49		cluster=cluster,
50		taskDefinition=task_definition,
51		count=count,
52		startedBy=started_by,
53		overrides=overrides
54		)
55
56
57	1	class EcsService(dict):
58	1	def __init__(self, cluster, iterable=None, **kwargs):
59	1	self._cluster = cluster
60	1	super(EcsService, self).__init__(iterable, **kwargs)
61
62	1	def set_desired_count(self, desired_count):
63	1	self[u'desiredCount'] = desired_count
64
65	1	def set_task_definition(self, task_definition):
66	1	self[u'taskDefinition'] = task_definition.arn
67
68	1	@property
69		def cluster(self):
70	1	return self._cluster
71
72	1	@property
73		def name(self):
74	1	return self.get(u'serviceName')
75
76	1	@property
77		def task_definition(self):
78	1	return self.get(u'taskDefinition')
79
80	1	@property
81		def desired_count(self):
82	1	return self.get(u'desiredCount')
83
84	1	@property
85		def deployment_created_at(self):
86	1	for deployment in self.get(u'deployments'):
87	1	if deployment.get(u'status') == u'PRIMARY':
88	1	return deployment.get(u'createdAt')
89	1	return datetime.now()
90
91	1	@property
92		def deployment_updated_at(self):
93	1	for deployment in self.get(u'deployments'):
94	1	if deployment.get(u'status') == u'PRIMARY':
95	1	return deployment.get(u'updatedAt')
96	1	return datetime.now()
97
98	1	@property
99		def errors(self):
100	1	errors = {}
101	1	for event in self.get('events'):
102	1	if u'unable' in event[u'message'] and event[u'createdAt'] >= self.deployment_updated_at:
103	1	errors[event[u'createdAt'].isoformat()] = 'ERROR: %s' % event[u'message']
104	1	return errors
105
106	1	@property
107		def older_errors(self):
108	1	errors = {}
109	1	for event in self.get('events'):
110	1	if u'unable' in event[u'message'] and \
111		self.deployment_created_at <= event[u'createdAt'] <= self.deployment_updated_at:
112	1	errors[event[u'createdAt'].isoformat()] = 'ERROR: %s' % event[u'message']
113	1	return errors
114
115
116	1	class EcsTaskDefinition(dict):
117	1	def __init__(self, iterable=None, **kwargs):
118	1	super(EcsTaskDefinition, self).__init__(iterable, **kwargs)
119	1	self._diff = []
120
121	1	@property
122		def containers(self):
123	1	return self.get(u'containerDefinitions')
124
125	1	@property
126		def container_names(self):
127	1	for container in self.get(u'containerDefinitions'):
128	1	yield container[u'name']
129
130	1	@property
131		def volumes(self):
132	1	return self.get(u'volumes')
133
134	1	@property
135		def arn(self):
136	1	return self.get(u'taskDefinitionArn')
137
138	1	@property
139		def family(self):
140	1	return self.get(u'family')
141
142	1	@property
143		def role_arn(self):
144	1	return self.get(u'taskRoleArn')
145
146	1	@property
147		def revision(self):
148	1	return self.get(u'revision')
149
150	1	@property
151		def family_revision(self):
152	1	return '%s:%d' % (self.get(u'family'), self.get(u'revision'))
153
154	1	@property
155		def diff(self):
156	1	return self._diff
157
158	1	def get_overrides(self):
159	1	override = dict()
160	1	overrides = []
161	1	for diff in self.diff:
162	1	if override.get('name') != diff.container:
163	1	override = dict(name=diff.container)
164	1	overrides.append(override)
165	1	if diff.field == 'command':
166	1	override['command'] = self.get_overrides_command(diff.value)
167	1	elif diff.field == 'environment':
168	1	override['environment'] = self.get_overrides_environment(diff.value)
169	1	return overrides
170
171	1	def get_overrides_command(self, command):
172	1	return command.split(' ')
173
174	1	def get_overrides_environment(self, environment_dict):
175	1	return [{"name": e, "value": environment_dict[e]} for e in environment_dict]
176
177	1	def set_images(self, tag=None, **images):
178	1	self.validate_container_options(**images)
179	1	for container in self.containers:
180	1	if container[u'name'] in images:
181	1	new_image = images[container[u'name']]
182	1	diff = EcsTaskDefinitionDiff(container[u'name'], u'image', new_image, container[u'image'])
183	1	self._diff.append(diff)
184	1	container[u'image'] = new_image
185	1	elif tag:
186	1	image_definition = container[u'image'].rsplit(u':', 1)
187	1	new_image = u'%s:%s' % (image_definition[0], tag.strip())
188	1	diff = EcsTaskDefinitionDiff(container[u'name'], u'image', new_image, container[u'image'])
189	1	self._diff.append(diff)
190	1	container[u'image'] = new_image
191
192	1	def set_commands(self, **commands):
193	1	self.validate_container_options(**commands)
194	1	for container in self.containers:
195	1	if container[u'name'] in commands:
196	1	new_command = commands[container[u'name']]
197	1	diff = EcsTaskDefinitionDiff(container[u'name'], u'command', new_command, container.get(u'command'))
198	1	self._diff.append(diff)
199	1	container[u'command'] = [new_command]
200
201	1	def set_environment(self, environment_list):
202	1	environment = {}
203
204	1	for env in environment_list:
205	1	environment.setdefault(env[0], {})
206	1	environment[env[0]][env[1]] = env[2]
207
208	1	self.validate_container_options(**environment)
209	1	for container in self.containers:
210	1	if container[u'name'] in environment:
211	1	self.apply_container_environment(container, environment[container[u'name']])
212
213	1	def apply_container_environment(self, container, new_environment):
214	1	old_environment = {env['name']: env['value'] for env in container.get('environment', {})}
215	1	merged_environment = old_environment.copy()
216	1	merged_environment.update(new_environment)
217
218	1	diff = EcsTaskDefinitionDiff(container[u'name'], u'environment', merged_environment, old_environment)
219	1	self._diff.append(diff)
220
221	1	container[u'environment'] = [{"name": e, "value": merged_environment[e]} for e in merged_environment]
222
223	1	def validate_container_options(self, **container_options):
224	1	for container_name in container_options:
225	1	if container_name not in self.container_names:
226	1	raise UnknownContainerError(u'Unknown container: %s' % container_name)
227
228	1	def set_role_arn(self, role_arn):
229	1	if role_arn:
230	1	diff = EcsTaskDefinitionDiff(None, u'role_arn', role_arn, self[u'taskRoleArn'])
231	1	self[u'taskRoleArn'] = role_arn
232	1	self._diff.append(diff)
233
234
235	1	class EcsTaskDefinitionDiff(object):
236	1	def __init__(self, container, field, value, old_value):
237	1	self.container = container
238	1	self.field = field
239	1	self.value = value
240	1	self.old_value = old_value
241
242	1	def __repr__(self):
243	1	if self.container:
244	1	return u"Changed %s of container '%s' to: %s (was: %s)" % (
245		self.field,
246		self.container,
247		dumps(self.value),
248		dumps(self.old_value)
249		)
250		else:
251	1	return u"Changed %s to: %s (was: %s)" % (
252		self.field,
253		dumps(self.value),
254		dumps(self.old_value)
255		)
256
257
258
259	1	class EcsAction(object):
260	1	def __init__(self, client, cluster_name, service_name):
261	1	self._client = client
262	1	self._cluster_name = cluster_name
263	1	self._service_name = service_name
264
265	1	try:
266	1	self._service = self.get_service()
267	1	except IndexError:
268	1	raise ConnectionError(u'An error occurred when calling the DescribeServices operation: Service not found.')
269	1	except ClientError as e:
270	1	raise ConnectionError(str(e))
271	1	except NoCredentialsError:
272	1	raise ConnectionError(u'Unable to locate credentials. Configure credentials by running "aws configure".')
273
274	1	def get_service(self):
275	1	services_definition = self._client.describe_services(self._cluster_name, self._service_name)
276	1	return EcsService(self._cluster_name, services_definition[u'services'][0])
277
278	1	def get_current_task_definition(self, service):
279	1	task_definition_payload = self._client.describe_task_definition(service.task_definition)
280	1	task_definition = EcsTaskDefinition(task_definition_payload[u'taskDefinition'])
281	1	return task_definition
282
283	1	def get_task_definition(self, task_definition):
284	1	task_definition_payload = self._client.describe_task_definition(task_definition)
285	1	task_definition = EcsTaskDefinition(task_definition_payload[u'taskDefinition'])
286	1	return task_definition
287
288	1	def update_task_definition(self, task_definition):
289	1	response = self._client.register_task_definition(
290		task_definition.family,
291		task_definition.containers,
292		task_definition.volumes,
293		task_definition.role_arn
294		)
295	1	new_task_definition = EcsTaskDefinition(response[u'taskDefinition'])
296	1	self._client.deregister_task_definition(task_definition.arn)
297	1	return new_task_definition
298
299	1	def update_service(self, service):
300	1	response = self._client.update_service(service.cluster, service.name, service.desired_count,
301		service.task_definition)
302	1	return EcsService(self._cluster_name, response[u'service'])
303
304	1	def is_deployed(self, service):
305	1	if len(service[u'deployments']) != 1:
306	1	return False
307	1	running_tasks = self._client.list_tasks(service.cluster, service.name)
308	1	if not running_tasks[u'taskArns']:
309	1	return service.desired_count == 0
310	1	return service.desired_count == self.get_running_tasks_count(service, running_tasks[u'taskArns'])
311
312	1	def get_running_tasks_count(self, service, task_arns):
313	1	running_count = 0
314	1	tasks_details = self._client.describe_tasks(self._cluster_name, task_arns)
315	1	for task in tasks_details[u'tasks']:
316	1	if task[u'taskDefinitionArn'] == service.task_definition and task[u'lastStatus'] == u'RUNNING':
317	1	running_count += 1
318	1	return running_count
319
320	1	@property
321		def client(self):
322	1	return self._client
323
324	1	@property
325		def service(self):
326	1	return self._service
327
328	1	@property
329		def cluster_name(self):
330	1	return self._cluster_name
331
332	1	@property
333		def service_name(self):
334	1	return self._service_name
335
336
337	1	class DeployAction(EcsAction):
338	1	def deploy(self, task_definition):
339	1	self._service.set_task_definition(task_definition)
340	1	return self.update_service(self._service)
341
342
343	1	class ScaleAction(EcsAction):
344	1	def scale(self, desired_count):
345	1	self._service.set_desired_count(desired_count)
346	1	return self.update_service(self._service)
347
348
349	1	class RunAction(EcsAction):
350	1	def __init__(self, client, cluster_name):
351	1	self._client = client
352	1	self._cluster_name = cluster_name
353	1	self.started_tasks = []
354
355	1	def run(self, task_definition, count, started_by):
356	1	result = self._client.run_task(
357		cluster=self._cluster_name,
358		task_definition=task_definition.family_revision,
359		count=count,
360		started_by=started_by,
361		overrides=dict(containerOverrides=task_definition.get_overrides())
362		)
363	1	self.started_tasks = result['tasks']
364	1	return True
365
366
367	1	class EcsError(Exception):
368	1	pass
369
370
371	1	class ConnectionError(EcsError):
372	1	pass
373
374
375	1	class UnknownContainerError(EcsError):
376		pass
377

fabfuel / ecs-deploy

Pull Request — develop (#10)

EcsTaskDefinition.role_arn() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like