/*
    * Copyright 2012 smartics, Kronseder & Reiner GmbH
    *
    * 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 test.de.smartics.ci.config.utils;
  
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.hamcrest.Matchers.equalTo;
  import static org.hamcrest.Matchers.is;
  
  import org.jdom.Element;
  import org.jdom.JDOMException;
  import org.junit.Test;
  import org.junit.experimental.categories.Category;
  
  import de.smartics.ci.config.utils.JDomUtils;
  import de.smartics.testdoc.annotations.Uut;
  import de.smartics.testdoc.categories.Technical;
  import de.smartics.util.lang.NullArgumentException;
  
  /**
   * Tests {@link JDomUtils#calcXPath(Element, Element)}.
   */
  @Uut(type = JDomUtils.class, method = "calcXPath(Element, Element)")
  public class JDomUtilsCalcXPathTest
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- prepare --------------------------------------------------------------
  
    // --- helper ---------------------------------------------------------------
  
    // --- tests ----------------------------------------------------------------
  
    @Test(expected = NullArgumentException.class)
    public void rejectsIfElementIsNull() throws JDOMException
    {
      final Element rootElement = new Element("root"); // NOPMD
      JDomUtils.calcXPath(rootElement, null);
    }
  
    @Test
    public void calcsPathFromDocumentRootIfNullArgumentIsPassed()
      throws JDOMException
    {
      final Element element = new Element("test"); // NOPMD
      final Element elementSubElement = new Element("sub"); // NOPMD
      final Element elementSubSubElement = new Element("subsub"); // NOPMD
      element.addContent(elementSubElement);
      elementSubElement.addContent(elementSubSubElement);
  
      final String path = JDomUtils.calcXPath(null, elementSubSubElement);
      assertThat(path, is(equalTo("/test/sub/subsub")));
    }
  
    @Test
    public void calcsPathRelativeToGivenRootElement()
      throws JDOMException
    {
      final Element element = new Element("test");
      final Element elementSubElement = new Element("sub");
      final Element elementSubSubElement = new Element("subsub");
      element.addContent(elementSubElement);
      elementSubElement.addContent(elementSubSubElement);
  
      final String path = JDomUtils.calcXPath(element, elementSubSubElement);
      assertThat(path, is(equalTo("sub/subsub")));
    }
  
    @Test
    @Category(Technical.class)
    public void rootElementIsNotRequiredToBeADirectChildOfTheDocumentsRoot()
      throws JDOMException
    {
      final Element element = new Element("test");
      final Element elementSubElement = new Element("sub");
      final Element elementSubSubElement = new Element("subsub");
      element.addContent(elementSubElement);
      elementSubElement.addContent(elementSubSubElement);
  
     final String path = JDomUtils.calcXPath(elementSubElement, elementSubSubElement);
     assertThat(path, is(equalTo("subsub")));
   }
 }