org.identityconnectors.contract.test.TestApiOpTests Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of connector-framework-contract Show documentation
The newest version!
/*
 * ====================
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of the Common Development
 * and Distribution License("CDDL") (the "License").  You may not use this file
 * except in compliance with the License.
 *
 * You can obtain a copy of the License at
 * http://opensource.org/licenses/cddl1.php
 * See the License for the specific language governing permissions and limitations
 * under the License.
 *
 * When distributing the Covered Code, include this CDDL Header Notice in each file
 * and include the License file at http://opensource.org/licenses/cddl1.php.
 * If applicable, add the following below this CDDL Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * ====================
 * Portions Copyrighted 2010-2013 ForgeRock AS.
 * Portions Copyrighted 2018 ConnId
 */
package org.identityconnectors.contract.test;

import static org.junit.jupiter.api.Assertions.fail;

import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.identityconnectors.common.logging.Log;

import org.identityconnectors.contract.exceptions.ObjectNotFoundException;
import org.identityconnectors.framework.api.operations.APIOperation;
import org.identityconnectors.framework.api.operations.TestApiOp;
import org.junit.jupiter.api.Test;

/**
 * Contract test of {@link TestApiOp}. Positive test for test() is performed
 * everytime connector facade is created and connector supports the operation.
 * Test uses the same configuration as ValidateApiOpTest.
 *
 * Currently there is not ability in API to test contract in case connection is lost.
 */
public class TestApiOpTests extends ContractTestBase {

    private static final Log LOG = Log.getLog(TestApiOpTests.class);

    public static final String TEST_NAME = "Test";

    private static final String PROPERTY_NAME_INVALID_CONFIG = "invalidConfig";

    /**
     * Tests test() with configuration that should NOT be correct. Expects a RuntimeException to be thrown.
     */
    @Test
    public void testTestFail() {
        final String testPropertyName = "testsuite." + TEST_NAME + "."
                + PROPERTY_NAME_INVALID_CONFIG;

        // run test only in case operation is supported
        if (ConnectorHelper.operationsSupported(getConnectorFacade(), getAPIOperations())) {
            // READ THE TEST PROPERTY WITH WRONG CONFIGURATIONS THAT OVERRIDE THE DEFAULT CONFIGURATION
            Object o = null;
            try {
                o = getDataProvider().getTestSuiteAttribute(PROPERTY_NAME_INVALID_CONFIG, TEST_NAME);
            } catch (ObjectNotFoundException ex) {
                fail(String.format("Missing test property: '%s'", testPropertyName));
            }

            if (!(o instanceof List)) {
                fail(String.format("Test property '%s' should be of type List", testPropertyName));
            }

            final List wrongConfigList = (List) o;

            wrongConfigList.forEach(currentWrongConfigMap -> {
                if (!(currentWrongConfigMap instanceof Map)) {
                    fail(String.format("Test property '%s' contains other than Map properties.", testPropertyName));
                }
                Map currentWrongMapConfig = (Map) currentWrongConfigMap;

                _connFacade = ConnectorHelper
                        .createConnectorFacadeWithWrongConfiguration(
                                getDataProvider(), currentWrongMapConfig);
                try {
                    // should throw RuntimeException
                    getConnectorFacade().test();
                    String msg = String.format(
                            "test() should throw RuntimeException because configuration should be invalid. Wrong properties used: \n%s",
                            currentWrongMapConfig.toString());
                    fail(msg);
                } catch (RuntimeException ex) {
                    // expected
                }
            });
        } else {
            LOG.info("--------------------------------");
            LOG.info("Skipping test ''testTestFail''.");
            LOG.info("--------------------------------");
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Set> getAPIOperations() {
        Set> s = new HashSet<>();
        // list of required operations by this test:
        s.add(TestApiOp.class);
        return s;
    }
}