AbstractMultiUserChatIntegrationTest.java

  1. /**
  2.  *
  3.  * Copyright 2021-2024 Florian Schmaus
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  18. package org.jivesoftware.smackx.muc;

  20. import java.util.List;
  21. import java.util.logging.Level;

  23. import org.jivesoftware.smack.SmackException;
  24. import org.jivesoftware.smack.XMPPException;
  25. import org.jivesoftware.smack.XMPPException.XMPPErrorException;
  26. import org.jivesoftware.smack.packet.StanzaError;
  27. import org.jivesoftware.smack.util.StringUtils;
  28. import org.jivesoftware.smackx.muc.MultiUserChatException.MissingMucCreationAcknowledgeException;
  29. import org.jivesoftware.smackx.muc.MultiUserChatException.MucAlreadyJoinedException;
  30. import org.jivesoftware.smackx.muc.MultiUserChatException.NotAMucServiceException;
  31. import org.jivesoftware.smackx.xdata.form.FillableForm;
  32. import org.jivesoftware.smackx.xdata.form.Form;

  34. import org.igniterealtime.smack.inttest.AbstractSmackIntegrationTest;
  35. import org.igniterealtime.smack.inttest.SmackIntegrationTestEnvironment;
  36. import org.igniterealtime.smack.inttest.TestNotPossibleException;
  37. import org.jxmpp.jid.DomainBareJid;
  38. import org.jxmpp.jid.EntityBareJid;
  39. import org.jxmpp.jid.impl.JidCreate;
  40. import org.jxmpp.jid.parts.Localpart;
  41. import org.jxmpp.jid.parts.Resourcepart;
  42. import org.jxmpp.stringprep.XmppStringprepException;


  45. public abstract class AbstractMultiUserChatIntegrationTest extends AbstractSmackIntegrationTest {

  47.     final String randomString = StringUtils.insecureRandomString(6);

  49.     final MultiUserChatManager mucManagerOne;
  50.     final MultiUserChatManager mucManagerTwo;
  51.     final MultiUserChatManager mucManagerThree;
  52.     final DomainBareJid mucService;

  54.     public AbstractMultiUserChatIntegrationTest(SmackIntegrationTestEnvironment environment)
  55.             throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException,
  56.             InterruptedException, TestNotPossibleException, MucAlreadyJoinedException, MissingMucCreationAcknowledgeException, NotAMucServiceException, XmppStringprepException {
  57.         super(environment);
  58.         mucManagerOne = MultiUserChatManager.getInstanceFor(conOne);
  59.         mucManagerTwo = MultiUserChatManager.getInstanceFor(conTwo);
  60.         mucManagerThree = MultiUserChatManager.getInstanceFor(conThree);

  62.         List<DomainBareJid> services = mucManagerOne.getMucServiceDomains();
  63.         if (services.isEmpty()) {
  64.             throw new TestNotPossibleException("No MUC (XEP-0045) service found");
  65.         }

  67.         DomainBareJid needle = null;
  68.         for (final DomainBareJid service : services) {
  69.             MultiUserChat multiUserChat = null;
  70.             try {
  71.                 String roomNameLocal = String.join("-", "smack-inttest-abstract", testRunId, StringUtils.insecureRandomString(6));
  72.                 EntityBareJid mucAddress = JidCreate.entityBareFrom(Localpart.from(roomNameLocal), service.getDomain());
  73.                 multiUserChat = mucManagerOne.getMultiUserChat(mucAddress);

  75.                 createMuc(multiUserChat, "test");

  77.                 needle = service;
  78.                 break;
  79.             } catch (XMPPException.XMPPErrorException e) {
  80.                 mucCreationDisallowedOrThrow(e);
  81.                 LOGGER.log(Level.FINER, "MUC service " + service + " does not allow MUC creation", e);
  82.             } finally {
  83.                 tryDestroy(multiUserChat);
  84.             }
  85.         }

  87.         if (needle == null) {
  88.             throw new TestNotPossibleException("No MUC (XEP-0045) service found that allows test users to createa new room. Considered MUC services: " + services);
  89.         }
  90.         mucService = needle;
  91.     }

  93.     static void mucCreationDisallowedOrThrow(XMPPException.XMPPErrorException e) throws XMPPErrorException {
  94.         StanzaError.Condition condition = e.getStanzaError().getCondition();
  95.         if (condition == StanzaError.Condition.not_allowed)
  96.             return;
  97.         throw e;
  98.     }

  100.     /**
  101.      * Gets a random room name.
  102.      *
  103.      * @param prefix A prefix to add to the room name for descriptive purposes
  104.      * @return the bare JID of a random room
  105.      * @throws XmppStringprepException if the prefix isn't a valid XMPP Localpart
  106.      */
  107.     public EntityBareJid getRandomRoom(String prefix) throws XmppStringprepException {
  108.         final String roomNameLocal = String.join("-", prefix, testRunId, StringUtils.insecureRandomString(6));
  109.         return JidCreate.entityBareFrom(Localpart.from(roomNameLocal), mucService.getDomain());
  110.     }

  112.     /**
  113.      * Destroys a MUC room, ignoring any exceptions.
  114.      *
  115.      * @param muc The room to destroy (can be null).
  116.      * @throws InterruptedException if the calling thread was interrupted.
  117.      * @throws SmackException.NotConnectedException if the XMPP connection is not connected.
  118.      * @throws XMPPException.XMPPErrorException if there was an XMPP error returned.
  119.      * @throws SmackException.NoResponseException if there was no response from the remote entity.
  120.      */
  121.     static void tryDestroy(final MultiUserChat muc) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException {
  122.         if (muc == null) {
  123.             return;
  124.         }
  125.         muc.destroy("test fixture teardown", null);
  126.     }

  128.     static void createMuc(MultiUserChat muc, Resourcepart resourceName) throws
  129.             SmackException.NoResponseException, XMPPException.XMPPErrorException,
  130.             InterruptedException, MultiUserChatException.MucAlreadyJoinedException,
  131.             SmackException.NotConnectedException,
  132.             MultiUserChatException.MissingMucCreationAcknowledgeException,
  133.             MultiUserChatException.NotAMucServiceException {
  134.         muc.create(resourceName).makeInstant();
  135.     }

  137.     static void createMuc(MultiUserChat muc, String nickname) throws
  138.             XmppStringprepException, MultiUserChatException.MucAlreadyJoinedException,
  139.             XMPPException.XMPPErrorException, SmackException.NotConnectedException,
  140.             MultiUserChatException.MissingMucCreationAcknowledgeException,
  141.             SmackException.NoResponseException, InterruptedException,
  142.             MultiUserChatException.NotAMucServiceException {
  143.         createMuc(muc, Resourcepart.from(nickname));
  144.     }

  146.     static void createMembersOnlyMuc(MultiUserChat muc, Resourcepart resourceName) throws
  147.             SmackException.NoResponseException, XMPPException.XMPPErrorException,
  148.             InterruptedException, MultiUserChatException.MucAlreadyJoinedException,
  149.             SmackException.NotConnectedException,
  150.             MultiUserChatException.MissingMucCreationAcknowledgeException,
  151.             MultiUserChatException.MucConfigurationNotSupportedException,
  152.             MultiUserChatException.NotAMucServiceException {
  153.         muc.create(resourceName)
  154.             .getConfigFormManager()
  155.             .makeMembersOnly()
  156.             .submitConfigurationForm();
  157.     }

  159.     static void createModeratedMuc(MultiUserChat muc, Resourcepart resourceName)
  160.                     throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException,
  161.                     MultiUserChatException.MucAlreadyJoinedException, SmackException.NotConnectedException,
  162.                     MultiUserChatException.MissingMucCreationAcknowledgeException,
  163.                     MultiUserChatException.NotAMucServiceException,
  164.                     MultiUserChatException.MucConfigurationNotSupportedException {
  165.         muc.create(resourceName)
  166.             .getConfigFormManager()
  167.             .makeModerated()
  168.             .submitConfigurationForm();
  169.     }

  171.     static void createHiddenMuc(MultiUserChat muc, Resourcepart resourceName)
  172.                     throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException,
  173.                     MultiUserChatException.MucAlreadyJoinedException, SmackException.NotConnectedException,
  174.                     MultiUserChatException.MissingMucCreationAcknowledgeException, MultiUserChatException.NotAMucServiceException, XmppStringprepException,
  175.                     MultiUserChatException.MucConfigurationNotSupportedException {
  176.         muc.create(resourceName)
  177.             .getConfigFormManager()
  178.             .makeHidden()
  179.             .submitConfigurationForm();
  180.     }

  182.     /**
  183.      * Creates a non-anonymous room.
  184.      *
  185.      * <p>From XEP-0045 § 10.1.3:</p>
  186.      * <blockquote>
  187.      * Note: The _whois configuration option specifies whether the room is non-anonymous (a value of "anyone"),
  188.      * semi-anonymous (a value of "moderators"), or fully anonymous (a value of "none", not shown here).
  189.      * </blockquote>
  190.      */
  191.     static void createNonAnonymousMuc(MultiUserChat muc, Resourcepart resourceName) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException, MultiUserChatException.MucAlreadyJoinedException, SmackException.NotConnectedException, MultiUserChatException.MissingMucCreationAcknowledgeException, MultiUserChatException.NotAMucServiceException {
  192.         muc.create(resourceName);
  193.         Form configForm = muc.getConfigurationForm();
  194.         FillableForm answerForm = configForm.getFillableForm();
  195.         answerForm.setAnswer("muc#roomconfig_whois", "anyone");
  196.         muc.sendConfigurationForm(answerForm);
  197.     }

  199.     /**
  200.      * Creates a semi-anonymous room.
  201.      *
  202.      * <p>From XEP-0045 § 10.1.3:</p>
  203.      * <blockquote>
  204.      * Note: The _whois configuration option specifies whether the room is non-anonymous (a value of "anyone"),
  205.      * semi-anonymous (a value of "moderators"), or fully anonymous (a value of "none", not shown here).
  206.      * </blockquote>
  207.      */
  208.     static void createSemiAnonymousMuc(MultiUserChat muc, Resourcepart resourceName) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException, MultiUserChatException.MucAlreadyJoinedException, SmackException.NotConnectedException, MultiUserChatException.MissingMucCreationAcknowledgeException, MultiUserChatException.NotAMucServiceException {
  209.         muc.create(resourceName);
  210.         Form configForm = muc.getConfigurationForm();
  211.         FillableForm answerForm = configForm.getFillableForm();
  212.         answerForm.setAnswer("muc#roomconfig_whois", "moderators");
  213.         muc.sendConfigurationForm(answerForm);
  214.     }

  216.     /**
  217.      * Creates a password-protected room.
  218.      */
  219.     static void createPasswordProtectedMuc(MultiUserChat muc, Resourcepart resourceName, String password) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException, MultiUserChatException.MucAlreadyJoinedException, SmackException.NotConnectedException, MultiUserChatException.MissingMucCreationAcknowledgeException, MultiUserChatException.NotAMucServiceException {
  220.         muc.create(resourceName);
  221.         Form configForm = muc.getConfigurationForm();
  222.         FillableForm answerForm = configForm.getFillableForm();
  223.         answerForm.setAnswer("muc#roomconfig_passwordprotectedroom", true);
  224.         answerForm.setAnswer("muc#roomconfig_roomsecret", password);
  225.         muc.sendConfigurationForm(answerForm);
  226.     }

  228.     static void setMaxUsers(MultiUserChat muc, int maxUsers) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, InterruptedException, SmackException.NotConnectedException {
  229.         Form configForm = muc.getConfigurationForm();
  230.         FillableForm answerForm = configForm.getFillableForm();
  231.         answerForm.setAnswer("muc#roomconfig_maxusers", maxUsers);
  232.         muc.sendConfigurationForm(answerForm);
  233.     }

  235. }
Created with JaCoCo 0.8.6.202009150832