/*!
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.test.platform.web;

import static junit.framework.Assert.assertEquals;
import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;

import java.io.IOException;
import java.util.Date;

import org.custommonkey.xmlunit.Diff;
import org.custommonkey.xmlunit.examples.RecursiveElementNameAndTextQualifier;
import org.junit.Before;
import org.junit.Test;
import org.pentaho.platform.api.cache.ILastModifiedCacheItem;
import org.pentaho.platform.plugin.services.cache.CacheExpirationRegistry;
import org.pentaho.platform.web.servlet.CacheExpirationService;
import org.xml.sax.SAXException;

/**
 * User: rfellows Date: 10/25/11 Time: 2:42 PM
 */
public class CacheExpirationServiceTest {
  CacheExpirationRegistry registry;
  CacheExpirationService service;

  @Before
  public void setup() {
    registry = new CacheExpirationRegistry();
    service = new CacheExpirationService();
    service.setExpirationRegistry( registry );
  }

  @Test
  public void testGetXml() {
    TestCacheItem item = new TestCacheItem( "pentaho_cache_itemKey" );
    String lm = Long.toString( item.getLastModified() );

    registry.register( item );

    String xml = service.getXml();
    String expected =
        "<cache-expiration-items><cache-item><key>pentaho_cache_itemKey</key><last-modified>" + lm
            + "</last-modified></cache-item></cache-expiration-items>";
    assertEquals( expected, xml );
    assertEquals( 1, registry.getCachedItems().size() );

    // re-registering an item with the same key will just overwrite the old one
    registry.register( item );
    xml = service.getXml();
    assertEquals( expected, xml );
    assertEquals( 1, registry.getCachedItems().size() );

  }

  @Test
  public void testGetXml_MultipleItems() throws SAXException, IOException {
    TestCacheItem item = new TestCacheItem( "pentaho_cache_itemKey1" );
    String lm = Long.toString( item.getLastModified() );

    registry.register( item );

    item = new TestCacheItem( "pentaho_cache_itemKey2" );
    String lm2 = Long.toString( item.getLastModified() );

    registry.register( item );

    String xml = service.getXml();
    
    Diff myDiff = new Diff( "<cache-expiration-items><cache-item><key>pentaho_cache_itemKey1</key><last-modified>" + lm
          + "</last-modified></cache-item><cache-item><key>pentaho_cache_itemKey2</key><last-modified>" + lm2
          + "</last-modified></cache-item></cache-expiration-items>", xml);

    //This allows the xml elements to be ordered differently and still pass the equality check
    myDiff.overrideElementQualifier( new RecursiveElementNameAndTextQualifier( ) );
    assertXMLEqual(
        "But they are equal when an ElementQualifier controls which test element is compared with each control element",
        myDiff, true );

    assertEquals( 2, registry.getCachedItems().size() );

  }

  @Test
  public void testUnRegister() {
    TestCacheItem item = new TestCacheItem( "pentaho_cache_itemKey1" );
    String lm = Long.toString( item.getLastModified() );

    registry.register( item );
    assertEquals( 1, registry.getCachedItems().size() );

    registry.unRegister( item );
    assertEquals( 0, registry.getCachedItems().size() );

  }

  class TestCacheItem implements ILastModifiedCacheItem {

    String key;
    long timestamp;

    TestCacheItem( String key ) {
      this.key = key;
      this.timestamp = new Date().getTime();
    }

    @Override
    public long getLastModified() {
      return timestamp;
    }

    @Override
    public String getCacheKey() {
      return key;
    }
  }

}