cookie.py

Go to the documentation of this file.

# Copyright 2008-2011 Nokia Networks
# Copyright 2011-2016 Ryan Tomac, Ed Manlove and contributors
# Copyright 2016-     Robot Framework Foundation
#
# 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 datetime import datetime
 
from robot.libraries.DateTime import convert_date
from robot.utils import DotDict
 
from SeleniumLibrary.base import LibraryComponent, keyword
from SeleniumLibrary.errors import CookieNotFound
from SeleniumLibrary.utils import is_truthy, is_noney, is_falsy
 
 
class CookieKeywords(LibraryComponent):
 
    @keyword
    
    def delete_all_cookies(self):
        self.driverdriverdriver.delete_all_cookies()
 
    @keyword
    
    def delete_cookie(self, name):
        self.driverdriverdriver.delete_cookie(name)
 
    @keyword
    
    def get_cookies(self, as_dict=False):
        if is_falsy(as_dict):
            pairs = []
            for cookie in self.driverdriverdriver.get_cookies():
                pairs.append(cookie['name'] + "=" + cookie['value'])
            return '; '.join(pairs)
        else:
            pairs = DotDict()
            for cookie in self.driverdriverdriver.get_cookies():
                pairs[cookie['name']] = cookie['value']
            return pairs
 
    @keyword
    
    def get_cookie(self, name):
        cookie = self.driverdriverdriver.get_cookie(name)
        if not cookie:
            raise CookieNotFound("Cookie with name '%s' not found." % name)
        return CookieInformation(**cookie)
 
    @keyword
    
    def add_cookie(self, name, value, path=None, domain=None, secure=None,
                   expiry=None):
        new_cookie = {'name': name, 'value': value}
        if not is_noney(path):
            new_cookie['path'] = path
        if not is_noney(domain):
            new_cookie['domain'] = domain
        # Secure must be True or False
        if not is_noney(secure):
            new_cookie['secure'] = is_truthy(secure)
        if not is_noney(expiry):
            new_cookie['expiry'] = self._expiry_expiry(expiry)
        self.driverdriverdriver.add_cookie(new_cookie)
 
    def _expiry(self, expiry):
        try:
            return int(expiry)
        except ValueError:
            return int(convert_date(expiry, result_format='epoch'))
 
 
class CookieInformation():
 
    def __init__(self, name, value, path=None, domain=None, secure=False,
                 httpOnly=False, expiry=None, **extra):
        self.namename = name
        self.valuevalue = value
        self.pathpath = path
        self.domaindomain = domain
        self.securesecure = secure
        self.httpOnlyhttpOnly = httpOnly
        self.expiryexpiry = datetime.fromtimestamp(expiry) if expiry else None
        self.extraextra = extra
 
    def __str__(self):
        items = 'name value path domain secure httpOnly expiry'.split()
        string = '\n'.join('%s=%s' % (item, getattr(self, item))
                           for item in items)
        if self.extraextra:
            string = '%s\n%s=%s\n' % (string, 'extra', self.extraextra)
        return string