x/poppy
Code Issues Proposed changes

Implements log delivery part of services API

Browse Source 
This change adds optional log_delivery (boolean) filed to service.
This field can be set while creating a service or as a PATCH
service = {
    "name": ...
    "domains": ...
    "origins": ...
    "log_delivery": true
}

patch = [{
    "op":"replace",
    "path":"log_delivery",
    "value":true
}]

Link: https://blueprints.launchpad.net/poppy/+spec/log-delivery

Implements: blueprint log-delivery
Change-Id: I766448bb5d453ef7c8c62c71a9b35db45c9f1fd4
This commit is contained in:
Obulpathi
2015-04-03 11:11:30 -04:00
parent 72ae555fe3
commit 084b7da073
17 changed files with 258 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
poppy/model/log_delivery.py Normal file
View File

@@ -0,0 +1,36 @@
# Copyright (c) 2015 Rackspace, Inc.
#
# 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.
from poppy.model import common
class LogDelivery(common.DictSerializableModel):
"""LogDelivery."""
def __init__(self, enabled=False):
self._enabled = enabled
@property
def enabled(self):
return self._enabled
@enabled.setter
def enabled(self, value):
self._enabled = value
@classmethod
def init_from_dict(cls, input_dict):
o = cls(input_dict.get('enabled', False))
return o

23
poppy/model/service.py
View File

@@ -20,6 +20,7 @@ from poppy.model.helpers import domain
from poppy.model.helpers import origin
from poppy.model.helpers import provider_details
from poppy.model.helpers import restriction
from poppy.model import log_delivery as ld
VALID_STATUSES = [u'create_in_progress', u'deployed', u'update_in_progress',
@@ -37,7 +38,8 @@ class Service(common.DictSerializableModel):
origins,
flavor_id,
caching=[],
restrictions=[]):
restrictions=[],
log_delivery=None):
self._service_id = str(service_id)
self._name = name
self._domains = domains
@@ -45,6 +47,7 @@ class Service(common.DictSerializableModel):
self._flavor_id = flavor_id
self._caching = caching
self._restrictions = restrictions
self._log_delivery = log_delivery or ld.LogDelivery(False)
self._status = 'create_in_progress'
self._provider_details = {}
@@ -111,6 +114,16 @@ class Service(common.DictSerializableModel):
def restrictions(self, value):
self._restrictions = value
@property
def log_delivery(self):
"""Get log_delivery."""
return self._log_delivery
@log_delivery.setter
def log_delivery(self, value):
"""Set log_delivery."""
self._log_delivery = value
@property
def status(self):
"""Get or set status.
@@ -197,7 +210,13 @@ class Service(common.DictSerializableModel):
input_dict['provider_details'][provider_name] = (
provider_details.ProviderDetail.init_from_dict(pd))
log_delivery = input_dict.get('log_delivery', {})
input_dict['log_delivery'] = ld.LogDelivery.init_from_dict(
log_delivery)
o.from_dict(input_dict)
return o
def to_dict(self):
@@ -230,4 +249,6 @@ class Service(common.DictSerializableModel):
provider_details[provider].to_dict())
result['provider_details'] = new_provider_details
result['log_delivery'] = result['log_delivery'].to_dict()
return result

5
poppy/storage/cassandra/migrations/002_log_delivery.cql Normal file
View File

@@ -0,0 +1,5 @@
ALTER TABLE services ADD log_delivery varchar;
--//@UNDO
ALTER TABLE services DROP log_delivery;

25
poppy/storage/cassandra/services.py
View File

@@ -29,6 +29,7 @@ from poppy.model.helpers import origin
from poppy.model.helpers import provider_details
from poppy.model.helpers import restriction
from poppy.model.helpers import rule
from poppy.model import log_delivery as ld
from poppy.model import service
from poppy.openstack.common import log as logging
from poppy.storage import base
@@ -58,7 +59,8 @@ CQL_LIST_SERVICES = '''
origins,
caching_rules,
restrictions,
provider_details
provider_details,
log_delivery
FROM services
WHERE project_id = %(project_id)s
AND service_id > %(marker)s
@@ -75,7 +77,8 @@ CQL_GET_SERVICE = '''
origins,
caching_rules,
restrictions,
provider_details
provider_details,
log_delivery
FROM services
WHERE project_id = %(project_id)s AND service_id = %(service_id)s
'''
@@ -153,7 +156,8 @@ CQL_CREATE_SERVICE = '''
origins,
caching_rules,
restrictions,
provider_details
provider_details,
log_delivery
)
VALUES (%(project_id)s,
%(service_id)s,
@@ -163,7 +167,8 @@ CQL_CREATE_SERVICE = '''
%(origins)s,
%(caching_rules)s,
%(restrictions)s,
%(provider_details)s)
%(provider_details)s,
%(log_delivery)s)
'''
CQL_UPDATE_SERVICE = CQL_CREATE_SERVICE
@@ -311,6 +316,7 @@ class ServicesController(base.ServicesController):
for caching_rule in service_obj.caching]
restrictions = [json.dumps(r.to_dict())
for r in service_obj.restrictions]
log_delivery = json.dumps(service_obj.log_delivery.to_dict())
# create a new service
service_args = {
@@ -322,6 +328,7 @@ class ServicesController(base.ServicesController):
'origins': origins,
'caching_rules': caching_rules,
'restrictions': restrictions,
'log_delivery': log_delivery,
'provider_details': {}
}
@@ -363,6 +370,7 @@ class ServicesController(base.ServicesController):
json.dumps(service_obj.provider_details[provider].to_dict())
for provider in service_obj.provider_details}
log_delivery = json.dumps(service_obj.log_delivery.to_dict())
# fetch current domains
args = {
'project_id': project_id,
@@ -381,7 +389,8 @@ class ServicesController(base.ServicesController):
'origins': origins,
'caching_rules': caching_rules,
'restrictions': restrictions,
'provider_details': pds
'provider_details': pds,
'log_delivery': log_delivery
}
stmt = query.SimpleStatement(
@@ -561,6 +570,7 @@ class ServicesController(base.ServicesController):
for r in result.get('restrictions', []) or []]
caching_rules = [json.loads(c) for c in result.get('caching_rules', [])
or []]
log_delivery = json.loads(result.get('log_delivery', '{}') or '{}')
# create models for each item
origins = [
@@ -594,10 +604,13 @@ class ServicesController(base.ServicesController):
for rule_i in caching_rule['rules']])
for caching_rule in caching_rules]
log_delivery = ld.LogDelivery(log_delivery.get('enabled', False))
# create the service object
s = service.Service(service_id, name, domains, origins, flavor_id,
caching=caching_rules,
restrictions=restrictions)
restrictions=restrictions,
log_delivery=log_delivery)
# format the provider details
provider_detail_results = result.get('provider_details') or {}

22
poppy/transport/pecan/models/request/log_delivery.py Normal file
View File

@@ -0,0 +1,22 @@
# Copyright (c) 2014 Rackspace, Inc.
#
# 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.
from poppy.model import log_delivery as ld
def load_from_json(json_data):
enabled = json_data.get("enabled", False)
result = ld.LogDelivery(enabled)
return result

6
poppy/transport/pecan/models/request/service.py
View File

@@ -17,6 +17,7 @@ import uuid
from poppy.model import service
from poppy.transport.pecan.models.request import cachingrule
from poppy.transport.pecan.models.request import domain
from poppy.transport.pecan.models.request import log_delivery as ld
from poppy.transport.pecan.models.request import origin
from poppy.transport.pecan.models.request import provider_details
from poppy.transport.pecan.models.request import restriction
@@ -31,11 +32,13 @@ def load_from_json(json_data):
flavor_id = json_data.get("flavor_id")
restrictions = json_data.get("restrictions", [])
pd = json_data.get("provider_details", {})
log_delivery = json_data.get("log_delivery", {})
# load caching rules json string from input
origins = [origin.load_from_json(o) for o in origins]
domains = [domain.load_from_json(d) for d in domains]
restrictions = [restriction.load_from_json(r) for r in restrictions]
log_delivery = ld.load_from_json(log_delivery)
# convert caching rule json string list into object list
caching = json_data.get("caching", [])
@@ -47,7 +50,8 @@ def load_from_json(json_data):
origins,
flavor_id,
caching,
restrictions)
restrictions,
log_delivery)
r.provider_details = dict([(k, provider_details.load_from_json(v))
for k, v in pd.items()])

28
poppy/transport/pecan/models/response/log_delivery.py Normal file
View File

@@ -0,0 +1,28 @@
# Copyright (c) 2015 Rackspace, Inc.
#
# 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.
try:
import ordereddict as collections
except ImportError: # pragma: no cover
import collections # pragma: no cover
class Model(collections.OrderedDict):
'Response class for Log Delivery'
def __init__(self, log_delivery):
super(Model, self).__init__()
self['enabled'] = log_delivery.enabled

2
poppy/transport/pecan/models/response/service.py
View File

@@ -23,6 +23,7 @@ from poppy.common import uri
from poppy.transport.pecan.models.response import cachingrules
from poppy.transport.pecan.models.response import domain
from poppy.transport.pecan.models.response import link
from poppy.transport.pecan.models.response import log_delivery
from poppy.transport.pecan.models.response import origin
from poppy.transport.pecan.models.response import restriction
@@ -43,6 +44,7 @@ class Model(collections.OrderedDict):
service_obj.caching]
self["status"] = service_obj.status
self["flavor_id"] = service_obj.flavor_id
self["log_delivery"] = log_delivery.Model(service_obj.log_delivery)
self["errors"] = []

13
poppy/transport/validators/schemas/service.py
View File

@@ -354,6 +354,16 @@ class ServiceSchema(schema_base.SchemaBase):
'required': True,
'minLength': 1,
'maxLength': 256
},
'log_delivery': {
'type': 'object',
'required': False,
'properties': {
'enabled': {
'type': 'boolean',
'required': True
}
}
}
}},
'PATCH': {
@@ -375,7 +385,8 @@ class ServiceSchema(schema_base.SchemaBase):
'origins',
'domains',
'caching_rule',
'restrictions'
'restrictions',
'log_delivery'
]
},
'value': {

39
tests/api/services/data_create_service.json
View File

@@ -20,7 +20,10 @@
"request_url" : "/*"
}
]}
]
],
"log_delivery": {
"enabled": false
}
},
"caching_empty": {
"name": "caching_empty",
@@ -105,5 +108,37 @@
"ttl": 1200,
"rules": [{"name" : "Rule 1",
"request_url" : "/images/test.jpg"}]}]
}
},
"log_delivery_enabled": {
"name": "log_delivery",
"domain_list": [{"domain": "mywebsite.com", "protocol": "http"},
{"domain": "blog.mywebsite.com", "protocol": "http"}],
"origin_list": [{"origin": "mywebsite1.com",
"port": 80,
"ssl": false}],
"caching_list": [{"name": "default", "ttl": 3600},
{"name": "home",
"ttl": 1200,
"rules": [{"name" : "index",
"request_url" : "/index.htm"}]}],
"log_delivery": {
"enabled": true
}
},
"log_delivery_disabled": {
"name": "log_delivery",
"domain_list": [{"domain": "mywebsite.com", "protocol": "http"},
{"domain": "blog.mywebsite.com", "protocol": "http"}],
"origin_list": [{"origin": "mywebsite1.com",
"port": 80,
"ssl": false}],
"caching_list": [{"name": "default", "ttl": 3600},
{"name": "home",
"ttl": 1200,
"rules": [{"name" : "index",
"request_url" : "/index.htm"}]}],
"log_delivery": {
"enabled": false
}
}
}

10
tests/api/services/data_patch_service.json
View File

@@ -206,5 +206,15 @@
}
}
],
"enable_log_delivery": [
{"op": "replace",
"path": "/log_delivery/enabled",
"value": true}
],
"disable_log_delivery": [
{"op": "replace",
"path": "/log_delivery/enabled",
"value": false}
],
"empty_list": []
}

5
tests/api/services/data_patch_service_negative.json
View File

@@ -153,5 +153,10 @@
"rules": [{"name": "rule1", "referrer": "ab"}]
}
}
],
"log_delivery_non_boolean": [
{"op": "replace",
"path": "/log_delivery/enabled",
"value": "not a boolean"}
]
}

35
tests/api/services/test_services.py
View File

@@ -49,13 +49,16 @@ class TestCreateService(providers.TestProviderBase):
item['domain'] = str(uuid.uuid1()) + '.com'
origin_list = test_data['origin_list']
caching_list = test_data['caching_list']
log_delivery = test_data.get('log_delivery')
flavor_id = self.flavor_id
resp = self.client.create_service(service_name=self.service_name,
domain_list=domain_list,
origin_list=origin_list,
caching_list=caching_list,
flavor_id=flavor_id)
flavor_id=flavor_id,
log_delivery=log_delivery)
self.assertEqual(resp.status_code, 202)
self.assertEqual(resp.text, '')
self.service_url = resp.headers['location']
@@ -140,15 +143,6 @@ class TestCreateService(providers.TestProviderBase):
self.assertEqual(resp.status_code, 400)
def tearDown(self):
if self.service_url != '':
self.client.delete_service(location=self.service_url)
if self.test_config.generate_flavors:
self.client.delete_flavor(flavor_id=self.flavor_id)
super(TestCreateService, self).tearDown()
@ddt.file_data("data_create_service_xss.json")
def test_create_service_with_xss_injection(self, test_data):
# create with hacker data
@@ -159,6 +153,7 @@ class TestCreateService(providers.TestProviderBase):
origin_list = test_data['origin_list']
caching_list = test_data['caching_list']
if 'flavor_id' in test_data:
flavor_id = test_data['flavor_id']
else:
@@ -221,6 +216,15 @@ class TestCreateService(providers.TestProviderBase):
cgi.escape(caching_list[1]['rules'][0]['request_url'])
)
def tearDown(self):
if self.service_url != '':
self.client.delete_service(location=self.service_url)
if self.test_config.generate_flavors:
self.client.delete_flavor(flavor_id=self.flavor_id)
super(TestCreateService, self).tearDown()
@ddt.ddt
class TestListServices(base.TestBase):
@@ -239,12 +243,14 @@ class TestListServices(base.TestBase):
{"name": "home", "ttl": 1200,
"rules": [{"name": "index",
"request_url": "/index.htm"}]}]
self.log_delivery = {"enabled": False}
resp = self.client.create_service(service_name=service_name,
domain_list=self.domain_list,
origin_list=self.origin_list,
caching_list=self.caching_list,
flavor_id=self.flavor_id)
flavor_id=self.flavor_id,
log_delivery=self.log_delivery)
self.service_url = resp.headers["location"]
return self.service_url
@@ -493,6 +499,7 @@ class TestServicePatch(base.TestBase):
super(TestServicePatch, self).setUp()
self.service_name = str(uuid.uuid1())
self.flavor_id = self.test_flavor
self.log_delivery = {"enabled": False}
domain = str(uuid.uuid1()) + '.com'
self.domain_list = [{"domain": domain, "protocol": "http"}]
@@ -519,7 +526,8 @@ class TestServicePatch(base.TestBase):
origin_list=self.origin_list,
caching_list=self.caching_list,
restrictions_list=self.restrictions_list,
flavor_id=self.flavor_id)
flavor_id=self.flavor_id,
log_delivery=self.log_delivery)
self.service_url = resp.headers["location"]
@@ -529,7 +537,8 @@ class TestServicePatch(base.TestBase):
"origins": self.origin_list,
"caching": self.caching_list,
"restrictions": self.restrictions_list,
"flavor_id": self.flavor_id}
"flavor_id": self.flavor_id,
"log_delivery": self.log_delivery}
self.client.wait_for_service_status(
location=self.service_url,

32
tests/api/utils/client.py
View File

@@ -78,7 +78,8 @@ class PoppyClient(client.AutoMarshallingHTTPClient):
domain_list=None, origin_list=None,
caching_list=None, restrictions_list=None,
requestslib_kwargs=None,
flavor_id=None):
flavor_id=None,
log_delivery=None):
"""Creates Service
:return: Response Object containing response code 200 and body with
@@ -87,13 +88,28 @@ class PoppyClient(client.AutoMarshallingHTTPClient):
services/{service_name}
"""
url = '{0}/services'.format(self.url)
request_object = requests.CreateService(
service_name=service_name,
domain_list=domain_list,
origin_list=origin_list,
caching_list=caching_list,
restrictions_list=restrictions_list,
flavor_id=flavor_id)
if not log_delivery:
log_delivery = {"enabled": False}
if log_delivery:
request_object = requests.CreateService(
service_name=service_name,
domain_list=domain_list,
origin_list=origin_list,
caching_list=caching_list,
restrictions_list=restrictions_list,
flavor_id=flavor_id,
log_delivery=log_delivery)
else:
request_object = requests.CreateService(
service_name=service_name,
domain_list=domain_list,
origin_list=origin_list,
caching_list=caching_list,
restrictions_list=restrictions_list,
flavor_id=flavor_id)
return self.request('POST', url, request_entity=request_object,
requestslib_kwargs=requestslib_kwargs)

7
tests/api/utils/models/requests.py
View File

@@ -22,7 +22,8 @@ class CreateService(base.AutoMarshallingModel):
"""Marshalling for Create Service requests."""
def __init__(self, service_name=None, domain_list=None, origin_list=None,
caching_list=None, restrictions_list=None, flavor_id=None):
caching_list=None, restrictions_list=None, flavor_id=None,
log_delivery=None):
super(CreateService, self).__init__()
self.service_name = service_name
@@ -31,6 +32,7 @@ class CreateService(base.AutoMarshallingModel):
self.caching_list = caching_list or []
self.restrictions_list = restrictions_list or []
self.flavor_id = flavor_id
self.log_delivery = log_delivery or {"enabled": False}
def _obj_to_json(self):
create_service_request = {"name": self.service_name,
@@ -38,7 +40,8 @@ class CreateService(base.AutoMarshallingModel):
"origins": self.origin_list,
"caching": self.caching_list,
"restrictions": self.restrictions_list,
"flavor_id": self.flavor_id}
"flavor_id": self.flavor_id,
"log_delivery": self.log_delivery}
return json.dumps(create_service_request)

2
tests/api/utils/schema/services.py
View File

@@ -58,6 +58,7 @@ error_message = {'type': 'object',
restrictions = {'type': 'array'}
flavor_id = {'type': 'string', 'pattern': '([a-zA-Z0-9_\-]{1,256})'}
log_delivery = {'type': 'object'}
service_name = {'type': 'string', 'pattern': '([a-zA-Z0-9_\-\.]{1,256})'}
uuid4 = '([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})' # noqa
service_id = {'type': 'string', 'pattern': uuid4}
@@ -90,6 +91,7 @@ get_service = {
'delete_in_progress', 'deployed', 'failed']},
'restrictions': restrictions,
'flavor_id': flavor_id,
'log_delivery': log_delivery,
'errors': {'type': 'array',
'items': error_message}
},

3
tests/unit/model/test_service.py
View File

@@ -40,6 +40,7 @@ class TestServiceModel(base.TestCase):
self.mydomains = []
self.myrestrictions = []
self.mycaching = []
self.log_delivery = {"enabled": False}
self.myorigins.append(origin.Origin('mysite.com'))
self.myorigins.append(origin.Origin('yoursite.io', port=80, ssl=True))
@@ -62,7 +63,7 @@ class TestServiceModel(base.TestCase):
myservice = service.Service(
self.service_id,
self.service_name, self.mydomains, self.myorigins, self.flavor_id,
self.mycaching, self.myrestrictions)
self.mycaching, self.myrestrictions, self.log_delivery)
# test all properties
# id