WebElement.click()

Прочитав вступление, вы можете сказать: "И что тут такого? Я всегда тестировал имейлинг на нашем корпоративном SMTP-сервере. И до сих пор не было никаких проблем. Что тут такого?". Это может означать только одно: Вы - везучий человек. Я бы выделил несколько причин, по которым тестировать имейлинг на реальной инфраструктуре не следует.

Таким образом, используя сервер-заглушку, вы сможете повысить надежность и эффективность ваших тестов.

В нашем примере мы установим GreenMail сервер-заглушку, поддерживающую протоколы SMTP, POP3, IMAP и их TLS-обертки. Мы сконцентрируемся на первых двух протоколах, чтобы не усложнять статью.

Мы узнаем как создавать пользовательские аккаунты на сервере, как отправлять и получать письма используя один из популярных мейл-клиентов Mozilla Thunderbird (остальные будут конфигурироваться примерно так же).

Итак, мы почти готовы начать. Осталось соблюсти одно необходимое условие. Так как библиотека написана на языке Java, нам необходимо сперва установить JRE, а также прописать путь до исполняемого файла java/java.exe в переменную окружения PATH. Опционально можно убедиться в том, что порты, которые вы собираетесь использовать для запуска сервера, свободны и доступны из необходимых мест вашей сети (в противном случае, вы сможете взаимодействовать с сервером только локально через localhost).

Как я уже упомянул ранее, GreenMail - Java-библиотека. Эта библиотека распространяется как jar-архив. Стоит отметить, что она распространяется в нескольких видах. В зависимости от того для чего вы собираетесь её использовать (как часть вашего автоматизированного решения или как инфраструктуру для ручного тестирования), вам могут понадобиться различные дистрибутивы. Для ручного тестирования нам потребуется standalone-дистрибутив. Этот дистрибутив является самодостаточным исполняемым файлом, который можно запустить простой командой в командной строке. Такой вариант, хоть и является менее гибким, чем запуск из автоматического теста, но зато ваш сервер может быть доступен большему кругу людей и использоваться тестами, написанными на любом языке программирования, а не только на Java.

Так как моя статья рассказывает в основном про #ручное тестирование, мы не будем управлять всем из кода. Вообще-то мы даже не напишем ни одной строчки кода сегодня, а поэтому нам необходимо скачать standalone-дистрибутив. Самые свежие дистрибутивы вы сможете скачать на официальном сайте проекта GreenMail. Вам необходимо перейти по ссылке и скачать файл напротив GreenMail Standalone (только не трогайте ссылку "Docker Hub" - это не то, что нам сейчас нужно). Сохраните скачанный файл в какую-нибудь папку на жестком диске, откуда вам было бы удобно его запускать.

Теперь откройте командную строку, перейдите в каталог со скачанным standalone-дистрибутивом и выполните команду

Где:

Указанные команды запустят "быструю конфигурацию" GreenMail, с которой у вас не будет проблем до тех пор пока вы либо не обнаружите, что тестовые порты заняты, либо вам не понадобится подключаться к GreenMail с какого-то другого компьютера сети.

Если вы по каким либо причинам не удовлетворены "быстрой" конфигурацией, вы можете использовать дополнительные свойства для того чтобы точнее настроить необходимые вам особенности сервера. Например изменить порты на которых будут "висеть" протоколы, или отключить какие-то протоколы вообще.

Если вы хотите привязать протоколы к другим портам, вы можете комбинировать свойства, отвечающие за подобные конфигурации. Главное помнить несколько вещей:

Пример выше устанавливает тестовые настройки по умолчанию для протоколов SMTP (-Dgreenmail.setup.test.smtp) и POP3 (-Dgreenmail.setup.test.pop3) но переопределяет привязку к ip-адресу по умолчанию (-Dgreenmail.hostname=0.0.0.0) таким образом, что оба протокола в итоге сохраняют привязки к тестовым портам по умолчанию (те, что со сдвигов на 3000), но привязаны теперь не к т.н. луп-бэк адресу, а к 0.0.0.0 (т.е. ко всем возможным адресам, которые ваш компьютер потенциально может получить в сети). Других протоколов, кроме указанных двух, не запускается.

Пример выше запускает GreenMail с двумя протоколами: SMTP, стартующем на порту 12345 и POP3, стартующем на дефолтном тестовом порту 3110. Оба протокола имеют привязку к "общему" адресу 0.0.0.0 и доступны из внешних узлов сети.

Пример выше практически идентичен предыдущему. За тем лишь исключением, что в данном случае оба протокола привязаны к адресу 127.0.0.1, а значит, могут быть использованы только с того же компьютера, где запускается сам сервис.

Пример выше показывает как можно запустить только протокол SMTP, доступный для подключения только с локальной машины.

Пример выше показывает как можно запустить только протоколы SMTP и POP3, доступные для подключений извне. Оба протокола запускаются на нестандартных портах.

GreenMail - это сервис-песочница, который не предназначен для того, чтобы сохранять своё состояние между перезапусками. Если на вашем сервере в процессе тестирования накопилось какое-то состояние (переписка и/или пользователи), то всё это будет утеряно после остановки сервера. Как мы, в таком случае, настраиваем пользователей на сервере? В GreenMail существует два пути, которыми на сервере могут быть созданы пользовательские аккаунты.

Первый способ - это добавление пользователей при старте через системные свойства (так же как мы настраиваем протоколы и порты). Существует несколько паттернов, которыми можно описать добавляемые пользовательские аккаунты. Я предпочитаю такой:

Свойство -Dgreenmail.users просто добавляется к остальным системным свойствам при запуске сервера. Не смотря на то, что вы сможете создать пользователя, даже если у вас включен только SMTP-протокол, в нашем примере для демонстрационных целях мы будем также включать протокол POP3 для получения входящих сообщений. Так, используя следующий набор свойств, мы можем запустить протоколы SMTP и POP3 с некоторым тестовым пользовательским аккаунтом:

Пример выше запустит протоколы SMTP и POP3 доступные только для локальных соединений, а также сконфигурирует аккаунт с именем пользователя testacc, паролем testpwd и имейл-адресом testacc@webelement.click.

Второй способ - когда вы отправляете имейл на адрес, который не имеет ассоциированного аккаунта на сервере. Если имейл отправляется через SMTP, поднятом на GreenMail, и аккаутна с таким имейлом не существует, то такой аккаунт создается автоматически. В таком случае имя пользователя создается равным самому адресу (в отличие от первого способа, где имя пользователя отличается от имейл-адреса). Пароль устанавливается равным имени пользователя, и, очевидно, самому имейл-адресу. Мы взглянем на эти процессы по-внимательнее в следующем параграфе.

Ваши тесты не будут надежными и эффективными если вы не будете иметь возможность отправлять и получать письма, используя стандартные имейл-клиенты, такие как, например, Mozilla Thunderbird. На его примере далее мы рассмотрим как отправлять и получать письма внутри GreenMail, а также рассмотрим процесс создания новых пользователей на сервере.

Тут я предполагаю, что у вас уже установлен мейл-клиент так что мы не будем начинать с "чистого листа". Давайте запустим оба протокола: SMTP и POP3 (возможности подключать только локальные соединения будет вполне достаточно для целей демонстрации принципа) так как мы уже делали это в примерах ранее:

Здесь вы должны увидеть некоторые лог-сообщения, которые сервер выводит в консоль (если вы конечно не "отцепили" ваш сервер от консоли, что скорее всего вы не делали, т.к. следовали инструкциям из статьи). Лог сам по себе довольно информативен даже не смотря на то, что сейчас сервер запущен в "немногословном" режиме (режим детализации логов также может быть изменен при помощи соответствующего свойства). Из лога можно почерпнуть какие протоколы и на каких портах подняты, а также к каким ip-адресам они привязаны. Теперь мы можем начать настраивать наш мейл-клиент на только что запущенный нами сервер GreenMail.

Нажмите кнопку [Email] под строкой "Set up an account". Вы увидите диалог настройки мейл-аккаунта. Его состояние по умолчанию предполагает, что Thunderbird настроит всё автоматически за вас, однако мы всё же действуем внутри некой модели (пусть даже весьма точной) инфраструктуры, поэтому нам придется настраивать всё вручную. Введите имя, имя пользователя (имя аккаунта), имейл адрес и пароль. Вы можете указать какое угодно имя, но имя аккаунта, имейл и пароль должны соответствовать той конфигурации, которую мы задали при старте. Помните, что имя аккаунта - testacc, пароль - testpwd, а адрес электронной почты - testacc@webelement.click. После того, как эти поля заполнены, нажмите кнопку [Manual config].

Теперь нам надо указать параметры соединения с нашими сервисами. Поля, которые требуется изменить выделены оранжевой линией. Установить протокол входящих сообщений в POP3, поменяйте "server host name" для обоих протоколов на localhost, измените номера портов так, чтобы они соответствовали указанным портам при запуске сервера: 54321 для POP3 и 12345 для SMTP. Нажмите кнопку [Re-test]. Параметры SSL и Authentication будут запрошены с сервера, и установятся в нашем диалоге автоматически.

Нажмите кнопку [Done]. Вы увидите предупреждение о том, что сервер не использует SSL шифрование. Поставьте галочку в чекбокс "I understand the risk" и нажмите [Done]. Поздравляю! Через ваш имейл клиент теперь можно отправлять и принимать почту используя аккаунт testacc.

Если вы нажмете кнопку [Get Messages], то никаких входящих писем вы не увидите. Дело в том, что пока ни один человек и ни один процесс не отправил ни одного письма на ваш имейл, используя запущенный нами SMTP-сервер. Давайте напишем какое-нибудь письмо на несуществующий адрес.

Нажмите кнопку [Write] - вы увидите редактор письма. Укажите какой-нибудь несуществующий адрес в поле To:. Таким адресом, например, может быть адрес testacc@webelement.pleasedontclick. Укажите также какую-у тему письма и введите текст в тело письма (также можно добавить вложения). Нажмите кнопку [Send]. Теперь посмотрите в консоль где вы запустили сервер GreenMail. Вы должны увидеть там нечто подобное:

"Created user login testacc@webelement.pleasedontclick for address testacc@webelement.pleasedontclick with password testacc@webelement.pleasedontclick because it didn’t exist before"

Это означает, что теперь мы можем повторить шаги конфигурирования мейл-клиента, которые мы проходили для аккаунта testacc, но с небольшой разницей. В прошлый раз именем аккаунта была та часть имейл адреса, которая идет до символа @. В этот раз именем аккауна (как и паролем) будет имейл адрес полностью.

Поля, на которые указывают стрелки (и само поле имейла) должны содержать полное значение имейл адреса (т.е. testacc@webelement.pleasedontclick). Как только вы подтвердите все последующие диалоги, вы увидите, что теперь в списке ваших аккаунтов появился еще один - тот, что мы только что настроили. Вы также заметите, что в ящике входящих писем уже лежит одно письмо. Как раз то, которое мы туда недавно отправили.

Теперь вы знаете как настроить полнофункциональное тестовое окружение таким образом чтобы свести риск утечки конфиденциальных данных к нулю. Если у вас остались вопросы, задавайте их тут. Я постараюсь дополнить статью опираясь на ваши замечания.