Files
impala/tests/shell/test_cookie_util.py
Joe McDonnell 1913ab46ed IMPALA-14501: Migrate most scripts from impala-python to impala-python3
To remove the dependency on Python 2, existing scripts need to use
python3 rather than python. These commands find those
locations (for impala-python and regular python):
git grep impala-python | grep -v impala-python3 | grep -v impala-python-common | grep -v init-impala-python
git grep bin/python | grep -v python3

This removes or switches most of these locations by various means:
1. If a python file has a #!/bin/env impala-python (or python) but
   doesn't have a main function, it removes the hash-bang and makes
   sure that the file is not executable.
2. Most scripts can simply switch from impala-python to impala-python3
   (or python to python3) with minimal changes.
3. The cm-api pypi package (which doesn't support Python 3) has been
   replaced by the cm-client pypi package and interfaces have changed.
   Rather than migrating the code (which hasn't been used in years), this
   deletes the old code and stops installing cm-api into the virtualenv.
   The code can be restored and revamped if there is any interest in
   interacting with CM clusters.
4. This switches tests/comparison over to impala-python3, but this code has
   bit-rotted. Some pieces can be run manually, but it can't be fully
   verified with Python 3. It shouldn't hold back the migration on its own.
5. This also replaces locations of impala-python in comments / documentation /
   READMEs.
6. kazoo (used for interacting with HBase) needed to be upgraded to a
   version that supports Python 3. The newest version of kazoo requires
   upgrades of other component versions, so this uses kazoo 2.8.0 to avoid
   needing other upgrades.

The two remaining uses of impala-python are:
 - bin/cmake_aux/create_virtualenv.sh
 - bin/impala-env-versioned-python
These will be removed separately when we drop Python 2 support
completely. In particular, these are useful for testing impala-shell
with Python 2 until we stop supporting Python 2 for impala-shell.

The docker-based tests still use /usr/bin/python, but this can
be switched over independently (and doesn't impact impala-python)

Testing:
 - Ran core job
 - Ran build + dataload on Centos 7, Redhat 8
 - Manual testing of individual scripts (except some bitrotted areas like the
   random query generator)

Change-Id: If209b761290bc7e7c716c312ea757da3e3bca6dc
Reviewed-on: http://gerrit.cloudera.org:8080/23468
Reviewed-by: Michael Smith <michael.smith@cloudera.com>
Tested-by: Michael Smith <michael.smith@cloudera.com>
2025-10-22 16:30:17 +00:00

183 lines
7.7 KiB
Python

# -*- coding: utf-8 -*-
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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 __future__ import absolute_import, division, print_function
from datetime import datetime, timedelta
from http.client import HTTPMessage
import sys
from impala_shell.cookie_util import (
cookie_matches_path,
get_all_matching_cookies,
get_cookie_expiry,
)
from tests.common.base_test_suite import BaseTestSuite
class TestCookieUtil(BaseTestSuite):
def test_cookie_matches_path(self):
assert cookie_matches_path({}, '/')
assert cookie_matches_path({}, '')
assert cookie_matches_path({}, 'cliservice')
assert cookie_matches_path({}, '/cliservice')
assert cookie_matches_path({}, '/cliservice/')
assert cookie_matches_path({'path': ''}, '/')
assert cookie_matches_path({'path': '/'}, '')
assert cookie_matches_path({'path': '/'}, 'clisevice')
assert cookie_matches_path({'path': '/'}, '/clisevice')
assert not cookie_matches_path({'path': '/cliservice'}, '')
assert not cookie_matches_path({'path': '/cliservice'}, '/')
assert cookie_matches_path({'path': '/cliservice'}, 'cliservice')
assert cookie_matches_path({'path': 'cliservice'}, '/cliservice')
assert cookie_matches_path({'path': '/cliservice/'}, '/cliservice/')
assert cookie_matches_path({'path': '/cliservice'}, 'cliservice/abc/def/ghi')
assert cookie_matches_path({'path': '/cliservice/'}, 'cliservice/?q=abcd')
assert not cookie_matches_path({'path': '/a/b/c//'}, '/a')
assert not cookie_matches_path({'path': '/a/b/c//'}, '/a/b')
assert cookie_matches_path({'path': '/a/b/c//'}, 'a/b/c')
assert cookie_matches_path({'path': '/a/b/c//'}, '/a/b/c')
assert cookie_matches_path({'path': '/a/b/c//'}, 'a/b/c/d')
assert cookie_matches_path({'path': '/a/b/c//'}, '/a/b/c/d')
assert cookie_matches_path({'path': '/a/b/c//'}, '/a/b/c/d/e/f/g/h')
def test_get_cookie_expiry(self):
assert get_cookie_expiry({}) is None
assert get_cookie_expiry({'max-age': ''}) is None
hour = timedelta(hours=1)
sec = timedelta(seconds=1)
now = datetime.now()
assert now <= get_cookie_expiry({'max-age': '0'}) <= now + sec
now = datetime.now()
assert now - sec <= get_cookie_expiry({'max-age': '-1'}) <= now
now = datetime.now()
assert now - hour <= get_cookie_expiry({'max-age': '-3600'}) <= now - hour + sec
now = datetime.now()
assert now + hour <= get_cookie_expiry({'max-age': '3600'}) <= now + hour + sec
now = datetime.now()
days2k = timedelta(days=2000)
assert now - days2k <= \
get_cookie_expiry({'max-age': '-172800000'}) <= \
now - days2k + sec
now = datetime.now()
assert now + days2k <= \
get_cookie_expiry({'max-age': '172800000'}) <= \
now + days2k + sec
def test_get_all_matching_cookies(self):
cookies = get_all_matching_cookies(['a', 'b'], '/path', {})
assert not cookies
headers = make_cookie_headers([
('c_cookie', 'c_value'),
('b_cookie', 'b_value'),
('a_cookie', 'a_value')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie'], '/path', headers)
assert len(cookies) == 2
assert cookies[0].key == 'a_cookie' and cookies[0].value == 'a_value'
assert cookies[1].key == 'b_cookie' and cookies[1].value == 'b_value'
cookies = get_all_matching_cookies(['b_cookie', 'a_cookie'], '/path', headers)
assert len(cookies) == 2
assert cookies[0].key == 'b_cookie' and cookies[0].value == 'b_value'
assert cookies[1].key == 'a_cookie' and cookies[1].value == 'a_value'
headers = make_cookie_headers([
('c_cookie', 'c_value;Path=/'),
('b_cookie', 'b_value;Path=/path'),
('a_cookie', 'a_value;Path=/')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie'], '/path', headers)
assert len(cookies) == 2
assert cookies[0].key == 'a_cookie' and cookies[0].value == 'a_value'
assert cookies[1].key == 'b_cookie' and cookies[1].value == 'b_value'
headers = make_cookie_headers([
('c_cookie', 'c_value;Path=/'),
('b_cookie', 'b_value;Path=/path'),
('a_cookie', 'a_value;Path=/path/path2')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie'], '/path', headers)
assert len(cookies) == 1
assert cookies[0].key == 'b_cookie' and cookies[0].value == 'b_value'
cookies = get_all_matching_cookies(['b_cookie', 'a_cookie'], '/path', headers)
assert len(cookies) == 1
assert cookies[0].key == 'b_cookie' and cookies[0].value == 'b_value'
headers = make_cookie_headers([
('c_cookie', 'c_value;Path=/'),
('b_cookie', 'b_value;Path=/path'),
('a_cookie', 'a_value;Path=/path')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie'], '/path/path1',
headers)
assert len(cookies) == 2
assert cookies[0].key == 'a_cookie' and cookies[0].value == 'a_value'
assert cookies[1].key == 'b_cookie' and cookies[1].value == 'b_value'
headers = make_cookie_headers([
('c_cookie', 'c_value;Path=/'),
('b_cookie', 'b_value;Path=/path1'),
('a_cookie', 'a_value;Path=/path2')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie'], '/path', headers)
assert not cookies
headers = make_cookie_headers([
('c_cookie', 'c_value;Path=/'),
('b_cookie', 'b_value;Path=/path1'),
('a_cookie', 'a_value;Path=/path2')
])
cookies = get_all_matching_cookies(['a_cookie', 'b_cookie', 'c_cookie'], '/path',
headers)
assert len(cookies) == 1
assert cookies[0].key == 'c_cookie' and cookies[0].value == 'c_value'
def make_cookie_headers(cookie_vals):
"""Make an HTTPMessage containing Set-Cookie headers for Python 2 or Python 3"""
if sys.version_info.major == 2:
# In Python 2 the HTTPMessage is a mimetools.Message object, and the
# Set-Cookie values all appear in a single header, separated by newlines.
cookies = ""
count = 0
for pair in cookie_vals:
name = pair[0]
value = pair[1]
cookies += name + '=' + value
if count + 1 < len(cookie_vals):
# Separate the cookies, unless it is the last cookie.
cookies += '\n '
count += 1
return {'Set-Cookie': cookies}
else:
# In Python 3 the HTTPMessage is an email.message.Message, and the
# Set-Cookie values appear as duplicate headers.
headers = HTTPMessage()
for pair in cookie_vals:
name = pair[0]
value = pair[1]
headers.add_header('Set-Cookie', name + "=" + value)
return headers