ReadOnlyDeviceIntegrationTest.java

/**
 *
 * Copyright 2018 Paul Schaub
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jivesoftware.smackx.omemo;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.IOException;

import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.XMPPException;

import org.jivesoftware.smackx.omemo.exceptions.CryptoFailedException;
import org.jivesoftware.smackx.omemo.exceptions.ReadOnlyDeviceException;
import org.jivesoftware.smackx.omemo.exceptions.UndecidedOmemoIdentityException;

import org.igniterealtime.smack.inttest.SmackIntegrationTestEnvironment;
import org.igniterealtime.smack.inttest.TestNotPossibleException;
import org.igniterealtime.smack.inttest.annotations.SmackIntegrationTest;
import org.igniterealtime.smack.inttest.annotations.SpecificationReference;

@SpecificationReference(document = "XEP-0384", version = "0.3.0")
public class ReadOnlyDeviceIntegrationTest extends AbstractTwoUsersOmemoIntegrationTest {

    public ReadOnlyDeviceIntegrationTest(SmackIntegrationTestEnvironment environment) throws XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException, SmackException.NoResponseException, TestNotPossibleException {
        super(environment);
    }

    @SmackIntegrationTest
    public void test() throws InterruptedException, SmackException.NoResponseException,
                    SmackException.NotLoggedInException, SmackException.NotConnectedException, CryptoFailedException,
                    UndecidedOmemoIdentityException, IOException {
        boolean prevIgnoreReadOnlyConf = OmemoConfiguration.getIgnoreReadOnlyDevices();
        int prevMaxMessageCounter = OmemoConfiguration.getMaxReadOnlyMessageCount();

        OmemoConfiguration.setIgnoreReadOnlyDevices(true);
        // Set the maxReadOnlyMessageCount to ridiculously low threshold of 5.
        // This means that Alice will be able to encrypt 5 messages for Bob, while the 6th will not be encrypted for Bob.
        OmemoConfiguration.setMaxReadOnlyMessageCount(5);

        // Reset counter to begin test
        alice.getOmemoService().getOmemoStoreBackend().storeOmemoMessageCounter(alice.getOwnDevice(), bob.getOwnDevice(), 0);

        // Since the max threshold is 5, we must be able to encrypt 5 messages for Bob.
        for (int i = 0; i < 5; i++) {
            assertEquals(i, alice.getOmemoService().getOmemoStoreBackend().loadOmemoMessageCounter(alice.getOwnDevice(), bob.getOwnDevice()));
            OmemoMessage.Sent message = alice.encrypt(bob.getOwnJid(), "Hello World!");
            assertFalse(message.getSkippedDevices().containsKey(bob.getOwnDevice()));
        }

        // Now the message counter must be too high and Bobs device must be skipped.
        OmemoMessage.Sent message = alice.encrypt(bob.getOwnJid(), "Hello World!");
        Throwable exception = message.getSkippedDevices().get(bob.getOwnDevice());
        assertTrue(exception instanceof ReadOnlyDeviceException);
        assertEquals(bob.getOwnDevice(), ((ReadOnlyDeviceException) exception).getDevice());

        // Reset the message counter
        alice.getOmemoService().getOmemoStoreBackend().storeOmemoMessageCounter(alice.getOwnDevice(), bob.getOwnDevice(), 0);

        // Reset the configuration to previous values
        OmemoConfiguration.setMaxReadOnlyMessageCount(prevMaxMessageCounter);
        OmemoConfiguration.setIgnoreReadOnlyDevices(prevIgnoreReadOnlyConf);
    }
}