LocaleUtilsUnitTest.java

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 * 
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 * 
 * Copyright 2015 The ZAP Development Team
 * 
 * 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.zaproxy.zap.utils;

import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;

import java.util.List;
import java.util.regex.Pattern;

import org.junit.Test;

/**
 * Unit test for {@link LocaleUtils}.
 */
public class LocaleUtilsUnitTest {

    private static final String FILE_NAME = "FileName";
    private static final String FILE_EXTENSION = ".extension";

    @Test(expected = IllegalArgumentException.class)
    public void shouldThrowExceptionWhenGettingResourceFilesRegexWithNullFileName() {
        // Given
        String nullFileName = null;
        // When
        LocaleUtils.createResourceFilesRegex(nullFileName, FILE_EXTENSION);
        // Then = IllegalArgumentException
    }

    @Test(expected = IllegalArgumentException.class)
    public void shouldThrowExceptionWhenGettingResourceFilesRegexWithNullFileExtension() {
        // Given
        String nullFileExtension = null;
        // When
        LocaleUtils.createResourceFilesRegex(FILE_NAME, nullFileExtension);
        // Then = IllegalArgumentException
    }

    @Test
    public void shouldReturnValidRegexWhenGettingResourceFilesRegexWithNonNullFileNameAndFileExtension() {
        // Given
        String regex = LocaleUtils.createResourceFilesRegex(FILE_NAME, FILE_EXTENSION);
        // When
        Pattern.compile(regex);
        // Then = valid regex
    }

    @Test
    public void shouldAcceptFileNameWithSpecialRegexCharsWhenGettingResourceFilesRegex() {
        // Given
        String fileNameWithSpecialRegexChars = "?]|*-)(^[:.";
        // When
        Pattern.compile(LocaleUtils.createResourceFilesRegex(fileNameWithSpecialRegexChars, FILE_EXTENSION));
        // Then = valid regex
    }

    @Test
    public void shouldAcceptFileExtensionWithSpecialRegexCharsWhenGettingResourceFilesRegex() {
        // Given
        String fileExtensionWithSpecialRegexChars = "?]|*-)(^[:.";
        // When
        Pattern.compile(LocaleUtils.createResourceFilesRegex(FILE_NAME, fileExtensionWithSpecialRegexChars));
        // Then = valid regex
    }

    @Test
    public void shouldProduceSameRegexForCreateResourceFilesRegexAsCreateResourceFilesPattern() {
        // Given
        String regex = LocaleUtils.createResourceFilesRegex(FILE_NAME, FILE_EXTENSION);
        Pattern pattern = LocaleUtils.createResourceFilesPattern(FILE_NAME, FILE_EXTENSION);
        // When
        String patternRegex = pattern.toString();
        // Then
        assertThat(regex, is(equalTo(patternRegex)));
    }

    @Test
    public void shouldMatchValidResourceFilesWithCreatedResourceFilesPattern() {
        // Given
        String[] resourceFiles = {
                "FileName.extension",
                "FileName_en.extension",
                "FileName_en_GB.extension",
                "FileName_ar_SA.extension",
                "FileName_fil_PH.extension",
                "FileName_zh_CN.extension" };
        // When
        Pattern pattern = LocaleUtils.createResourceFilesPattern(FILE_NAME, FILE_EXTENSION);
        // Then
        for (String file : resourceFiles) {
            assertThat(file, pattern.matcher(file).matches(), is(equalTo(true)));
        }
    }

    @Test
    public void shouldNotMatchInvalidResourceFilesWithCreatedResourceFilesPattern() {
        // Given
        String[] resourceFiles = {
                "Vulnerabilities.xml",
                "Vulnerabilities_en.xml",
                "Vulnerabilities_en_GB.xml",
                "OtherFile_ar_SA.properties",
                "fileName.ext" };
        // When
        Pattern pattern = LocaleUtils.createResourceFilesPattern(FILE_NAME, FILE_EXTENSION);
        // Then
        for (String file : resourceFiles) {
            assertThat(file, pattern.matcher(file).matches(), is(equalTo(false)));
        }
    }

    @Test
    public void shouldMatchValidMessagesPropertiesFilesWithCreateMessagesPropertiesFilePattern() {
        // Given
        String[] resourceFiles = {
                "Messages.properties",
                "Messages_en.properties",
                "Messages_en_GB.properties",
                "Messages_ar_SA.properties",
                "Messages_fil_PH.properties",
                "Messages_zh_CN.properties" };
        // When
        Pattern pattern = LocaleUtils.createMessagesPropertiesFilePattern();
        // Then
        for (String file : resourceFiles) {
            assertThat(file, pattern.matcher(file).matches(), is(equalTo(true)));
        }
    }

    @Test
    public void shouldNotMatchInvalidMessagesPropertiesFilesWithCreateMessagesPropertiesFilePattern() {
        // Given
        String[] resourceFiles = {
                "Vulnerabilities.xml",
                "Vulnerabilities_en.xml",
                "Vulnerabilities_en_GB.xml",
                "OtherFile_ar_SA.properties",
                "messages.properties" };
        // When
        Pattern pattern = LocaleUtils.createMessagesPropertiesFilePattern();
        // Then
        for (String file : resourceFiles) {
            assertThat(file, pattern.matcher(file).matches(), is(equalTo(false)));
        }
    }

    @Test
    public void shoudAvailableLocalesBeNonEmpty() {
        // Given
        List<String> locales = LocaleUtils.getAvailableLocales();

        // When/Then
        assertThat(locales, is(not(empty())));
    }

    @Test
    public void shouldHaveEnglishAsFirstAvailableLocale() {
        // Given
        List<String> locales = LocaleUtils.getAvailableLocales();

        // When
        String firstAvailableLocale = locales.get(0);

        // Then
        assertThat(firstAvailableLocale, is(equalTo("en_GB")));
    }
}