#!/usr/bin/env python
"""Tests for the UI forms."""

from absl import app
from selenium.webdriver.common import keys

from grr_response_core.lib.rdfvalues import structs as rdf_structs
from grr_response_proto import tests_pb2
from grr_response_proto.api import user_pb2 as api_user_pb2
from grr_response_server import flow_base
from grr_response_server.flows.general import file_finder as flows_file_finder
from grr_response_server.gui import api_call_context
from grr_response_server.gui import gui_test_lib
from grr_response_server.gui.api_plugins import user as user_plugin
from grr.test_lib import test_lib


class DefaultArgsTestFlowArgs(rdf_structs.RDFProtoStruct):
  protobuf = tests_pb2.DefaultArgsTestFlowArgs


class DefaultArgsTestFlow(flow_base.FlowBase):
  args_type = DefaultArgsTestFlowArgs
  category = "/Tests/"
  behaviours = flow_base.BEHAVIOUR_BASIC


class TestForms(gui_test_lib.GRRSeleniumTest):
  """Tests basic forms rendering."""

  def testControlsWithoutDefaultValuesAreCorrectlyDisplayed(self):
    # Open the "new hunt" form and select the DefaultArgsTestFlow.
    self.Open("/legacy#main=ManageHunts")
    self.Click("css=button[name=NewHunt]")

    self.Click("css=#_Tests > i.jstree-icon")
    self.Click("link=DefaultArgsTestFlow")

    self.WaitUntil(self.IsTextPresent, "String value")

    # Check that shown default values of the controls are just default
    # values of the corresponding types.
    self.WaitUntilEqual(
        "",
        self.GetValue,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('String value')) input",
    )
    self.WaitUntilEqual(
        "0",
        self.GetValue,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Int value')) input",
    )
    self.WaitUntil(
        self.IsElementPresent,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Bool value')) input:not(:checked)",
    )
    self.WaitUntil(
        self.IsElementPresent,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Enum value')) select "
        "option:selected(label='OPTION_1 (default)')",
    )

  def testControlsWithDefaultValuesAreCorrectlyDisplayed(self):
    # Open the "new hunt" form and select the DefaultArgsTestFlow.
    self.Open("/legacy#main=ManageHunts")
    self.Click("css=button[name=NewHunt]")

    self.Click("css=#_Tests > i.jstree-icon")
    self.Click("link=DefaultArgsTestFlow")

    self.WaitUntil(self.IsTextPresent, "String value")

    # Check that shown default values of the controls are the default values
    # that we specified in the RDFValue definition.
    self.WaitUntilEqual(
        "default string",
        self.GetValue,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('String value with default')) input",
    )
    self.WaitUntilEqual(
        "42",
        self.GetValue,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Int value with default')) input",
    )
    self.WaitUntil(
        self.IsElementPresent,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Bool value with default')) "
        "input:checked",
    )
    self.WaitUntil(
        self.IsElementPresent,
        "css=grr-new-hunt-wizard-form "
        ".form-group:has(label:contains('Enum value with default')) select "
        "option:selected(label='OPTION_2 (default)')",
    )

  def testFileFinderArgsPathsDocHintIsDisplayed(self):
    self.Open("/legacy#/hunts")

    self.Click("css=button[name=NewHunt]")

    self.Click("css=#_Filesystem > i.jstree-icon")
    self.Click("link=" + flows_file_finder.FileFinder.friendly_name)

    self.WaitUntil(
        self.IsElementPresent,
        "css=label:contains(Paths) "
        "a[href*='help/investigating-with-grr/flows/"
        "specifying-file-paths.html']",
    )

  def testFileFinderArgsHasOnePathAddedByDefault(self):
    self.Open("/legacy#/hunts")

    self.Click("css=button[name=NewHunt]")

    self.Click("css=#_Filesystem > i.jstree-icon")
    self.Click("link=" + flows_file_finder.FileFinder.friendly_name)

    self.WaitUntil(
        self.IsElementPresent,
        "css=input[placeholder*='Type %% for autocompletion']",
    )

  def testApproverInputShowsAutocompletion(self):
    self.CreateUser("sanchezrick")

    # add decoy user, to assure that autocompletion results are based on the
    # query
    self.CreateUser("aaa")

    client_id = self.SetupClient(0)
    self.Open("/legacy#/clients/%s/host-info" % client_id)

    # We do not have an approval, so we need to request one.
    self.Click("css=button[name=requestApproval]")

    input_selector = "css=grr-approver-input input"

    self.Type(input_selector, "sanchez")

    self.WaitUntil(
        self.IsElementPresent, "css=[uib-typeahead-popup]:contains(sanchezrick)"
    )

    self.GetElement(input_selector).send_keys(keys.Keys.ENTER)

    self.WaitUntilEqual(
        "sanchezrick, ", self.GetValue, input_selector + ":text"
    )

    self.Type("css=grr-request-approval-dialog input[name=acl_reason]", "Test")
    self.Click(
        "css=grr-request-approval-dialog button[name=Proceed]:not([disabled])"
    )

    # "Request Approval" dialog should go away
    self.WaitUntilNot(self.IsVisible, "css=.modal-open")

    handler = user_plugin.ApiListClientApprovalsHandler()
    args = api_user_pb2.ApiListClientApprovalsArgs(client_id=client_id)
    res = handler.Handle(
        args=args, context=api_call_context.ApiCallContext(self.test_username)
    )
    self.assertLen(res.items, 1)
    self.assertLen(res.items[0].notified_users, 1)
    self.assertEqual(res.items[0].notified_users[0], "sanchezrick")

  def testSuggestedReasonIsPropagatedFromHostInfoToApproval(self):
    client_id = self.SetupClient(0)

    self.Open("/legacy#/clients/{}/host-info?reason=t123".format(client_id))

    self.Click("css=button[name=requestApproval]")

    self.WaitUntilEqual("t123", self.GetValue, "css=input[name=acl_reason]")


class TestFormsValidation(gui_test_lib.GRRSeleniumTest):
  """Tests forms validation in different workflows ."""

  def setUp(self):
    super().setUp()
    self.client_id = self.SetupClient(0)
    self.RequestAndGrantClientApproval(self.client_id)

  def testLaunchFlowButtonIsDisabledIfFlowArgumentsInvalid(self):
    self.Open("/legacy#/clients/%s/launch-flow" % self.client_id)

    self.Click("css=#_Filesystem a")
    self.Click("link=" + flows_file_finder.FileFinder.friendly_name)

    # FileFinder's literal match condition has bytes field that should
    # be validated: it shouldn't contain Unicode characters.
    self.Click("css=label:contains('Conditions') ~ * button")
    self.Select(
        "css=label:contains('Condition type') ~ * select",
        "Contents literal match",
    )
    self.Type("css=label:contains('Literal') ~ * input", "昨夜")

    self.WaitUntil(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Launch'):disabled"
    )

    self.Type("css=label:contains('Literal') ~ * input", "something safe")

    self.WaitUntilNot(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Launch'):not(:disabled)"
    )

  def testLaunchButtonInCopyFlowIsDisabledIfArgumentsInvalid(self):
    self.Open("/legacy#/clients/%s/launch-flow" % self.client_id)

    # Launch the flow.
    self.Click("css=#_Filesystem a")
    self.Click("link=" + flows_file_finder.FileFinder.friendly_name)
    self.Type(
        "css=grr-form-proto-repeated-field:contains('Paths') input", "foo/bar"
    )
    self.Click("css=button:contains('Launch')")

    # Open the copy dialog.
    self.Open("/legacy#/clients/%s/flows" % self.client_id)
    self.Click("css=tr:contains('%s')" % flows_file_finder.FileFinder.__name__)
    self.Click("css=button[name=copy_flow]")

    # FileFinder's literal match condition has bytes field that should
    # be validated: it shouldn't contain Unicode characters.
    self.Click("css=label:contains('Conditions') ~ * button")
    self.Select(
        "css=label:contains('Condition type') ~ * select",
        "Contents literal match",
    )
    self.Type("css=label:contains('Literal') ~ * input", "昨夜")

    self.WaitUntil(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Launch'):disabled"
    )

    self.Type("css=label:contains('Literal') ~ * input", "something safe")

    self.WaitUntilNot(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Launch'):not(:disabled)"
    )

  def testNextButtonInHuntWizardIsDisabledIfArgumentsInalid(self):
    self.Open("/legacy#/hunts")
    self.Click("css=button[name=NewHunt]")

    self.Click("css=#_Filesystem a")
    self.Click("link=" + flows_file_finder.FileFinder.friendly_name)

    # FileFinder's literal match condition has bytes field that should
    # be validated: it shouldn't contain Unicode characters.
    self.Click("css=label:contains('Conditions') ~ * button")
    self.Select(
        "css=label:contains('Condition type') ~ * select",
        "Contents literal match",
    )
    self.Type("css=label:contains('Literal') ~ * input", "昨夜")

    self.WaitUntil(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Next'):disabled"
    )

    self.Type("css=label:contains('Literal') ~ * input", "something safe")

    self.WaitUntilNot(
        self.IsElementPresent,
        "css=.text-danger:contains('Unicode characters are not "
        "allowed in a byte string')",
    )
    self.WaitUntil(
        self.IsElementPresent, "css=button:contains('Next'):not(:disabled)"
    )


if __name__ == "__main__":
  app.run(test_lib.main)
