[policy/models.git] /

/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
 * Modifications Copyright (C) 2024 Nordix Foundation
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.controlloop.actorserviceprovider;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;

import ch.qos.logback.classic.Logger;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.atomic.AtomicInteger;
import lombok.Builder;
import lombok.Data;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.onap.policy.common.utils.test.log.logback.ExtractAppender;
import org.slf4j.LoggerFactory;

class UtilTest {
    protected static final String EXPECTED_EXCEPTION = "expected exception";

    /**
     * Used to attach an appender to the class' logger.
     */
    private static final Logger logger = (Logger) LoggerFactory.getLogger(Util.class);
    private static final ExtractAppender appender = new ExtractAppender();

    /**
     * Initializes statics.
     */
    @BeforeAll
    static void setUpBeforeClass() {
        appender.setContext(logger.getLoggerContext());
        appender.start();

        logger.addAppender(appender);
    }

    @AfterAll
    static void tearDownAfterClass() {
        appender.stop();
    }

    @BeforeEach
   void setUp() {
        appender.clearExtractions();
    }

    @Test
   void testIdent() {
        Object object = new Object();
        String result = Util.ident(object).toString();

        assertNotEquals(object.toString(), result);
        assertThat(result).startsWith("@");
        assertTrue(result.length() > 1);
    }

    @Test
   void testRunFunction() {
        // no exception, no log
        AtomicInteger count = new AtomicInteger();
        Util.runFunction(() -> count.incrementAndGet(), "no error");
        assertEquals(1, count.get());
        assertEquals(0, appender.getExtracted().size());

        // with an exception
        Runnable runnable = () -> {
            count.incrementAndGet();
            throw new IllegalStateException("expected exception");
        };

        appender.clearExtractions();
        Util.runFunction(runnable, "error with no args");
        List<String> output = appender.getExtracted();
        assertEquals(1, output.size());
        assertThat(output.get(0)).contains("error with no args");

        appender.clearExtractions();
        Util.runFunction(runnable, "error {} {} arg(s)", "with", 2);
        output = appender.getExtracted();
        assertEquals(1, output.size());
        assertThat(output.get(0)).contains("error with 2 arg(s)");
    }

    @Test
   void testTranslate() {
        // Abc => Abc
        final Abc abc = Abc.builder().intValue(1).strValue("hello").anotherString("another").build();
        Abc abc2 = Util.translate("abc to abc", abc, Abc.class);
        assertEquals(abc, abc2);

        // Abc => Similar
        Similar sim = Util.translate("abc to similar", abc, Similar.class);
        assertEquals(abc.getIntValue(), sim.getIntValue());
        assertEquals(abc.getStrValue(), sim.getStrValue());

        // Abc => Map
        @SuppressWarnings("unchecked")
        Map<String, Object> map = Util.translate("abc to map", abc, TreeMap.class);
        assertEquals("{anotherString=another, intValue=1, strValue=hello}", map.toString());

        // Map => Map
        @SuppressWarnings("unchecked")
        Map<String, Object> map2 = Util.translate("map to map", map, LinkedHashMap.class);
        assertEquals(map.toString(), map2.toString());

        // Map => Abc
        abc2 = Util.translate("map to abc", map, Abc.class);
        assertEquals(abc, abc2);
    }

    @Test
    void testTranslateToMap() {
        assertNull(Util.translateToMap("map: null", null));

        // Abc => Map
        final Abc abc = Abc.builder().intValue(2).strValue("world").anotherString("some").build();
        Map<String, Object> map = new TreeMap<>(Util.translateToMap("map: abc to map", abc));
        assertEquals("{anotherString=some, intValue=2, strValue=world}", map.toString());

        // Map => Map
        Map<String, Object> map2 = Util.translateToMap("map: map to map", map);
        assertEquals(map.toString(), map2.toString());

        assertThatIllegalArgumentException().isThrownBy(() -> Util.translateToMap("map: string", "some string"))
                        .withMessageContaining("map: string");
    }

    @Data
    @Builder
    static class Abc {
        private int intValue;
        private String strValue;
        private String anotherString;
    }

    // this shares some fields with Abc so the data should transfer
    @Data
    @Builder
    static class Similar {
        private int intValue;
        private String strValue;
    }

    // throws an exception when getXxx() is used
    static class DataWithException {
        @SuppressWarnings("unused")
        private int intValue;

        int getIntValue() {
            throw new IllegalStateException();
        }
    }
}