org.openhab.tools.analysis.checkstyle.test.KarafFeatureCheckTest.java Source code

Introduction

Here is the source code for org.openhab.tools.analysis.checkstyle.test.KarafFeatureCheckTest.java

Source

/**
 * Copyright (c) 2010-2018 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.tools.analysis.checkstyle.test;

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.times;
import static org.openhab.tools.analysis.checkstyle.api.CheckConstants.POM_XML_FILE_NAME;

import java.io.File;
import java.text.MessageFormat;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;

import org.apache.commons.lang.ArrayUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import org.openhab.tools.analysis.checkstyle.KarafFeatureCheck;
import org.openhab.tools.analysis.checkstyle.api.AbstractStaticCheckTest;

import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.Configuration;

/**
 * Tests for {@link KarafFeatureCheck}
 *
 * @author Svilen Valkanov - Initial contribution
 */
@RunWith(MockitoJUnitRunner.class)
public class KarafFeatureCheckTest extends AbstractStaticCheckTest {

    @Mock
    private Handler handler;

    @Captor
    private ArgumentCaptor<LogRecord> captor;

    private static final String MSG_MISSING_BUNDLE_IN_FEATURE_XML = "Bundle with ID '{0}' must be added in {1}";
    private static final String TEST_DIRECTORY = "karafFeatureCheck";
    private static final DefaultConfiguration CONFIGURATION = createCheckConfig(KarafFeatureCheck.class);

    @Override
    protected DefaultConfiguration createCheckerConfig(Configuration config) {
        DefaultConfiguration configParent = new DefaultConfiguration("root");
        configParent.addChild(config);
        return configParent;
    }

    @BeforeClass
    public static void setUp() {
        CONFIGURATION.addAttribute("featureXmlPath", "feature/feature.xml");
    }

    @Before
    public void setup() {
        Logger system = Logger.getLogger("");
        system.addHandler(handler);
    }

    @After
    public void teardown() {
        Logger system = Logger.getLogger("");
        system.removeHandler(handler);
    }

    @Test
    public void testIncludedBundle() throws Exception {
        verify("includedBundle", ArrayUtils.EMPTY_STRING_ARRAY);
    }

    @Test
    public void testIncludedBundleWithParentGroupIdOnly() throws Exception {
        verify("includedBundleWithParentGroupIdOnly", ArrayUtils.EMPTY_STRING_ARRAY);
    }

    @Test
    public void testInvalidBundle() throws Exception {
        verify("invalidBundle", ArrayUtils.EMPTY_STRING_ARRAY);

        org.mockito.Mockito.verify(handler, times(1)).publish(captor.capture());

        assertThat(captor.getValue().getLevel(), is(Level.WARNING));
        assertThat(captor.getValue().getMessage(), startsWith(
                "KarafFeatureCheck will be skipped. Could not find Maven group ID (parent group ID) or artifact ID in"));
    }

    @Test
    public void testMissingBundle() throws Exception {
        String[] messages = generateExpectedMessages(0, MessageFormat.format(MSG_MISSING_BUNDLE_IN_FEATURE_XML,
                "mvn:org.openhab.binding/org.openhab.binding.missing/{project.version}", "feature/feature.xml"));
        verify("missingBundle", messages);
    }

    private void verify(String fileDirectory, String[] expectedMessages) throws Exception {
        verify(CONFIGURATION,
                getPath(TEST_DIRECTORY + File.separator + fileDirectory + File.separator + POM_XML_FILE_NAME),
                expectedMessages);
    }
}