/*
 * This work is Open Source and licensed by the European Commission under the
 * conditions of the European Public License v1.1 
 *  
 * (http://www.osor.eu/eupl/european-union-public-licence-eupl-v.1.1); 
 * 
 * any use of this file implies acceptance of the conditions of this license. 
 * 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 eu.stork.peps.tests;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertFalse;

import java.util.Properties;

import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;

import eu.stork.peps.auth.commons.IPersonalAttributeList;
import eu.stork.peps.auth.commons.PEPSErrors;
import eu.stork.peps.auth.commons.PEPSParameters;
import eu.stork.peps.auth.commons.PEPSUtil;
import eu.stork.peps.auth.commons.PersonalAttributeList;
import eu.stork.peps.auth.commons.exceptions.InternalErrorPEPSException;
import eu.stork.peps.auth.commons.exceptions.InvalidParameterPEPSException;

/**
 * The PEPSUtil's Test Case.
 * 
 * @author ricardo.ferreira@multicert.com, renato.portela@multicert.com,
 *         luis.felix@multicert.com
 * 
 * @version $Revision: $, $Date: $
 */
public final class PEPSUtilTestCase {
  
  /**
   * Message example.
   */
  private static final String MESSAGE_SAMPLE = "003002 - Authentication Failed";
  
  /**
   * Error message example.
   */
  private static final String ERROR_MESSAGE_SAMPLE = "Authentication Failed";
  
  /**
   * Error code example.
   */
  private static final String ERROR_CODE_SAMPLE = "003002";
  
  /**
   * Properties values for testing proposes.
   */
  private static final Properties CONFIGS1 = new Properties();
  
  /**
   * Properties values for testing proposes.
   */
  private static final Properties CONFIGS2 = new Properties();
  
  /**
   * The empty string value: "".
   */
  private static final String EMPTY_STRING = "";
  
  /**
   * The empty byte value: [].
   */
  private static final byte[] EMPTY_BYTE = new byte[] {};
  
  /**
   * The empty byte hash value.
   */
  private static final byte[] EMPTY_HASH_BYTE = new byte[] { -49, -125, -31,
    53, 126, -17, -72, -67, -15, 84, 40, 80, -42, 109, -128, 7, -42, 32, -28,
    5, 11, 87, 21, -36, -125, -12, -87, 33, -45, 108, -23, -50, 71, -48, -47,
    60, 93, -123, -14, -80, -1, -125, 24, -46, -121, 126, -20, 47, 99, -71, 49,
    -67, 71, 65, 122, -127, -91, 56, 50, 122, -7, 39, -38, 62 };
  
  /**
   * The SAML example byte[] value.
   */
  private static final byte[] SAML_BYTE_SAMPLE = new byte[] { 60, 115, 97, 109,
    108, 62, 46, 46, 46, 60, 47, 115, 97, 109, 108 };
  
  /**
   * The SAML's Base64 example value.
   */
  private static final String SAML_BASE64_SAMPLE = "PHNhbWw+Li4uPC9zYW1s";
  
  /**
   * The SAML's Base64 byte[] example value.
   */
  private static byte[] SAML_BASE64_BYTE_SAMPLE = new byte[] { 80, 72, 78, 104,
    98, 87, 119, 43, 76, 105, 52, 117, 80, 67, 57, 122, 89, 87, 49, 115 };
  
  /**
   * The SAML's Base64 Hash byte[] example value.
   */
  private static byte[] HASH_BYTE_SAMPLE = new byte[] { 67, 38, 11, 115, 49,
    -5, 54, -85, 38, 43, -99, 96, 71, -41, 50, -96, 71, -86, 90, -97, 66, -67,
    90, 101, 30, 82, -13, 60, -106, -72, -103, -75, 19, 2, -107, 107, -6, -56,
    34, -111, -44, -57, -26, -5, 33, 78, -1, 30, 21, 74, -26, 118, -46, -12,
    -102, 12, -56, 30, -59, -104, -21, -42, -103, 82 };
  
  /**
   * Init PEPSUtilTestCase class.
   */
  @BeforeClass
  public static void runsBeforeTheTestSuite() {
    
    CONFIGS1.setProperty("max.attrList.size", "20000");
    CONFIGS1.setProperty("attrList.code", "202005");
    CONFIGS1.setProperty("attrList.message", "invalid.attrList.parameter");
    
    CONFIGS1.setProperty("max.qaaLevel.size", "1");
    CONFIGS1.setProperty("max.spUrl.size", "inv");
    CONFIGS1.setProperty("validation.active", "true");
    CONFIGS1.setProperty("hashDigest.className",
      "org.bouncycastle.crypto.digests.SHA512Digest");
    CONFIGS1.setProperty("invalidAgeDateValue.code", "35");
    CONFIGS1.setProperty("invalidAttributeValue.code", "34");
    CONFIGS1.setProperty("invalidAttributeValue.message",
      "Unexpected or invalid content was encountered within a "
        + "<saml:Attribute> or <saml:AttributeValue> element.");
  }
   
  /**
   * Tests the {@link PEPSUtil#createInstance(Properties)} method for the given
   * properties object.
   */
  @Test
  public void testCreateInstance() {
    Assert.assertNotNull(PEPSUtil.createInstance(CONFIGS2));
  }
  
  /**
   * Tests the {@link PEPSUtil#getConfigs()}.
   */
  @Test
  public void testGetConfigs() {
    final PEPSUtil pepsUtils = PEPSUtil.createInstance(CONFIGS1);
    assertEquals(pepsUtils.getConfigs(), CONFIGS1);
  }
  
  /**
   * Tests the {@link PEPSUtil#getConfigs()}.
   */
  @Test
  public void testGetConfigsDifferent() {
    final PEPSUtil pepsUtils = PEPSUtil.createInstance(CONFIGS1);
    assertNotSame(pepsUtils.getConfigs(), CONFIGS2);
  }
  
  /**
   * Tests the {@link PEPSUtil#getConfig(String)} method for the given existing
   * config.
   */
  @Test
  public void testGetConfigExists() {
    assertEquals(PEPSUtil.getConfig("hashDigest.className"),
      "org.bouncycastle.crypto.digests.SHA512Digest");
  }
  
  /**
   * Tests the {@link PEPSUtil#getConfig(String)} method for the given not
   * existing config.
   */
  @Test
  public void testGetConfigNoExists() {
    assertNull(PEPSUtil.getConfig("doesnt.exists"));
  }
  
  /**
   * Tests the {@link PEPSUtil#getConfig(String)} method for the given null
   * value.
   */
  @Test(expected = NullPointerException.class)
  public void testGetConfigNull() {
    assertNull(PEPSUtil.getConfig(null));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterExists() {
    assertTrue(PEPSUtil.isValidParameter("qaaLevel", "1"));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterExistsGreat() {
    assertFalse(PEPSUtil.isValidParameter("qaaLevel", "12"));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterExistsIvalidConf() {
    assertFalse(PEPSUtil
      .isValidParameter("spUrl", "http://localhost:8080/SP/"));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterNotExists() {
    assertFalse(PEPSUtil.isValidParameter("doesntexists",
      "http://localhost:8080/SP/"));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterNullParamName() {
    assertFalse(PEPSUtil.isValidParameter(null, "http://localhost:8080/SP/"));
  }
  
  /**
   * Tests the {@link PEPSUtil#isValidParameter(String, String)} method for the
   * given param values.
   */
  @Test
  public void testIsValidParameterNullParamValue() {
    assertFalse(PEPSUtil.isValidParameter("spUrl", null));
  }
  
  /**
   * Tests the {@link PEPSUtil#validateParameter(String, String, Object)} method
   * for the given object values.
   */
  @Test
  public void testValidateParameterValid() {
    final IPersonalAttributeList persAttrList = new PersonalAttributeList();
    persAttrList.populate("isAgeOver:true:[15,]:Available;");
    PEPSUtil.validateParameter("ServiceProviderAction",
      PEPSParameters.ATTRIBUTE_LIST.toString(), persAttrList);
  }
  
  /**
   * Tests the {@link PEPSUtil#validateParameter(String, String, Object)} method
   * for the given string values.
   */
  @Test(expected = InvalidParameterPEPSException.class)
  public void testValidateParameterNull() {
    PEPSUtil.validateParameter("ServiceProviderAction",
      PEPSParameters.ATTRIBUTE_LIST.toString(), null);
  }
  
  /**
   * Tests the {@link PEPSUtil#validateParameter(String, String, String)} method
   * for the given string values.
   * 
   * The tested class just invokes
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * so further tests will be later.
   */
  @Test
  public void testValidateParameter() {
    PEPSUtil.validateParameter("ServiceProviderAction",
      PEPSParameters.ATTRIBUTE_LIST.toString(),
      "isAgeOver:true:[15,]:Available;");
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, PEPSErrors)}
   * method for the given string value and {@link PEPSErrors} enum.
   * 
   * The tested class just invokes
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * so further tests will be later.
   */
  @Test
  public void testValidateParameterPEPSErrors() {
    PEPSUtil.validateParameter("CountrySelectorAction",
      PEPSParameters.ATTRIBUTE_LIST.toString(),
      "isAgeOver:true:[15,]:Available;",
      PEPSErrors.SP_COUNTRY_SELECTOR_INVALID_ATTR);
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * method for the given string values.
   */
  @Test
  public void testValidateParameterValidParams() {
    PEPSUtil.validateParameter("ServiceProviderAction", "qaaLevel", "1",
      "qaaLevel.code", "qaaLevel.message");
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * method for the given string values.
   */
  @Test(expected = InvalidParameterPEPSException.class)
  public void testValidateParameterInvalidParamValue() {
    PEPSUtil.validateParameter("ServiceProviderAction", "qaaLevel", "10",
      "qaaLevel.code", "qaaLevel.message");
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * method for the given string values.
   */
  @Test(expected = InvalidParameterPEPSException.class)
  public void testValidateParameterInvalidParamName() {
    PEPSUtil.validateParameter("ServiceProviderAction", "doesnt.exists", "1",
      "qaaLevel.code", "qaaLevel.message");
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * method for the given string values.
   */
  @Test(expected = InvalidParameterPEPSException.class)
  public void testValidateParameterNullParamName() {
    PEPSUtil.validateParameter("ServiceProviderAction", null, "1",
      "qaaLevel.code", "qaaLevel.message");
  }
  
  /**
   * Tests the
   * {@link PEPSUtil#validateParameter(String, String, String, String, String)}
   * method for the given string values.
   */
  @Test(expected = InvalidParameterPEPSException.class)
  public void testValidateParameterNullParamValue() {
    PEPSUtil.validateParameter("ServiceProviderAction", "qaaLevel", null,
      "qaaLevel.code", "qaaLevel.message");
  }
  
  /**
   * Tests the {@link PEPSUtil#encodeSAMLToken(byte[])} method for the given
   * string value.
   */
  @Test
  public void testEncodeSAMLToken() {
    assertEquals(PEPSUtil.encodeSAMLToken(SAML_BYTE_SAMPLE), SAML_BASE64_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#encodeSAMLToken(byte[])} method for the given
   * null.
   */
  @Test(expected = NullPointerException.class)
  public void testEncodeSAMLTokenNull() {
    assertNotSame(PEPSUtil.encodeSAMLToken(null), SAML_BASE64_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#encodeSAMLToken(byte[])} method for the given
   * empty byte[] value.
   */
  @Test
  public void testEncodeSAMLTokenEmpty() {
    assertEquals(PEPSUtil.encodeSAMLToken(EMPTY_BYTE), EMPTY_STRING);
  }
  
  /**
   * Tests the {@link PEPSUtil#decodeSAMLToken(byte[])} method for the given
   * byte[] value.
   */
  @Test
  public void testDecodeSAMLToken() {
    assertArrayEquals(PEPSUtil.decodeSAMLToken(SAML_BASE64_SAMPLE),
      SAML_BYTE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#decodeSAMLToken(byte[])} method for the given
   * null value.
   */
  @Test(expected = NullPointerException.class)
  public void testDecodeSAMLTokenNull() {
    assertNotSame(PEPSUtil.decodeSAMLToken(null), SAML_BYTE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#decodeSAMLToken(byte[])} method for the given
   * empty string value.
   */
  @Test(expected = StringIndexOutOfBoundsException.class)
  public void testDecodeSAMLTokenEmpty() {
    assertTrue(PEPSUtil.decodeSAMLToken(EMPTY_STRING) == EMPTY_BYTE);
  }
  
  /**
   * Tests the {@link PEPSUtil#hashPersonalToken(byte[])} method for the given
   * byte[] value.
   */
  @Test
  public void testHashPersonalToken() {
    assertArrayEquals(PEPSUtil.hashPersonalToken(SAML_BASE64_BYTE_SAMPLE),
      HASH_BYTE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#hashPersonalToken(byte[])} method for the given
   * null value.
   */
  @Test(expected = InternalErrorPEPSException.class)
  public void testHashPersonalTokenNull() {
    assertNull(PEPSUtil.hashPersonalToken(null));
  }
  
  /**
   * Tests the {@link PEPSUtil#hashPersonalToken(byte[])} method for the given
   * empty value.
   */
  @Test
  public void testHashPersonalTokenEmpty() {
    assertArrayEquals(PEPSUtil.hashPersonalToken(EMPTY_BYTE), EMPTY_HASH_BYTE);
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * correct message.
   */
  @Test
  public void testGetStorkErrorCodeExists() {
    assertEquals(PEPSUtil.getStorkErrorCode(MESSAGE_SAMPLE), ERROR_CODE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * invalid message.
   */
  @Test
  public void testGetStorkErrorCodeNoExists() {
    assertNull(PEPSUtil.getStorkErrorCode(ERROR_MESSAGE_SAMPLE));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * empty message.
   */
  @Test
  public void testGetStorkErrorCodeEmpty() {
    assertNull(PEPSUtil.getStorkErrorCode(EMPTY_STRING));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * null message.
   */
  @Test
  public void testGetStorkErrorCodeNull() {
    assertNull(PEPSUtil.getStorkErrorCode(null));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * invalid message.
   */
  @Test
  public void testGetStorkErrorCodeWithSepFake() {
    assertNull(PEPSUtil.getStorkErrorCode("-"));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorCode(String)} method for the given
   * invalid message.
   */
  @Test
  public void testGetStorkErrorCodeWithSepAndCodeFake() {
    assertNull(PEPSUtil.getStorkErrorCode("000001 -"));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given correct message.
   */
  @Test
  public void testGetStorkErrorMessageExists() {
    assertEquals(PEPSUtil.getStorkErrorMessage(MESSAGE_SAMPLE),
      ERROR_MESSAGE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given invalid message.
   */
  @Test
  public void testGetStorkErrorMessageNoExists() {
    assertEquals(PEPSUtil.getStorkErrorMessage(ERROR_MESSAGE_SAMPLE),
      ERROR_MESSAGE_SAMPLE);
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given empty message.
   */
  @Test
  public void testGetStorkErrorMessageEmpty() {
    assertEquals(PEPSUtil.getStorkErrorMessage(EMPTY_STRING),
      EMPTY_STRING);
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given null message.
   */
  @Test
  public void testGetStorkErrorMessageNull() {
    assertNull(PEPSUtil.getStorkErrorMessage(null));
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given invalid message.
   */
  @Test
  public void testGetStorkErrorMessageWithSepFake() {
    assertEquals(PEPSUtil.getStorkErrorMessage("-"),"-");
  }
  
  /**
   * Tests the {@link PEPSUtil#getStorkErrorMessage(String)} method for the
   * given invalid message.
   */
  @Test
  public void testGetStorkErrorMessageWithSepAndCodeFake() {
    assertEquals(PEPSUtil.getStorkErrorMessage("000001 -"),"000001 -");
  }
  
}