/*
    * CollectionTest.java
    * JUnit based test
    *
    * Created on May 4, 2004, 4:04 PM
    */
   
   package gov.noaa.gdsg.xmldbremote.xmldbClient;
   
  import junit.framework.*;
  import org.xmldb.api.base.Collection;
  import org.xmldb.api.base.XMLDBException;
  import org.xmldb.api.base.Resource;
  import org.xmldb.api.base.Service;
  import org.xmldb.api.base.ErrorCodes;
  import org.xmldb.api.modules.XMLResource;
  
  import java.util.Map;
  import java.util.HashMap;
  
  /***
   *
   * @author tns
   */
  public class XmldbClientCollectionTest extends TestCase {
      
      private Collection collection = null;
      private String endPointUrl = "http://localhost:8080/mm/services/nmmrdb";
      private String collectionUri = "xmldb:nmmr://www.ngdc.noaa.gov/nmmrdb/NGDC";
      private String collectionName = "NGDC";
      private String collectionUserName = "guest";
      private String collectionPassword = "guest";
      private String childCollection = null;
      private String testRecord = "test_record.xml";
      
      public XmldbClientCollectionTest(java.lang.String testName) {
          super(testName);
      }
      
      public static Test suite() {
          TestSuite suite = new TestSuite(XmldbClientCollectionTest.class);
          return suite;
      }
      
      protected void setUp() throws Exception {
          try {
              //set up the database
              XmldbClientDatabase db = new XmldbClientDatabase();
              db.setEndPointUrl(endPointUrl);
              db.init();
              this.collection = db.getCollection(collectionUri, collectionUserName, collectionPassword);
          } catch (XMLDBException e){
              e.printStackTrace();
              throw new Exception(e);
          }
      }
      
      protected void tearDown() throws Exception {
          this.collection.close();
          this.collection = null;
      }
      
      /*** Test of close method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
      public void testClose() throws Exception {
          System.out.println("testClose");
          
          // Add your test code below by replacing the default call to fail.
          this.collection.close();
      }
      
      /*** Test of createId method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
      public void testCreateId() throws Exception {
          System.out.println("testCreateId");
          String id = this.collection.createId();
          
      }
      
      /*** Test of createResource method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
      public void testCreateResource() throws Exception {
          System.out.println("testCreateResource");
          
          // Add your test code below by replacing the default call to fail.
          String id = this.collection.createId();
          Resource resource = this.collection.createResource(id, "XMLResource");
          assertNotNull("Resource not created, null returned",resource);
      }
      
      /*** Test of getChildCollection method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
      public void testGetChildCollection() throws Exception {
          System.out.println("testGetChildCollection");
          
          // Add your test code below by replacing the default call to fail.
          Collection childCollection = this.collection.getChildCollection(this.childCollection);
      }
      
      /*** Test of getChildCollectionCount method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
      public void testGetChildCollectionCount() throws Exception {
          System.out.println("testGetChildCollectionCount");
          
         // Add your test code below by replacing the default call to fail.
         int count = this.collection.getChildCollectionCount();
     }
     
     /*** Test of getName method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetName()  throws Exception {
         System.out.println("testGetName");
         
         // Add your test code below by replacing the default call to fail.
         String name = this.collection.getName();
         assertNotNull("Collection name is null",name);
         assertEquals(name,this.collectionName);
     }
     
     /*** Test of getParentCollection method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetParentCollection()  throws Exception {
         System.out.println("testGetParentCollection");
         
         // Add your test code below by replacing the default call to fail.
         Collection parent = this.collection.getParentCollection();
     }
     
     /*** Test of getProperty method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetProperty()  throws Exception {
         System.out.println("testGetProperty");
         
         // Add your test code below by replacing the default call to fail.
         String result = this.collection.getProperty("");
     }
     
     /*** Test of getResource method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetResource()  throws Exception {
         System.out.println("testGetResource");
         
         // Add your test code below by replacing the default call to fail.
         String[] resources = this.collection.listResources();
         if (resources.length == 0){
             fail("No resources in the collection.");
         }
         Resource resource = this.collection.getResource(resources[0]);
         assertNotNull("Resource returned is null, the resource requested is:" + resources[0],resource);
     }
     
     /*** Test of getResourceCount method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetResourceCount()  throws Exception {
         System.out.println("testGetResourceCount");
         
         // Add your test code below by replacing the default call to fail.
         int count = this.collection.getResourceCount();
         String[] ids = this.collection.listResources();
         assertNotNull("listResources returned null ids",ids);
         assertEquals("resource count and list resources should be the same size",count,ids.length);
     }
     
     /*** Test of getService method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetService()  throws Exception {
         System.out.println("testGetService");
         
         // Add your test code below by replacing the default call to fail.
         Service[] services = this.collection.getServices();
         assertNotNull("get services returned null",services);
         assertTrue("No services to check",services.length != 0);
         for (int i = 0; i < services.length; i++){
             String name = services[i].getName();
             assertNotNull("Null name",name);
             String version = services[i].getVersion();
             assertNotNull("Null versioin",version);
             Service service = this.collection.getService(name, version);
             assertNotNull("Request for service with name:" + name + " version:" + version
             + " returned null", service);
             
             //compare the two
             String serviceName = service.getName();
             assertNotNull("Retrived service name is null",serviceName);
             String serviceVersion = service.getVersion();
             assertNotNull("Retrives service version is null",serviceVersion);
             boolean equals = serviceName.equals(name) && serviceVersion.equals(version);
             
             
             assertTrue("Retrived service different then requested service, "
             + " retrived service name:" + serviceName + " version:" + serviceVersion
             + " requested service name:" + name + " version:" + version, equals);
         }
     }
     
     public void testGetDummyService() throws Exception {
         System.out.println("testGetDummyService");
         
         //make sure dummy versioin/name return null service
         try {
             Service service = this.collection.getService("lakjfjdljaljdlfdlkadlfad", ";aldflajdkfdkfalaf;lajdla");
             fail("Service request did not throw a NO_SUCH_SERVICE exception");
         } catch (XMLDBException expected){
             //expected
         }
         
         
     }
     
     
     /*** Test of getServices method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testGetServices()  throws Exception {
         System.out.println("testGetServices");
         
         // Add your test code below by replacing the default call to fail.
         Service[] services = this.collection.getServices();
         assertNotNull("Services returned",services);
         for (int i = 0; i < services.length; i++){
             assertNotNull("Service in service array",services[i]);
             System.out.println("Service returned:" + services[i].getName() + "," + services[i].getVersion());
         }
     }
     
     /*** Test of isOpen method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testIsOpen()  throws Exception {
         System.out.println("testIsOpen");
         
         // Add your test code below by replacing the default call to fail.
         this.collection.isOpen();
     }
     
     /*** Test of listChildCollections method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testListChildCollections()  throws Exception {
         System.out.println("testListChildCollections");
         
         // Add your test code below by replacing the default call to fail.
         this.collection.listChildCollections();
     }
     
     /*** Test of listResources method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testListResources()  throws Exception {
         System.out.println("testListResources");
         
         // Add your test code below by replacing the default call to fail.
         String[] resources = this.collection.listResources();
         assertNotNull(resources);
         assertTrue("listResources returned 0 resources",  resources.length > 0);
         for (int i = 0; i < resources.length; i++){
             assertNotNull("The index of " + i + " in the list of resources contains a null resource",resources[i]);
         }
     }
     
     /*** Test of removeResource method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testRemoveResource()  throws Exception {
         System.out.println("testRemoveResource");
        
         int beginningCount = this.collection.getResourceCount();
         // Add your test code below by replacing the default call to fail.
         String[] resources = this.collection.listResources();
         assertNotNull(resources);
         assertTrue("NO resources to remove",0 != resources.length);
         Resource resource = this.collection.getResource(resources[0]);
         assertNotNull("Requested resource not available", resource);
         this.collection.removeResource(resource);
         assertEquals("ending count should be one less than beginning count",
         beginningCount, this.collection.getResourceCount() + 1);
     }
     
     /*** Test of setProperty method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testSetProperty() throws Exception  {
         System.out.println("testSetProperty");
         
         // Add your test code below by replacing the default call to fail.
         this.collection.setProperty("prop","val");
     }
     
     private org.w3c.dom.Node loadTestRecord() throws Exception {
         java.io.InputStream is = this.getClass().getResourceAsStream(this.testRecord);
         if (is == null){
             throw new NullPointerException("Input Stream not found for test record:" 
             + this.testRecord);
         }
             javax.xml.parsers.DocumentBuilderFactory factory =
                 new org.apache.xerces.jaxp.DocumentBuilderFactoryImpl();
         javax.xml.parsers.DocumentBuilder builder = 
             factory.newDocumentBuilder();
         return builder.parse(is);
     }
     
     /*** Test of storeResource method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testStoreNewResource()  throws Exception {
         System.out.println("testStoreNewResource");
         
         int beginningCount = this.collection.getResourceCount();
         
         // Add your test code below by replacing the default call to fail.
         String id = this.collection.createId();
         XMLResource resource = (XMLResource) this.collection.createResource(id, "XMLResource");
         assertNotNull("Resource not created, null returned",resource);
         org.w3c.dom.Node testRecord = this.loadTestRecord();
         resource.setContentAsDOM(testRecord);
         this.collection.storeResource(resource);
         
         int endingCount = this.collection.getResourceCount();
         assertEquals("Ending count should have been one more than beginning count",
         beginningCount + 1, endingCount);
         
     }
     
     /*** Test of storeResource method, of class gov.noaa.mm.xmldbImpl.BMSCollection. */
     public void testStoreUpdatedResource()  throws Exception {
         System.out.println("testUpdatedStoreResource");
         
         // Add your test code below by replacing the default call to fail.
         int beginningCount = this.collection.getResourceCount();
         
         String resources[] = this.collection.listResources();
         assertNotNull("listResources returned null");
         this.assertTrue("no resources in collection", resources.length > 0);
         Resource resource = this.collection.getResource(resources[0]);
         assertNotNull("Resource was null", resource);
         if (resource instanceof XMLResource){
             XMLResource xResource = (XMLResource) resource;
             xResource.setContentAsDOM(this.loadTestRecord());
             this.collection.storeResource(xResource);
         }
         else {
             fail("Only XMLResource can currently be tested");
         }
         
         
         
         
     }
     
     
     
     
     // Add test methods here, they have to start with 'test' name.
     // for example:
     // public void testHello() {}
     
     
 }