test_resultset.py

# Copyright DataStax, 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.

import unittest
from unittest.mock import Mock, PropertyMock, patch

from cassandra.cluster import ResultSet
from cassandra.query import named_tuple_factory, dict_factory, tuple_factory, SimpleStatement, BatchStatement

from tests.util import assertListEqual
import pytest


class ResultSetTests(unittest.TestCase):

    def test_iter_non_paged(self):
        expected = list(range(10))
        rs = ResultSet(Mock(has_more_pages=False), expected)
        itr = iter(rs)
        assertListEqual(list(itr), expected)

    def test_iter_paged(self):
        expected = list(range(10))
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = (ResultSet(Mock(), expected[-5:]), )  # ResultSet is iterable, so it must be protected in order to be returned whole by the Mock
        rs = ResultSet(response_future, expected[:5])
        itr = iter(rs)
        # this is brittle, depends on internal impl details. Would like to find a better way
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, True, False))  # after init to avoid side effects being consumed by init
        assertListEqual(list(itr), expected)

    def test_iter_paged_with_empty_pages(self):
        expected = list(range(10))
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = [
            ResultSet(Mock(), []),
            ResultSet(Mock(), [0, 1, 2, 3, 4]),
            ResultSet(Mock(), []),
            ResultSet(Mock(), [5, 6, 7, 8, 9]),
        ]
        rs = ResultSet(response_future, [])
        itr = iter(rs)
        assertListEqual(list(itr), expected)

    def test_list_non_paged(self):
        # list access on RS for backwards-compatibility
        expected = list(range(10))
        rs = ResultSet(Mock(has_more_pages=False), expected)
        for i in range(10):
            assert rs[i] == expected[i]
        assert list(rs) == expected

    def test_list_paged(self):
        # list access on RS for backwards-compatibility
        expected = list(range(10))
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = (ResultSet(Mock(), expected[-5:]), )  # ResultSet is iterable, so it must be protected in order to be returned whole by the Mock
        rs = ResultSet(response_future, expected[:5])
        # this is brittle, depends on internal impl details. Would like to find a better way
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, True, True, False))  # First two True are consumed on check entering list mode
        assert rs[9] == expected[9]
        assert list(rs) == expected

    def test_has_more_pages(self):
        response_future = Mock()
        response_future.has_more_pages.side_effect = PropertyMock(side_effect=(True, False))
        rs = ResultSet(response_future, [])
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, False))  # after init to avoid side effects being consumed by init
        assert rs.has_more_pages
        assert not rs.has_more_pages

    def test_iterate_then_index(self):
        # RuntimeError if indexing with no pages
        expected = list(range(10))
        rs = ResultSet(Mock(has_more_pages=False), expected)
        itr = iter(rs)
        # before consuming
        with pytest.raises(RuntimeError):
            rs[0]
        list(itr)
        # after consuming
        with pytest.raises(RuntimeError):
            rs[0]

        assert not rs
        assert not list(rs)

        # RuntimeError if indexing during or after pages
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = (ResultSet(Mock(), expected[-5:]), )  # ResultSet is iterable, so it must be protected in order to be returned whole by the Mock
        rs = ResultSet(response_future, expected[:5])
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, False))
        itr = iter(rs)
        # before consuming
        with pytest.raises(RuntimeError):
            rs[0]
        for row in itr:
            # while consuming
            with pytest.raises(RuntimeError):
                rs[0]
        # after consuming
        with pytest.raises(RuntimeError):
            rs[0]
        assert not rs
        assert not list(rs)

    def test_index_list_mode(self):
        # no pages
        expected = list(range(10))
        rs = ResultSet(Mock(has_more_pages=False), expected)

        # index access before iteration causes list to be materialized
        assert rs[0] == expected[0]

        # resusable iteration
        assertListEqual(list(rs), expected)
        assertListEqual(list(rs), expected)

        assert rs

        # pages
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = (ResultSet(Mock(), expected[-5:]), )  # ResultSet is iterable, so it must be protected in order to be returned whole by the Mock
        rs = ResultSet(response_future, expected[:5])
        # this is brittle, depends on internal impl details. Would like to find a better way
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, True, True, False))  # First two True are consumed on check entering list mode
        # index access before iteration causes list to be materialized
        assert rs[0] == expected[0]
        assert rs[9] == expected[9]
        # resusable iteration
        assertListEqual(list(rs), expected)
        assertListEqual(list(rs), expected)

        assert rs

    def test_eq(self):
        # no pages
        expected = list(range(10))
        rs = ResultSet(Mock(has_more_pages=False), expected)

        # eq before iteration causes list to be materialized
        assert rs == expected

        # results can be iterated or indexed once we're materialized
        assertListEqual(list(rs), expected)
        assert rs[9] == expected[9]
        assert rs

        # pages
        response_future = Mock(has_more_pages=True, _continuous_paging_session=None)
        response_future.result.side_effect = (ResultSet(Mock(), expected[-5:]), )  # ResultSet is iterable, so it must be protected in order to be returned whole by the Mock
        rs = ResultSet(response_future, expected[:5])
        type(response_future).has_more_pages = PropertyMock(side_effect=(True, True, True, False))
        # eq before iteration causes list to be materialized
        assert rs == expected

        # results can be iterated or indexed once we're materialized
        assertListEqual(list(rs), expected)
        assert rs[9] == expected[9]
        assert rs

    def test_bool(self):
        assert not ResultSet(Mock(has_more_pages=False), [])
        assert ResultSet(Mock(has_more_pages=False), [1])

    def test_was_applied(self):
        # Create a non-LWT query so these assertions exercise the slow (regex) path.
        # Without this, Mock().query.is_lwt() returns a truthy Mock, accidentally
        # routing all checks through the fast path.
        non_lwt_query = Mock(spec=SimpleStatement)
        non_lwt_query.is_lwt.return_value = False
        non_lwt_query.query_string = "INSERT INTO t (k) VALUES (1)"

        # unknown row factory raises
        with pytest.raises(RuntimeError):
            ResultSet(Mock(query=non_lwt_query), []).was_applied

        response_future = Mock(row_factory=named_tuple_factory, query=non_lwt_query)

        # no row
        with pytest.raises(RuntimeError):
            ResultSet(response_future, []).was_applied

        # too many rows
        with pytest.raises(RuntimeError):
            ResultSet(response_future, [tuple(), tuple()]).was_applied

        # various internal row factories
        for row_factory in (named_tuple_factory, tuple_factory):
            for applied in (True, False):
                rs = ResultSet(Mock(row_factory=row_factory, query=non_lwt_query), [(applied,)])
                assert rs.was_applied == applied

        row_factory = dict_factory
        for applied in (True, False):
            rs = ResultSet(Mock(row_factory=row_factory, query=non_lwt_query), [{'[applied]': applied}])
            assert rs.was_applied == applied


    def test_was_applied_lwt_fast_path(self):
        """Test that was_applied uses fast path for known LWT statements."""
        # BoundStatement-like query with is_lwt() = True (fast path)
        lwt_query = Mock()
        lwt_query.is_lwt.return_value = True
        for row_factory in (named_tuple_factory, tuple_factory):
            for applied in (True, False):
                rf = Mock(row_factory=row_factory, query=lwt_query)
                rs = ResultSet(rf, [(applied,)])
                assert rs.was_applied == applied

        for applied in (True, False):
            rf = Mock(row_factory=dict_factory, query=lwt_query)
            rs = ResultSet(rf, [{'[applied]': applied}])
            assert rs.was_applied == applied

        # Fast path with too many rows should raise
        rf = Mock(row_factory=named_tuple_factory, query=lwt_query)
        with pytest.raises(RuntimeError, match="exactly one row"):
            ResultSet(rf, [tuple(), tuple()]).was_applied

    def test_was_applied_non_lwt_fallback(self):
        """Test that was_applied falls back to slow path for non-LWT statements."""
        # SimpleStatement-like query with is_lwt() = False (slow path, non-batch)
        non_lwt_query = Mock(spec=SimpleStatement)
        non_lwt_query.is_lwt.return_value = False
        non_lwt_query.query_string = "INSERT INTO t (k) VALUES (1)"

        for applied in (True, False):
            rf = Mock(row_factory=tuple_factory, query=non_lwt_query)
            rs = ResultSet(rf, [(applied,)])
            assert rs.was_applied == applied

    def test_was_applied_batch_statement(self):
        """Test that was_applied handles BatchStatement correctly (slow path)."""
        # BatchStatement with LWT should check column_names
        batch_query = Mock(spec=BatchStatement)
        batch_query.is_lwt.return_value = True

        # Batch with [applied] column -- pass _col_names so ResultSet.__init__
        # sets column_names correctly (instead of post-construction override).
        rf = Mock(row_factory=tuple_factory, query=batch_query,
                  _col_names=['[applied]'], _col_types=None)
        rs = ResultSet(rf, [(True,)])
        assert rs.was_applied == True

        # Batch without [applied] column raises
        rf = Mock(row_factory=tuple_factory, query=batch_query,
                  _col_names=['other'], _col_types=None)
        rs = ResultSet(rf, [(True,)])
        with pytest.raises(RuntimeError, match="No LWT were present"):
            rs.was_applied

    def test_one(self):
        # no pages
        first, second = Mock(), Mock()
        rs = ResultSet(Mock(has_more_pages=False), [first, second])

        assert rs.one() == first

    def test_all(self):
        first, second = Mock(), Mock()
        rs1 = ResultSet(Mock(has_more_pages=False), [first, second])
        rs2 = ResultSet(Mock(has_more_pages=False), [first, second])

        assert rs1.all() == list(rs2)

    @patch('cassandra.cluster.warn')
    def test_indexing_deprecation(self, mocked_warn):
        # normally we'd use catch_warnings to test this, but that doesn't work
        # pre-Py3.0 for some reason
        first, second = Mock(), Mock()
        rs = ResultSet(Mock(has_more_pages=False), [first, second])
        assert rs[0] == first
        assert len(mocked_warn.mock_calls) == 1
        index_warning_args = tuple(mocked_warn.mock_calls[0])[1]
        assert 'indexing support will be removed in 4.0' in str(index_warning_args[0])
        assert index_warning_args[1] is DeprecationWarning