~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2008 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

from cStringIO import StringIO

class FakeReadFile(object):

    """A file-like object that can be given predefined content and read

    like a file.  The maximum size and number of the reads is recorded."""

    def __init__(self, data):

        """Initialize the mock file object with the provided data."""

        self.data = StringIO(data)

        self.max_read_size = None

        self.read_count = 0

    def read(self, size=-1):

        """Reads size characters from the input (or the rest of the string if

        size is -1)."""

        data = self.data.read(size)

        self.max_read_size = max(self.max_read_size, len(data))

        self.read_count += 1

        return data

    def get_max_read_size(self):

        """Returns the maximum read size or None if no reads have occured."""

        return self.max_read_size

    def get_read_count(self):

        """Returns the number of calls to read."""

        return self.read_count

    def reset_read_count(self):

        """Clears the read count."""

        self.read_count = 0