"""
Integration tests for the stem.response.ControlMessage class.
"""

import re
import unittest

import stem.socket
import stem.version
import test.runner

from test.util import (
  require_controller,
  require_version,
  random_fingerprint,
)


class TestControlMessage(unittest.TestCase):
  @require_controller
  def test_unestablished_socket(self):
    """
    Checks message parsing when we have a valid but unauthenticated socket.
    """

    # If an unauthenticated connection gets a message besides AUTHENTICATE or
    # PROTOCOLINFO then tor will give an 'Authentication required.' message and
    # hang up.

    control_socket = test.runner.get_runner().get_tor_socket(False)
    control_socket.send('GETINFO version')

    auth_required_response = control_socket.recv()
    self.assertEqual('Authentication required.', str(auth_required_response))
    self.assertEqual(['Authentication required.'], list(auth_required_response))
    self.assertEqual('514 Authentication required.\r\n', auth_required_response.raw_content())
    self.assertEqual([('514', ' ', 'Authentication required.')], auth_required_response.content())

    # The socket's broken but doesn't realize it yet. These use cases are
    # checked in more depth by the ControlSocket integ tests.

    self.assertTrue(control_socket.is_alive())
    self.assertRaises(stem.SocketClosed, control_socket.recv)
    self.assertFalse(control_socket.is_alive())

    # Additional socket usage should fail, and pulling more responses will fail
    # with more closed exceptions.

    self.assertRaises(stem.SocketError, control_socket.send, 'GETINFO version')
    self.assertRaises(stem.SocketClosed, control_socket.recv)
    self.assertRaises(stem.SocketClosed, control_socket.recv)
    self.assertRaises(stem.SocketClosed, control_socket.recv)

    # The socket connection is already broken so calling close shouldn't have
    # an impact.

    control_socket.close()
    self.assertRaises(stem.SocketClosed, control_socket.send, 'GETINFO version')
    self.assertRaises(stem.SocketClosed, control_socket.recv)

  @require_controller
  def test_invalid_command(self):
    """
    Parses the response for a command which doesn't exist.
    """

    with test.runner.get_runner().get_tor_socket() as control_socket:
      control_socket.send('blarg')
      unrecognized_command_response = control_socket.recv()
      self.assertEqual('Unrecognized command "blarg"', str(unrecognized_command_response))
      self.assertEqual(['Unrecognized command "blarg"'], list(unrecognized_command_response))
      self.assertEqual('510 Unrecognized command "blarg"\r\n', unrecognized_command_response.raw_content())
      self.assertEqual([('510', ' ', 'Unrecognized command "blarg"')], unrecognized_command_response.content())

  @require_controller
  def test_invalid_getinfo(self):
    """
    Parses the response for a GETINFO query which doesn't exist.
    """

    with test.runner.get_runner().get_tor_socket() as control_socket:
      control_socket.send('GETINFO blarg')
      unrecognized_key_response = control_socket.recv()
      self.assertEqual('Unrecognized key "blarg"', str(unrecognized_key_response))
      self.assertEqual(['Unrecognized key "blarg"'], list(unrecognized_key_response))
      self.assertEqual('552 Unrecognized key "blarg"\r\n', unrecognized_key_response.raw_content())
      self.assertEqual([('552', ' ', 'Unrecognized key "blarg"')], unrecognized_key_response.content())

  @require_controller
  def test_getinfo_config_file(self):
    """
    Parses the 'GETINFO config-file' response.
    """

    runner = test.runner.get_runner()
    torrc_dst = runner.get_torrc_path()

    with runner.get_tor_socket() as control_socket:
      control_socket.send('GETINFO config-file')
      config_file_response = control_socket.recv()
      self.assertEqual('config-file=%s\nOK' % torrc_dst, str(config_file_response))
      self.assertEqual(['config-file=%s' % torrc_dst, 'OK'], list(config_file_response))
      self.assertEqual('250-config-file=%s\r\n250 OK\r\n' % torrc_dst, config_file_response.raw_content())
      self.assertEqual([('250', '-', 'config-file=%s' % torrc_dst), ('250', ' ', 'OK')], config_file_response.content())

  @require_controller
  @require_version(stem.version.Requirement.GETINFO_CONFIG_TEXT)
  def test_getinfo_config_text(self):
    """
    Parses the 'GETINFO config-text' response.
    """

    runner = test.runner.get_runner()

    # We can't be certain of the order, and there may be extra config-text
    # entries as per...
    # https://trac.torproject.org/projects/tor/ticket/2362
    #
    # so we'll just check that the response is a superset of our config

    torrc_contents = []

    for line in runner.get_torrc_contents().splitlines():
      line = line.strip()

      if line and not line.startswith('#'):
        torrc_contents.append(line)

    with runner.get_tor_socket() as control_socket:
      control_socket.send('GETINFO config-text')
      config_text_response = control_socket.recv()

      # the response should contain two entries, the first being a data response
      self.assertEqual(2, len(list(config_text_response)))
      self.assertEqual('OK', list(config_text_response)[1])
      self.assertEqual(('250', ' ', 'OK'), config_text_response.content()[1])
      self.assertTrue(config_text_response.raw_content().startswith('250+config-text=\r\n'))
      self.assertTrue(config_text_response.raw_content().endswith('\r\n.\r\n250 OK\r\n'))
      self.assertTrue(str(config_text_response).startswith('config-text=\n'))
      self.assertTrue(str(config_text_response).endswith('\nOK'))

      for torrc_entry in torrc_contents:
        self.assertTrue('\n%s\n' % torrc_entry in str(config_text_response))
        self.assertTrue(torrc_entry in list(config_text_response)[0])
        self.assertTrue('%s\r\n' % torrc_entry in config_text_response.raw_content())
        self.assertTrue('%s' % torrc_entry in config_text_response.content()[0][2])

  @require_controller
  def test_setconf_event(self):
    """
    Issues 'SETEVENTS CONF_CHANGED' and parses an events.
    """

    with test.runner.get_runner().get_tor_socket() as control_socket:
      control_socket.send('SETEVENTS CONF_CHANGED')
      setevents_response = control_socket.recv()
      self.assertEqual('OK', str(setevents_response))
      self.assertEqual(['OK'], list(setevents_response))
      self.assertEqual('250 OK\r\n', setevents_response.raw_content())
      self.assertEqual([('250', ' ', 'OK')], setevents_response.content())

      # We'll receive both a CONF_CHANGED event and 'OK' response for the
      # SETCONF, but not necessarily in any specific order.

      control_socket.send('SETCONF NodeFamily=%s' % random_fingerprint())
      msg1 = control_socket.recv()
      msg2 = control_socket.recv()

      if msg1.content()[0][0] == '650':
        conf_changed_event, setconf_response = msg1, msg2
      else:
        setconf_response, conf_changed_event = msg1, msg2

      self.assertTrue(re.match('CONF_CHANGED\nNodeFamily=.*', str(conf_changed_event)))
      self.assertTrue(re.match('650-CONF_CHANGED\r\n650-NodeFamily=.*\r\n650 OK', conf_changed_event.raw_content()))
      self.assertEqual(('650', '-'), conf_changed_event.content()[0][:2])

      self.assertEqual([('250', ' ', 'OK')], setconf_response.content())
