# Copyright (C) 2005, 2007 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

"""Tests for the Command.encoding_type interface."""

from ...commands import Command, plugin_cmds, register_command
from .. import TestCaseWithMemoryTransport


class cmd_echo_exact(Command):
    """This command just repeats what it is given.

    It decodes the argument, and then writes it to stdout.
    """

    takes_args = ["text"]
    encoding_type = "exact"

    def run(self, text=None):
        self.outf.write(text)


class cmd_echo_strict(cmd_echo_exact):
    """Raise a UnicodeError for unrepresentable characters."""

    encoding_type = "strict"


class cmd_echo_replace(cmd_echo_exact):
    """Replace bogus unicode characters."""

    encoding_type = "replace"


class TestCommandEncoding(TestCaseWithMemoryTransport):
    def test_exact(self):
        def bzr(*args, **kwargs):
            kwargs["encoding"] = "ascii"
            return self.run_bzr_raw(*args, **kwargs)[0]

        register_command(cmd_echo_exact)
        try:
            self.assertEqual(b"foo", bzr("echo-exact foo"))
            # Exact should fail to decode the string
            self.assertRaises(UnicodeEncodeError, bzr, ["echo-exact", "foo\xb5"])
            # Previously a non-ascii bytestring was also tested, as 'exact'
            # outputs bytes untouched, but needed buggy argv parsing to work
        finally:
            plugin_cmds.remove("echo-exact")

    def test_strict_utf8(self):
        def bzr(*args, **kwargs):
            kwargs["encoding"] = "utf-8"
            return self.run_bzr_raw(*args, **kwargs)[0]

        register_command(cmd_echo_strict)
        try:
            self.assertEqual(b"foo", bzr("echo-strict foo"))
            expected = "foo\xb5"
            expected = expected.encode("utf-8")
            self.assertEqual(expected, bzr(["echo-strict", "foo\xb5"]))
        finally:
            plugin_cmds.remove("echo-strict")

    def test_strict_ascii(self):
        def bzr(*args, **kwargs):
            kwargs["encoding"] = "ascii"
            return self.run_bzr_raw(*args, **kwargs)[0]

        register_command(cmd_echo_strict)
        try:
            self.assertEqual(b"foo", bzr("echo-strict foo"))
            # ascii can't encode \xb5
            self.assertRaises(UnicodeEncodeError, bzr, ["echo-strict", "foo\xb5"])
        finally:
            plugin_cmds.remove("echo-strict")

    def test_replace_utf8(self):
        def bzr(*args, **kwargs):
            kwargs["encoding"] = "utf-8"
            return self.run_bzr_raw(*args, **kwargs)[0]

        register_command(cmd_echo_replace)
        try:
            self.assertEqual(b"foo", bzr("echo-replace foo"))
            self.assertEqual("foo\xb5".encode(), bzr(["echo-replace", "foo\xb5"]))
        finally:
            plugin_cmds.remove("echo-replace")

    def test_replace_ascii(self):
        def bzr(*args, **kwargs):
            kwargs["encoding"] = "ascii"
            return self.run_bzr_raw(*args, **kwargs)[0]

        register_command(cmd_echo_replace)
        try:
            self.assertEqual(b"foo", bzr("echo-replace foo"))
            # ascii can't encode \xb5
            self.assertEqual(b"foo?", bzr(["echo-replace", "foo\xb5"]))
        finally:
            plugin_cmds.remove("echo-replace")
